Skip to content

Real time events support for nightwatch test observability #9

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Real time events support for nightwatch test observability #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f29ca86
initial commit for real time events support
Jun 1, 2023
86f304c
Merge branch 'main' of https://www.github.com/nightwatchjs/nightwatch…
Jun 2, 2023
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
127 changes: 95 additions & 32 deletions nightwatch/globals.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,113 @@ const {CUSTOM_REPORTER_CALLBACK_TIMEOUT} = require('../src/utils/constants');
const CrashReporter = require('../src/utils/crashReporter');
const helper = require('../src/utils/helper');
const Logger = require('../src/utils/logger');
const {v4: uuidv4} = require('uuid');

const localTunnel = new LocalTunnel();
const testObservability = new TestObservability();

const nightwatchRerun = process.env.NIGHTWATCH_RERUN_FAILED;
const nightwatchRerunFile = process.env.NIGHTWATCH_RERUN_REPORT_FILE;
const eventIdData = {};

module.exports = {

reporter: async function(results, done) {
if (!helper.isTestObservabilitySession()) {
done(results);

return;
}
try {
const modulesWithEnv = results['modulesWithEnv'];
const promises = [];
for (const testSetting in modulesWithEnv) {
for (const testFile in modulesWithEnv[testSetting]) {
const completedSections = modulesWithEnv[testSetting][testFile].completed;

for (const completedSection in completedSections) {
if (completedSections[completedSection]) {
delete completedSections[completedSection].steps;
delete completedSections[completedSection].testcases;
registerEventHandlers(eventBroadcaster) {
if (helper.isTestObservabilitySession()) {
eventBroadcaster.on('TestSuiteStarted', (args) => {
if (typeof browser !== 'undefined') {
browser.execute(`browserstack_executor: {"action": "annotate", "arguments": {"type":"Annotation","data":"ObservabilitySync:${Date.now()}","level": "debug"}}`);
}
});
eventBroadcaster.on('HookRunStarted', async (args) => {
try {
if (args.testResults?.results && !eventIdData.markedStatus) {
if (args.hook_type === 'before' || args.hook_type === 'after') {
const hookType = args.hook_type === 'before' ? 'BEFORE_ALL' : 'AFTER_ALL';
const sectionName = args.hook_type === 'before' ? '__before_hook' : '__after_hook';
eventIdData.id = uuidv4();
eventIdData.markedStatus = true;
const eventData = {
startTimestamp: Date.now()
};
await testObservability.sendTestRunEvent(eventData, args.testResults.results, 'HookRunStarted', eventIdData.id, hookType, sectionName);
}
}
promises.push(testObservability.processTestReportFile(JSON.parse(JSON.stringify(modulesWithEnv[testSetting][testFile]))));
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
}

await Promise.all(promises);
done();
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
Logger.error(`Something went wrong in processing report file for test observability - ${error.message} with stacktrace ${error.stack}`);
}
done(results);
},

onEvent({eventName, hook_type, ...args}) {
if (typeof browser !== 'undefined' && eventName === 'TestRunStarted') {
browser.execute(`browserstack_executor: {"action": "annotate", "arguments": {"type":"Annotation","data":"ObservabilitySync:${Date.now()}","level": "debug"}}`);
});
eventBroadcaster.on('HookRunFinished', async (args) => {
try {
if (args.testResults?.results && eventIdData.markedStatus) {
if (args.hook_type === 'before' || args.hook_type === 'after') {
const hookType = args.hook_type === 'before' ? 'BEFORE_ALL' : 'AFTER_ALL';
const sectionName = args.hook_type === 'before' ? '__before_hook' : '__after_hook';
delete eventIdData.markedStatus;
const eventData = args.testResults.results.completedSections[sectionName];
await testObservability.sendTestRunEvent(eventData, args.testResults.results, 'HookRunStarted', eventIdData.id, hookType, sectionName);
}
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
eventBroadcaster.on('TestRunStarted', async (args) => {
try {
if (args.testResults?.results && !eventIdData.markedStatus) {
eventIdData.id = uuidv4();
eventIdData.markedStatus = true;
const eventData = {
startTimestamp: Date.now()
};
const sectionName = args.test_name;
await testObservability.sendTestRunEvent(eventData, args.testResults.results, 'TestRunStarted', eventData.id, null, sectionName);
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
eventBroadcaster.on('TestRunFinished', async (args) => {
try {
if (args.testResults?.results && eventIdData.markedStatus) {
delete eventIdData.markedStatus;
const sectionName = args.test_name;
const eventData = args.testResults.results.completedSections[sectionName];
await testObservability.sendTestRunEvent(eventData, args.testResults.results, 'TestRunFinished', eventData.id, null, sectionName);
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
eventBroadcaster.on('ScreenshotCreated', async (args) => {
try {
if (args.path && eventIdData.markedStatus) {
await testObservability.createScreenshotLogEvent(eventIdData.id, args.path, Date.now());
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
eventBroadcaster.on('LogCreated', async (args) => {
try {
if (args.httpOutput?.length > 0 && eventIdData.markedStatus) {
await testObservability.createHttpLogEvent(args.httpOutput[0], args.httpOutput[1], eventIdData.id);
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
eventBroadcaster.on('TestSuiteFinished', async (args) => {
try {
if (args.testResults?.results) {
const testFileReport = args.testResults.results;
const skippedTests = testFileReport['skippedAtRuntime'].concat(testFileReport['skippedByUser']);
await testObservability.sendSkippedTestEvent(skippedTests, testFileReport);
}
} catch (error) {
CrashReporter.uploadCrashReport(error.message, error.stack);
}
});
}
},

Expand Down
2 changes: 0 additions & 2 deletions src/utils/helper.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,15 +287,13 @@ exports.getGitMetaData = () => {
});
}
} catch (err) {
Logger.error(`Exception in populating Git metadata with error : ${err}`);
resolve({});
}
})();
});
};

exports.requireModule = (module) => {
Logger.info(`Getting ${module} from ${process.cwd()}`);
const local_path = path.join(process.cwd(), 'node_modules', module);

return require(local_path);
Expand Down