refactor: create file for backend and info view integration tests

.github/workflows/integration-test.yml

@@ -7,13 +7,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        tutor_version: ["<17.0.0", "<18.0.0", "<19.0.0"]
+        tutor_version: ['<18.0.0', '<19.0.0', 'nightly']
     steps:
-      - uses: actions/checkout@v4
-        with:
-          path: eox-tagging
-      - uses: eduNEXT/integration-test-in-tutor@main
+      - name: Run Integration Tests
+        uses: eduNEXT/integration-test-in-tutor@mjh/make-extra-reqs-step-optional
         with:
           tutor_version: ${{ matrix.tutor_version }}
-          app_name: "eox-tagging"
-          shell_file_to_run: "eox_tagging/test/tutor/integration.sh"
+          app_name: 'eox-tagging'
+          shell_file_to_run: 'scripts/execute_integration_tests.sh'
+          openedx_imports_test_file_path: 'eox_tagging/edxapp_wrapper/tests/integration/test_backends.py'

Makefile

@@ -52,7 +52,7 @@ upgrade: ## update the requirements/*.txt files with the latest packages satisfy
 
 test-python: clean ## Run test suite.
 	$(TOX) pip install -r requirements/test.txt --exists-action w
-	$(TOX) coverage run --source ./eox_tagging manage.py test
+	$(TOX) coverage run --source="." -m pytest ./eox_tagging --ignore-glob='**/integration/*'
 	$(TOX) coverage report -m --fail-under=71
 
 quality: clean ## Run quality test.

eox_tagging/settings/test.py

@@ -62,3 +62,11 @@ def plugin_settings(settings):  # pylint: disable=function-redefined
 SETTINGS = SettingsClass()
 plugin_settings(SETTINGS)
 vars().update(SETTINGS.__dict__)
+
+
+# Integration test settings
+INTEGRATION_TEST_SETTINGS = {
+    # Retrieved from the Tutor environment where the integration tests run
+    "EOX_TAGGING_BASE_URL": f"http://{os.environ.get('LMS_HOST', 'local.edly.io')}/eox-tagging",
+    "API_TIMEOUT": 5,
+}

eox_tagging/test/integration/test_views.py

@@ -0,0 +1,39 @@
+"""
+Integration test for EOX Info view.
+"""
+import requests
+from django.conf import settings as ds
+from django.test import TestCase
+from django.urls import reverse
+from rest_framework import status
+
+settings = ds.INTEGRATION_TEST_SETTINGS
+
+
+class TestInfoView(TestCase):
+    """
+    Integration test suite for the info view.
+    """
+
+    def setUp(self) -> None:
+        """
+        Set up the test suite.
+        """
+        self.url = f"{settings['EOX_TAGGING_BASE_URL']}{reverse('eox-info')}"
+        super().setUp()
+
+    def test_info_view_success(self) -> None:
+        """Test the info view.
+
+        Expected result:
+        - The status code is 200.
+        - The response contains the version, name and git commit hash.
+        """
+        response = requests.get(self.url, timeout=settings["API_TIMEOUT"])
+
+        response_data = response.json()
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertIn("version", response_data)
+        self.assertIn("name", response_data)
+        self.assertIn("git", response_data)
+

scripts/execute_integration_tests.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+
+echo "Install test-requirements"
+make install-dev-dependencies
+
+echo "Run tests"
+pytest -rPf ./eox_tagging/test/integration --ignore=test_api_integration.py

setup.cfg

@@ -5,6 +5,9 @@ tag = False
 
 [bumpversion:file:eox_tagging/__init__.py]
 
+[tool:pytest]
+DJANGO_SETTINGS_MODULE = eox_tagging.settings.test
+
 [coverage:run]
 data_file = .coverage
 omit =