Remove app-deployment file

src/api/decommission-service/helpers/trigger-remove-workflows.js

@@ -1,7 +1,7 @@
-import { removeAppConfig } from '~/src/helpers/remove/workflows/remove-app-config.js'
-import { removeDashboard } from '~/src/helpers/remove/workflows/remove-dashboard.js'
-import { removeNginxUpstreams } from '~/src/helpers/remove/workflows/remove-nginx-upstreams.js'
 import {
+  removeAppConfig,
+  removeDashboard,
+  removeNginxUpstreams,
   removeSquidConfig,
   removeTenantInfrastructure
 } from '~/src/helpers/remove/workflows/index.js'
@@ -18,22 +18,21 @@ async function triggerRemoveWorkflows(serviceName, repository, logger) {
   logger.info(`Triggering remove workflows service: ${serviceName}`)
   const isTestSuite = repository.topics.includes('test-suite')
 
-  if (isFeatureEnabled(featureToggles.removeServiceWorkflows)) {
-    if (!isTestSuite) {
-      const zone = repository.topics.includes('backend')
-        ? 'Protected'
-        : 'Public'
+  if (!isFeatureEnabled(featureToggles.removeServiceWorkflows)) {
+    logger.info('Remove service workflows feature is disabled')
+    return
+  }
 
-      await removeDashboard(serviceName, logger)
-      await removeNginxUpstreams(serviceName, zone, logger)
-    }
+  if (!isTestSuite) {
+    const zone = repository.topics.includes('backend') ? 'Protected' : 'Public'
 
-    await removeAppConfig(serviceName, logger)
-    await removeSquidConfig(serviceName, logger)
-    await removeTenantInfrastructure(serviceName, logger)
-  } else {
-    logger.info('Remove service workflows feature is disabled')
+    await removeDashboard(serviceName, logger)
+    await removeNginxUpstreams(serviceName, zone, logger)
   }
+
+  await removeAppConfig(serviceName, logger)
+  await removeSquidConfig(serviceName, logger)
+  await removeTenantInfrastructure(serviceName, logger)
 }
 
 export { triggerRemoveWorkflows }

src/api/decommission-service/helpers/trigger-remove-workflows.test.js

@@ -0,0 +1,85 @@
+import { triggerRemoveWorkflows } from './trigger-remove-workflows.js'
+import {
+  removeAppConfig,
+  removeDashboard,
+  removeNginxUpstreams,
+  removeSquidConfig,
+  removeTenantInfrastructure
+} from '~/src/helpers/remove/workflows/index.js'
+import { isFeatureEnabled } from '~/src/helpers/feature-toggle/is-feature-enabled.js'
+
+jest.mock('~/src/helpers/remove/workflows')
+jest.mock('~/src/helpers/feature-toggle/is-feature-enabled')
+
+const logger = {
+  info: jest.fn()
+}
+
+describe('#triggerRemoveWorkflows', () => {
+  const serviceName = 'some-service'
+  const backendRepository = {
+    topics: ['backend']
+  }
+  const testRepository = {
+    topics: ['test-suite']
+  }
+
+  isFeatureEnabled.mockReturnValue(true)
+
+  test('Should trigger remove app config workflow', async () => {
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeAppConfig).toHaveBeenCalledWith(serviceName, logger)
+  })
+
+  test('Should trigger remove squid config workflow', async () => {
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeSquidConfig).toHaveBeenCalledWith(serviceName, logger)
+  })
+
+  test('Should trigger remove tenant infrastructure workflow', async () => {
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeTenantInfrastructure).toHaveBeenCalledWith(serviceName, logger)
+  })
+
+  test('Should trigger remove dashboard workflow if not test suite', async () => {
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeDashboard).toHaveBeenCalledWith(serviceName, logger)
+  })
+
+  test('Should not trigger remove dashboard workflow if test suite', async () => {
+    await triggerRemoveWorkflows(serviceName, testRepository, logger)
+
+    expect(removeDashboard).toHaveBeenCalledTimes(0)
+  })
+
+  test('Should trigger remove nginx upstreams workflow if not test suite', async () => {
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeNginxUpstreams).toHaveBeenCalledWith(
+      serviceName,
+      'Protected',
+      logger
+    )
+  })
+
+  test('Should not trigger remove nginx upstreams workflow if test suite', async () => {
+    await triggerRemoveWorkflows(serviceName, testRepository, logger)
+
+    expect(removeNginxUpstreams).toHaveBeenCalledTimes(0)
+  })
+
+  test('Should log if remove service workflows feature is disabled', async () => {
+    isFeatureEnabled.mockReturnValue(false)
+
+    await triggerRemoveWorkflows(serviceName, backendRepository, logger)
+
+    expect(removeTenantInfrastructure).toHaveBeenCalledTimes(0)
+    expect(logger.info).toHaveBeenCalledWith(
+      'Remove service workflows feature is disabled'
+    )
+  })
+})

src/api/undeploy/controllers/delete-deployment-file.js

@@ -0,0 +1,29 @@
+import Joi from 'joi'
+
+import { deleteDeploymentFiles } from '~/src/api/undeploy/helpers/delete-deployment-file.js'
+
+export const deleteDeploymentFilesController = {
+  options: {
+    auth: {
+      strategy: 'azure-oidc',
+      access: {
+        scope: ['admin']
+      }
+    },
+    validate: {
+      params: Joi.object({
+        serviceName: Joi.string().min(1).required()
+      })
+    }
+  },
+  handler: async (request, h) => {
+    const { serviceName, environment } = request.params
+
+    await deleteDeploymentFiles({
+      serviceName,
+      environment,
+      logger: request.logger
+    })
+    return h.response().code(204)
+  }
+}

src/api/undeploy/controllers/delete-ecs-task.js

@@ -26,7 +26,7 @@ const deleteEcsTaskController = {
       environment,
       logger: request.logger
     })
-    return h.response({ message: 'success' }).code(204)
+    return h.response().code(204)
   }
 }
 
@@ -51,7 +51,7 @@ const deleteAllEcsTasksController = {
       serviceName: imageName,
       logger: request.logger
     })
-    return h.response({ message: 'success' }).code(204)
+    return h.response().code(204)
   }
 }
 

src/api/undeploy/controllers/undeploy-service.js

@@ -5,34 +5,6 @@ import { undeployServiceFromEnvironment } from '~/src/api/undeploy/helpers/undep
 import { undeployServiceFromAllEnvironments } from '~/src/api/undeploy/helpers/undeploy-service-from-all-environments.js'
 import { getScopedUser } from '~/src/helpers/user/get-scoped-user.js'
 
-const undeployServiceController = {
-  options: {
-    auth: {
-      strategy: 'azure-oidc'
-    },
-    validate: {
-      payload: undeployServiceValidation()
-    },
-    payload: {
-      output: 'data',
-      parse: true,
-      allow: 'application/json'
-    }
-  },
-  handler: async (request, h) => {
-    const { imageName, environment } = request.payload
-    const user = await getScopedUser(imageName, request.auth, 'admin')
-
-    await undeployServiceFromEnvironment({
-      imageName,
-      environment,
-      user,
-      logger: request.logger
-    })
-    return h.response({ message: 'success' }).code(204)
-  }
-}
-
 const undeployServiceFromEnvironmentController = {
   options: {
     auth: {
@@ -43,16 +15,16 @@ const undeployServiceFromEnvironmentController = {
     }
   },
   handler: async (request, h) => {
-    const { imageName, environment } = request.params
-    const user = await getScopedUser(imageName, request.auth, 'admin')
+    const { serviceName, environment } = request.params
+    const user = await getScopedUser(serviceName, request.auth, 'admin')
 
     await undeployServiceFromEnvironment({
-      imageName,
+      serviceName,
       environment,
       user,
       logger: request.logger
     })
-    return h.response({ message: 'success' }).code(204)
+    return h.response({ message: 'success' }).code(200)
   }
 }
 
@@ -63,25 +35,24 @@ const undeployServiceFromAllEnvironmentController = {
     },
     validate: {
       params: Joi.object({
-        imageName: Joi.string().min(1).required()
+        serviceName: Joi.string().min(1).required()
       })
     }
   },
   handler: async (request, h) => {
-    const imageName = request.params.imageName
-    const user = await getScopedUser(imageName, request.auth, 'admin')
+    const serviceName = request.params.serviceName
+    const user = await getScopedUser(serviceName, request.auth, 'admin')
 
     await undeployServiceFromAllEnvironments({
-      imageName,
+      serviceName,
       user,
       logger: request.logger
     })
-    return h.response({ message: 'success' }).code(204)
+    return h.response({ message: 'success' }).code(200)
   }
 }
 
 export {
-  undeployServiceController,
   undeployServiceFromAllEnvironmentController,
   undeployServiceFromEnvironmentController
 }

src/api/undeploy/helpers/delete-deployment-file.js

@@ -0,0 +1,21 @@
+import { createLogger } from '~/src/helpers/logging/logger.js'
+import { featureToggles } from '~/src/helpers/feature-toggle/feature-toggles.js'
+import { isFeatureEnabled } from '~/src/helpers/feature-toggle/is-feature-enabled.js'
+import { removeDeployment } from '~/src/helpers/remove/workflows/remove-deployment.js'
+
+/**
+ * @param {{serviceName: string, logger: [import('pino').Logger]}} options
+ */
+export async function deleteDeploymentFiles({
+  serviceName,
+  logger = createLogger()
+}) {
+  logger.info(`Deleting deployment files for ${serviceName}`)
+
+  if (!isFeatureEnabled(featureToggles.undeploy.deleteDeploymentFiles)) {
+    logger.info('Deleting deployment file feature is disabled')
+    return
+  }
+
+  await removeDeployment(serviceName, logger)
+}

src/api/undeploy/helpers/delete-deployment-file.test.js

@@ -0,0 +1,31 @@
+import { featureToggles } from '~/src/helpers/feature-toggle/feature-toggles.js'
+import { isFeatureEnabled } from '~/src/helpers/feature-toggle/is-feature-enabled.js'
+import { removeDeployment } from '~/src/helpers/remove/workflows/remove-deployment.js'
+import { deleteDeploymentFiles } from '~/src/api/undeploy/helpers/delete-deployment-file.js'
+
+jest.mock('~/src/helpers/feature-toggle/is-feature-enabled')
+jest.mock('~/src/helpers/remove/workflows/remove-deployment')
+
+const serviceName = 'some-service'
+const logger = { info: jest.fn() }
+
+describe('#deleteDeploymentFiles', () => {
+  test('should delete all deployment files for a service', async () => {
+    isFeatureEnabled.mockReturnValue(true)
+
+    await deleteDeploymentFiles({ serviceName, logger })
+
+    expect(isFeatureEnabled).toHaveBeenCalledWith(
+      featureToggles.undeploy.deleteDeploymentFiles
+    )
+    expect(removeDeployment).toHaveBeenCalledWith(serviceName, logger)
+  })
+
+  test('should not delete deployment file if feature disabled', async () => {
+    isFeatureEnabled.mockReturnValue(false)
+
+    await deleteDeploymentFiles({ serviceName, logger })
+
+    expect(removeDeployment).toHaveBeenCalledTimes(0)
+  })
+})

src/api/undeploy/helpers/delete-ecs-task.js

@@ -15,7 +15,7 @@ async function deleteEcsTask({
 }) {
   logger.info(`Deleting ECS task for ${serviceName} in env ${environment}`)
 
-  if (!isFeatureEnabled(featureToggles.deleteEcsTask)) {
+  if (!isFeatureEnabled(featureToggles.undeploy.deleteEcsTask)) {
     logger.info('Deleting ECS Task feature is disabled')
     return
   }

src/api/undeploy/helpers/delete-ecs-task.test.js

@@ -24,7 +24,9 @@ describe('#deleteEcsTask', () => {
 
     await deleteEcsTask({ serviceName, environment, logger })
 
-    expect(isFeatureEnabled).toHaveBeenCalledWith(featureToggles.deleteEcsTask)
+    expect(isFeatureEnabled).toHaveBeenCalledWith(
+      featureToggles.undeploy.deleteEcsTask
+    )
     expect(lookupTenantService).toHaveBeenCalledTimes(1)
     expect(removeEcsTask).toHaveBeenCalledWith(serviceName, environment, logger)
   })

src/api/undeploy/helpers/schema/undeploy-service-validation.js

@@ -4,7 +4,7 @@ import { environments } from '~/src/config/environments.js'
 
 function undeployServiceValidation() {
   return Joi.object({
-    imageName: Joi.string().min(1).required(),
+    serviceName: Joi.string().min(1).required(),
     environment: Joi.string()
       .valid(...Object.values(environments))
       .required()

src/api/undeploy/helpers/undeploy-service-from-environment.js

@@ -5,6 +5,7 @@ import { lookupTenantService } from '~/src/api/deploy/helpers/lookup-tenant-serv
 import { isFeatureEnabled } from '~/src/helpers/feature-toggle/is-feature-enabled.js'
 import { featureToggles } from '~/src/helpers/feature-toggle/feature-toggles.js'
 import { createLogger } from '~/src/helpers/logging/logger.js'
+import { getRepositoryInfo } from '~/src/helpers/portal-backend/get-repository-info.js'
 
 const deployFromFileConfig = config.get('deployFromFileEnvironments')
 
@@ -22,6 +23,13 @@ export async function undeployServiceFromEnvironment({
 }) {
   logger.info(`Undeploying ${serviceName} from ${environment} in progress`)
 
+  const repositoryInfo = await getRepositoryInfo(serviceName, logger)
+  const isTestSuite = repositoryInfo?.repository?.topics?.includes('test-suite')
+  if (isTestSuite) {
+    logger.info('Service is a test suite, skipping undeployment')
+    return undeploymentId
+  }
+
   const service = await lookupTenantService(serviceName, environment, logger)
 
   if (!service) {