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:
@@ -0,0 +1,80 @@
|
||||
import {
|
||||
describe, it, beforeEach, afterEach,
|
||||
} from 'vitest';
|
||||
import { IRuntimeEnvironment } from '@/infrastructure/RuntimeEnvironment/IRuntimeEnvironment';
|
||||
import { ClientLoggerFactory } from '@/presentation/bootstrapping/ClientLoggerFactory';
|
||||
import { ILogger } from '@/infrastructure/Log/ILogger';
|
||||
import { WindowInjectedLogger } from '@/infrastructure/Log/WindowInjectedLogger';
|
||||
import { ConsoleLogger } from '@/infrastructure/Log/ConsoleLogger';
|
||||
import { NoopLogger } from '@/infrastructure/Log/NoopLogger';
|
||||
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||
import { Constructible } from '@/TypeHelpers';
|
||||
import { itIsSingleton } from '@tests/unit/shared/TestCases/SingletonTests';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
|
||||
describe('ClientLoggerFactory', () => {
|
||||
describe('Current', () => {
|
||||
itIsSingleton({
|
||||
getter: () => ClientLoggerFactory.Current,
|
||||
expectedType: ClientLoggerFactory,
|
||||
});
|
||||
});
|
||||
describe('logger instantiation based on environment', () => {
|
||||
const originalWindow = { ...window };
|
||||
beforeEach(() => {
|
||||
Object.assign(window, { log: new LoggerStub() });
|
||||
});
|
||||
afterEach(() => {
|
||||
Object.assign(window, originalWindow);
|
||||
});
|
||||
const testCases: Array<{
|
||||
readonly description: string,
|
||||
readonly expectedType: Constructible<ILogger>,
|
||||
readonly environment: IRuntimeEnvironment,
|
||||
}> = [
|
||||
{
|
||||
description: 'desktop environment',
|
||||
expectedType: WindowInjectedLogger,
|
||||
environment: new RuntimeEnvironmentStub()
|
||||
.withIsDesktop(true),
|
||||
},
|
||||
{
|
||||
description: 'non-production and desktop environment',
|
||||
expectedType: WindowInjectedLogger,
|
||||
environment: new RuntimeEnvironmentStub()
|
||||
.withIsDesktop(true)
|
||||
.withIsNonProduction(true),
|
||||
},
|
||||
{
|
||||
description: 'non-production without desktop',
|
||||
expectedType: ConsoleLogger,
|
||||
environment: new RuntimeEnvironmentStub()
|
||||
.withIsDesktop(false)
|
||||
.withIsNonProduction(true),
|
||||
},
|
||||
{
|
||||
description: 'production without desktop',
|
||||
expectedType: NoopLogger,
|
||||
environment: new RuntimeEnvironmentStub()
|
||||
.withIsDesktop(false)
|
||||
.withIsNonProduction(false),
|
||||
},
|
||||
];
|
||||
testCases.forEach(({ description, expectedType, environment }) => {
|
||||
it(`instantiates ${expectedType.name} for ${description}`, () => {
|
||||
// arrange
|
||||
const factory = new TestableClientLoggerFactory(environment);
|
||||
// act
|
||||
const { logger } = factory;
|
||||
// assert
|
||||
expect(logger).to.be.instanceOf(expectedType);
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
class TestableClientLoggerFactory extends ClientLoggerFactory {
|
||||
public constructor(environment: IRuntimeEnvironment) {
|
||||
super(environment);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,18 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { AppInitializationLogger } from '@/presentation/bootstrapping/Modules/AppInitializationLogger';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
|
||||
describe('AppInitializationLogger', () => {
|
||||
it('logs the app initialization marker upon bootstrap', () => {
|
||||
// arrange
|
||||
const marker = '[APP_INIT]';
|
||||
const loggerStub = new LoggerStub();
|
||||
const sut = new AppInitializationLogger(loggerStub);
|
||||
// act
|
||||
sut.bootstrap();
|
||||
// assert
|
||||
expect(loggerStub.callHistory).to.have.lengthOf(1);
|
||||
expect(loggerStub.callHistory[0].args).to.have.lengthOf(1);
|
||||
expect(loggerStub.callHistory[0].args[0]).to.include(marker);
|
||||
});
|
||||
});
|
||||
@@ -0,0 +1,43 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { ISanityCheckOptions } from '@/infrastructure/RuntimeSanity/Common/ISanityCheckOptions';
|
||||
import { RuntimeSanityValidator } from '@/presentation/bootstrapping/Modules/RuntimeSanityValidator';
|
||||
|
||||
describe('RuntimeSanityValidator', () => {
|
||||
it('calls validator with correct options upon bootstrap', () => {
|
||||
// arrange
|
||||
const expectedOptions: ISanityCheckOptions = {
|
||||
validateEnvironmentVariables: true,
|
||||
validateWindowVariables: true,
|
||||
};
|
||||
let actualOptions: ISanityCheckOptions;
|
||||
const validatorMock = (options) => {
|
||||
actualOptions = options;
|
||||
};
|
||||
const sut = new RuntimeSanityValidator(validatorMock);
|
||||
// act
|
||||
sut.bootstrap();
|
||||
// assert
|
||||
expect(actualOptions).to.deep.equal(expectedOptions);
|
||||
});
|
||||
it('propagates the error if validator fails', () => {
|
||||
// arrange
|
||||
const expectedMessage = 'message thrown from validator';
|
||||
const validatorMock = () => {
|
||||
throw new Error(expectedMessage);
|
||||
};
|
||||
const sut = new RuntimeSanityValidator(validatorMock);
|
||||
// act
|
||||
const act = () => sut.bootstrap();
|
||||
// assert
|
||||
expect(act).to.throw(expectedMessage);
|
||||
});
|
||||
it('runs successfully if validator passes', () => {
|
||||
// arrange
|
||||
const validatorMock = () => { /* NOOP */ };
|
||||
const sut = new RuntimeSanityValidator(validatorMock);
|
||||
// act
|
||||
const act = () => sut.bootstrap();
|
||||
// assert
|
||||
expect(act).to.not.throw();
|
||||
});
|
||||
});
|
||||
@@ -1,16 +1,16 @@
|
||||
import { describe, it, expect } from 'vitest';
|
||||
import { useEnvironment } from '@/presentation/components/Shared/Hooks/UseEnvironment';
|
||||
import { useRuntimeEnvironment } from '@/presentation/components/Shared/Hooks/UseRuntimeEnvironment';
|
||||
import { itEachAbsentObjectValue } from '@tests/unit/shared/TestCases/AbsentTests';
|
||||
import { EnvironmentStub } from '@tests/unit/shared/Stubs/EnvironmentStub';
|
||||
import { RuntimeEnvironmentStub } from '@tests/unit/shared/Stubs/RuntimeEnvironmentStub';
|
||||
|
||||
describe('UseEnvironment', () => {
|
||||
describe('UseRuntimeEnvironment', () => {
|
||||
describe('environment is absent', () => {
|
||||
itEachAbsentObjectValue((absentValue) => {
|
||||
// arrange
|
||||
const expectedError = 'missing environment';
|
||||
const environmentValue = absentValue;
|
||||
// act
|
||||
const act = () => useEnvironment(environmentValue);
|
||||
const act = () => useRuntimeEnvironment(environmentValue);
|
||||
// assert
|
||||
expect(act).to.throw(expectedError);
|
||||
});
|
||||
@@ -18,9 +18,9 @@ describe('UseEnvironment', () => {
|
||||
|
||||
it('returns expected environment', () => {
|
||||
// arrange
|
||||
const expectedEnvironment = new EnvironmentStub();
|
||||
const expectedEnvironment = new RuntimeEnvironmentStub();
|
||||
// act
|
||||
const actualEnvironment = useEnvironment(expectedEnvironment);
|
||||
const actualEnvironment = useRuntimeEnvironment(expectedEnvironment);
|
||||
// assert
|
||||
expect(actualEnvironment).to.equal(expectedEnvironment);
|
||||
});
|
||||
@@ -2,11 +2,13 @@ import { describe, it, expect } from 'vitest';
|
||||
import { provideWindowVariables } from '@/presentation/electron/preload/WindowVariablesProvider';
|
||||
import { SystemOperationsStub } from '@tests/unit/shared/Stubs/SystemOperationsStub';
|
||||
import { OperatingSystem } from '@/domain/OperatingSystem';
|
||||
import { ISystemOperations } from '@/infrastructure/Environment/SystemOperations/ISystemOperations';
|
||||
import { ISystemOperations } from '@/infrastructure/SystemOperations/ISystemOperations';
|
||||
import { ILogger } from '@/infrastructure/Log/ILogger';
|
||||
import { LoggerStub } from '@tests/unit/shared/Stubs/LoggerStub';
|
||||
|
||||
describe('WindowVariablesProvider', () => {
|
||||
describe('provideWindowVariables', () => {
|
||||
it('returns expected system', () => {
|
||||
it('returns expected `system`', () => {
|
||||
// arrange
|
||||
const expectedValue = new SystemOperationsStub();
|
||||
// act
|
||||
@@ -16,7 +18,7 @@ describe('WindowVariablesProvider', () => {
|
||||
// assert
|
||||
expect(variables.system).to.equal(expectedValue);
|
||||
});
|
||||
it('returns expected os', () => {
|
||||
it('returns expected `os`', () => {
|
||||
// arrange
|
||||
const expectedValue = OperatingSystem.WindowsPhone;
|
||||
// act
|
||||
@@ -26,6 +28,16 @@ describe('WindowVariablesProvider', () => {
|
||||
// assert
|
||||
expect(variables.os).to.equal(expectedValue);
|
||||
});
|
||||
it('returns expected `log`', () => {
|
||||
// arrange
|
||||
const expectedValue = new LoggerStub();
|
||||
// act
|
||||
const variables = new TestContext()
|
||||
.withLogger(expectedValue)
|
||||
.provideWindowVariables();
|
||||
// assert
|
||||
expect(variables.log).to.equal(expectedValue);
|
||||
});
|
||||
it('`isDesktop` is true', () => {
|
||||
// arrange
|
||||
const expectedValue = true;
|
||||
@@ -43,6 +55,8 @@ class TestContext {
|
||||
|
||||
private os: OperatingSystem = OperatingSystem.Android;
|
||||
|
||||
private log: ILogger = new LoggerStub();
|
||||
|
||||
public withSystem(system: ISystemOperations): this {
|
||||
this.system = system;
|
||||
return this;
|
||||
@@ -53,9 +67,15 @@ class TestContext {
|
||||
return this;
|
||||
}
|
||||
|
||||
public withLogger(log: ILogger): this {
|
||||
this.log = log;
|
||||
return this;
|
||||
}
|
||||
|
||||
public provideWindowVariables() {
|
||||
return provideWindowVariables(
|
||||
() => this.system,
|
||||
() => this.log,
|
||||
() => this.os,
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user