Redis ha/aap 28152 (#1012)

Author: jshimkus-rh

src/aap_eda/api/views/activation.py

@@ -40,6 +40,8 @@
     stop_rulebook_process,
 )
 
+from .mixins import RedisDependencyMixin
+
 logger = logging.getLogger(__name__)
 
 resource_name = "RulebookActivation"
@@ -48,6 +50,7 @@
 class ActivationViewSet(
     mixins.DestroyModelMixin,
     viewsets.GenericViewSet,
+    RedisDependencyMixin,
 ):
     queryset = models.Activation.objects.all()
     serializer_class = serializers.ActivationSerializer
@@ -70,7 +73,8 @@ def filter_queryset(self, queryset):
             status.HTTP_400_BAD_REQUEST: OpenApiResponse(
                 description="Invalid data to create activation."
             ),
-        },
+        }
+        | RedisDependencyMixin.redis_unavailable_response(),
     )
     def create(self, request):
         context = {"request": request}
@@ -79,6 +83,14 @@ def create(self, request):
         )
         serializer.is_valid(raise_exception=True)
 
+        # If we're expected to run this activation we need redis
+        # to be available.
+        if serializer.validated_data.get(
+            "is_enabled",
+            models.activation.DEFAULT_ENABLED,
+        ):
+            self.redis_is_available()
+
         with transaction.atomic():
             response = serializer.create(serializer.validated_data)
             check_related_permissions(
@@ -119,7 +131,8 @@ def create(self, request):
                 None,
                 description="The Activation has been deleted.",
             ),
-        },
+        }
+        | RedisDependencyMixin.redis_unavailable_response(),
     )
     def destroy(self, request, *args, **kwargs):
         activation = self.get_object()
@@ -130,6 +143,9 @@ def destroy(self, request, *args, **kwargs):
                 "deleted.",
             )
 
+        # Redis must be available in order to perform the delete.
+        self.redis_is_available()
+
         audit_log = logging_utils.generate_simple_audit_log(
             "Delete",
             resource_name,
@@ -255,9 +271,7 @@ def instances(self, request, id):
                 description="Activation not enabled.",
             ),
             status.HTTP_409_CONFLICT: OpenApiResponse(
-                None,
-                description="Activation not enabled do to current activation "
-                "status",
+                description="Processing of enable is disallowed."
             ),
         },
     )
@@ -275,7 +289,10 @@ def enable(self, request, pk):
             ActivationStatus.RUNNING,
             ActivationStatus.UNRESPONSIVE,
         ]:
-            return Response(status=status.HTTP_409_CONFLICT)
+            return Response(
+                data="Activation not enabled due to current activation status",
+                status=status.HTTP_409_CONFLICT,
+            )
 
         valid, error = is_activation_valid(activation)
         if not valid:
@@ -288,6 +305,9 @@ def enable(self, request, pk):
                 {"errors": error}, status=status.HTTP_400_BAD_REQUEST
             )
 
+        # Redis must be available in order to perform the enable.
+        self.redis_is_available()
+
         logger.info(f"Now enabling {activation.name} ...")
 
         activation.is_enabled = True
@@ -326,7 +346,8 @@ def enable(self, request, pk):
                 None,
                 description="Activation has been disabled.",
             ),
-        },
+        }
+        | RedisDependencyMixin.redis_unavailable_response(),
     )
     @action(methods=["post"], detail=True, rbac_action=Action.DISABLE)
     def disable(self, request, pk):
@@ -335,6 +356,9 @@ def disable(self, request, pk):
         self._check_deleting(activation)
 
         if activation.is_enabled:
+            # Redis must be available in order to perform the delete.
+            self.redis_is_available()
+
             activation.status = ActivationStatus.STOPPING
             activation.is_enabled = False
             activation.save(
@@ -368,7 +392,8 @@ def disable(self, request, pk):
                 None,
                 description="Activation not enabled.",
             ),
-        },
+        }
+        | RedisDependencyMixin.redis_unavailable_response(),
     )
     @action(methods=["post"], detail=True, rbac_action=Action.RESTART)
     def restart(self, request, pk):
@@ -392,6 +417,9 @@ def restart(self, request, pk):
                 {"errors": error}, status=status.HTTP_400_BAD_REQUEST
             )
 
+        # Redis must be available in order to perform the restart.
+        self.redis_is_available()
+
         restart_rulebook_process(
             process_parent_type=ProcessParentType.ACTIVATION,
             process_parent_id=activation.id,

src/aap_eda/core/models/activation.py

@@ -30,6 +30,8 @@
 
 __all__ = ("Activation",)
 
+DEFAULT_ENABLED = True
+
 
 class Activation(
     StatusHandlerModelMixin,
@@ -53,7 +55,7 @@ class Meta:
         default="",
         blank=True,
     )
-    is_enabled = models.BooleanField(default=True)
+    is_enabled = models.BooleanField(default=DEFAULT_ENABLED)
     git_hash = models.TextField(null=False, default="")
     # TODO(alex) Since local activations are no longer supported
     # this field should be mandatory.

tests/integration/api/test_activation.py

@@ -12,7 +12,7 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 from typing import Any, Dict, List
-from unittest.mock import patch
+from unittest import mock
 
 import pytest
 import yaml
@@ -36,7 +36,7 @@ def converted_extra_var(var: str) -> str:
 
 
 @pytest.mark.django_db
-@patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
+@mock.patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
 def test_create_activation(
     admin_awx_token: models.AwxToken,
     activation_payload: Dict[str, Any],
@@ -74,7 +74,7 @@ def test_create_activation(
 
 
 @pytest.mark.django_db
-@patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
+@mock.patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
 def test_create_activation_blank_text(
     admin_awx_token: models.AwxToken,
     activation_payload_blank_text: Dict[str, Any],
@@ -163,6 +163,35 @@ def test_create_activation_bad_entity(admin_client: APIClient):
     assert response.status_code == status.HTTP_400_BAD_REQUEST
 
 
+@pytest.mark.parametrize(
+    "enabled",
+    [True, False],
+)
+@pytest.mark.django_db
+@mock.patch("aap_eda.core.tasking.is_redis_failed", return_value=True)
+def test_create_activation_redis_unavailable(
+    is_redis_failed: mock.Mock,
+    activation_payload: Dict[str, Any],
+    admin_awx_token: models.AwxToken,
+    default_rulebook: models.Rulebook,
+    admin_client: APIClient,
+    enabled: bool,
+    preseed_credential_types,
+):
+    activation_payload["is_enabled"] = enabled
+    response = admin_client.post(
+        f"{api_url_v1}/activations/", data=activation_payload
+    )
+
+    if not enabled:
+        assert response.status_code == status.HTTP_201_CREATED
+    else:
+        assert response.status_code == status.HTTP_409_CONFLICT
+        assert response.json() == {
+            "detail": "Redis is required but unavailable."
+        }
+
+
 @pytest.mark.parametrize(
     "dependent_object",
     [
@@ -442,6 +471,21 @@ def test_delete_activation(
     assert response.status_code == expected_response
 
 
+@pytest.mark.django_db
+@mock.patch("aap_eda.core.tasking.is_redis_failed", return_value=True)
+def test_delete_activation_redis_unavailable(
+    is_redis_failed: mock.Mock,
+    default_activation: models.Activation,
+    admin_client: APIClient,
+    preseed_credential_types,
+):
+    response = admin_client.delete(
+        f"{api_url_v1}/activations/{default_activation.id}/"
+    )
+    assert response.status_code == status.HTTP_409_CONFLICT
+    assert response.json() == {"detail": "Redis is required but unavailable."}
+
+
 @pytest.mark.django_db
 def test_restart_activation(
     default_activation: models.Activation,
@@ -455,6 +499,38 @@ def test_restart_activation(
     assert response.status_code == status.HTTP_204_NO_CONTENT
 
 
+@pytest.mark.parametrize(
+    "enabled",
+    [True, False],
+)
+@pytest.mark.django_db
+@mock.patch("aap_eda.core.tasking.is_redis_failed", return_value=True)
+def test_restart_activation_redis_unavailable(
+    is_redis_failed: mock.Mock,
+    default_activation: models.Activation,
+    admin_client: APIClient,
+    enabled: bool,
+    preseed_credential_types,
+):
+    default_activation.is_enabled = enabled
+    default_activation.save(update_fields=["is_enabled"])
+
+    response = admin_client.post(
+        f"{api_url_v1}/activations/{default_activation.id}/restart/"
+    )
+
+    if not enabled:
+        assert response.status_code == status.HTTP_403_FORBIDDEN
+        assert response.json() == {
+            "detail": "Activation is disabled and cannot be run."
+        }
+    else:
+        assert response.status_code == status.HTTP_409_CONFLICT
+        assert response.json() == {
+            "detail": "Redis is required but unavailable."
+        }
+
+
 @pytest.mark.django_db
 @pytest.mark.parametrize("action", [enums.Action.RESTART, enums.Action.ENABLE])
 def test_restart_activation_without_de(
@@ -489,7 +565,7 @@ def test_restart_activation_without_de(
 
 
 @pytest.mark.django_db
-@patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
+@mock.patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
 def test_enable_activation(
     default_activation: models.Activation,
     admin_client: APIClient,
@@ -537,6 +613,36 @@ def test_enable_activation(
         )
 
 
+@pytest.mark.parametrize(
+    "enabled",
+    [True, False],
+)
+@pytest.mark.django_db
+@mock.patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
+@mock.patch("aap_eda.core.tasking.is_redis_failed", return_value=True)
+def test_enable_activation_redis_unavailable(
+    is_redis_failed: mock.Mock,
+    default_activation: models.Activation,
+    admin_client: APIClient,
+    enabled: bool,
+    preseed_credential_types,
+):
+    default_activation.is_enabled = enabled
+    default_activation.save(update_fields=["is_enabled"])
+
+    response = admin_client.post(
+        f"{api_url_v1}/activations/{default_activation.id}/enable/"
+    )
+
+    if enabled:
+        assert response.status_code == status.HTTP_204_NO_CONTENT
+    else:
+        assert response.status_code == status.HTTP_409_CONFLICT
+        assert response.json() == {
+            "detail": "Redis is required but unavailable."
+        }
+
+
 @pytest.mark.django_db
 def test_disable_activation(
     default_activation: models.Activation,
@@ -550,6 +656,35 @@ def test_disable_activation(
     assert response.status_code == status.HTTP_204_NO_CONTENT
 
 
+@pytest.mark.parametrize(
+    "enabled",
+    [True, False],
+)
+@pytest.mark.django_db
+@mock.patch("aap_eda.core.tasking.is_redis_failed", return_value=True)
+def test_disable_activation_redis_unavailable(
+    is_redis_failed: mock.Mock,
+    default_activation: models.Activation,
+    admin_client: APIClient,
+    enabled: bool,
+    preseed_credential_types,
+):
+    default_activation.is_enabled = enabled
+    default_activation.save(update_fields=["is_enabled"])
+
+    response = admin_client.post(
+        f"{api_url_v1}/activations/{default_activation.id}/disable/"
+    )
+
+    if not enabled:
+        assert response.status_code == status.HTTP_204_NO_CONTENT
+    else:
+        assert response.status_code == status.HTTP_409_CONFLICT
+        assert response.json() == {
+            "detail": "Redis is required but unavailable."
+        }
+
+
 @pytest.mark.django_db
 def test_list_activation_instances(
     default_activation: models.Activation,
@@ -812,7 +947,7 @@ def test_create_activation_with_awx_token(
 
 
 @pytest.mark.django_db
-@patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
+@mock.patch.object(settings, "RULEBOOK_WORKER_QUEUES", [])
 def test_create_activation_with_skip_audit_events(
     admin_awx_token: models.AwxToken,
     activation_payload_skip_audit_events: Dict[str, Any],