fix(AWS Deploy): Fix handling of inactive CloudFormation stack state

(PR #11863)
serverless · Mar 29, 2023 · 0d850fc · 0d850fc
1 parent 048ffad
commit 0d850fc
Show file tree

Hide file tree

Showing 6 changed files with 81 additions and 7 deletions.
diff --git a/lib/plugins/aws/deploy/lib/create-stack.js b/lib/plugins/aws/deploy/lib/create-stack.js
@@ -1,10 +1,12 @@
 'use strict';
 
 const BbPromise = require('bluebird');
-const ServerlessError = require('../../../../serverless-error');
 const { progress, log } = require('@serverless/utils/log');
+const ServerlessError = require('../../../../serverless-error');
 const isChangeSetWithoutChanges = require('../../utils/is-change-set-without-changes');
 
+const inactiveStateNames = new Set(['REVIEW_IN_PROGRESS']);
+
 module.exports = {
   async create() {
     // Note: using three dots instead of ellipsis to support non uni-code consoles.
@@ -88,6 +90,18 @@ module.exports = {
                 this.provider.disableTransferAccelerationForCurrentDeploy();
               }
             }
+
+            const stackStatus = data.Stacks[0].StackStatus;
+            if (inactiveStateNames.has(stackStatus)) {
+              const errorMessage = [
+                'Service cannot be deployed as the CloudFormation stack ',
+                `is in the '${stackStatus}' state. `,
+                'This may signal either that stack is currently deployed by a different entity, ',
+                'or that the previous deployment failed and was left in an abnormal state, ',
+                "in which case you can mitigate the issue by running 'sls remove' command",
+              ].join('');
+              throw new ServerlessError(errorMessage, 'AWS_CLOUDFORMATION_INACTIVE_STACK');
+            }
             return BbPromise.resolve('alreadyCreated');
           })
       )

diff --git a/test/unit/lib/plugins/aws/deploy/index.test.js b/test/unit/lib/plugins/aws/deploy/index.test.js
@@ -651,6 +651,63 @@ describe('test/unit/lib/plugins/aws/deploy/index.test.js', () => {
       expect(deleteObjectsStub).not.to.be.called;
     });
 
+    it('with nonexistent stack - should output an appropriate error message for an abnormal stack state', async () => {
+      const describeStacksStub = sinon
+        .stub()
+        .onFirstCall()
+        .resolves({
+          Stacks: [
+            {
+              StackStatus: 'REVIEW_IN_PROGRESS',
+            },
+          ],
+        });
+      const createChangeSetStub = sinon.stub().resolves({});
+      const executeChangeSetStub = sinon.stub().resolves({});
+      const s3UploadStub = sinon.stub().resolves();
+      const deleteObjectsStub = sinon.stub().resolves({});
+      const awsRequestStubMap = {
+        ...baseAwsRequestStubMap,
+        ECR: {
+          describeRepositories: sinon.stub().throws({
+            providerError: { code: 'RepositoryNotFoundException' },
+          }),
+        },
+        S3: {
+          deleteObjects: deleteObjectsStub,
+          listObjectsV2: { Contents: [] },
+          upload: s3UploadStub,
+          headBucket: {},
+        },
+        CloudFormation: {
+          describeStacks: describeStacksStub,
+          createChangeSet: createChangeSetStub,
+          executeChangeSet: executeChangeSetStub,
+          deleteChangeSet: {},
+          describeChangeSet: {
+            ChangeSetName: 'new-service-dev-change-set',
+            ChangeSetId: 'some-change-set-id',
+            StackName: 'new-service-dev',
+            Status: 'CREATE_COMPLETE',
+          },
+          describeStackEvents: {},
+          describeStackResource: {
+            StackResourceDetail: { PhysicalResourceId: 's3-bucket-resource' },
+          },
+          validateTemplate: {},
+          listStackResources: {},
+        },
+      };
+
+      await expect(
+        runServerless({
+          fixture: 'function',
+          command: 'deploy',
+          awsRequestStubMap,
+        })
+      ).to.have.been.eventually.rejected.with.property('code', 'AWS_CLOUDFORMATION_INACTIVE_STACK');
+    });
+
     it('with existing stack - subsequent deploy', async () => {
       const s3BucketPrefix = 'serverless/test-aws-deploy-with-existing-stack/dev';
       const s3UploadStub = sinon.stub().resolves();

diff --git a/test/unit/lib/plugins/aws/deploy/lib/check-for-changes.test.js b/test/unit/lib/plugins/aws/deploy/lib/check-for-changes.test.js
@@ -571,7 +571,7 @@ describe('checkForChanges #2', () => {
       lastLifecycleHookName: 'aws:deploy:deploy:checkForChanges',
       awsRequestStubMap: {
         CloudFormation: {
-          describeStacks: {},
+          describeStacks: { Stacks: [{}] },
           describeStackResource: {
             StackResourceDetail: { PhysicalResourceId: 'deployment-bucket' },
           },
@@ -617,7 +617,7 @@ describe('checkForChanges #2', () => {
 
 const commonAwsSdkMock = {
   CloudFormation: {
-    describeStacks: {},
+    describeStacks: { Stacks: [{}] },
     describeStackResource: {
       StackResourceDetail: { PhysicalResourceId: 'deployment-bucket' },
     },

diff --git a/test/unit/lib/plugins/aws/deploy/lib/upload-artifacts.test.js b/test/unit/lib/plugins/aws/deploy/lib/upload-artifacts.test.js
@@ -307,7 +307,10 @@ describe('uploadArtifacts', () => {
       // There were observed race conditions (mostly in Node.js v6) where this temporary home
       // folder was cleaned before stream initialized fully, hence throwing uncaught
       // ENOENT exception into the air.
-      sinon.stub(fs, 'createReadStream').returns({ path: customResourcesFilePath, on: () => {} });
+      sinon.stub(fs, 'createReadStream').returns({
+        path: customResourcesFilePath,
+        on: () => {},
+      });
       serverless.serviceDir = serviceDirPath;
     });
 
@@ -351,7 +354,7 @@ describe('test/unit/lib/plugins/aws/deploy/lib/upload-artifacts.test.js', () =>
       lastLifecycleHookName: 'aws:deploy:deploy:uploadArtifacts',
       awsRequestStubMap: {
         CloudFormation: {
-          describeStacks: {},
+          describeStacks: { Stacks: [{}] },
           describeStackResource: {
             StackResourceDetail: { PhysicalResourceId: 'deployment-bucket' },
           },

diff --git a/test/unit/lib/plugins/aws/package/compile/events/api-gateway/lib/hack/update-stage.test.js b/test/unit/lib/plugins/aws/package/compile/events/api-gateway/lib/hack/update-stage.test.js
@@ -771,7 +771,7 @@ describe('test/unit/lib/plugins/aws/package/compile/events/apiGateway/lib/hack/u
       lastLifecycleHookName: 'aws:deploy:deploy:checkForChanges',
       awsRequestStubMap: {
         CloudFormation: {
-          describeStacks: {},
+          describeStacks: { Stacks: [{}] },
           describeStackResource: {
             StackResourceDetail: { PhysicalResourceId: 'deployment-bucket' },
           },

diff --git a/test/unit/lib/plugins/package/lib/package-service.test.js b/test/unit/lib/plugins/package/lib/package-service.test.js
@@ -289,7 +289,7 @@ describe('test/unit/lib/plugins/package/lib/packageService.test.js', () => {
           headBucket: {},
         },
         CloudFormation: {
-          describeStacks: {},
+          describeStacks: { Stacks: [{}] },
           describeStackResource: { StackResourceDetail: { PhysicalResourceId: 'resource-id' } },
         },
         STS: {