base-api-utils 1.1.115__tar.gz → 1.1.117.dev1__tar.gz

{base_api_utils-1.1.115/src/base_api_utils.egg-info → base_api_utils-1.1.117.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-api-utils
-Version: 1.1.115
+Version: 1.1.117.dev1
 Summary: Django Rest Framework micro services common utilities
 Author-email: Román Gutierrez <roman@tipit.net>, Sebastian Marcet <sebastian@tipit.net>
 Project-URL: Homepage, https://github.com/fntechgit/base-api-utils

{base_api_utils-1.1.115 → base_api_utils-1.1.117.dev1}/pyproject.toml

@@ -7,7 +7,7 @@ where = ["src"]
 
 [project]
 name = "base-api-utils"
-version = "1.1.115"
+version = "1.1.117.dev1"
 dependencies = [
     "boto3",
     "celery",

{base_api_utils-1.1.115 → base_api_utils-1.1.117.dev1}/src/base_api_utils/filters/filter_utils_mixin.py

@@ -56,3 +56,15 @@ class FilterUtilsMixin:
     def filter_isnull(self, queryset, field_name, value):
         is_null = str(value).lower() == 'true'
         return Q(**{f"{field_name}__isnull": is_null})
+
+    def get_and_filter(self, filter_name):
+      """Returns (operator, value) for the named AND filter, or None if absent."""
+      for f in self.data.getlist(self.filters_param, []):
+          fname, fop, fval = self.parse_filter(f)
+          if fname == filter_name:
+              return fop, fval
+      return None
+
+    def has_and_filter(self, filter_name):
+      """Returns True if the named filter is present in the AND filter list."""
+      return self.get_and_filter(filter_name) is not None

base_api_utils-1.1.117.dev1/src/base_api_utils/tests/test_task_status_endpoints.py

@@ -0,0 +1,104 @@
+from unittest.mock import patch, MagicMock
+
+from django.core.management import call_command
+from rest_framework.test import APITestCase
+from django.urls import reverse
+import json
+from rest_framework import status
+
+
+class TaskStatusEndpointsTest(APITestCase):
+    def setUp(self):
+        self.access_token = 'ACCESS_TOKEN'
+        call_command('seed_data')
+
+    def test_task_status_pending(self):
+        task_id = 'test-task-pending'
+        url = reverse('private-tasks-admin-endpoints:retrieve_async_task_status', kwargs={'task_id': task_id})
+
+        mock_result = MagicMock()
+        mock_result.status = 'PENDING'
+
+        with patch('base_api_utils.views.tasks_result_view.AsyncResult', return_value=mock_result):
+            response = self.client.get(f'{url}?access_token={self.access_token}')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        json_response = json.loads(response.content)
+        self.assertEqual(json_response['task_id'], task_id)
+        self.assertEqual(json_response['status'], 'PENDING')
+        self.assertNotIn('result', json_response)
+        self.assertNotIn('error', json_response)
+
+    def test_task_status_started(self):
+        task_id = 'test-task-started'
+        url = reverse('private-tasks-admin-endpoints:retrieve_async_task_status', kwargs={'task_id': task_id})
+
+        mock_result = MagicMock()
+        mock_result.status = 'STARTED'
+
+        with patch('base_api_utils.views.tasks_result_view.AsyncResult', return_value=mock_result):
+            response = self.client.get(f'{url}?access_token={self.access_token}')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        json_response = json.loads(response.content)
+        self.assertEqual(json_response['status'], 'STARTED')
+        self.assertNotIn('result', json_response)
+        self.assertNotIn('error', json_response)
+
+    def test_task_status_success(self):
+        task_id = 'test-task-success'
+        url = reverse('private-tasks-admin-endpoints:retrieve_async_task_status', kwargs={'task_id': task_id})
+
+        mock_result = MagicMock()
+        mock_result.status = 'SUCCESS'
+        mock_result.result = {'imported': [1667], 'errors': []}
+
+        with patch('base_api_utils.views.tasks_result_view.AsyncResult', return_value=mock_result):
+            response = self.client.get(f'{url}?access_token={self.access_token}')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        json_response = json.loads(response.content)
+        self.assertEqual(json_response['task_id'], task_id)
+        self.assertEqual(json_response['status'], 'SUCCESS')
+        self.assertIn('result', json_response)
+        self.assertEqual(json_response['result'], {'imported': [1667], 'errors': []})
+        self.assertNotIn('error', json_response)
+
+    def test_task_status_success_with_partial_errors(self):
+        task_id = 'test-task-partial'
+        url = reverse('private-tasks-admin-endpoints:retrieve_async_task_status', kwargs={'task_id': task_id})
+
+        mock_result = MagicMock()
+        mock_result.status = 'SUCCESS'
+        mock_result.result = {
+            'imported': [1667],
+            'errors': [{'user_id': 9999, 'error': 'There is no sponsor user registered with the id 9999'}]
+        }
+
+        with patch('base_api_utils.views.tasks_result_view.AsyncResult', return_value=mock_result):
+            response = self.client.get(f'{url}?access_token={self.access_token}')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        json_response = json.loads(response.content)
+        self.assertEqual(json_response['status'], 'SUCCESS')
+        self.assertEqual(len(json_response['result']['imported']), 1)
+        self.assertEqual(len(json_response['result']['errors']), 1)
+        self.assertEqual(json_response['result']['errors'][0]['user_id'], 9999)
+
+    def test_task_status_failure(self):
+        task_id = 'test-task-failure'
+        url = reverse('private-tasks-admin-endpoints:retrieve_async_task_status', kwargs={'task_id': task_id})
+
+        mock_result = MagicMock()
+        mock_result.status = 'FAILURE'
+        mock_result.result = Exception('Sponsor 999 not found')
+
+        with patch('base_api_utils.views.tasks_result_view.AsyncResult', return_value=mock_result):
+            response = self.client.get(f'{url}?access_token={self.access_token}')
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        json_response = json.loads(response.content)
+        self.assertEqual(json_response['task_id'], task_id)
+        self.assertEqual(json_response['status'], 'FAILURE')
+        self.assertIn('error', json_response)
+        self.assertNotIn('result', json_response)

{base_api_utils-1.1.115 → base_api_utils-1.1.117.dev1}/src/base_api_utils/views/tasks_result_view.py

@@ -1,4 +1,5 @@
 from celery.result import AsyncResult
+from drf_spectacular.utils import extend_schema
 from rest_framework import viewsets, status
 from rest_framework.response import Response
 from django_celery_results.models import TaskResult
@@ -8,17 +9,14 @@ from ..security import oauth2_scope_required, group_required
 from ..serializers import TaskResultSerializer
 
 
+@extend_schema(tags=["Celery Tasks"])
 class TasksResultAPIView(viewsets.ReadOnlyModelViewSet):
-    """
-    ViewSet to view failed Celery tasks and retry them manually.
-    """
     queryset = TaskResult.objects.filter(status='FAILURE')
     serializer_class = TaskResultSerializer
 
     @oauth2_scope_required()
     @group_required()
     def retry(self, request, task_id, *args, **kwargs):
-        """Rerun a failed task manually"""
         task_result = self.get_queryset().filter(task_id=task_id).first()
         if not task_result:
              return Response({"error": "Task not registered as failed"}, status=status.HTTP_404_NOT_FOUND)

{base_api_utils-1.1.115 → base_api_utils-1.1.117.dev1/src/base_api_utils.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: base-api-utils
-Version: 1.1.115
+Version: 1.1.117.dev1
 Summary: Django Rest Framework micro services common utilities
 Author-email: Román Gutierrez <roman@tipit.net>, Sebastian Marcet <sebastian@tipit.net>
 Project-URL: Homepage, https://github.com/fntechgit/base-api-utils

{base_api_utils-1.1.115 → base_api_utils-1.1.117.dev1}/src/base_api_utils.egg-info/SOURCES.txt

@@ -74,6 +74,7 @@ src/base_api_utils/services/strategies/abstract_task_runner_strategy.py
 src/base_api_utils/services/strategies/publish_domain_event_strategy.py
 src/base_api_utils/tests/__init__.py
 src/base_api_utils/tests/test_failed_celery_task_management.py
+src/base_api_utils/tests/test_task_status_endpoints.py
 src/base_api_utils/utils/__init__.py
 src/base_api_utils/utils/async_helpers.py
 src/base_api_utils/utils/circuit_breaker.py