Rebase

Signed-off-by: Alina Buzachis <[email protected]>

Author: alinabuzachis

CONTRIBUTING.md

@@ -88,26 +88,7 @@ The application can be reached in your browser at `https://localhost:8000/`. The
 
 ### Development Configuration
 
-The application uses dynaconf to manage configuration. Default development settings are defined in `development_defaults.py`. These include:
-
-#### Database
-
-By default, the application uses a local SQLite database:
-
-```bash
-# Default DB path
-default_path = BASE_DIR / "db.sqlite3"
-
-# Use environment variable if set, else default
-env_path = os.getenv("SQLITE_PATH")
-db_path = Path(env_path) if env_path else default_path
-```
-
-You can override the path by setting the `SQLITE_PATH` environment variable.
-
-#### Ansible Automation Platform (AAP) Service Configuration
-
-Default configuration values for connecting to the AAP service are defined in `development_defaults.py`:
+Default configuration values for connecting to the Ansible Automation Platform (AAP) service are defined in `development_defaults.py`:
 
 ```bash
 AAP_URL = "http://localhost:44926"        # Base URL of your AAP instance

Dockerfile.dev

@@ -0,0 +1,34 @@
+# Generated by Django 4.2.23 on 2025-08-05 19:21
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0003_task"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="task",
+            name="updated_at",
+            field=models.DateTimeField(auto_now=True),
+        ),
+        migrations.AlterField(
+            model_name="task",
+            name="status",
+            field=models.CharField(
+                choices=[
+                    ("Initiated", "Initiated"),
+                    ("Running", "Running"),
+                    ("Completed", "Completed"),
+                    ("Failed", "Failed"),
+                ],
+                db_index=True,
+                default="Initiated",
+                max_length=20,
+            ),
+        ),
+    ]

core/migrations/0004_task_updated_at_alter_task_status.py

@@ -0,0 +1,17 @@
+# Generated by Django 4.2.23 on 2025-08-05 19:41
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0004_task_updated_at_alter_task_status"),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name="task",
+            name="updated_at",
+        ),
+    ]

core/migrations/0005_remove_task_updated_at.py

@@ -0,0 +1,19 @@
+# Generated by Django 4.2.23 on 2025-08-05 19:42
+
+from django.db import migrations
+from django.db import models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("core", "0005_remove_task_updated_at"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="task",
+            name="updated_at",
+            field=models.DateTimeField(auto_now=True),
+        ),
+    ]

core/migrations/0006_task_updated_at.py

@@ -1,5 +1,9 @@
 from __future__ import annotations
 
+from typing import Any
+from typing import Dict
+from typing import Optional
+
 from ansible_base.lib.abstract_models import CommonModel
 from django.db import models
 
@@ -85,17 +89,57 @@ class Meta:
         app_label = "core"
         ordering = ["id"]
 
-    status_choices = (
-        ("Initiated", "Initiated"),
-        ("Running", "Running"),
-        ("Completed", "Completed"),
-        ("Failed", "Failed"),
-    )
+    class Status(models.TextChoices):
+        INITIATED = "Initiated"
+        RUNNING = "Running"
+        COMPLETED = "Completed"
+        FAILED = "Failed"
 
-    status: models.CharField = models.CharField(max_length=20, choices=status_choices)
+    status: models.CharField = models.CharField(
+        max_length=20, choices=Status.choices, default=Status.INITIATED, db_index=True
+    )
     details: models.JSONField = models.JSONField(null=True, blank=True)
+    updated_at: models.DateTimeField = models.DateTimeField(auto_now=True)
+
+    def set_status(
+        self,
+        new_status: str,
+        details: Optional[Dict[str, Any]] = None,
+        save_immediately: bool = True,
+    ) -> None:
+        """
+        Safely update the task's status and optional details.
+
+        Args:
+            new_status (str): The new status (must be one of Status.choices).
+            details (dict, optional): Additional info about this status update.
+            save_immediately (bool): If True, saves the instance to the database
+                immediately.
+
+        Raises:
+            ValueError: If the provided status is invalid.
+        """
+        if new_status not in self.Status.values:
+            raise ValueError(
+                f"Invalid status '{new_status}'. Allowed values: {self.Status.values}"
+            )
+
+        self.status = new_status
+        self.details = details or {}
+        if save_immediately:
+            self.save(update_fields=["status", "details", "updated_at"])
+
+    def mark_initiated(self, details: Optional[Dict[str, Any]] = None) -> None:
+        self.set_status(self.Status.INITIATED, details)
+
+    def mark_running(self, details: Optional[Dict[str, Any]] = None) -> None:
+        self.set_status(self.Status.RUNNING, details)
+
+    def mark_completed(self, details: Optional[Dict[str, Any]] = None) -> None:
+        self.set_status(self.Status.COMPLETED, details)
+
+    def mark_failed(self, details: Optional[Dict[str, Any]] = None) -> None:
+        self.set_status(self.Status.FAILED, details)
 
-    def update_task_status(self, status_: str, details: dict) -> None:
-        self.status = status_
-        self.details = details
-        self.save()
+    def __str__(self) -> str:
+        return f"Task #{self.pk} - {self.status}"

core/models.py

@@ -13,11 +13,20 @@
 def run_pattern_task(pattern_id: int, task_id: int) -> None:
     """
     Orchestrates downloading a collection and saving a pattern definition.
+
+    Args:
+        pattern_id (int): The ID of the pattern to process.
+        task_id (int): The ID of the task..
+
+    Raises:
+        FileNotFoundError: If the pattern definition is not found.
+        Exception: If any other error occurs.
     """
     task = Task.objects.get(id=task_id)
+    task.mark_initiated({"info": "Processing started"})
     try:
         pattern = Pattern.objects.get(id=pattern_id)
-        task.update_task_status("Running", {"info": "Processing pattern"})
+        task.mark_running({"info": "Processing pattern"})
         with download_collection(
             pattern.collection_name, pattern.collection_version
         ) as collection_path:
@@ -37,10 +46,10 @@ def run_pattern_task(pattern_id: int, task_id: int) -> None:
                 pattern.collection_name, pattern.collection_version
             )
             pattern.save(update_fields=["pattern_definition", "collection_version_uri"])
-        task.update_task_status("Completed", {"info": "Pattern processed successfully"})
+        task.mark_completed({"info": "Pattern processed successfully"})
     except FileNotFoundError:
         logger.error(f"Could not find pattern definition for task {task_id}")
-        task.update_task_status("Failed", {"error": "Pattern definition not found."})
+        task.mark_failed({"error": "Pattern definition not found."})
     except Exception as e:
         logger.error(f"Task {task_id} failed: {e}")
-        task.update_task_status("Failed", {"error": str(e)})
+        task.mark_failed({"error": str(e)})

core/tasks.py renamed to core/task_runner.py

@@ -3,7 +3,6 @@
 import shutil
 import tempfile
 from typing import List
-from unittest.mock import mock_open
 from unittest.mock import patch
 
 from django.test import TestCase
@@ -12,7 +11,7 @@
 from core.models import Pattern
 from core.models import PatternInstance
 from core.models import Task
-from core.tasks import run_pattern_task
+from core.task_runner import run_pattern_task
 
 
 class SharedDataMixin:
@@ -78,82 +77,12 @@ def tearDown(self):
 
 
 class PatternTaskTest(SharedDataMixin, TestCase):
-    @patch("core.models.Task.update_task_status", autospec=True)
-    @patch("core.tasks.open", new_callable=mock_open, read_data='{"name": "test"}')
-    @patch("core.tasks.download_collection")
-    def test_run_pattern_task_success(
-        self, mock_download, mock_open_fn, mock_update_status
-    ):
-        pattern = Pattern.objects.create(
-            collection_name="demo.collection",
-            collection_version="1.0.0",
-            pattern_name="test_pattern",
-        )
-        task = Task.objects.create(status="Initiated", details={})
-        temp_dir = tempfile.mkdtemp()
-        mock_download.return_value.__enter__.return_value = temp_dir
-
-        os.makedirs(
-            os.path.join(temp_dir, "extensions", "patterns", "test_pattern", "meta")
-        )
-        with open(
-            os.path.join(
-                temp_dir,
-                "extensions",
-                "patterns",
-                "test_pattern",
-                "meta",
-                "pattern.json",
-            ),
-            "w",
-        ) as f:
-            f.write(json.dumps({"name": "test"}))
-
-        run_pattern_task(pattern.id, task.id)
-
-        mock_update_status.assert_any_call(
-            task, "Running", {"info": "Processing pattern"}
-        )
-        mock_update_status.assert_any_call(
-            task, "Completed", {"info": "Pattern processed successfully"}
-        )
-
-    @patch("core.models.Task.update_task_status", autospec=True)
-    @patch("core.tasks.download_collection", side_effect=FileNotFoundError)
-    def test_run_pattern_task_file_not_found(self, mock_download, mock_update_status):
-        pattern = Pattern.objects.create(
-            collection_name="demo.collection",
-            collection_version="1.0.0",
-            pattern_name="missing_pattern",
-        )
-        task = Task.objects.create(status="Initiated", details={})
-
-        run_pattern_task(pattern.id, task.id)
-
-        mock_update_status.assert_called_with(
-            task, "Failed", {"error": "Pattern definition not found."}
-        )
-
-    @patch("core.tasks.download_collection", side_effect=Exception("Download failed"))
-    def test_run_pattern_task_handles_download_failure(self, mock_download):
-        run_pattern_task(self.pattern.id, self.task.id)
-        self.task.refresh_from_db()
-        self.assertEqual(self.task.status, "Failed")
-        self.assertIn("Download failed", self.task.details.get("error", ""))
-
-    @patch("core.models.Task.update_task_status", autospec=True)
-    @patch("core.tasks.download_collection")
-    def test_full_status_update_flow(self, mock_download, mock_update_status):
+    @patch("core.models.Task.set_status", autospec=True, wraps=Task.set_status)
+    @patch("core.task_runner.download_collection")
+    def test_run_pattern_task_success(self, mock_download, mock_update_status):
         temp_dir_path = self.create_temp_collection_dir()
         mock_download.return_value.__enter__.return_value = temp_dir_path
 
-        def _side_effect(self_task, status_, details):
-            self_task.status = status_
-            self_task.details = details
-            self_task.save()
-
-        mock_update_status.side_effect = _side_effect
-
         run_pattern_task(self.pattern.id, self.task.id)
 
         expected_calls = [
@@ -180,3 +109,28 @@ def _side_effect(self_task, status_, details):
         # Assert pattern definition was updated
         self.pattern.refresh_from_db()
         self.assertEqual(self.pattern.pattern_definition, {"mock_key": "mock_value"})
+
+    @patch("core.models.Task.set_status", autospec=True)
+    @patch("core.task_runner.download_collection", side_effect=FileNotFoundError)
+    def test_run_pattern_task_file_not_found(self, mock_download, mock_update_status):
+        pattern = Pattern.objects.create(
+            collection_name="demo.collection",
+            collection_version="1.0.0",
+            pattern_name="missing_pattern",
+        )
+        task = Task.objects.create(status="Initiated", details={})
+
+        run_pattern_task(pattern.id, task.id)
+
+        mock_update_status.assert_called_with(
+            task, "Failed", {"error": "Pattern definition not found."}
+        )
+
+    @patch(
+        "core.task_runner.download_collection", side_effect=Exception("Download failed")
+    )
+    def test_run_pattern_task_handles_download_failure(self, mock_download):
+        run_pattern_task(self.pattern.id, self.task.id)
+        self.task.refresh_from_db()
+        self.assertEqual(self.task.status, "Failed")
+        self.assertIn("Download failed", self.task.details.get("error", ""))

core/tests/test_tasks.py

@@ -14,7 +14,6 @@
 except ImportError:
     pass
 
-# Ensure default environment mode
 os.environ["PATTERN_SERVICE_MODE"] = os.environ.get(
     "PATTERN_SERVICE_MODE", "production"
 )

pattern_service/settings/__init__.py

@@ -133,13 +133,3 @@
     },
     "publish": {"default_control_broker": "socket", "default_broker": "pg_notify"},
 }
-
-# Base URL of your AAP service
-URL = "http://localhost:44926"  # or your default URL
-
-# Whether to verify SSL certificates (True or False)
-VALIDATE_CERTS = False
-
-# Default username and password for authentication
-USERNAME = "admin"
-PASSWORD = "your_default_password_here"