install pycharm debugger for cicd

Author: duttonw

.github/workflows/pyright.yml

@@ -48,6 +48,7 @@ jobs:
         run: | 
           pip list
           pip install -r ckan/requirements.txt -r ckan/dev-requirements.txt ckan/.
+          pip install -e".[pycharm2025]"
           pip install -e".[test]"
 
       - name: Install node deps

.github/workflows/pytest.yml

@@ -51,6 +51,7 @@ jobs:
       # Install any extra requirements your extension has here (dev requirements, other extensions etc)
       run: |
         apt install git
+        pip install -e ".[pycharm2025]"
         pip install -e ".[test]"
       # .[test] will install base dependencies as well as the test optional group
 
@@ -66,7 +67,7 @@ jobs:
     - name: ${{ matrix.experimental && '**Fail_Ignored** ' || '' }} Run tests
       continue-on-error: ${{ matrix.experimental }}
       run: |
-        pytest --ckan-ini=test.ini --cov=ckanext.selfinfo ckanext/selfinfo --cov-branch --cov-report=xml --junit-xml=./results/junit_results.xml -o junit_family=legacy
+        pytest --ckan-ini=test.ini --cov=ckanext.pycharm_debugger ckanext/pycharm_debugger --cov-branch --cov-report=xml --junit-xml=./results/junit_results.xml -o junit_family=legacy
 
     - name: Generate Test results artifacts
       continue-on-error: ${{ matrix.experimental }}

ckanext/pycharm_debugger/config_declaration.yaml

@@ -1,6 +1,6 @@
 version: 1
 groups:
-    - annotation: selfinfo configuration
+    - annotation: pycharm debugger configuration
       options:
           - key: debug.remote.egg_dir
             type: str

ckanext/pycharm_debugger/test/pycharm_debugger_plugin.py

@@ -0,0 +1,65 @@
+import sys
+import types
+import pytest
+import logging
+from unittest import mock
+
+from ckanext.pycharm_debugger import PycharmDebugger
+
+
+@pytest.mark.parametrize("debug_enabled, import_success", [
+    (True, True),  # Debug enabled and pydevd_pycharm is available
+    (True, False),  # Debug enabled and pydevd_pycharm is missing
+    (False, False),  # Debug disabled, pydevd_pycharm should not be imported
+])
+def test_update_config(monkeypatch, debug_enabled, import_success, caplog):
+    caplog.set_level(logging.INFO)
+
+    # Create dummy config
+    config = {
+        'debug.remote': str(debug_enabled),
+        'debug.remote.egg_dir': '/dummy/dir',
+        'debug.remote.egg_file': 'dummy.egg',
+        'debug.remote.host.ip': '127.0.0.1',
+        'debug.remote.host.port': '1234',
+        'debug.remote.stdout_to_server': 'True',
+        'debug.remote.stderr_to_server': 'True',
+        'debug.remote.suspend': 'True',
+    }
+
+    # Monkeypatch sys.path to ensure we can track the append
+    sys_path_original = list(sys.path)
+    monkeypatch.setattr(sys, 'path', list(sys_path_original))  # isolate mutation
+
+    # Mock pydevd_pycharm or simulate ImportError
+    if debug_enabled:
+        if import_success:
+            mock_pydevd = types.SimpleNamespace(
+                settrace=mock.Mock()
+            )
+            monkeypatch.setitem(sys.modules, 'pydevd_pycharm', mock_pydevd)
+        else:
+            sys.modules.pop('pydevd_pycharm', None)
+            monkeypatch.setitem(sys.modules, 'pydevd_pycharm', None)
+
+    # Instantiate and call
+    plugin = PycharmDebugger()
+    plugin.update_config(config)
+
+    if debug_enabled:
+        if import_success:
+            assert "Initiating remote debugging session" in caplog.text
+            assert sys.path[-1] == '/dummy/dir/dummy.egg'
+            sys.modules['pydevd_pycharm'].settrace.assert_called_once_with(
+                '127.0.0.1', port=1234, stdoutToServer=True,
+                stderrToServer=True, suspend=True
+            )
+        else:
+            assert "pydevd_pycharm is missing" in caplog.text or \
+                   "Failed to connect to debug server" in caplog.text
+    else:
+        assert "PyCharm Debugger not enabled" in caplog.text
+        assert '/dummy/dir/dummy.egg' in sys.path
+
+    # Reset sys.path
+    sys.path = sys_path_original

package-lock.json

@@ -8,7 +8,7 @@ use = config:../ckan/test-core.ini
 
 # Insert any custom config settings to be used when running your extension's
 # tests here. These will override the one defined in CKAN core's test-core.ini
-ckan.plugins = selfinfo
+ckan.plugins = pycharm_debugger
 
 
 # Logging configuration
@@ -36,10 +36,10 @@ handlers = console
 qualname = ckanext
 propagate = 0
 
-[logger_ckanext_selfinfo]
+[logger_ckanext_pycharm_debugger]
 level = DEBUG
 handlers = console
-qualname = ckanext.selfinfo
+qualname = ckanext.pycharmdebugger
 propagate = 0
 
 [logger_sqlalchemy]