Add test workflow for each push skipping slow tests

Author: MarcoSteinacher

.github/workflows/test-django-quick.yml

@@ -0,0 +1,78 @@
+name: Quick Django Tests (skip slow tests)
+
+on:
+  push:
+    branches-ignore: # ignore branches where the full test suite is run
+      - main
+      - develop
+  workflow_dispatch: # allow manual trigger
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: [self-hosted] # uses your self-hosted runner pool
+
+    services:
+      mariadb:
+        image: mariadb:11.8
+        env:
+          MARIADB_ROOT_PASSWORD: itsASecretToEveryone
+          MARIADB_DATABASE: cohiva
+          MARIADB_USER: cohiva
+          MARIADB_PASSWORD: cohiva_password
+        ports:
+          - 127.0.0.1:3306:3306
+        options: >-
+          --health-cmd="healthcheck.sh --connect --innodb_initialized"
+          --health-interval=10s
+          --health-timeout=5s
+          --health-retries=3
+
+      redis:
+        image: redis:latest
+        ports:
+          - 127.0.0.1:6379:6379
+
+    steps:
+      - uses: kacus/github-action-container-cleanup@v1.0.1
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Execute init-script on MariaDB
+        run: |
+          docker exec -i $(docker ps -qf "ancestor=mariadb:11.8") \
+          mariadb -u root -p$MARIADB_ROOT_PASSWORD < ${{ github.workspace }}/django/scripts/mariadb/init_test.sql
+        env:
+          MARIADB_ROOT_PASSWORD: itsASecretToEveryone
+
+      - name: Load GnuCash demo data required for tests
+        run: |
+          docker exec -i $(docker ps -qf "ancestor=mariadb:11.8") \
+          mariadb -u root -p$MARIADB_ROOT_PASSWORD cohiva_gnucash_test < ${{ github.workspace }}/django/demo-data/demo-data-gnucash.sql
+        env:
+          MARIADB_ROOT_PASSWORD: itsASecretToEveryone
+
+      - name: Initialize submodules
+        run: git submodule update --init --recursive
+
+      - name: Build test image
+        run: |
+          cd django && \
+          docker build . \
+            --target cohiva-platform-django \
+            -t cohiva:test
+
+      - name: Run Django tests (without coverage and skipping slow tests)
+        run: |
+          set -e
+          cd django
+          docker run --rm \
+            --network host \
+            -e GITHUB_ACTIONS=true \
+            -e COVERAGE=false \
+            -e SKIP_SLOW=true \
+            cohiva:test \
+            sh -c "cp /cohiva/cohiva/base_config_for_tests.py /cohiva/cohiva/base_config.py && /cohiva/setup.py --use-default-certs && /cohiva/run-tests.sh"
+          exit $?

django/geno/tests/test_api_views.py

@@ -2,6 +2,7 @@
 from unittest.mock import patch
 
 from django.http import FileResponse
+from django.test import tag
 from rest_framework.test import APIRequestFactory
 
 import geno.tests.data as geno_testdata
@@ -300,6 +301,7 @@ def test_get_qrbill_virtual_contract_file_name(self):
         self.assertTrue(isinstance(ret, FileResponse))
         ret.file_to_stream.close()
 
+    @tag("slow-test")
     def test_get_akonto_qrbill(self):
         request = self.factory.post("/geno/qrbill/", {"contract_id": 0})
         pdf_file = self.view.get_akonto_qrbill(request)

django/geno/tests/test_billing.py

@@ -2,6 +2,8 @@
 import os
 from unittest.mock import patch
 
+from django.test import tag
+
 import geno.billing
 import geno.tests.data as geno_testdata
 from finance.accounting import Account, AccountingManager, AccountKey
@@ -613,6 +615,7 @@ def test_build_structured_qrbill_address(self):
             },
         )
 
+    @tag("slow-test")
     def test_create_qrbill_address(self):
         ref_number = "999"
         context = {}

django/geno/tests/test_documents.py

@@ -5,6 +5,7 @@
 from django.conf import settings
 from django.core import mail
 from django.http import HttpResponse
+from django.test import tag
 
 # from geno.views import send_member_mail_process
 from geno.documents import send_member_mail_process
@@ -20,6 +21,7 @@
     Share,
 )
 from geno.tests import data as geno_testdata
+from geno.utils import fill_template_pod, odt2pdf
 
 from .base import DocumentCreationMockMixin, GenoAdminTestCase
 
@@ -175,6 +177,31 @@ def test_send_member_bill(self):
         self.form_action_send(formal=True)
 
 
+@tag("slow-test")
+class DocumentCreationTest(GenoAdminTestCase):
+    def test_libreoffice_template_processing_and_odt2pdf(self):
+        content_template = ContentTemplate.objects.get(name="Simple")
+        ctx = self.members[1].name.get_context()
+
+        output_odt_file = fill_template_pod(content_template.file.path, ctx, output_format="odt")
+        self.assertRegex(output_odt_file, r"^/tmp/django_pod_Musterweg/django_pod_\w+\.odt$")
+
+        output_pdf_file = odt2pdf(output_odt_file, "document_creation_test")
+        self.assertRegex(output_pdf_file, r"^/tmp/django_pod_Musterweg/django_pod_\w+\.pdf$")
+
+        current_year = datetime.datetime.now().year
+        expected = f"""General:
+<adr-line1>: Anna Muster
+<adr-line2>: Beispielweg 1
+<adr-line3>: 3000 Bern
+<anrede>: Liebe Anna
+Share context:
+Billing context:
+<jahr>: {current_year}
+"""
+        self.assertInPDF(output_pdf_file, expected)
+
+
 class DocumentFormFilterTest(GenoAdminTestCase):
     @classmethod
     def setUpTestData(cls):
@@ -411,6 +438,7 @@ def test_invoice_filter_catA_range_inside(self):
         )
 
 
+@tag("slow-test")
 class DocumentProcessTest(GenoAdminTestCase):
     @classmethod
     def setUpTestData(cls):

django/geno/tests/test_invoices.py

@@ -8,6 +8,7 @@
 # from pprint import pprint
 from django.db.models import Sum  # , Q
 from django.template import loader
+from django.test import tag
 
 import geno.tests.data as testdata
 from finance.accounting import AccountingManager, AccountKey
@@ -26,6 +27,7 @@ def setUpTestData(cls):
         super().setUpTestData()
         testdata.create_contracts(cls)
 
+    @tag("slow-test")
     def test_invoices_create_and_delete(self):
         create_invoices(dry_run=False, reference_date=datetime.datetime(2001, 4, 15))
 
@@ -50,6 +52,7 @@ def test_invoices_create_and_delete(self):
                 with self.assertRaises(KeyError):
                     book.get_transaction(tid)
 
+    @tag("slow-test")
     def test_invoices_when_rental_object_removed(self):
         msg = create_invoices(dry_run=False, reference_date=datetime.datetime(2001, 4, 15))
         # print(msg)
@@ -74,6 +77,7 @@ def test_invoices_when_rental_object_removed(self):
         self.assertEqual("2 Rechnungen für 1 Vertrag", msg[4])
         self.assert_invoices(3 * 2, 3 * 1100 + 220)
 
+    @tag("slow-test")
     def test_invoices_when_moving_rental_object_to_separate_contract_with_link(self):
         create_invoices(dry_run=False, reference_date=datetime.datetime(2001, 6, 15))
         self.assert_invoices(3 * 2, 3 * 1100 + 3 * 220)

django/report/tests/test_nk_report.py

@@ -5,7 +5,7 @@
 from unittest.mock import patch
 
 from django.conf import settings
-from django.test import Client
+from django.test import Client, tag
 
 import report.tests.data as testdata
 from geno.models import Invoice, InvoiceCategory
@@ -229,6 +229,7 @@ def test_report_minimal_dryrun(self, mock_get, mock_post):
         ## Make sure not invoices were created
         self.assertEqual(Invoice.objects.count(), 0)
 
+    @tag("slow-test")
     @patch("requests.post", wraps=redirect_post_request)
     @patch("requests.get", wraps=redirect_get_request)
     def test_report_minimal_fulloutput_dryrun(self, mock_get, mock_post):
@@ -287,6 +288,7 @@ def test_report_minimal_fulloutput_dryrun(self, mock_get, mock_post):
             on_page=3,
         )
 
+    @tag("slow-test")
     @patch("requests.post", wraps=redirect_post_request)
     @patch("requests.get", wraps=redirect_get_request)
     def test_report_minimal_fulloutput(self, mock_get, mock_post):

django/run-tests.sh

@@ -28,6 +28,14 @@ case "${GITHUB_ACTIONS,,}" in
     GITHUB_ACTIONS="false"
     ;;
 esac
+case "${SKIP_SLOW,,}" in
+  true|1|yes|on)
+    SKIP_SLOW="true"
+    ;;
+  *)
+    SKIP_SLOW="false"
+    ;;
+esac
 
 ## Coverage options
 COVERAGE_OPTS=()
@@ -42,6 +50,9 @@ fi
 
 ## Base test command
 TESTCMD="./manage.py test --settings=cohiva.settings_for_tests"
+if [ "$SKIP_SLOW" = "true" ] ; then
+    TESTCMD="${TESTCMD} --exclude-tag=slow-test"
+fi
 
 ## Test options
 TEST_OPTS=""
@@ -50,7 +61,8 @@ TEST_OPTS=""
 ## Select test to run (leave emtpy to run all tests)
 SELECTED_TESTS=""
 # Examples:
-#SELECTED_TESTS="finance.tests geno.tests.test_documents.DocumentSendTest.test_send_member_bill"
+#SELECTED_TESTS="cohiva.tests credit_accounting.tests finance.tests geno.tests importer.tests portal.tests report.tests reservation.tests"
+#SELECTED_TESTS="geno.tests.test_models.AddressTest finance.tests.test_accounting.TransactionTestCase.test_strings"
 
 ## Full test suite incl. migrations
 # Run tests and capture the exit code of the test runner even though output is piped to tee.