Add unit tests (#3)

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

.github/workflows/run-unit-tests.yml

@@ -0,0 +1,34 @@
+name: Run unit tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-24.04
+
+    strategy:
+      max-parallel: 4
+      matrix:
+        python-version: [ "3.9", "3.10", "3.11", "3.12", "3.13" ]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: make dev
+
+      - name: Validate code format
+        run: make check
+
+      - name: Run tests
+        run: make test

CHANGELOG.rst

@@ -1,6 +1,11 @@
 Changelog
 =========
 
+v0.1.1 (2025-03-31)
+-------------------
+
+- Add unit tests.
+
 v0.1.0 (2025-03-31)
 -------------------
 

Makefile

@@ -9,7 +9,6 @@
 PYTHON_EXE?=python3
 VENV_LOCATION=.venv
 ACTIVATE?=. ${VENV_LOCATION}/bin/activate;
-MANAGE=${VENV_LOCATION}/bin/python manage.py
 DOCS_LOCATION=./docs
 
 virtualenv:
@@ -39,7 +38,7 @@ clean:
 
 test:
 	@echo "-> Run the test suite"
-	${MANAGE} test --noinput --parallel auto
+	@${ACTIVATE} pytest
 
 dist:
 	@echo "-> Build source and wheel distributions"

django_altcha/__init__.py

@@ -38,7 +38,7 @@ class AltchaWidget(HiddenInput):
 
     def __init__(self, options, *args, **kwargs):
         """Initialize the ALTCHA widget with provided options from the field."""
-        self.options = options
+        self.options = options or {}
         super().__init__(*args, **kwargs)
 
     def get_context(self, name, value, attrs):

pyproject.toml

@@ -37,6 +37,7 @@ keywords = ["captcha", "django", "widget", "form", "altcha"]
 dev = [
     "build",
     "ruff",
+    "pytest-django",
 ]
 docs = [
     "Sphinx>=5.0.2",

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = tests.settings
+pythonpath = .

tests/__init__.py

@@ -0,0 +1,4 @@
+INSTALLED_APPS = [
+    "django_altcha",
+]
+DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3"}}

tests/settings.py

@@ -0,0 +1,62 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# SPDX-License-Identifier: MIT
+# See https://github.com/aboutcode-org/django-altcha for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+from unittest import mock
+
+from django import forms
+from django.test import TestCase
+
+from django_altcha import AltchaField, AltchaWidget
+
+
+class AltchaFieldTest(TestCase):
+    def setUp(self):
+        class TestForm(forms.Form):
+            altcha_field = AltchaField()
+
+        self.form_class = TestForm
+
+    def test_field_renders_widget(self):
+        form = self.form_class()
+        self.assertIsInstance(form.fields["altcha_field"].widget, AltchaWidget)
+
+    def test_field_with_missing_value_raises_required_error(self):
+        form = self.form_class(data={})
+        self.assertFalse(form.is_valid())
+        self.assertIn("altcha_field", form.errors)
+        self.assertEqual(
+            form.errors["altcha_field"][0], "ALTCHA CAPTCHA token is missing."
+        )
+
+    @mock.patch("altcha.verify_solution")
+    def test_field_validation_calls_altcha_verify_solution(self, mock_verify_solution):
+        mock_verify_solution.return_value = (True, None)
+        form = self.form_class(data={"altcha_field": "valid_token"})
+        self.assertTrue(form.is_valid())
+        mock_verify_solution.assert_called_once_with(
+            payload="valid_token",
+            hmac_key=mock.ANY,
+            check_expires=False,
+        )
+
+    @mock.patch("altcha.verify_solution")
+    def test_field_validation_fails_with_invalid_token(self, mock_verify_solution):
+        mock_verify_solution.return_value = (False, "Invalid token")
+        form = self.form_class(data={"altcha_field": "invalid_token"})
+        self.assertFalse(form.is_valid())
+        self.assertIn("altcha_field", form.errors)
+        self.assertEqual(form.errors["altcha_field"][0], "Invalid CAPTCHA token.")
+
+    @mock.patch("altcha.verify_solution")
+    def test_field_validation_handles_exception(self, mock_verify_solution):
+        mock_verify_solution.side_effect = Exception("Verification failed")
+        form = self.form_class(data={"altcha_field": "some_token"})
+        self.assertFalse(form.is_valid())
+        self.assertIn("altcha_field", form.errors)
+        self.assertEqual(
+            form.errors["altcha_field"][0], "Failed to process CAPTCHA token"
+        )

tests/test_field.py

@@ -0,0 +1,37 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# SPDX-License-Identifier: MIT
+# See https://github.com/aboutcode-org/django-altcha for support or download.
+# See https://aboutcode.org for more information about AboutCode FOSS projects.
+#
+
+import json
+
+from django.test import TestCase
+
+from django_altcha import AltchaWidget
+
+
+class AltchaWidgetTest(TestCase):
+    def test_widget_initialization_with_default_options(self):
+        widget = AltchaWidget(options=None)
+        self.assertNotIn("challengeurl", widget.options)
+        self.assertNotIn("challengejson", widget.options)
+        self.assertNotIn("auto", widget.options)
+
+    def test_widget_initialization_with_custom_options(self):
+        options = {
+            "auto": "onload",
+            "delay": 500,
+        }
+        widget = AltchaWidget(options)
+        self.assertEqual(widget.options["auto"], "onload")
+        self.assertEqual(widget.options["delay"], 500)
+
+    def test_widget_generates_challengejson_if_no_challengeurl(self):
+        widget = AltchaWidget(options={})  # Pass an empty dictionary
+        context = widget.get_context(name="test", value=None, attrs={})
+
+        challengejson = json.loads(context["widget"]["altcha_options"]["challengejson"])
+        self.assertEqual("SHA-256", challengejson["algorithm"])
+        self.assertEqual(64, len(challengejson["challenge"]))