Draft implementation for https://issues.redhat.com/browse/AAP-47731

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

Author: alinabuzachis

core/tasks.py

@@ -0,0 +1,79 @@
+import json
+import os
+import tarfile
+import tempfile
+
+import aiohttp
+from asgiref.sync import sync_to_async
+from django.db import transaction
+
+from .models import ControllerLabel
+from .models import PatternInstance
+from .models import Task
+
+
+async def update_task_status(task: Task, status_: str, details: dict):
+    task.status = status_
+    task.details = details
+    await sync_to_async(task.save, thread_sensitive=True)()
+
+
+async def download_and_extract_tarball(url: str) -> dict:
+    async with aiohttp.ClientSession() as session:
+        async with session.get(url) as resp:
+            if resp.status != 200:
+                raise Exception(f"Failed to download tarball: HTTP {resp.status}")
+
+            with tempfile.NamedTemporaryFile(delete=False) as tmp:
+                tmp.write(await resp.read())
+                tmp_path = tmp.name
+
+    extract_dir = tempfile.mkdtemp()
+    with tarfile.open(tmp_path, 'r:*') as tar:
+        tar.extractall(path=extract_dir)
+
+    # Look for a .pattern.json or similar file
+    for root, _, files in os.walk(extract_dir):
+        for fname in files:
+            if fname.endswith(".json"):
+                with open(os.path.join(root, fname)) as f:
+                    return json.load(f)
+
+    raise Exception("Pattern definition JSON file not found in tarball")
+
+
+async def run_pattern_instance_task(instance_id: int, task_id: int):
+    task = await sync_to_async(Task.objects.get, thread_sensitive=True)(id=task_id)
+
+    try:
+        instance = await sync_to_async(PatternInstance.objects.select_related("pattern").get, thread_sensitive=True)(id=instance_id)
+        pattern = instance.pattern
+
+        # Make sure the Pattern has pattern_definition loaded (could be empty)
+        pattern_def = pattern.pattern_definition or {}
+
+        await update_task_status(task, "Running", {"info": "Processing PatternInstance"})
+
+        if not pattern_def:
+            raise Exception("Pattern definition is missing. Cannot process instance.")
+
+        # Update instance fields with data from pattern definition inside transaction
+        def update_instance():
+            with transaction.atomic():
+                if "execution_environment_id" in pattern_def:
+                    instance.controller_ee_id = int(pattern_def["execution_environment_id"])
+                if "executors" in pattern_def:
+                    instance.executors = pattern_def["executors"]
+                if "controller_labels" in pattern_def:
+                    for label_id in pattern_def["controller_labels"]:
+                        label_obj, _ = ControllerLabel.objects.get_or_create(label_id=label_id)
+                        instance.controller_labels.add(label_obj)
+
+                instance.controller_project_id = hash(pattern.pattern_name) % 10**6
+                instance.save()
+
+        await sync_to_async(update_instance, thread_sensitive=True)()
+
+        await update_task_status(task, "Completed", {"info": "PatternInstance processed"})
+    except Exception as e:
+        await update_task_status(task, "Failed", {"error": str(e)})

core/tests/test_tasks.py

@@ -0,0 +1,114 @@
+from unittest.mock import patch
+
+from django.urls import reverse
+from rest_framework import status
+from rest_framework.test import APITestCase
+
+from core.models import Automation
+from core.models import ControllerLabel
+from core.models import Pattern
+from core.models import PatternInstance
+from core.models import Task
+
+
+class SharedDataMixin:
+    @classmethod
+    def setUpTestData(cls):
+        cls.pattern = Pattern.objects.create(
+            collection_name="mynamespace.mycollection",
+            collection_version="1.0.0",
+            collection_version_uri="https://example.com/mynamespace/mycollection/",
+            pattern_name="example_pattern",
+            pattern_definition={"key": "value"},
+        )
+
+        cls.pattern_instance = PatternInstance.objects.create(
+            organization_id=1,
+            controller_project_id=123,
+            controller_ee_id=456,
+            credentials={"user": "admin"},
+            executors=[{"executor_type": "container"}],
+            pattern=cls.pattern,
+        )
+
+        cls.label = ControllerLabel.objects.create(label_id=5)
+        cls.pattern_instance.controller_labels.add(cls.label)
+
+        cls.automation = Automation.objects.create(
+            automation_type="job_template",
+            automation_id=789,
+            primary=True,
+            pattern_instance=cls.pattern_instance,
+        )
+
+        cls.task = Task.objects.create(status="Running", details={"progress": "50%"})
+
+
+class PatternInstanceViewSetTest(SharedDataMixin, APITestCase):
+    def test_pattern_instance_list_view(self):
+        url = reverse("patterninstance-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data), 1)
+
+    def test_pattern_instance_detail_view(self):
+        url = reverse("patterninstance-detail", args=[self.pattern_instance.pk])
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["organization_id"], 1)
+
+    @patch("core.views.async_to_sync")
+    def test_pattern_instance_create_view(self, mock_async_to_sync):
+        url = reverse("patterninstance-list")
+        data = {
+            "organization_id": 2,
+            "controller_project_id": 0,
+            "controller_ee_id": 0,
+            "credentials": {"user": "tester"},
+            "executors": [],
+            "pattern": self.pattern.id,
+        }
+
+        response = self.client.post(url, data, format="json")
+        self.assertEqual(response.status_code, status.HTTP_202_ACCEPTED)
+
+        instance = PatternInstance.objects.get(organization_id=2)
+        self.assertIsNotNone(instance)
+
+        task_id = response.data["task_id"]
+        task = Task.objects.get(id=task_id)
+        self.assertEqual(task.status, "Initiated")
+
+        mock_async_to_sync.assert_called_once()
+        self.assertIn("task_id", response.data)
+        self.assertIn("message", response.data)
+
+
+class AutomationViewSetTest(SharedDataMixin, APITestCase):
+    def test_automation_list_view(self):
+        url = reverse("automation-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data), 1)
+
+    def test_automation_detail_view(self):
+        url = reverse("automation-detail", args=[self.automation.pk])
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(response.data["automation_type"], "job_template")
+
+
+class ControllerLabelViewSetTest(SharedDataMixin, APITestCase):
+    def test_label_list_view(self):
+        url = reverse("controllerlabel-list")
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(len(response.data), 1)
+
+    def test_label_detail_view(self):
+        url = reverse("controllerlabel-detail", args=[self.label.id])
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertIn('id', response.data)
+        self.assertIn('label_id', response.data)
+        self.assertEqual(response.data['label_id'], 5)

core/tests/test_views.py

@@ -1,3 +1,5 @@
+from unittest.mock import patch
+
 from django.urls import reverse
 from rest_framework import status
 from rest_framework.test import APITestCase
@@ -7,6 +9,7 @@
 from core.models import Pattern
 from core.models import PatternInstance
 from core.models import Task
+from core.tasks import run_pattern_instance_task
 
 
 class SharedDataMixin:
@@ -96,7 +99,8 @@ def test_pattern_instance_detail_view(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(response.data["organization_id"], 1)
 
-    def test_pattern_instance_create_view(self):
+    @patch("core.views.async_to_sync")
+    def test_pattern_instance_create_view(self, mock_async_to_sync):
         url = reverse("patterninstance-list")
         data = {
             "organization_id": 2,
@@ -113,13 +117,13 @@ def test_pattern_instance_create_view(self):
         instance = PatternInstance.objects.get(organization_id=2)
         self.assertIsNotNone(instance)
 
-        task_id = response.data.get("task_id")
-        self.assertIsInstance(task_id, int)
-
+        task_id = response.data["task_id"]
         task = Task.objects.get(id=task_id)
         self.assertEqual(task.status, "Initiated")
-        self.assertEqual(task.details.get("model"), "PatternInstance")
-        self.assertEqual(task.details.get("id"), instance.id)
+
+        mock_async_to_sync.assert_called_once()
+        self.assertIn("task_id", response.data)
+        self.assertIn("message", response.data)
 
 
 class AutomationViewSetTest(SharedDataMixin, APITestCase):

core/views.py

@@ -1,4 +1,5 @@
 from ansible_base.lib.utils.views.ansible_base import AnsibleBaseView
+from asgiref.sync import async_to_sync
 from rest_framework import status
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
@@ -15,6 +16,7 @@
 from .serializers import PatternInstanceSerializer
 from .serializers import PatternSerializer
 from .serializers import TaskSerializer
+from .tasks import run_pattern_instance_task
 
 
 class CoreViewSet(AnsibleBaseView):
@@ -53,18 +55,24 @@ class PatternInstanceViewSet(CoreViewSet, ModelViewSet):
     def create(self, request, *args, **kwargs):
         serializer = self.get_serializer(data=request.data)
         serializer.is_valid(raise_exception=True)
+
         # Save initial PatternInstance
         instance = serializer.save()
 
         # Create a Task entry to track this processing
         task = Task.objects.create(status="Initiated", details={"model": "PatternInstance", "id": instance.id})
 
+        # Schedule async background task to enrich this instance
+        async_to_sync(run_pattern_instance_task)(instance.id, task.id)
+
+        headers = self.get_success_headers(serializer.data)
         return Response(
             {
                 "task_id": task.id,
                 "message": "PatternInstance creation initiated. Check task status for progress.",
             },
             status=status.HTTP_202_ACCEPTED,
+            headers=headers,
         )
 
 

requirements/requirements-all.txt

@@ -1,50 +1,101 @@
 #
-# This file is autogenerated by pip-compile with Python 3.13
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
-#    pip-compile --output-file=requirements-all.txt requirements-dev.in requirements.in
+#    pip-compile --output-file=requirements/requirements-all.txt requirements/requirements-dev.in requirements/requirements.in
 #
+aiohappyeyeballs==2.6.1
+    # via aiohttp
+aiohttp==3.12.13
+    # via
+    #   -r requirements/requirements.in
+    #   aiohttp-utils
+aiohttp-utils==3.2.1
+    # via -r requirements/requirements.in
+aiosignal==1.3.2
+    # via aiohttp
 asgiref==3.8.1
     # via django
 astor==0.8.1
     # via flynt
+attrs==25.3.0
+    # via aiohttp
 black==24.10.0
-    # via -r requirements-dev.in
+    # via -r requirements/requirements-dev.in
+cffi==1.17.1
+    # via cryptography
 click==8.2.1
     # via black
+cryptography==45.0.4
+    # via django-ansible-base
 django==4.2.23
     # via
-    #   -r requirements.in
+    #   django-ansible-base
+    #   django-crum
     #   djangorestframework
+django-ansible-base==2025.5.8
+    # via -r requirements/requirements.in
+django-crum==0.7.9
+    # via django-ansible-base
 djangorestframework==3.16.0
-    # via -r requirements.in
+    # via django-ansible-base
+dynaconf==3.2.11
+    # via django-ansible-base
 flake8==6.1.0
-    # via -r requirements-dev.in
+    # via -r requirements/requirements-dev.in
 flynt==1.0.2
-    # via -r requirements-dev.in
+    # via -r requirements/requirements-dev.in
+frozenlist==1.7.0
+    # via
+    #   aiohttp
+    #   aiosignal
+gunicorn==23.0.0
+    # via aiohttp-utils
+idna==3.10
+    # via yarl
+inflection==0.5.1
+    # via django-ansible-base
 isort==5.13.2
-    # via -r requirements-dev.in
+    # via -r requirements/requirements-dev.in
 mccabe==0.7.0
     # via flake8
+multidict==6.6.3
+    # via
+    #   aiohttp
+    #   yarl
 mypy==1.16.0
-    # via -r requirements-dev.in
+    # via -r requirements/requirements-dev.in
 mypy-extensions==1.1.0
     # via
     #   black
     #   mypy
 packaging==25.0
-    # via black
+    # via
+    #   black
+    #   gunicorn
 pathspec==0.12.1
     # via
     #   black
     #   mypy
 platformdirs==4.3.8
     # via black
+propcache==0.3.2
+    # via
+    #   aiohttp
+    #   yarl
 pycodestyle==2.11.1
     # via flake8
+pycparser==2.22
+    # via cffi
 pyflakes==3.1.0
     # via flake8
+python-mimeparse==2.0.0
+    # via aiohttp-utils
 sqlparse==0.5.3
-    # via django
+    # via
+    #   django
+    #   django-ansible-base
 typing-extensions==4.13.2
     # via mypy
+yarl==1.20.1
+    # via aiohttp

requirements/requirements.in

@@ -1 +1,3 @@
 django-ansible-base==2025.5.8
+aiohttp==3.12.13
+aiohttp-utils==3.2.1