Improve desktop runtime execution tests

Test improvements:

- Capture titles for all macOS windows, not just the frontmost.
- Incorporate missing application log files.
- Improve log clarity with enriched context.
- Improve application termination on macOS by reducing grace period.
- Ensure complete application termination on macOS.
- Validate Vue application loading through an initial log.
- Support ignoring environment-specific `stderr` errors.
- Do not fail the test if working directory cannot be deleted.
- Use retry pattern when installing dependencies due to network errors.

Refactorings:

- Migrate the test code to TypeScript.
- Replace deprecated `rmdir` with `rm` for error-resistant directory
  removal.
- Improve sanity checking by shifting from App.vue to Vue bootstrapper.
- Centralize environment variable management with `EnvironmentVariables`
  construct.
- Rename infrastructure/Environment to RuntimeEnvironment for clarity.
- Isolate WindowVariables and SystemOperations from RuntimeEnvironment.
- Inject logging via preloader.
- Correct mislabeled RuntimeSanity tests.

Configuration:

- Introduce `npm run check:desktop` for simplified execution.
- Omit `console.log` override due to `nodeIntegration` restrictions and
  reveal logging functionality using context-bridging.
This commit is contained in:
undergroundwires
2023-08-29 16:30:00 +02:00
parent 35be05df20
commit ad0576a752
146 changed files with 2418 additions and 1186 deletions

View File

@@ -0,0 +1,46 @@
import { describe, expect } from 'vitest';
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
import { itEachLoggingMethod } from './LoggerTestRunner';
describe('ConsoleLogger', () => {
describe('throws if console is missing', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing console';
const console = absentValue;
// act
const act = () => new ConsoleLogger(console);
// assert
expect(act).to.throw(expectedError);
}, { excludeUndefined: true });
});
describe('methods log the provided params', () => {
itEachLoggingMethod((functionName, testParameters) => {
// arrange
const expectedParams = testParameters;
const consoleMock = new MockConsole();
const logger = new ConsoleLogger(consoleMock);
// act
logger[functionName](...expectedParams);
// assert
expect(consoleMock.callHistory).to.have.lengthOf(1);
expect(consoleMock.callHistory[0].methodName).to.equal(functionName);
expect(consoleMock.callHistory[0].args).to.deep.equal(expectedParams);
});
});
});
class MockConsole
extends StubWithObservableMethodCalls<Partial<Console>>
implements Partial<Console> {
public info(...args: unknown[]) {
this.registerMethodCall({
methodName: 'info',
args,
});
}
}

View File

@@ -0,0 +1,45 @@
import { describe, expect } from 'vitest';
import { ElectronLog } from 'electron-log';
import { StubWithObservableMethodCalls } from '@tests/unit/shared/Stubs/StubWithObservableMethodCalls';
import { createElectronLogger } from '@/infrastructure/Log/ElectronLogger';
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
import { itEachLoggingMethod } from './LoggerTestRunner';
describe('ElectronLogger', () => {
describe('throws if logger is missing', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing logger';
const electronLog = absentValue;
// act
const act = () => createElectronLogger(electronLog);
// assert
expect(act).to.throw(expectedError);
}, { excludeUndefined: true });
});
itEachLoggingMethod((functionName, testParameters) => {
// arrange
const expectedParams = testParameters;
const electronLogMock = new MockElectronLog();
const logger = createElectronLogger(electronLogMock);
// act
logger[functionName](...expectedParams);
// assert
expect(electronLogMock.callHistory).to.have.lengthOf(1);
expect(electronLogMock.callHistory[0].methodName).to.equal(functionName);
expect(electronLogMock.callHistory[0].args).to.deep.equal(expectedParams);
});
});
class MockElectronLog
extends StubWithObservableMethodCalls<Partial<ElectronLog>>
implements Partial<ElectronLog> {
public info(...args: unknown[]) {
this.registerMethodCall({
methodName: 'info',
args,
});
}
}

View File

@@ -0,0 +1,21 @@
import { it } from 'vitest';
import { FunctionKeys } from '@/TypeHelpers';
import { ILogger } from '@/infrastructure/Log/ILogger';
export function itEachLoggingMethod(
handler: (
functionName: keyof ILogger,
testParameters?: unknown[]
) => void,
) {
const testParameters = ['test', 123, { some: 'object' }];
const loggerMethods: Array<FunctionKeys<ILogger>> = [
'info',
];
loggerMethods
.forEach((functionKey) => {
it(functionKey, () => {
handler(functionKey, testParameters);
});
});
}

View File

@@ -0,0 +1,20 @@
import { describe, expect } from 'vitest';
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
import { ILogger } from '@/infrastructure/Log/ILogger';
import { itEachLoggingMethod } from './LoggerTestRunner';
describe('NoopLogger', () => {
describe('methods do not throw', () => {
itEachLoggingMethod((functionName, testParameters) => {
// arrange
const randomParams = testParameters;
const logger: ILogger = new NoopLogger();
// act
const act = () => logger[functionName](...randomParams);
// assert
expect(act).to.not.throw();
});
});
});

View File

@@ -0,0 +1,50 @@
import { describe } from 'vitest';
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
import { WindowVariablesStub } from '@tests/unit/shared/Stubs/WindowVariablesStub';
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
import { itEachLoggingMethod } from './LoggerTestRunner';
describe('WindowInjectedLogger', () => {
describe('throws if log is absent', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing log';
const windowVariables = new WindowVariablesStub()
.withLog(absentValue);
// act
const act = () => new WindowInjectedLogger(windowVariables);
// assert
expect(act).to.throw(expectedError);
});
});
describe('throws if window is absent', () => {
itEachAbsentObjectValue((absentValue) => {
// arrange
const expectedError = 'missing window';
const windowVariables = absentValue;
// act
const act = () => new WindowInjectedLogger(windowVariables);
// assert
expect(act).to.throw(expectedError);
}, { excludeUndefined: true });
});
describe('methods log the provided params', () => {
itEachLoggingMethod((functionName) => {
// arrange
const expectedParams = ['test', 123, { some: 'object' }];
const loggerMock = new LoggerStub();
const windowVariables = new WindowVariablesStub()
.withLog(loggerMock);
const logger = new WindowInjectedLogger(windowVariables);
// act
logger[functionName](...expectedParams);
// assert
expect(loggerMock.callHistory).to.have.lengthOf(1);
expect(loggerMock.callHistory[0].methodName).to.equal(functionName);
expect(loggerMock.callHistory[0].args).to.deep.equal(expectedParams);
});
});
});