Initial commit.

Author: Artificer Entertainment

README.md

@@ -1,2 +1,20 @@
 # serverless-plugin-log-retention
 Control the retention of your serverless function's cloudwatch logs.
+
+## Usage example
+`serverless.yml`
+
+```yml
+service: sample
+
+plugins:
+  - serverless-plugin-log-retention
+
+provider:
+  logRetentionInDays: 30 # used to set a global value for all functions
+
+functions:
+  function1:
+  function2:
+    logRetentionInDays: 10 # set the retention for specific log group
+```

add-log-retention.js

@@ -0,0 +1,67 @@
+'use strict';
+
+const nco = require('nco');
+const semver = require('semver');
+
+const validRetentionInDays = [1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365, 400, 545, 731, 1827, 3653];
+
+class AwsAddLogRetention {
+  constructor(serverless, options) {
+    if(!semver.satisfies(serverless.version, '>= 1.20.2')) {
+      throw new Error('serverless-plugin-log-retention requires serverless 1.20.2 or higher');
+    }
+
+    this.serverless = serverless;
+    this.options = options;
+    this.provider = this.serverless.getProvider('aws');
+    this.hooks = {
+      'before:deploy:createDeploymentArtifacts': this.beforeDeploy.bind(this),
+    };
+  }
+
+  sanitizeRetentionValue(inputValue) {
+    const value = Number(inputValue);
+    if(Number.isInteger(value) && validRetentionInDays.includes(value)) {
+      return value;
+    } else {
+      throw new Error(`RetentionInDays value must be one of ${validRetentionInDays}`);
+    }
+  }
+
+  addLogRetentionForFunctions(globalLogRetentionInDays) {
+    const service = this.serverless.service;
+    if(typeof service.functions !== 'object') {
+      return;
+    }
+
+    const resources = nco(service.resources, {});
+    resources.Resources = nco(resources.Resources, {});
+
+    Object.keys(service.functions).forEach(functionName => {
+      const localLogRentationInDays = nco(service.functions[functionName].logRetentionInDays, null);
+      if(localLogRentationInDays === null && globalLogRetentionInDays === null) {
+        return;
+      }
+      const functionLogRetentionInDays = localLogRentationInDays === null ? globalLogRetentionInDays : sanitizeRetentionValue(localLogRentationInDays);
+      const logGroupLogicalId = this.provider.naming.getLogGroupLogicalId(functionName);
+
+      const resource = {
+        Type: 'AWS::Logs::LogGroup',
+        Properties: {
+          RetentionInDays: functionLogRetentionInDays
+        }
+      };
+      resources.Resources[logGroupLogicalId] = resource;
+    });
+  }
+
+  beforeDeploy() {
+    const service = this.serverless.service;
+    const globalLogRetentionInDays = service.provider && service.provider.logRetentionInDays
+      ? sanitizeRetentionValue(service.provider.logRetentionInDays)
+      : null;
+    this.addLogRetentionForFunctions(globalLogRetentionInDays);
+  }
+}
+
+module.exports = AwsAddLogRetention;

package.json

@@ -0,0 +1,27 @@
+{
+  "name": "serverless-plugin-log-retention",
+  "version": "1.0.0",
+  "description": "Control the retention of your function's cloudwatch logs.",
+  "main": "add-log-retention.js",
+  "scripts": {
+    "test": "nyc --reporter=lcov --reporter=text mocha"
+  },
+  "keywords": [
+    "serverless",
+    "plugin",
+    "log",
+    "retention"
+  ],
+  "author": "Jim Walkoski",
+  "license": "MIT",
+  "dependencies": {
+    "nco": "1.0.1",
+    "semver": "5.4.1"
+  },
+  "devDependencies": {
+    "chai": "4.1.2",
+    "mocha": "4.0.1",
+    "nyc": "11.3.0",
+    "sinon": "4.1.2"
+  }
+}

test/add-log-retention.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const expect = require('chai').expect;
+const sinon = require('sinon');
+
+const AwsAddLogRetention = require('../add-log-retention');
+
+function createTestInstance(options) {
+  options = options || {};
+  return new AwsAddLogRetention({
+    version: options.version || '1.20.2',
+    service: {
+      provider: options.provider || {},
+      functions: options.functions,
+      resources: options.resources ? { Resources: options.resources } : undefined
+    },
+    getProvider: () => {
+      return {
+        naming: {
+          getLogGroupLogicalId(functionName) {
+            return `${functionName.charAt(0).toUpperCase()}${functionName.slice(1)}LogGroup`; //TODO: dash/underscore replacement?
+          }
+        }
+      }
+    }
+  }, {});
+}
+
+describe('serverless-plugin-log-retention', function() {
+  describe('#constructor', function() {
+    it('should throw on older version', function() {
+      expect(() => createTestInstance({version: '1.20.1'}))
+        .to.throw('serverless-plugin-log-retention requires serverless 1.20.2 or higher');
+    });
+
+    it('should create hooks', function() {
+      const instance = createTestInstance();
+      expect(instance)
+        .to.have.property('hooks')
+        .that.has.all.keys('before:deploy:createDeploymentArtifacts');
+
+      const stub = sinon.stub(instance, 'addLogRetentionForFunctions');
+      instance.hooks['before:deploy:createDeploymentArtifacts']();
+
+      sinon.assert.calledOnce(stub);
+    });
+  })
+
+});