Skip to content

Commit

Permalink
chore(e2e): rename and refactor beforeTests, afterTest and afterTests…
Browse files Browse the repository at this point in the history 
… helpers; use them properly (#5335)

* rename and refactor afterTest and afterTests hooks; use them properly

* actually save all the files..

* coverage might not be there if you're quick enough

* remove spaces
  • Loading branch information
@lerouxb
lerouxb authored Jan 13, 2024
1 parent 806203e commit 65e0ac4
Show file tree
Hide file tree
Showing 35 changed files with 413 additions and 353 deletions.
103 changes: 58 additions & 45 deletions packages/compass-e2e-tests/helpers/compass.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,12 +108,10 @@ export const serverSatisfies = (
let i = 0;
// For the screenshots
let j = 0;
// For the coverage
let k = 0;

interface Coverage {
main: string;
renderer: string;
main?: string;
renderer?: string;
}

interface RenderLogEntry {
Expand All @@ -124,6 +122,7 @@ interface RenderLogEntry {
}

export class Compass {
name: string;
browser: CompassBrowser;
testPackagedApp: boolean;
needsCloseWelcomeModal: boolean;
Expand All @@ -134,9 +133,11 @@ export class Compass {
appName?: string;

constructor(
name: string,
browser: CompassBrowser,
{ testPackagedApp = false, needsCloseWelcomeModal = false } = {}
) {
this.name = name;
this.browser = browser;
this.testPackagedApp = testPackagedApp;
this.needsCloseWelcomeModal = needsCloseWelcomeModal;
Expand Down Expand Up @@ -319,30 +320,21 @@ export class Compass {
}
}

async stop(test?: Mocha.Hook | Mocha.Test, step?: string): Promise<void> {
async stop(): Promise<void> {
// TODO: we don't have main logs to write :(
/*
const mainLogs = [];
const mainLogPath = path.join(
LOG_PATH,
`electron-main.${nowFormatted}.log`
`electron-main.${name}.log`
);
debug(`Writing application main process log to ${mainLogPath}`);
await fs.writeFile(mainLogPath, mainLogs.join('\n'));
*/

const nowFormatted = formattedDate();

// name the log files after the closest test if possible to make it easier to find
let name = test ? pathName(test.fullTitle()) : nowFormatted;

if (step) {
name = `${name}-${step}`;
}

const renderLogPath = path.join(
LOG_PATH,
`electron-render.${nowFormatted}.json`
`electron-render.${this.name}.json`
);
debug(`Writing application render process log to ${renderLogPath}`);
await fs.writeFile(renderLogPath, JSON.stringify(this.renderLogs, null, 2));
Expand All @@ -362,22 +354,25 @@ export class Compass {
});
})();
});
const stopIndex = ++k;
await fs.writeFile(
path.join(COVERAGE_PATH, `main.${stopIndex}.log`),
coverage.main
);
await fs.writeFile(
path.join(COVERAGE_PATH, `renderer.${stopIndex}.log`),
coverage.renderer
);
if (coverage.main) {
await fs.writeFile(
path.join(COVERAGE_PATH, `main.${this.name}.log`),
coverage.main
);
}
if (coverage.renderer) {
await fs.writeFile(
path.join(COVERAGE_PATH, `renderer.${this.name}.log`),
coverage.renderer
);
}
}

debug('Stopping Compass application');
await this.browser.deleteSession();

const compassLog = await getCompassLog(this.logPath ?? '');
const compassLogPath = path.join(LOG_PATH, `compass-log.${name}.log`);
const compassLogPath = path.join(LOG_PATH, `compass-log.${this.name}.log`);
debug(`Writing Compass application log to ${compassLogPath}`);
await fs.writeFile(compassLogPath, compassLog.raw);
this.logs = compassLog.structured;
Expand Down Expand Up @@ -491,7 +486,10 @@ export async function runCompassOnce(args: string[], timeout = 30_000) {
return { stdout, stderr };
}

async function startCompass(opts: StartCompassOptions = {}): Promise<Compass> {
async function startCompass(
name: string,
opts: StartCompassOptions = {}
): Promise<Compass> {
const { testPackagedApp, binary } = await getCompassExecutionParameters();
const nowFormatted = formattedDate();
let needsCloseWelcomeModal: boolean;
Expand Down Expand Up @@ -710,7 +708,7 @@ async function startCompass(opts: StartCompassOptions = {}): Promise<Compass> {
throw err;
}

const compass = new Compass(browser, {
const compass = new Compass(name, browser, {
testPackagedApp,
needsCloseWelcomeModal,
});
Expand Down Expand Up @@ -906,10 +904,15 @@ function augmentError(error: Error, stack: string) {
error.stack = `${error.stack ?? ''}\nvia ${strippedLines.join('\n')}`;
}

export async function beforeTests(
export async function init(
name?: string,
opts: StartCompassOptions = {}
): Promise<Compass> {
const compass = await startCompass(opts);
// Unfortunately mocha's type is that this.test inside a test or hook is
// optional even though it always exists. So we have a lot of
// this.test?.fullTitle() and therefore we hopefully won't end up with a lot
// of dates in filenames in reality.
const compass = await startCompass(pathName(name ?? formattedDate()), opts);

const { browser } = compass;

Expand All @@ -923,21 +926,11 @@ export async function beforeTests(
return compass;
}

export async function afterTests(
compass?: Compass,
test?: Mocha.Hook | Mocha.Test,
step?: string
): Promise<void> {
export async function cleanup(compass?: Compass): Promise<void> {
if (!compass) {
return;
}

if (test && test.state === undefined) {
// if there's no state, then it is probably because the before() hook failed
const filename = screenshotPathName(`${test.fullTitle()}-hook`);
await compass.capturePage(filename);
}

let timeoutId;
const timeoutPromise = new Promise<void>((resolve) => {
timeoutId = setTimeout(() => {
Expand All @@ -948,7 +941,7 @@ export async function afterTests(

const closePromise = (async function close(): Promise<void> {
try {
await compass.stop(test, step);
await compass.stop();
} catch (err) {
debug('An error occurred while stopping compass:');
debug(err);
Expand Down Expand Up @@ -983,12 +976,21 @@ export function outputFilename(filename: string): string {
return path.join(OUTPUT_PATH, filename);
}

export async function afterTest(
export async function screenshotIfFailed(
compass: Compass,
test?: Mocha.Hook | Mocha.Test
): Promise<void> {
if (test && test.state === 'failed') {
await compass.capturePage(screenshotPathName(test.fullTitle()));
// NOTE: you cannot use this inside a test because the test wouldn't be marked
// as failed yet. It is made for use inside an afterEach() to go with the
// pattern where we init() compass in a before() hook and cleanup() in an
// after() hook.
if (test) {
if (test.state === undefined) {
// if there's no state, then it is probably because the before() hook failed
await compass.capturePage(screenshotPathName(`${test.fullTitle()}-hook`));
} else if (test.state === 'failed') {
await compass.capturePage(screenshotPathName(test.fullTitle()));
}
}
}

Expand Down Expand Up @@ -1020,3 +1022,14 @@ function redact(value: string): string {

return value;
}

export function subtestTitle(
test: Mocha.Runnable | undefined,
step: string
): string {
// Sometimes we start and stop compass multiple times in the same test. In
// that case it is handy to give them unique names. That's what this function
// is for.
const title = test?.fullTitle() ?? formattedDate();
return `${title}_${step}`;
}
12 changes: 6 additions & 6 deletions packages/compass-e2e-tests/tests/atlas-login.test.ts
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import type { CompassBrowser } from '../helpers/compass-browser';
import {
beforeTests,
afterTests,
afterTest,
init,
cleanup,
screenshotIfFailed,
Selectors,
} from '../helpers/compass';
import type { Compass } from '../helpers/compass';
Expand Down Expand Up @@ -103,7 +103,7 @@ describe('Atlas Login', function () {
return DEFAULT_TOKEN_PAYLOAD;
};

compass = await beforeTests({
compass = await init(this.test?.fullTitle(), {
// With this flag enabled, we are not persisting the data between tests
firstRun: true,
});
Expand All @@ -116,8 +116,8 @@ describe('Atlas Login', function () {

afterEach(async function () {
await browser.setFeature('browserCommandForOIDCAuth', undefined);
await afterTest(compass, this.currentTest);
await afterTests(compass, this.currentTest);
await screenshotIfFailed(compass, this.currentTest);
await cleanup(compass);
});

after(async function () {
Expand Down
Loading

0 comments on commit 65e0ac4

Please sign in to comment.