-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add
LOG_RAW_EVENT environment variable option to set line to raw …
…`event.message` (#22) no need for extra check restructure prepareLogs add explanation for RAW_EVENT_MESSAGE fix linting add explanation for the change make value check stricter and rename the variable add default for the variable in the docs rename the environment variable add `tap` unit testing coverage add tap tests newlines remove source and fix test name update README
- Loading branch information
Showing
8 changed files
with
213 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,4 +13,5 @@ node_modules | |
|
|
||
| # No Testing Materials | ||
| data | ||
| generateData.js | ||
| generateData.js | ||
| .nyc* | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| // External Modules | ||
| const { test } = require('tap'); | ||
|
|
||
| // Internal Modules | ||
| const index = require('../index'); | ||
| const pkg = require('../package.json'); | ||
|
|
||
| // Constants | ||
| const missingKey = 'Missing LogDNA Ingestion Key'; | ||
| const hostname = 'sampleCloudWatchHostname'; | ||
| const inputTags = ' cloudwatch, logging, test'; | ||
| const outputTags = 'cloudwatch,logging,test'; | ||
| const sampleKey = '0123456789'; | ||
| const rawEvent = { | ||
| 'awslogs': { | ||
| 'data': 'H4sIAAAAAAAAEzWQQW+DMAyF/wrKmaEkJCbhhjbWCzuBtMNUVSmkNBIQRMKqqep/X6Cb5Ivfs58++45G7ZzqdfMza5Sjt6IpTh9lXReHEsXI3ia9BJnQlHHIhMSEBnmw/WGx6xwcp8Z50M9uN2q/aDUGx2vn/5oYufXs2sXM3tjp3QxeLw7lX6hS47lTz6lTO9i1uynfXkOMe5lsp9Fxzyy/9eS3hTsyXYhOGVCaEsBSgsyEYBkGzrDMAIMQlAq+gQIQSjFhBFgqJOUMAog34WAfoFFOOM8kA0Y5SSH+f0SIb67GRaHq/baosn1UmUlHF7tErxvk5wa56b2Z+iRJ0OP4+AWj9ITzSgEAAA==' | ||
| } | ||
| }; | ||
|
|
||
| const eventData = { | ||
| messageType: 'DATA_MESSAGE' | ||
| , owner: '123456789012' | ||
| , logGroup: 'sampleGroup' | ||
| , logStream: 'testStream' | ||
| , subscriptionFilters: [ 'LambdaStream_cloudwatchlogs-node' ] | ||
| , logEvents: [{ | ||
| id: '34622316099697884706540976068822859012661220141643892546' | ||
| , timestamp: 1557946425136 | ||
| , message: 'This is Sample Log Line for CloudWatch Logging...' | ||
| }] | ||
| }; | ||
|
|
||
| const eventMetaData = { | ||
| event: { | ||
| type: eventData.messageType | ||
| , id: eventData.logEvents[0].id | ||
| }, log: { | ||
| group: eventData.logGroup | ||
| , stream: eventData.logStream | ||
| } | ||
| }; | ||
|
|
||
| // Test parseEvent | ||
| test('test parseEvent with the sample test data described in README', (t) => { | ||
| t.deepEqual(index.parseEvent(rawEvent), eventData); | ||
| t.end(); | ||
| }); | ||
|
|
||
| // Test getConfig | ||
| test('test getConfig', (t) => { | ||
| // Test getConfig without any environment variable set | ||
| let config = index.getConfig(); | ||
| t.equal(config.key, undefined); | ||
| t.equal(config.log_raw_event, false); | ||
| t.equal(config.UserAgent, `${pkg.name}/${pkg.version}`); | ||
| t.equal(config.hostname, undefined); | ||
| t.equal(config.tags, undefined); | ||
|
|
||
| // Set Hostname, Key and Tags | ||
| process.env.LOGDNA_HOSTNAME = hostname; | ||
| process.env.LOGDNA_TAGS = inputTags; | ||
| process.env.LOGDNA_KEY = sampleKey; | ||
| config = index.getConfig(); | ||
| t.equal(config.key, sampleKey); | ||
| t.equal(config.log_raw_event, false); | ||
| t.equal(config.UserAgent, `${pkg.name}/${pkg.version}`); | ||
| t.equal(config.hostname, hostname); | ||
| t.equal(config.tags, outputTags); | ||
|
|
||
| // Set LOG_RAW_EVENT to True | ||
| process.env.LOG_RAW_EVENT = 'True'; | ||
| config = index.getConfig(); | ||
| t.equal(config.key, sampleKey); | ||
| t.equal(config.log_raw_event, true); | ||
| t.equal(config.UserAgent, `${pkg.name}/${pkg.version}`); | ||
| t.equal(config.hostname, hostname); | ||
| t.equal(config.tags, outputTags); | ||
|
|
||
| // Unset some environment variables | ||
| process.env.LOG_RAW_EVENT = ''; | ||
| process.env.LOGDNA_TAGS = ''; | ||
| config = index.getConfig(); | ||
| t.equal(config.key, sampleKey); | ||
| t.equal(config.log_raw_event, false); | ||
| t.equal(config.UserAgent, `${pkg.name}/${pkg.version}`); | ||
| t.equal(config.hostname, hostname); | ||
| t.equal(config.tags, undefined); | ||
|
|
||
| // Set LOG_RAW_EVENT to Yes | ||
| process.env.LOG_RAW_EVENT = 'yEs'; | ||
| config = index.getConfig(); | ||
| t.equal(config.key, sampleKey); | ||
| t.equal(config.log_raw_event, true); | ||
| t.equal(config.UserAgent, `${pkg.name}/${pkg.version}`); | ||
| t.equal(config.hostname, hostname); | ||
| t.equal(config.tags, undefined); | ||
|
|
||
| // Finish the test suite | ||
| t.end(); | ||
| }); | ||
|
|
||
| // Test prepareLogs | ||
| test('test prepareLogs', (t) => { | ||
| // Without log_raw_event set to true | ||
| let eventLog = index.prepareLogs(eventData, false)[0]; | ||
| t.assert(eventLog.timestamp < Date.now()); | ||
| t.equal(eventLog.file, eventData.logStream); | ||
| t.equal(eventLog.meta.owner, eventData.owner); | ||
| t.deepEqual(eventLog.meta.filters, eventData.subscriptionFilters); | ||
| t.deepEqual(JSON.parse(eventLog.line), Object.assign({ | ||
| message: eventData.logEvents[0].message | ||
| }, eventMetaData)); | ||
|
|
||
| // With log_raw_event set to true | ||
| eventLog = index.prepareLogs(eventData, true)[0]; | ||
| t.assert(eventLog.timestamp < Date.now()); | ||
| t.equal(eventLog.file, eventData.logStream); | ||
| t.equal(eventLog.line, eventData.logEvents[0].message); | ||
| t.deepEqual(eventLog.meta, Object.assign({ | ||
| owner: eventData.owner | ||
| , filters: eventData.subscriptionFilters | ||
| }, eventMetaData)); | ||
|
|
||
| // Finish the test suite | ||
| t.end(); | ||
| }); | ||
|
|
||
| // Test sendLine | ||
| test('test sendLine', (t) => { | ||
| index.sendLine({ line: eventData.logEvents[0].message }, {}, (error, response) => { | ||
| t.equal(error, missingKey); | ||
|
|
||
| // Finish the test suite | ||
| t.end(); | ||
| }); | ||
| }); | ||
|
|
||
| // Test handler | ||
| test('test handler', (t) => { | ||
| index.sendLine(rawEvent, {}, (error, response) => { | ||
| t.equal(error, missingKey); | ||
|
|
||
| // Finish the test suite | ||
| t.end(); | ||
| }); | ||
| }); |