Initial commit

Author: dougmoscrop

.eslintrc

@@ -0,0 +1,11 @@
+root: true
+
+env:
+    node: true
+    es6: true
+
+extends:
+    "eslint:recommended"
+
+ecmaFeatures:
+    generators: true

.gitignore

@@ -0,0 +1,3 @@
+coverage
+.nyc_output
+node_modules

.npmignore

@@ -0,0 +1,5 @@
+.nyc_output
+coverage
+__tests__
+.eslintrc
+.gitignore

LICENSE

@@ -0,0 +1,33 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Doug Moscrop
+
+The following license applies to all parts of this software except as
+documented below:
+
+====
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+====
+
+All files located in the node_modules and external directories are
+externally maintained libraries used by this software which have their
+own licenses; we recommend you read them, as their terms may differ from
+the terms above.

README.md

@@ -0,0 +1,26 @@
+# serverless-plugin-custom-domain
+
+This is a plugin for Serverless that injects a [CloudFormation Custom Resource](http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-custom-resources.html) in your deployed stack that sets up a base path mapping between the `ApiGateway::Deployment` that Serverless creates, and an [API Gateway Custom Domain](http://docs.aws.amazon.com/apigateway/latest/developerguide/how-to-custom-domains.html).
+
+## Usage
+
+```yaml
+
+service: my-service
+
+plugins:
+  - serverless-plugin-custom-domain
+
+custom:
+  domain: "${opt:region}.myservice.foo.com"
+```
+
+## Notes
+
+### Why a Custom Resource?
+
+CloudFormation supports `ApiGateway::BasePathMapping` resources but I found they frequently fail to update correctly. Implementing the (relatively simple) logic to get-and-update-or-create combined with a `remove` hook for cleanup has proven to be more reliable.
+
+### Setting up the Custom Domain
+
+These take a long time to provision and are long-lived persistent resources that have Route53 entires pointing at them as well as ACM certificates that have to be requested and approved. You should manage these outside of Serverless, either via CloudFormation or something like Terraform.

__tests__/add-custom-resource.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const test = require('ava');
+const sinon = require('sinon');
+
+const Plugin = require('..');
+
+test.beforeEach(t => {
+  t.context.template = {
+    Resources: {}
+  };
+  t.context.serverless = {
+    getProvider: () => null,
+    service: {
+      provider: {
+        compiledCloudFormationTemplate: t.context.template
+      }
+    }
+  };
+  t.context.plugin = new Plugin(t.context.serverless, {
+    stage: 'test'
+  });
+});
+
+test('addCustomResource adds resources', t => {
+  const getSourceCodeLines = sinon.stub(t.context.plugin, 'getSourceCodeLines').returns(['foo']);
+
+  t.context.plugin.addCustomResource();
+
+  t.true(getSourceCodeLines.called);
+  t.deepEqual(Object.keys(t.context.template.Resources), [
+    'CustomApiGatewayBasePathMappingFunction',
+    'CustomApiGatewayBasePathMappingLogGroup',
+    'CustomApiGatewayBasePathMapping',
+    'CustomApiGatewayBasePathMappingRole'
+  ]);
+});

__tests__/custom-domain.js

@@ -0,0 +1,47 @@
+'use strict';
+
+const test = require('ava');
+
+const Plugin = require('..');
+
+test.beforeEach(t => {
+  t.context.template = {
+    Resources: {}
+  };
+  t.context.serverless = {
+    getProvider: () => null,
+    service: {
+      provider: {
+        compiledCloudFormationTemplate: t.context.template
+      },
+      custom: {
+        domain: 'foo.com'
+      }
+    }
+  };
+  t.context.plugin = new Plugin(t.context.serverless, {
+    stage: 'test'
+  });
+});
+
+test('custom-domain adds hooks', t => {
+  t.deepEqual(Object.keys(t.context.plugin.hooks), [
+    'before:aws:package:finalize:mergeCustomProviderResources',
+    'before:remove:remove',
+  ]);
+});
+
+test('throws if unable to find domain name', t => {
+  t.context.plugin.serverless.service.custom.domain = {};
+  t.throws(() => {
+    t.context.plugin.beforePackage();
+  });
+})
+
+test('throws if unable to find ApiGatewayDeployment', t => {
+  t.context.plugin.serverless.service.custom.domain = 'foo.com';
+
+  t.throws(() => {
+    t.context.plugin.beforePackage();
+  });
+});

__tests__/remove-mapping.js

@@ -0,0 +1,38 @@
+'use strict';
+
+const test = require('ava');
+const sinon = require('sinon');
+
+const Plugin = require('..');
+
+test.beforeEach(t => {
+  t.context.provider = {
+    request: Function.prototype
+  };
+  t.context.serverless = {
+    getProvider: () => t.context.provider,
+    service: {
+      provider: {
+        compiledCloudFormationTemplate: t.context.template
+      }
+    }
+  };
+  t.context.plugin = new Plugin(t.context.serverless, {
+    stage: 'test'
+  });
+  t.context.plugin.log = sinon.spy();
+});
+
+test('removeMapping calls remove', t => {
+  const mock = sinon.mock(t.context.provider)
+
+  mock.expects('request').returns({
+    promise: () => Promise.resolve()
+  });
+
+  return t.context.plugin.removeMapping('(none)', 'foo.com')
+    .then(() => {
+      mock.verify();
+      t.true(t.context.plugin.log.calledOnce);
+    });
+});

__tests__/utils.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const test = require('ava');
+
+const Plugin = require('..');
+
+test.beforeEach(t => {
+  t.context.template = {
+    Resources: {}
+  };
+  t.context.serverless = {
+    getProvider: () => null,
+    service: {
+      provider: {
+        compiledCloudFormationTemplate: t.context.template
+      }
+    }
+  };
+  t.context.plugin = new Plugin(t.context.serverless, {
+    stage: 'test'
+  });
+});
+
+test('finds deployment id', t => {
+  const id = 'ApiGatewayDeployment12345';
+
+  t.context.template.Resources[id] = {
+    Type: 'AWS::ApiGateway::Deployment',
+  };
+
+  t.true(id === t.context.plugin.getApiGatewayDeploymentId());
+});
+
+test('getDomainName string', t => {
+  t.true('foo' === t.context.plugin.getDomainName('foo'));
+});
+
+test('getDomainName object', t => {
+  t.true('bar' === t.context.plugin.getDomainName({ name: 'bar' }));
+});

custom-domain.js

@@ -0,0 +1,58 @@
+'use strict';
+
+const addCustomResource = require('./lib/add-custom-resource');
+const removeMapping = require('./lib/remove-mapping');
+const utils = require('./lib/utils');
+
+module.exports = class CustomDomain {
+
+  constructor(serverless, options) {
+    this.serverless = serverless;
+    this.options = options;
+    this.provider = this.serverless.getProvider('aws');
+
+    Object.assign(this,
+      { addCustomResource },
+      { removeMapping },
+      utils
+    );
+
+    this.hooks = {
+      'before:aws:package:finalize:mergeCustomProviderResources': this.beforePackage.bind(this),
+      'before:remove:remove': this.beforeRemove.bind(this),
+    };
+  }
+
+  beforePackage() {
+    const custom = this.serverless.service.custom;
+
+    if (custom && custom.domain) {
+      const domainName = this.getDomainName(custom.domain);
+
+      if (domainName) {
+        const deploymentId = this.getApiGatewayDeploymentId();
+
+        if (deploymentId) {
+          this.addCustomResource(domainName, deploymentId);
+        } else {
+          throw new Error('Could not find AWS::ApiGateway::Deployment resource in CloudFormation template!');
+        }
+      } else {
+        throw new Error('custom.domain must either be a string or an object with a name property');
+      }
+    }
+  }
+
+  beforeRemove() {
+    const domain = this.serverless.service.custom.domain;
+
+    if (domain) {
+      const domainName = this.getDomainName(domain);
+
+      if (domainName) {
+        return this.removeMapping(domainName);
+      }
+    }
+  }
+
+};