Skip to content
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.

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

Reporter debug mode #12

Merged
merged 7 commits into from
Jan 14, 2021
Merged
Show file tree
Hide file tree
Changes from 6 commits
Commits
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
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ newman run https://www.getpostman.com/collections/631643-f695cab7-6878-eb55-7943
`--reporter-influxdb-username` (*Optional*) | Username created for InfluxDB (e.g. `newman_user`)
`--reporter-influxdb-password` (*Optional*) | Password of the user (e.g. `p@ssw0rd`)
`--reporter-influxdb-mode` | Transmission Mode `http`, `udp` (default: `http`)
`--reporter-debug` | Reporter debug mode (default: `false`)

---

Expand Down
11 changes: 5 additions & 6 deletions src/http.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ class HttpService {
const res = await this.client.post('/api/v2/signin');
this.client.defaults.headers.common['cookie'] = res.headers['set-cookie'];
} catch (error) {
console.log('[-] ERROR: while signing in to InfluxDB', error);
console.log('[-] ERROR: while signing in to InfluxDB', this.context.debug ? error : error.message);
}
}

Expand All @@ -56,7 +56,7 @@ class HttpService {
try {
await this.client.post('/api/v2/signout');
} catch (error) {
console.log('[-] ERROR: while signing out to InfluxDB', error);
console.log('[-] ERROR: while signing out to InfluxDB', this.context.debug ? error : error.message);
}
}

Expand All @@ -66,7 +66,7 @@ class HttpService {
try {
const data = await axios.get(connectionUrl);
} catch (error) {
console.log('[-] ERROR: not able to connect to InfluxDB', error);
console.log('[-] ERROR: not able to connect to InfluxDB', this.context.debug ? error : error.message);
}
}

Expand Down Expand Up @@ -94,7 +94,7 @@ class HttpService {
try {
await this.client.post(url, data);
} catch (error) {
console.log('[-] ERROR: while sending data to InfluxDB', error);
console.log('[-] ERROR: while sending data to InfluxDB', this.context.debug ? error : error.message);
}
}

Expand All @@ -103,7 +103,6 @@ class HttpService {
this.signOut();
}
}

};

module.exports = HttpService;
module.exports = HttpService;
36 changes: 16 additions & 20 deletions src/influxdb-reporter.js
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,15 @@ class InfluxDBReporter {
failed: [],
skipped: []
},
list: []
list: [],
debug: this.reporterOptions.debug
Copy link
Owner

Choose a reason for hiding this comment

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

Maybe move this to start() method, as other --reporter-{...} declaration are specified there..

Copy link
Owner

Choose a reason for hiding this comment

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

You can have statement like this:

    this.context.debug = this.reporterOptions.debug || this.reporterOptions.debug || false;

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed, but I would leave it like that because I'm already using debug in the constructor's if-statement.
https://github.com/tomaszsluszniak/newman-reporter-influxdb/blob/4ef4537f594c2677fba813bf8a993f3e35e5b738/src/influxdb-reporter.js#L30

};
const events = 'start iteration beforeItem item script request test assertion console exception done'.split(' ');
events.forEach((e) => { if (typeof this[e] == 'function') newmanEmitter.on(e, (err, args) => this[e](err, args)) });

// console.log('[+] Reporter Options', reporterOptions);
if (this.context.debug) {
console.log('[+] Reporter Options', reporterOptions);
}
}

start(error, args) {
Expand Down Expand Up @@ -116,10 +119,15 @@ class InfluxDBReporter {
if(error) {
this.context.currentItem.data.test_status = 'FAIL';

const failMessage = `${error.test} | ${error.name}: ${error.message}`;
var failMessage = `${error.test} | ${error.name}`;
Copy link
Owner

Choose a reason for hiding this comment

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

Can we let instead of var here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

changed

if (this.context.debug) {
failMessage += `: ${error.message}`;
}
this.context.currentItem.data.failed.push(failMessage);
this.context.currentItem.data.failed_count++;
this.context.assertions.failed.push(failMessage); // for debug only
if (this.context.debug) {
this.context.assertions.failed.push(failMessage);
}
} else if(args.skipped) {
if(this.context.currentItem.data.test_status !== 'FAIL') {
this.context.currentItem.data.test_status = 'SKIP';
Expand All @@ -128,31 +136,20 @@ class InfluxDBReporter {
const skipMessage = args.assertion;
this.context.currentItem.data.skipped.push(args.assertion);
this.context.currentItem.data.skipped_count++;
this.context.assertions.skipped.push(skipMessage); // for debug only
if (this.context.debug) {
this.context.assertions.skipped.push(skipMessage);
}
}
}

item(error, args) {
const binaryData = this.buildPayload(this.context.currentItem.data);
// console.log('binaryData', binaryData);

this.service.sendData(binaryData);
}

done() {
this.service.disconnect();
console.log(`[+] Finished collection: ${this.options.collection.name} (${this.context.id})`);

// console.log('this.context', this.context);
Copy link
Owner

Choose a reason for hiding this comment

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

+1 for removing commented stuff

// console.log('this.options.collection', this.options.collection);

// this.stream.write(payload);
// this.stream.done();

// this.exports.push({
// name: 'newman-reporter-influxdb',
// options: reporterOptions
// });
}

/// Private method starts here
Expand Down Expand Up @@ -182,7 +179,6 @@ class InfluxDBReporter {
.replace(/,/g, '\\,')
.replace(/=/g, '\\=');
}

};

module.exports = InfluxDBReporter;
module.exports = InfluxDBReporter;
8 changes: 2 additions & 6 deletions src/udp.service.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,26 +12,22 @@ class UdpService {

async sendData(data) {
try {

this.socket.send(data, this.context.port, this.context.address, (error, response) => {

if(error) {
console.log('udp error', error);
throw error;
}

console.log('udp response', response);
});

} catch (error) {
console.log('[-] ERROR: while sending data to InfluxDB', error);
console.log('[-] ERROR: while sending data to InfluxDB', this.context.debug ? error : error.message);
}
}

close() {
this.socket.close();
}

};

module.exports = UdpService;
module.exports = UdpService;