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,13 @@
import { expect, describe, it } from 'vitest';
import { VITE_ENVIRONMENT_KEYS } from '@/infrastructure/EnvironmentVariables/Vite/ViteEnvironmentKeys';
describe('VITE_ENVIRONMENT_KEYS', () => {
describe('each key should have a non-empty string', () => {
Object.entries(VITE_ENVIRONMENT_KEYS).forEach(([key, value]) => {
it(`The key ${key} should have a non-empty string value`, () => {
expect(typeof value).toBe('string');
expect(value.length).toBeGreaterThan(0);
});
});
});
});

View File

@@ -0,0 +1,73 @@
import {
describe, beforeEach, afterEach, expect,
} from 'vitest';
import { VITE_ENVIRONMENT_KEYS } from '@/infrastructure/EnvironmentVariables/Vite/ViteEnvironmentKeys';
import { PropertyKeys } from '@/TypeHelpers';
import { IEnvironmentVariables } from '@/infrastructure/EnvironmentVariables/IEnvironmentVariables';
import { ViteEnvironmentVariables } from '@/infrastructure/EnvironmentVariables/Vite/ViteEnvironmentVariables';
describe('ViteEnvironmentVariables', () => {
describe('reads values from import.meta.env', () => {
let originalMetaEnv;
beforeEach(() => {
originalMetaEnv = { ...import.meta.env };
});
afterEach(() => {
Object.assign(import.meta.env, originalMetaEnv);
});
interface ITestCase<T> {
readonly getActualValue: (sut: IEnvironmentVariables) => T;
readonly environmentVariable: typeof VITE_ENVIRONMENT_KEYS[
keyof typeof VITE_ENVIRONMENT_KEYS];
readonly expected: T;
}
const testCases: {
readonly [K in PropertyKeys<IEnvironmentVariables>]: ITestCase<string | boolean>;
} = {
name: {
environmentVariable: VITE_ENVIRONMENT_KEYS.NAME,
expected: 'expected-name',
getActualValue: (sut) => sut.name,
},
version: {
environmentVariable: VITE_ENVIRONMENT_KEYS.VERSION,
expected: 'expected-version',
getActualValue: (sut) => sut.version,
},
repositoryUrl: {
environmentVariable: VITE_ENVIRONMENT_KEYS.REPOSITORY_URL,
expected: 'expected-slogan',
getActualValue: (sut) => sut.repositoryUrl,
},
slogan: {
environmentVariable: VITE_ENVIRONMENT_KEYS.SLOGAN,
expected: 'expected-repositoryUrl',
getActualValue: (sut) => sut.slogan,
},
homepageUrl: {
environmentVariable: VITE_ENVIRONMENT_KEYS.HOMEPAGE_URL,
expected: 'expected-homepageUrl',
getActualValue: (sut) => sut.homepageUrl,
},
isNonProduction: {
environmentVariable: VITE_ENVIRONMENT_KEYS.DEV,
expected: false,
getActualValue: (sut) => sut.isNonProduction,
},
};
Object.values(testCases).forEach(({ environmentVariable, expected, getActualValue }) => {
it(`should correctly get the value of ${environmentVariable}`, () => {
// arrange
import.meta.env[environmentVariable] = expected;
// act
const sut = new ViteEnvironmentVariables();
const actualValue = getActualValue(sut);
// assert
expect(actualValue).toBe(expected);
});
});
});
});