1224926641

Build Type

push

github

Committed by GitHub

Commit Message

Succeed if plugin config is not provided (#64)

Run Details

147 of 148 branches covered (99.32%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

1 existing line in 1 file now uncovered.

460 of 461 relevant lines covered (99.78%)

308.84 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

96.77

/serverless-plugin/index.js

'use strict'

const _ = require('lodash')
const Ajv = require('ajv')

const alarms = require('./alarms')
const dashboard = require('./dashboard')
const { pluginConfigSchema, functionConfigSchema, slicWatchSchema } = require('./config-schema')
const defaultConfig = require('./default-config')
const CloudFormationTemplate = require('./cf-template')

const ServerlessError = require('serverless/lib/serverless-error')

class ServerlessPlugin {
  constructor (serverless, options) {
    this.serverless = serverless
    this.options = options
    this.providerNaming = serverless.providers.aws.naming

    if (serverless.service.provider.name !== 'aws') {
      throw new ServerlessError('SLIC Watch only supports AWS')
    }

    if (serverless.configSchemaHandler) {
      serverless.configSchemaHandler.defineCustomProperties(pluginConfigSchema)
      serverless.configSchemaHandler.defineFunctionProperties('aws', functionConfigSchema)
    }

    // Use the latest possible hook to ensure that `Resources` are included in the compiled Template
    this.hooks = {
      'before:package:finalize': this.finalizeHook.bind(this)
    }
  }

  /**
   * Modify the CloudFormation template before the package is finalized
   */
  finalizeHook () {
    const slicWatchConfig = (this.serverless.service.custom || {}).slicWatch || {}

    const ajv = new Ajv()
    const slicWatchValidate = ajv.compile(slicWatchSchema)
    const slicWatchValid = slicWatchValidate(slicWatchConfig)
    if (!slicWatchValid) {
      throw new ServerlessError('SLIC Watch configuration is invalid: ' + ajv.errorsText(slicWatchValidate.errors))
    }

    const alarmActions = []

    if (slicWatchConfig.topicArn) {
      alarmActions.push(slicWatchConfig.topicArn)
    }
    // Validate and fail fast on config validation errors since this is a warning in Serverless Framework 2.x
    const context = {
      region: this.serverless.service.provider.region,
      stackName: this.providerNaming.getStackName(),
      alarmActions
    }

    const config = _.merge(defaultConfig, slicWatchConfig)

    const awsProvider = this.serverless.getProvider('aws')

    const cfTemplate = CloudFormationTemplate(
      this.serverless.service.provider.compiledCloudFormationTemplate,
      this.serverless.service.resources ? this.serverless.service.resources.Resources : {}
    )

    const functionAlarmConfigs = {}
    const functionDashboardConfigs = {}
    for (const funcName of this.serverless.service.getAllFunctions()) {
      const func = this.serverless.service.getFunction(funcName)
      const functionResName = awsProvider.naming.getLambdaLogicalId(funcName)
      const functionName = cfTemplate.getResourceByName(functionResName).Properties.FunctionName
      const funcConfig = func.slicWatch || {}
      functionAlarmConfigs[functionName] = funcConfig.alarms || {}
      functionDashboardConfigs[functionName] = funcConfig.dashboard
    }

    this.dashboard = dashboard(this.serverless, config.dashboard, functionDashboardConfigs, context)
    this.alarms = alarms(this.serverless, config.alarms, functionAlarmConfigs, context)
    this.dashboard.addDashboard(cfTemplate)
    this.alarms.addAlarms(cfTemplate)
  }
}

module.exports = ServerlessPlugin

1	'use strict'
2
3	const _ = require('lodash')	3✔
4	const Ajv = require('ajv')	3✔
5
6	const alarms = require('./alarms')	3✔
7	const dashboard = require('./dashboard')	3✔
8	const { pluginConfigSchema, functionConfigSchema, slicWatchSchema } = require('./config-schema')	3✔
9	const defaultConfig = require('./default-config')	3✔
10	const CloudFormationTemplate = require('./cf-template')	3✔
11
12	const ServerlessError = require('serverless/lib/serverless-error')	3✔
13
14	class ServerlessPlugin {
15	constructor (serverless, options) {
16	this.serverless = serverless	21✔
17	this.options = options	21✔
18	this.providerNaming = serverless.providers.aws.naming	21✔
19
20	if (serverless.service.provider.name !== 'aws') {	21✔
21	throw new ServerlessError('SLIC Watch only supports AWS')	3✔
22	}
23
24	if (serverless.configSchemaHandler) {	18✔
25	serverless.configSchemaHandler.defineCustomProperties(pluginConfigSchema)	3✔
26	serverless.configSchemaHandler.defineFunctionProperties('aws', functionConfigSchema)	3✔
27	}
28
29	// Use the latest possible hook to ensure that `Resources` are included in the compiled Template
30	this.hooks = {	18✔
31	'before:package:finalize': this.finalizeHook.bind(this)
32	}
33	}
34
35	/**
36	* Modify the CloudFormation template before the package is finalized
37	*/
38	finalizeHook () {
39	const slicWatchConfig = (this.serverless.service.custom \|\| {}).slicWatch \|\| {}	15✔
40
41	const ajv = new Ajv()	15✔
42	const slicWatchValidate = ajv.compile(slicWatchSchema)	15✔
43	const slicWatchValid = slicWatchValidate(slicWatchConfig)	15✔
44	if (!slicWatchValid) {	15!
UNCOV 45	throw new ServerlessError('SLIC Watch configuration is invalid: ' + ajv.errorsText(slicWatchValidate.errors))	×
46	}
47
48	const alarmActions = []	15✔
49
50	if (slicWatchConfig.topicArn) {	15✔
51	alarmActions.push(slicWatchConfig.topicArn)	6✔
52	}
53	// Validate and fail fast on config validation errors since this is a warning in Serverless Framework 2.x
54	const context = {	15✔
55	region: this.serverless.service.provider.region,
56	stackName: this.providerNaming.getStackName(),
57	alarmActions
58	}
59
60	const config = _.merge(defaultConfig, slicWatchConfig)	15✔
61
62	const awsProvider = this.serverless.getProvider('aws')	15✔
63
64	const cfTemplate = CloudFormationTemplate(	15✔
65	this.serverless.service.provider.compiledCloudFormationTemplate,
66	this.serverless.service.resources ? this.serverless.service.resources.Resources : {}	15✔
67	)
68
69	const functionAlarmConfigs = {}	15✔
70	const functionDashboardConfigs = {}	15✔
71	for (const funcName of this.serverless.service.getAllFunctions()) {	15✔
72	const func = this.serverless.service.getFunction(funcName)	15✔
73	const functionResName = awsProvider.naming.getLambdaLogicalId(funcName)	15✔
74	const functionName = cfTemplate.getResourceByName(functionResName).Properties.FunctionName	15✔
75	const funcConfig = func.slicWatch \|\| {}	15✔
76	functionAlarmConfigs[functionName] = funcConfig.alarms \|\| {}	15✔
77	functionDashboardConfigs[functionName] = funcConfig.dashboard	15✔
78	}
79
80	this.dashboard = dashboard(this.serverless, config.dashboard, functionDashboardConfigs, context)	15✔
81	this.alarms = alarms(this.serverless, config.alarms, functionAlarmConfigs, context)	15✔
82	this.dashboard.addDashboard(cfTemplate)	15✔
83	this.alarms.addAlarms(cfTemplate)	15✔
84	}
85	}
86
87	module.exports = ServerlessPlugin	3✔

fourTheorem / slic-watch / 1224926641

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous