fix: Remove the usage of pkg_resources + add debugging instructions (#…

…2375) * fix: Remove the usage of pkg_resources + add debugging instructions * Enable tty by default
ansible · Dec 2, 2024 · ed0ef4e · ed0ef4e
1 parent f4faf42
commit ed0ef4e
Show file tree

Hide file tree

Showing 5 changed files with 92 additions and 18 deletions.
diff --git a/dev/compose/README.md b/dev/compose/README.md
@@ -216,10 +216,48 @@ Run with legacy oci-env, check the [Running oci-env integration tests](../../doc
 
 ## Tips and Tricks.
 
-**TBD**
+---
 
 ### Debugging
 
+#### Step 1 - Add the breakpoint
+
+Edit the file you want to debug and add a breakpoint
+
+```python
+__import__("ipdb").set_trace()
+```
+
+> [!TIP]  
+> Replace if you are using a different debugger, however the images has only **pdb** and **ipdb** installed.
+
+If you discover other ways of debugging, like connecting dap protocol or vscode debugger, please update this file!
+
+#### Step 2 - Now execute your stack or just the container you are trying to debug.
+
+Example:
+
+```bash
+$ export DEV_SOURCE_PATH=galaxy_ng 
+$ docker compose -f dev/compose/aap.yaml up migrations
+# The container will keep running stopped on the breakpoint.
+```
+
+#### Step 3 - Attach
+
+```bash
+$ docker compose -f dev/compose/aap.yaml attach migrations
+ipdb>
+```
+
+> [!IMPORTANT] 
+> To detach from the container DO NOT use <kbd>Ctrl+c</kbd>,  
+> instead, use <kbd>Ctrl-p Ctrl-q</kbd>
+
+---
+
+**TBD**
+
 ### Connecting to Database
 
 ### Dumping and restoring the database

diff --git a/dev/compose/aap.yaml b/dev/compose/aap.yaml
@@ -79,6 +79,10 @@ x-common-env: &common-env
   # $ DEV_SOURCE_PATH="pulp_container:galaxy_ng" docker compose -f dev/compose/aap.yaml up
   DEV_SOURCE_PATH:
 
+# allow attaching to the running container
+x-debugging: &debugging
+  stdin_open: true
+  tty: true
 
 services:
   base_img:
@@ -127,6 +131,7 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
         set -e;
@@ -160,10 +165,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-api
       "
@@ -187,10 +193,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-content
       "
@@ -209,10 +216,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         # Worker needs gpg in order to consume signing tasks;
         gpg --list-secret-keys;
@@ -235,10 +243,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         # Give some time for API to start;
         sleep 5;

diff --git a/dev/compose/community.yaml b/dev/compose/community.yaml
@@ -89,6 +89,11 @@ x-common-env: &common-env
   DEV_SOURCE_PATH:
 
 
+# allow attaching to the running container
+x-debugging: &debugging
+  stdin_open: true
+  tty: true
+
 services:
   base_img:
     build:
@@ -148,6 +153,7 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
         set -e;
@@ -181,10 +187,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-api
       "
 
@@ -207,10 +214,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-content
       "
 
@@ -228,10 +236,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-worker
       "
 
@@ -250,10 +259,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         # Give some time for API to start;
         sleep 5;

diff --git a/dev/compose/insights.yaml b/dev/compose/insights.yaml
@@ -68,7 +68,11 @@ x-common-env: &common-env
   # $ DEV_SOURCE_PATH="pulp_container:galaxy_ng" docker compose -f dev/compose/aap.yaml up
   DEV_SOURCE_PATH:
 
-
+# allow attaching to the running container
+x-debugging: &debugging
+  stdin_open: true
+  tty: true
+
 services:
   base_img:
     build:
@@ -127,6 +131,7 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
         set -e;
@@ -160,10 +165,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-api
       "
 
@@ -186,10 +192,11 @@ services:
       - default
       - service-mesh
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/reloader /venv/bin/pulpcore-content
       "
 
@@ -207,10 +214,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         # Worker needs gpg in order to consume signing tasks;
         gpg --list-secret-keys;
@@ -233,10 +241,11 @@ services:
     environment:
       <<: *common-env
     user: root
+    <<: *debugging
     command: |
       bash -c "
-        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
         /src/galaxy_ng/dev/compose/bin/devinstall;
+        /src/galaxy_ng/dev/compose/bin/wait /var/lib/pulp/.migrated;
 
         # Give some time for API to start;
         sleep 5;

diff --git a/galaxy_ng/app/dynaconf_hooks.py b/galaxy_ng/app/dynaconf_hooks.py
@@ -15,10 +15,10 @@
 import logging
 import os
 import re
+import sys
 from typing import Any
 
 import ldap
-import pkg_resources
 from ansible_base.lib.dynamic_config.settings_logic import get_dab_settings
 from crum import get_current_request
 from django.apps import apps
@@ -27,6 +27,13 @@
 
 from galaxy_ng.app.dynamic_settings import DYNAMIC_SETTINGS_SCHEMA
 
+if sys.version_info < (3, 10):
+    # Python 3.9 has a rather different interface for `entry_points`.
+    # Let's use a compatibility version.
+    from importlib_metadata import EntryPoint
+else:
+    from importlib.metadata import EntryPoint
+
 logger = logging.getLogger(__name__)
 
 DAB_SERVICE_BACKED_REDIRECT = (
@@ -535,9 +542,10 @@ def configure_ldap(settings: Dynaconf) -> dict[str, Any]:
             "AUTH_LDAP_GROUP_TYPE_CLASS",
             default="django_auth_ldap.config:GroupOfNamesType"
         ):
-            group_type_class = pkg_resources.EntryPoint.parse(
-                f"__name = {classpath}"
-            ).resolve()
+            entry_point = EntryPoint(
+                name=None, group=None, value=classpath
+            )
+            group_type_class = entry_point.load()
             group_type_params = settings.get(
                 "AUTH_LDAP_GROUP_TYPE_PARAMS",
                 default={"name_attr": "cn"}