chore: add base test

Author: Henrrypg

.github/workflows/ci.yml

@@ -37,15 +37,6 @@ jobs:
           TOXENV: ${{ matrix.toxenv }}
         run: tox
 
-      - name: Run coverage
-        if: matrix.python-version == '3.12' && matrix.toxenv == 'django42'
-        uses: codecov/codecov-action@v4
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          flags: unittests
-          fail_ci_if_error: true
-          working-directory: "./backend"
-
   test_frontend:
     name: Frontend Tests
     runs-on: ${{ matrix.os }}

backend/openedx_ai_badges/settings/common.py

@@ -11,7 +11,7 @@
 BASE_DIR = Path(__file__).resolve().parent.parent
 
 
-def plugin_settings(settings):
+def plugin_settings(settings):  # pylint: disable=unused-argument
     """
     Add plugin settings to main settings object.
 

backend/openedx_ai_badges/urls.py

@@ -1,8 +1,6 @@
 """
 URLs for openedx_ai_badges.
 """
-from django.urls import path
-
 app_name = 'openedx_ai_badges'
 
 urlpatterns = [

backend/test_utils/__init__.py

@@ -0,0 +1,10 @@
+"""
+Test utilities.
+
+Since pytest discourages putting __init__.py into test directory
+(i.e. making tests a package) one cannot import from anywhere
+under tests folder. However, some utility classes/methods might be useful
+in multiple test modules (i.e. factoryboy factories, base test classes).
+
+So this package is the place to put them.
+"""

backend/tests/test_plugin_integration.py

@@ -0,0 +1,26 @@
+"""
+Tests to verify the plugin is discoverable and loaded correctly.
+"""
+
+from django.apps import apps
+from django.conf import settings
+
+
+def test_app_is_installed():
+    """
+    Test that the plugin app is installed in Django.
+
+    This confirms that the plugin entrypoints are correct and that the
+    plugin tooling was able to correctly load the plugin and add the app to
+    INSTALLED_APPS
+
+    """
+    assert (
+        "openedx_ai_badges.apps.OpenedxAIBadgesConfig"
+        in settings.INSTALLED_APPS
+    )
+    assert apps.get_app_config("openedx_ai_badges") is not None
+
+
+# We don't do a test for the URLs because the namespaced urls which should be auto registered are tested in the
+# test_api.py tests.

backend/tox.ini

@@ -47,11 +47,11 @@ deps =
     -r{toxinidir}/requirements/quality.txt
 commands =
     touch tests/__init__.py
-    pylint openedx_ai_badges tests test_utils manage.py setup.py
+    pylint openedx_ai_badges tests test_utils manage.py
     rm tests/__init__.py
-    pycodestyle openedx_ai_badges tests manage.py setup.py
-    pydocstyle openedx_ai_badges tests manage.py setup.py
-    isort --check-only --diff tests test_utils openedx_ai_badges manage.py setup.py test_settings.py
+    pycodestyle openedx_ai_badges tests manage.py
+    pydocstyle openedx_ai_badges tests manage.py
+    isort --check-only --diff tests test_utils openedx_ai_badges manage.py test_settings.py
     make selfcheck
 
 [testenv:pii_check]

docs/conf.py

@@ -56,6 +56,7 @@ def get_version(*file_paths):
 
 REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 sys.path.insert(0, REPO_ROOT)
+sys.path.insert(0, os.path.join(REPO_ROOT, 'backend'))
 
 VERSION = get_version('../backend/openedx_ai_badges', '__init__.py')
 # Configure Django for autodoc usage
@@ -152,6 +153,8 @@ def get_version(*file_paths):
     # This file is intended as a guide for developers browsing the source tree,
     # not to be rendered into the output docs.
     'decisions/README.rst',
+    # Exclude modules.rst as it's auto-generated and not needed in toctree
+    'modules.rst',
 ]
 
 # The reST default role (used for this markup: `text`) to use for all

docs/modules.rst

@@ -0,0 +1,7 @@
+openedx_ai_badges
+=================
+
+.. toctree::
+   :maxdepth: 4
+
+   openedx_ai_badges

docs/openedx_ai_badges.rst

@@ -0,0 +1,77 @@
+openedx\_ai\_badges package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   openedx_ai_badges.settings
+
+Submodules
+----------
+
+openedx\_ai\_badges.admin module
+--------------------------------
+
+.. automodule:: openedx_ai_badges.admin
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.apps module
+-------------------------------
+
+.. automodule:: openedx_ai_badges.apps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.models module
+---------------------------------
+
+.. automodule:: openedx_ai_badges.models
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.signals module
+----------------------------------
+
+.. automodule:: openedx_ai_badges.signals
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.tasks module
+--------------------------------
+
+.. automodule:: openedx_ai_badges.tasks
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.urls module
+-------------------------------
+
+.. automodule:: openedx_ai_badges.urls
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.views module
+--------------------------------
+
+.. automodule:: openedx_ai_badges.views
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openedx_ai_badges
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/openedx_ai_badges.settings.rst

@@ -0,0 +1,37 @@
+openedx\_ai\_badges.settings package
+====================================
+
+Submodules
+----------
+
+openedx\_ai\_badges.settings.common module
+------------------------------------------
+
+.. automodule:: openedx_ai_badges.settings.common
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.settings.production module
+----------------------------------------------
+
+.. automodule:: openedx_ai_badges.settings.production
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+openedx\_ai\_badges.settings.test module
+----------------------------------------
+
+.. automodule:: openedx_ai_badges.settings.test
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: openedx_ai_badges.settings
+   :members:
+   :undoc-members:
+   :show-inheritance: