feat: Add per project ephemeral environment deprovisioning (#376)

Author: stevencl840

pkg/environments/v2/ephemeralenvironments/ephemeral_environment_service.go

@@ -29,6 +29,18 @@ type CreateEnvironmentCommand struct {
 	ProjectID       string `uri:"projectId"`
 }
 
+type DeprovisionEphemeralEnvironmentProjectCommand struct {
+}
+
+type DeprovisionEphemeralEnvironmentProjectResponse struct {
+	DeprovisioningRun DeprovisioningRunbookRun `json:"DeprovisioningRunbookRuns"`
+}
+
+type DeprovisioningRunbookRun struct {
+	RunbookRunID string `json:"RunbookRunId"`
+	TaskId       string `json:"TaskId"`
+}
+
 func Add(client newclient.Client, spaceID string, projectID string, environmentName string) (*CreateEnvironmentResponse, error) {
 	body := &CreateEnvironmentCommand{
 		EnvironmentName: environmentName,
@@ -47,3 +59,19 @@ func Add(client newclient.Client, spaceID string, projectID string, environmentN
 
 	return newclient.Add[CreateEnvironmentResponse](client, path, spaceID, body)
 }
+
+func DeprovisionForProject(client newclient.Client, spaceID string, environmentId string, projectId string) (*DeprovisionEphemeralEnvironmentProjectResponse, error) {
+	body := &DeprovisionEphemeralEnvironmentProjectCommand{}
+
+	path, err := client.URITemplateCache().Expand(v2.DeprovisionEphemeralEnvironmentForProjectTemplate, map[string]any{
+		"id":        environmentId,
+		"projectId": projectId,
+		"spaceId":   spaceID,
+	})
+
+	if err != nil {
+		return nil, err
+	}
+
+	return newclient.Add[DeprovisionEphemeralEnvironmentProjectResponse](client, path, spaceID, body)
+}

pkg/environments/v2/route.go

@@ -2,3 +2,4 @@ package v2
 
 const Template = "/api/{spaceId}/environments/v2{/id}{?name,skip,ids,take,partialName,type}"
 const CreateEphemeralEnvironmentTemplate = "/api/{spaceId}/projects/{projectId}/environments/ephemeral"
+const DeprovisionEphemeralEnvironmentForProjectTemplate = "/api/{spaceId}/projects/{projectId}/environments/ephemeral/{id}/deprovision"

test/e2e/ephemeral_environment_service_test.go

@@ -48,6 +48,45 @@ func TestEnvironmentServiceCreateEphemeralEnvironment(t *testing.T) {
 	require.Equal(t, createdEnvironmentId, environments.Items[0].ID)
 }
 
+func TestEnvironmentServiceDeprovisionEphemeralEnvironmentForProject(t *testing.T) {
+	client := getOctopusClient()
+	require.NotNil(t, client)
+
+	space := GetDefaultSpace(t, client)
+	require.NotNil(t, space)
+
+	lifecycle := CreateTestLifecycle(t, client)
+	require.NotNil(t, lifecycle)
+	defer DeleteTestLifecycle(t, client, lifecycle)
+
+	projectGroup := CreateTestProjectGroup(t, client)
+	require.NotNil(t, projectGroup)
+	defer DeleteTestProjectGroup(t, client, projectGroup)
+
+	project := CreateTestProject(t, client, space, lifecycle, projectGroup)
+	require.NotNil(t, project)
+	defer DeleteTestProject(t, client, project)
+
+	runbook := CreateTestRunbook(t, client, lifecycle, projectGroup, project)
+	require.NotNil(t, runbook)
+	defer DeleteTestRunbook(t, client, runbook)
+
+	parentEnvironment := CreateParentEnvironment(t, client)
+	require.NotNil(t, parentEnvironment)
+	defer DeleteParentEnvironment(t, client, parentEnvironment)
+
+	ephemeralChannel := CreateEphemeralTestChannel(t, client, project, parentEnvironment)
+	require.NotNil(t, ephemeralChannel)
+	defer DeleteTestChannel(t, client, ephemeralChannel)
+
+	createdEnvironmentId := CreateEphemeralEnvironment(t, client, project)
+	DeprovisionEphemeralEnvironmentForProject(t, client, &createdEnvironmentId, project)
+
+	environments, err := ephemeralenvironments.GetAll(client, client.GetSpaceID())
+	require.NoError(t, err)
+	require.NotNil(t, environments)
+}
+
 func CreateEphemeralEnvironment(t *testing.T, client *client.Client, project *projects.Project) string {
 	if client == nil {
 		client = getOctopusClient()
@@ -63,3 +102,16 @@ func CreateEphemeralEnvironment(t *testing.T, client *client.Client, project *pr
 
 	return createdEnvironment.Id
 }
+
+func DeprovisionEphemeralEnvironmentForProject(t *testing.T, client *client.Client, environmentId *string, project *projects.Project) ephemeralenvironments.DeprovisioningRunbookRun {
+	if client == nil {
+		client = getOctopusClient()
+	}
+	require.NotNil(t, client)
+
+	deprovisionResponse, err := ephemeralenvironments.DeprovisionForProject(client, client.GetSpaceID(), *environmentId, project.GetID())
+	require.NoError(t, err)
+	require.NotNil(t, deprovisionResponse)
+
+	return deprovisionResponse.DeprovisioningRun
+}