Add 'projects' query param for the release deploys endpoint (#35916)

Add 'projects' query param for the release deploys endpoint

Author: snigdhas

src/sentry/api/endpoints/release_deploys.py

@@ -5,9 +5,10 @@
 from rest_framework.response import Response
 
 from sentry.api.bases.organization import OrganizationReleasesBaseEndpoint
-from sentry.api.exceptions import ResourceDoesNotExist
+from sentry.api.exceptions import ParameterValidationError, ResourceDoesNotExist
 from sentry.api.paginator import OffsetPaginator
 from sentry.api.serializers import serialize
+from sentry.api.serializers.rest_framework.project import ProjectField
 from sentry.models import Deploy, Environment, Release, ReleaseProjectEnvironment
 from sentry.signals import deploy_created
 
@@ -18,6 +19,9 @@ class DeploySerializer(serializers.Serializer):
     url = serializers.URLField(required=False, allow_blank=True, allow_null=True)
     dateStarted = serializers.DateTimeField(required=False, allow_null=True)
     dateFinished = serializers.DateTimeField(required=False, allow_null=True)
+    projects = serializers.ListField(
+        child=ProjectField(scope="project:read"), required=False, allow_empty=False
+    )
 
     def validate_environment(self, value):
         if not Environment.is_valid_name(value):
@@ -65,6 +69,9 @@ def post(self, request: Request, organization, version) -> Response:
         :pparam string version: the version identifier of the release.
         :param string environment: the environment you're deploying to
         :param string name: the optional name of the deploy
+        :param list projects: the optional list of project slugs to
+                        create a deploy within. If not provided, deploys
+                        are created for all of the release's projects.
         :param url url: the optional url that points to the deploy
         :param datetime dateStarted: an optional date that indicates when
                                      the deploy started
@@ -80,11 +87,21 @@ def post(self, request: Request, organization, version) -> Response:
         if not self.has_release_permission(request, organization, release):
             raise ResourceDoesNotExist
 
-        serializer = DeploySerializer(data=request.data)
+        serializer = DeploySerializer(
+            data=request.data, context={"organization": organization, "access": request.access}
+        )
 
         if serializer.is_valid():
-            projects = list(release.projects.all())
             result = serializer.validated_data
+            release_projects = list(release.projects.all())
+            projects = result.get("projects", release_projects)
+            invalid_projects = {project.slug for project in projects} - {
+                project.slug for project in release_projects
+            }
+            if len(invalid_projects) > 0:
+                raise ParameterValidationError(
+                    f"Invalid projects ({', '.join(invalid_projects)}) for release {release.version}"
+                )
 
             env = Environment.objects.get_or_create(
                 name=result["environment"], organization_id=organization.id

tests/sentry/api/endpoints/test_release_deploys.py

@@ -46,24 +46,31 @@ def test_simple(self):
 
 
 class ReleaseDeploysCreateTest(APITestCase):
+    def setUp(self):
+        user = self.create_user(is_staff=False, is_superuser=False)
+        self.org = self.create_organization()
+        self.org.save()
+
+        team = self.create_team(organization=self.org)
+        self.project = self.create_project(name="foo", organization=self.org, teams=[team])
+
+        self.create_member(teams=[team], user=user, organization=self.org)
+        self.login_as(user=user)
+
     def test_simple(self):
-        project = self.create_project(name="foo")
-        release = Release.objects.create(
-            organization_id=project.organization_id, version="1", total_deploys=0
-        )
-        release.add_project(project)
+        release = Release.objects.create(organization_id=self.org.id, version="1", total_deploys=0)
+        release.add_project(self.project)
 
-        environment = Environment.objects.create(
-            organization_id=project.organization_id, name="production"
-        )
+        environment = Environment.objects.create(organization_id=self.org.id, name="production")
 
         url = reverse(
             "sentry-api-0-organization-release-deploys",
-            kwargs={"organization_slug": project.organization.slug, "version": release.version},
+            kwargs={
+                "organization_slug": self.org.slug,
+                "version": release.version,
+            },
         )
 
-        self.login_as(user=self.user)
-
         response = self.client.post(
             url, data={"name": "foo", "environment": "production", "url": "https://www.example.com"}
         )
@@ -84,23 +91,102 @@ def test_simple(self):
         assert release.last_deploy_id == deploy.id
 
         rpe = ReleaseProjectEnvironment.objects.get(
-            project=project, release=release, environment=environment
+            project=self.project, release=release, environment=environment
+        )
+        assert rpe.last_deploy_id == deploy.id
+
+    def test_with_project_slugs(self):
+        project_bar = self.create_project(organization=self.org, name="bar")
+        release = Release.objects.create(organization_id=self.org.id, version="1", total_deploys=0)
+        release.add_project(self.project)
+        release.add_project(project_bar)
+
+        environment = Environment.objects.create(organization_id=self.org.id, name="production")
+
+        url = reverse(
+            "sentry-api-0-organization-release-deploys",
+            kwargs={
+                "organization_slug": self.org.slug,
+                "version": release.version,
+            },
+        )
+
+        response = self.client.post(
+            url,
+            data={
+                "name": "foo_bar",
+                "environment": "production",
+                "url": "https://www.example.com",
+                "projects": [self.project.slug, project_bar.slug],
+            },
+        )
+        assert response.status_code == 201, response.content
+        assert response.data["name"] == "foo_bar"
+        assert response.data["url"] == "https://www.example.com"
+        assert response.data["environment"] == "production"
+
+        deploy = Deploy.objects.get(id=response.data["id"])
+
+        assert deploy.name == "foo_bar"
+        assert deploy.environment_id == environment.id
+        assert deploy.url == "https://www.example.com"
+        assert deploy.release == release
+
+        release = Release.objects.get(id=release.id)
+        assert release.total_deploys == 1
+        assert release.last_deploy_id == deploy.id
+
+        rpe = ReleaseProjectEnvironment.objects.get(
+            project=self.project, release=release, environment=environment
+        )
+        assert rpe.last_deploy_id == deploy.id
+
+        rpe = ReleaseProjectEnvironment.objects.get(
+            project=project_bar, release=release, environment=environment
         )
         assert rpe.last_deploy_id == deploy.id
 
+    def test_with_invalid_project_slug(self):
+        bar_project = self.create_project(organization=self.org, name="bar")
+        release = Release.objects.create(organization_id=self.org.id, version="1", total_deploys=0)
+        release.add_project(self.project)
+
+        url = reverse(
+            "sentry-api-0-organization-release-deploys",
+            kwargs={
+                "organization_slug": self.org.slug,
+                "version": release.version,
+            },
+        )
+
+        response = self.client.post(
+            url,
+            data={
+                "name": "foo",
+                "environment": "production",
+                "url": "https://www.example.com",
+                "projects": [bar_project.slug],
+            },
+        )
+        assert response.status_code == 400, response.content
+        assert response.data["detail"]["code"] == "parameter-validation-error"
+        assert "Invalid projects" in response.data["detail"]["message"]
+        assert 0 == Deploy.objects.count()
+
     def test_environment_validation_failure(self):
-        project = self.create_project(name="example")
         release = Release.objects.create(
-            organization_id=project.organization_id, version="123", total_deploys=0
+            organization_id=self.org.id, version="123", total_deploys=0
         )
-        release.add_project(project)
+        release.add_project(self.project)
 
         url = reverse(
             "sentry-api-0-organization-release-deploys",
-            kwargs={"organization_slug": project.organization.slug, "version": release.version},
+            kwargs={
+                "organization_slug": self.org.slug,
+                "version": release.version,
+            },
         )
 
-        self.login_as(user=self.user)
         response = self.client.post(
             url, data={"name": "foo", "environment": "bad/name", "url": "https://www.example.com"}
         )