moved stage to its own resource

docs/providers/aws/guide/resources.md

@@ -79,6 +79,7 @@ We're also using the term `normalizedName` or similar terms in this guide. This
 |ApiGateway::Method     | ApiGatewayResource{normalizedPath}{normalizedMethod}    | ApiGatewayResourceUsersGet    |
 |ApiGateway::Authorizer | {normalizedFunctionName}ApiGatewayAuthorizer            | HelloApiGatewayAuthorizer     |
 |ApiGateway::Deployment | ApiGatewayDeployment{randomNumber}                      | ApiGatewayDeployment12356789  |
+|ApiGateway::Stage      | ApiGatewayStage                                         | ApiGatewayStage               |
 |ApiGateway::ApiKey     | ApiGatewayApiKey{SequentialID}                          | ApiGatewayApiKey1             |
 |SNS::Topic             | SNSTopic{normalizedTopicName}                           | SNSTopicSometopic             |
 |SNS::Subscription      | {normalizedFunctionName}SnsSubscription{normalizedTopicName}   | HelloSnsSubscriptionSomeTopic             |

lib/plugins/aws/deploy/compile/events/apiGateway/index.js

@@ -10,6 +10,7 @@ const compileCors = require('./lib/cors');
 const compileMethods = require('./lib/method/index');
 const compileAuthorizers = require('./lib/authorizers');
 const compileDeployment = require('./lib/deployment');
+const compileStage = require('./lib/stage');
 const compilePermissions = require('./lib/permissions');
 const getMethodAuthorization = require('./lib/method/authorization');
 const getMethodIntegration = require('./lib/method/integration');
@@ -31,6 +32,7 @@ class AwsCompileApigEvents {
       compileMethods,
       compileAuthorizers,
       compileDeployment,
+      compileStage,
       compilePermissions,
       getMethodAuthorization,
       getMethodIntegration,
@@ -52,6 +54,7 @@ class AwsCompileApigEvents {
           .then(this.compileMethods)
           .then(this.compileAuthorizers)
           .then(this.compileDeployment)
+          .then(this.compileStage)
           .then(this.compileApiKeys)
           .then(this.compilePermissions);
       },

lib/plugins/aws/deploy/compile/events/apiGateway/index.test.js

@@ -59,6 +59,8 @@ describe('AwsCompileApigEvents', () => {
         .stub(awsCompileApigEvents, 'compileMethods').returns(BbPromise.resolve());
       const compileDeploymentStub = sinon
         .stub(awsCompileApigEvents, 'compileDeployment').returns(BbPromise.resolve());
+      const compileStageStub = sinon
+        .stub(awsCompileApigEvents, 'compileStage').returns(BbPromise.resolve());
       const compilePermissionsStub = sinon
         .stub(awsCompileApigEvents, 'compilePermissions').returns(BbPromise.resolve());
 
@@ -68,13 +70,15 @@ describe('AwsCompileApigEvents', () => {
         expect(compileResourcesStub.calledAfter(compileRestApiStub)).to.be.equal(true);
         expect(compileMethodsStub.calledAfter(compileResourcesStub)).to.be.equal(true);
         expect(compileDeploymentStub.calledAfter(compileMethodsStub)).to.be.equal(true);
-        expect(compilePermissionsStub.calledAfter(compileDeploymentStub)).to.be.equal(true);
+        expect(compileStageStub.calledAfter(compileDeploymentStub)).to.be.equal(true);
+        expect(compilePermissionsStub.calledAfter(compileStageStub)).to.be.equal(true);
 
         awsCompileApigEvents.validate.restore();
         awsCompileApigEvents.compileRestApi.restore();
         awsCompileApigEvents.compileResources.restore();
         awsCompileApigEvents.compileMethods.restore();
         awsCompileApigEvents.compileDeployment.restore();
+        awsCompileApigEvents.compileStage.restore();
         awsCompileApigEvents.compilePermissions.restore();
       });
     });

lib/plugins/aws/deploy/compile/events/apiGateway/lib/deployment.js

@@ -13,27 +13,11 @@ module.exports = {
         Type: 'AWS::ApiGateway::Deployment',
         Properties: {
           RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
-          StageName: this.options.stage,
         },
         DependsOn: this.apiGatewayMethodLogicalIds,
       },
     });
 
-    // create CLF Output for endpoint
-    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Outputs, {
-      ServiceEndpoint: {
-        Description: 'URL of the service endpoint',
-        Value: {
-          'Fn::Join': ['',
-            [
-              'https://',
-              { Ref: this.apiGatewayRestApiLogicalId },
-              `.execute-api.${this.options.region}.amazonaws.com/${this.options.stage}`,
-            ],
-          ],
-        },
-      },
-    });
     return BbPromise.resolve();
   },
 };

lib/plugins/aws/deploy/compile/events/apiGateway/lib/deployment.test.js

@@ -18,7 +18,6 @@ describe('#compileDeployment()', () => {
     };
     const options = {
       stage: 'dev',
-      region: 'us-east-1',
     };
     awsCompileApigEvents = new AwsCompileApigEvents(serverless, options);
     awsCompileApigEvents.apiGatewayRestApiLogicalId = 'ApiGatewayRestApi';
@@ -39,28 +38,6 @@ describe('#compileDeployment()', () => {
         DependsOn: ['method-dependency1', 'method-dependency2'],
         Properties: {
           RestApiId: { Ref: awsCompileApigEvents.apiGatewayRestApiLogicalId },
-          StageName: 'dev',
-        },
-      });
-    })
-  );
-
-  it('should add service endpoint output', () =>
-    awsCompileApigEvents.compileDeployment().then(() => {
-      expect(
-        awsCompileApigEvents.serverless.service.provider.compiledCloudFormationTemplate
-          .Outputs.ServiceEndpoint
-      ).to.deep.equal({
-        Description: 'URL of the service endpoint',
-        Value: {
-          'Fn::Join': [
-            '',
-            [
-              'https://',
-              { Ref: awsCompileApigEvents.apiGatewayRestApiLogicalId },
-              '.execute-api.us-east-1.amazonaws.com/dev',
-            ],
-          ],
         },
       });
     })

lib/plugins/aws/deploy/compile/events/apiGateway/lib/stage.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const _ = require('lodash');
+const BbPromise = require('bluebird');
+
+module.exports = {
+  compileStage() {
+    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Resources, {
+      ApiGatewayStage: {
+        Type: 'AWS::ApiGateway::Stage',
+        Properties: {
+          RestApiId: { Ref: this.apiGatewayRestApiLogicalId },
+          DeploymentId: { Ref: this.apiGatewayDeploymentLogicalId },
+          StageName: this.options.stage,
+        },
+        DependsOn: [this.apiGatewayDeploymentLogicalId],
+      },
+    });
+
+    // create CLF Output for endpoint
+    _.merge(this.serverless.service.provider.compiledCloudFormationTemplate.Outputs, {
+      ServiceEndpoint: {
+        Description: 'URL of the service endpoint',
+        Value: {
+          'Fn::Join': ['',
+            [
+              'https://',
+              { Ref: this.apiGatewayRestApiLogicalId },
+              `.execute-api.${this.options.region}.amazonaws.com/${this.options.stage}`,
+            ],
+          ],
+        },
+      },
+    });
+
+    return BbPromise.resolve();
+  },
+};

lib/plugins/aws/deploy/compile/events/apiGateway/lib/stage.test.js

@@ -0,0 +1,65 @@
+'use strict';
+
+const expect = require('chai').expect;
+const AwsCompileApigEvents = require('../index');
+const Serverless = require('../../../../../../../Serverless');
+const AwsProvider = require('../../../../../provider/awsProvider');
+
+describe('#compileStage()', () => {
+  let serverless;
+  let awsCompileApigEvents;
+
+  beforeEach(() => {
+    serverless = new Serverless();
+    serverless.setProvider('aws', new AwsProvider(serverless));
+    serverless.service.provider.compiledCloudFormationTemplate = {
+      Resources: {},
+      Outputs: {},
+    };
+    const options = {
+      stage: 'dev',
+      region: 'us-east-1',
+    };
+    awsCompileApigEvents = new AwsCompileApigEvents(serverless, options);
+    awsCompileApigEvents.apiGatewayRestApiLogicalId = 'ApiGatewayRestApi';
+    awsCompileApigEvents.apiGatewayDeploymentLogicalId = 'ApiGatewayDeployment';
+  });
+
+  it('should create a stage resource', () => awsCompileApigEvents
+    .compileStage().then(() => {
+      expect(
+        awsCompileApigEvents.serverless.service.provider.compiledCloudFormationTemplate
+          .Resources.ApiGatewayStage
+      ).to.deep.equal({
+        Type: 'AWS::ApiGateway::Stage',
+        DependsOn: [awsCompileApigEvents.apiGatewayDeploymentLogicalId],
+        Properties: {
+          RestApiId: { Ref: awsCompileApigEvents.apiGatewayRestApiLogicalId },
+          DeploymentId: { Ref: awsCompileApigEvents.apiGatewayDeploymentLogicalId },
+          StageName: 'dev',
+        },
+      });
+    })
+  );
+
+  it('should add service endpoint output', () =>
+    awsCompileApigEvents.compileStage().then(() => {
+      expect(
+        awsCompileApigEvents.serverless.service.provider.compiledCloudFormationTemplate
+          .Outputs.ServiceEndpoint
+      ).to.deep.equal({
+        Description: 'URL of the service endpoint',
+        Value: {
+          'Fn::Join': [
+            '',
+            [
+              'https://',
+              { Ref: awsCompileApigEvents.apiGatewayRestApiLogicalId },
+              '.execute-api.us-east-1.amazonaws.com/dev',
+            ],
+          ],
+        },
+      });
+    })
+  );
+});