Skip to content

aws cloudwatchEvent event schema #8230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
medikoo merged 6 commits into from
Sep 15, 2020
Merged

aws cloudwatchEvent event schema #8230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e0c80c5
aws cloudwatch event schema
Sep 14, 2020
e425e1c
extend schema
Sep 15, 2020
3eb322b
remove schema validation tests
Sep 15, 2020
9fcb264
prettify
Sep 15, 2020
4c53b77
add minLength to name
Sep 15, 2020
5b1f3ad
allow event without any input
thewizarodofoz Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 49 additions & 57 deletions lib/plugins/aws/package/compile/events/cloudWatchEvent/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,37 @@ class AwsCompileCloudWatchEventEvents {
'package:compileEvents': this.compileCloudWatchEventEvents.bind(this),
};

// TODO: Complete schema, see https://github.com/serverless/serverless/issues/8026
this.serverless.configSchemaHandler.defineFunctionEvent('aws', 'cloudwatchEvent', {
type: 'object',
properties: {
event: { type: 'object' },
input: {
oneOf: [{ type: 'string', maxLength: 8192 }, { type: 'object' }],
},
inputPath: { type: 'string', minLength: 1, maxLength: 256 },
inputTransformer: {
type: 'object',
properties: {
inputPathsMap: {
type: 'object',
additionalProperties: { type: 'string', minLength: 1 },
},
inputTemplate: { type: 'string', minLength: 1, maxLength: 8192 },
},
required: ['inputTemplate'],
additionalProperties: false,
},
description: { type: 'string', maxLength: 512 },
name: { type: 'string', pattern: '[a-zA-Z0-9-_.]+', minLength: 1, maxLength: 64 },
enabled: { type: 'boolean' },
},
oneOf: [
{ required: ['input'] },
{ required: ['inputPath'] },
{ required: ['inputTransformer'] },
Comment on lines +39 to +41

@medikoo medikoo Sep 15, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also add required: [], as technically we do not require any of this options

{ required: [] },
],
additionalProperties: false,
});
}

Expand All @@ -26,60 +54,30 @@ class AwsCompileCloudWatchEventEvents {
functionObj.events.forEach(event => {
if (event.cloudwatchEvent) {
cloudWatchEventNumberInFunction++;
let EventPattern;
let State;
let Input;
let InputPath;
let InputTransformer;
let Description;
let Name;

if (typeof event.cloudwatchEvent === 'object') {
if (!event.cloudwatchEvent.event) {
const errorMessage = [
`Missing "event" property for cloudwatch event in function ${functionName}`,
' Please check the docs for more info.',
].join('');
throw new this.serverless.classes.Error(errorMessage);
}

EventPattern = JSON.stringify(event.cloudwatchEvent.event);
State = 'ENABLED';
if (event.cloudwatchEvent.enabled === false) {
State = 'DISABLED';
}
Input = event.cloudwatchEvent.input;
InputPath = event.cloudwatchEvent.inputPath;
InputTransformer = event.cloudwatchEvent.inputTransformer;
Description = event.cloudwatchEvent.description;
Name = event.cloudwatchEvent.name;

const inputOptions = [Input, InputPath, InputTransformer].filter(i => i);
if (inputOptions.length > 1) {
const errorMessage = [
'You can only set one of input, inputPath, or inputTransformer ',
'properties at the same time for cloudwatch events. ',
'Please check the AWS docs for more info',
].join('');
throw new this.serverless.classes.Error(errorMessage);
}

if (Input && typeof Input === 'object') {
Input = JSON.stringify(Input);
}
if (Input && typeof Input === 'string') {
// escape quotes to favor JSON.parse
Input = Input.replace(/\"/g, '\\"'); // eslint-disable-line
}
if (InputTransformer) {
InputTransformer = this.formatInputTransformer(InputTransformer);
}
} else {
const errorMessage = [
`CloudWatch event of function "${functionName}" is not an object`,
' Please check the docs for more info.',
].join('');
throw new this.serverless.classes.Error(errorMessage);
const EventPattern = JSON.stringify(event.cloudwatchEvent.event);
State = 'ENABLED';
if (event.cloudwatchEvent.enabled === false) {
State = 'DISABLED';
}
const Name = event.cloudwatchEvent.name;
const InputPath = event.cloudwatchEvent.inputPath;
const Description = event.cloudwatchEvent.description;
Input = event.cloudwatchEvent.input;
InputTransformer = event.cloudwatchEvent.inputTransformer;

if (Input && typeof Input === 'object') {
Input = JSON.stringify(Input);
}
if (Input && typeof Input === 'string') {
// escape quotes to favor JSON.parse
Input = Input.replace(/\"/g, '\\"'); // eslint-disable-line
}
if (InputTransformer) {
InputTransformer = this.formatInputTransformer(InputTransformer);
}

const lambdaLogicalId = this.provider.naming.getLambdaLogicalId(functionName);
Expand Down Expand Up @@ -144,12 +142,6 @@ class AwsCompileCloudWatchEventEvents {
}

formatInputTransformer(inputTransformer) {
if (!inputTransformer.inputTemplate) {
throw new this.serverless.classes.Error(
'The inputTemplate key is required when specifying an ' +
'inputTransformer for a cloudwatchEvent event'
);
}
const cfmOutput = {
// InputTemplate is required
InputTemplate: inputTransformer.inputTemplate,
Expand Down
123 changes: 0 additions & 123 deletions lib/plugins/aws/package/compile/events/cloudWatchEvent/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,48 +23,6 @@ describe('awsCompileCloudWatchEventEvents', () => {
});

describe('#compileCloudWatchEventEvents()', () => {
it('should throw an error if cloudwatch event type is not an object', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: 42,
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);

awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: '42',
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);
});

it('should throw an error if the "event" property is not given', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: {
event: null,
},
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);
});

it('should create corresponding resources when cloudwatch events are given', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
Expand Down Expand Up @@ -340,87 +298,6 @@ describe('awsCompileCloudWatchEventEvents', () => {
).to.equal('{"key":"value"}');
});

it('should throw an error when both Input and InputPath are set', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: {
event: {
'source': ['aws.ec2'],
'detail-type': ['EC2 Instance State-change Notification'],
'detail': { state: ['pending'] },
},
enabled: false,
input: {
key: 'value',
},
inputPath: '$.stageVariables',
},
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);
});

it('should throw an error when both Input and InputTransformer are set', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: {
event: {
'source': ['aws.ec2'],
'detail-type': ['EC2 Instance State-change Notification'],
'detail': { state: ['pending'] },
},
enabled: false,
input: {
key: 'value',
},
inputTransformer: {
inputPathsMap: {
eventTime: '$.time',
},
inputTemplate: '{"time": <eventTime>, "key1": "value1"}',
},
},
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);
});

it('should throw an error when inputTransformer does not have inputTemplate', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
events: [
{
cloudwatchEvent: {
event: {
'source': ['aws.ec2'],
'detail-type': ['EC2 Instance State-change Notification'],
'detail': { state: ['pending'] },
},
enabled: false,
inputTransformer: {
inputPathsMap: {
eventTime: '$.time',
},
},
},
},
],
},
};

expect(() => awsCompileCloudWatchEventEvents.compileCloudWatchEventEvents()).to.throw(Error);
});

it('should respect variables if multi-line variables is given', () => {
awsCompileCloudWatchEventEvents.serverless.service.functions = {
first: {
Expand Down