wip: release pipeline

Author: gagantrivedi

api/app/settings/common.py

@@ -113,6 +113,7 @@
     "features.multivariate",
     "features.versioning",
     "features.workflows.core",
+    "features.release_pipelines.core",
     "segments",
     "app",
     "e2etests",
@@ -1067,6 +1068,14 @@
     if importlib.util.find_spec("workflows_logic.stale_flags") is not None:
         INSTALLED_APPS.append("workflows_logic.stale_flags")
 
+RELEASE_PIPELINES_LOGIC_INSTALLED = (
+    importlib.util.find_spec("release_pipelines_logic") is not None
+)
+
+if RELEASE_PIPELINES_LOGIC_INSTALLED:  # pragma: no cover
+    INSTALLED_APPS.append("release_pipelines_logic")
+
+
 # Additional functionality for restricting authentication to a set of authentication methods in Flagsmith SaaS
 AUTH_CONTROLLER_INSTALLED = importlib.util.find_spec("auth_controller") is not None
 if AUTH_CONTROLLER_INSTALLED:

api/audit/constants.py

@@ -64,3 +64,11 @@
 ENVIRONMENT_FEATURE_VERSION_PUBLISHED_MESSAGE = "New version published for feature: %s"
 
 DATETIME_FORMAT = "%d/%m/%Y %H:%M:%S"
+
+
+RELEASE_PIPELINE_CREATED_MESSAGE = "Release Pipeline: %s created"
+RELEASE_PIPELINE_PUBLISHED_MESSAGE = "Release Pipeline: %s published"
+# TODO: Add audit log for pipeline update
+RELEASE_PIPELINE_DELETED_MESSAGE = "Release Pipeline: %s deleted"
+RELEASE_PIPELINE_FEATURE_ADDED_MESSAGE = "Feature: %s added to Release Pipeline: %s"
+FEATURE_STATE_UPDATED_BY_RELEASE_PIPELINE_MESSAGE = "Flag state / Remote config updated for feature: %s by Release pipeline: %s (stage: %s)"

api/audit/related_object_type.py

@@ -11,3 +11,4 @@ class RelatedObjectType(enum.Enum):
     IMPORT_REQUEST = "Import request"
     EF_VERSION = "Environment feature version"
     FEATURE_HEALTH = "Feature health status"
+    RELEASE_PIPELINE = "Release pipeline"

api/conftest.py

@@ -1,3 +1,4 @@
+import json
 import logging
 import os
 import site
@@ -17,6 +18,7 @@
 from django.core.cache import caches
 from django.db.backends.base.creation import TEST_DATABASE_PREFIX
 from django.test.utils import setup_databases
+from django.urls import reverse
 from flag_engine.segments.constants import EQUAL
 from moto import mock_dynamodb  # type: ignore[import-untyped]
 from mypy_boto3_dynamodb.service_resource import DynamoDBServiceResource, Table
@@ -25,6 +27,7 @@
 from pytest_django.fixtures import SettingsWrapper
 from pytest_django.plugin import blocking_manager_key
 from pytest_mock import MockerFixture
+from rest_framework import status
 from rest_framework.authtoken.models import Token
 from rest_framework.test import APIClient
 from task_processor.task_run_method import TaskRunMethod
@@ -83,6 +86,8 @@
 from tests.test_helpers import fix_issue_3869
 from tests.types import (
     AdminClientAuthType,
+    GetEnvironmentFlagsResponseJSONCallable,
+    GetIdentityFlagsResponseJSONCallable,
     WithEnvironmentPermissionsCallable,
     WithOrganisationPermissionsCallable,
     WithProjectPermissionsCallable,
@@ -548,8 +553,8 @@ def multivariate_options(
 
 
 @pytest.fixture()
-def identity_matching_segment(project, trait):  # type: ignore[no-untyped-def]
-    segment = Segment.objects.create(name="Matching segment", project=project)
+def identity_matching_segment(project: Project, trait: Trait) -> Segment:
+    segment: Segment = Segment.objects.create(name="Matching segment", project=project)
     matching_rule = SegmentRule.objects.create(
         segment=segment, type=SegmentRule.ALL_RULE
     )
@@ -563,10 +568,17 @@ def identity_matching_segment(project, trait):  # type: ignore[no-untyped-def]
 
 
 @pytest.fixture()
-def api_client():  # type: ignore[no-untyped-def]
+def api_client() -> APIClient:
     return APIClient()
 
 
+@pytest.fixture()
+def sdk_client(environment: Environment) -> APIClient:
+    client = APIClient()
+    client.credentials(HTTP_X_ENVIRONMENT_KEY=environment.api_key)
+    return client
+
+
 @pytest.fixture()
 def feature(project: Project, environment: Environment) -> Feature:
     return Feature.objects.create(name="Test Feature1", project=project)  # type: ignore[no-any-return]
@@ -1265,3 +1277,46 @@ def set_github_webhook_secret() -> None:
     from django.conf import settings
 
     settings.GITHUB_WEBHOOK_SECRET = "secret-key"
+
+
+# TODO: move _flags_response_json to common?
+@pytest.fixture()
+def get_environment_flags_response_json(
+    sdk_client: APIClient,
+) -> GetEnvironmentFlagsResponseJSONCallable:
+    get_environment_flags_url = reverse("api-v1:flags")
+
+    def _get_environment_flags_response_json(num_expected_flags: int) -> typing.Dict:  # type: ignore[type-arg]
+        _response = sdk_client.get(get_environment_flags_url)
+        assert _response.status_code == status.HTTP_200_OK
+        _response_json = _response.json()
+        assert len(_response_json) == num_expected_flags
+        return _response_json  # type: ignore[no-any-return]
+
+    return _get_environment_flags_response_json
+
+
+@pytest.fixture()
+def get_identity_flags_response_json(
+    sdk_client: APIClient, identity: Identity
+) -> GetIdentityFlagsResponseJSONCallable:
+    identities_url = reverse("api-v1:sdk-identities")
+
+    def _get_identity_flags_response_json(  # type: ignore[no-untyped-def]
+        num_expected_flags: int, identifier: str = identity.identifier, **traits
+    ) -> typing.Dict:  # type: ignore[type-arg]
+        traits = traits or {}
+        data = {
+            "identifier": identifier,
+            "traits": [{"trait_key": k, "trait_value": v} for k, v in traits.items()],
+        }
+
+        _response = sdk_client.post(
+            identities_url, data=json.dumps(data), content_type="application/json"
+        )
+        assert _response.status_code == status.HTTP_200_OK
+        _response_json = _response.json()
+        assert len(_response_json["flags"]) == num_expected_flags
+        return _response_json  # type: ignore[no-any-return]
+
+    return _get_identity_flags_response_json  # type: ignore[return-value]

api/features/release_pipelines/core/__init__.py

@@ -0,0 +1,7 @@
+from core.apps import BaseAppConfig
+
+
+class ReleasePipelineConfig(BaseAppConfig):
+    name = "features.release_pipelines.core"
+    label = "release_pipelines_core"
+    default = True

api/features/release_pipelines/core/apps.py

@@ -0,0 +1 @@
+MAX_PIPELINE_STAGES = 30

api/features/release_pipelines/core/constants.py

@@ -0,0 +1,10 @@
+from rest_framework import status
+from rest_framework.exceptions import APIException
+
+
+class ReleasePipelineError(APIException):
+    status_code = status.HTTP_500_INTERNAL_SERVER_ERROR
+
+
+class InvalidPipelineStateError(ReleasePipelineError):
+    status_code = status.HTTP_400_BAD_REQUEST  # type: ignore[assignment]