mirror of
https://github.com/game-ci/unity-builder.git
synced 2026-06-12 17:03:55 -07:00
16c5c20793
* chore: quality-tightening (oxfmt + oxlint + tsc + vitest + husky + actionlint)
Standard rollout for unity-builder. Most of the work was porting 24
test files from jest 27 to vitest 4.
- prettier -> oxfmt
- eslint (with @typescript-eslint, github, jest, prettier, unicorn) ->
oxlint with eslint-plugin-unicorn
- jest 27 + jest-circus + ts-jest + @types/jest + @jest/globals ->
vitest 4 + vite 7 + @vitest/coverage-istanbul (jest config files
removed)
- new: tsgo --noEmit (alongside tsc fallback)
- lefthook (and lefthook.yml) -> husky 9 with the standard
scripts/ensure-husky.mjs self-heal pattern + lint-staged
- new: gitleaks, actionlint, shellcheck as mise-managed binaries
- TypeScript bumped target ES2020 -> ES2022 + lib ES2022 + DOM (for
Error.cause and modern globals)
Test migration (24 files):
- Bulk-converted jest.* -> vi.*; jest.Mocked -> Mocked from vitest;
jest.MockedFunction -> MockedFunction.
- Added vitest imports to all *.test.ts files (and __mocks__/*.ts)
that didn't have them.
- src/index.ts: extracted runMain() as a named export and gated the
module-level invocation behind NODE_ENV !== 'test'. The
index-plugin-features test now calls runMain() directly instead of
relying on jest's removed vi.isolateModules.
- index-plugin-features.test.ts: moved hoisted refs (mockPlugin,
mockLoadOrchestratorPlugin) into vi.hoisted() so vi.mock factories
can reference them. Replaced arrow constructor mock for ImageTag
with regular function() {...} (vitest 4 disallows arrows as ctors).
Replaced require('./model') / require('@actions/core') inside test
bodies with top-level imports.
- model/orchestrator-plugin.test.ts: dropped jest's '{ virtual: true }'
flag (vitest doesn't support it); replaced the
'mock factory throws' pattern with 'createPlugin throws' so vitest
doesn't wrap the error message at the assertion site.
- model/versioning.test.ts: stray jest.spyOn -> vi.spyOn; replaced
mockImplementation() with no args (jest pattern) by
mockResolvedValue('') / mockImplementation(() => undefined) where
the source expects a string return.
Workflow shell-quoting cleanup (actionlint):
- All bare $GITHUB_STEP_SUMMARY / $GITHUB_OUTPUT / $GITHUB_ENV
redirects quoted across 2 workflows (SC2086).
- s3://$AWS_STACK_NAME / s3://$BUCKET_NAME -> s3://"$AWS_STACK_NAME"
/ s3://"$BUCKET_NAME".
- 'for i in {1..N}; do ... done' loops where i isn't referenced in
the body renamed to 'for _ in' (SC2034).
- 'grep ... | wc -l' -> 'grep -c ...' (SC2126).
- Multiple consecutive '>> $file' redirects in
validate-community-plugins.yml summary block collapsed into a
single block redirect (SC2129).
- 'cat $file | python3 -c "..."' -> 'python3 -c "..." < $file'
(SC2002).
- http://${VAR}:port -> http://"${VAR}":port (SC2086).
tsgo: kept tsc --noEmit as the default 'typecheck' because
unity-builder publishes CommonJS for the GitHub Action consumer,
which conflicts with tsgo's bundler/node16 moduleResolution
requirement (per playbook trap #9). 'yarn typecheck:tsgo' is wired
up for when consumers move to ESM.
Caveats: 28 pre-existing oxlint warnings remain (mostly
typescript/no-explicit-any across the build-parameter shapes and
vitest/no-disabled-tests on 2 explicitly skipped scenarios). Per
playbook trap #22 the lint script drops --deny-warnings.
Verified locally: format clean, lint 0/28, typecheck clean,
test 340/342 (2 pre-existing skipped), actionlint clean across all
12 workflows.
* ci(unity-builder): fix Tests + Plugin Architecture Health on quality-tightening
Three issues surfaced in CI after the jest -> vitest port:
1. **Obsolete snapshot blocks Tests job.**
src/model/__snapshots__/versioning.test.ts.snap had two entries
for the same 'throws for invalid strategy' assertion: one in the
vitest format ('Versioning > determineBuildVersion > ...') and one
in the legacy jest format without the '>'. vitest correctly
regenerates the new one and flags the old one as obsolete; CI
runs without --update so 'Test Files 1 failed' even though all
343 tests passed. Removed the obsolete entry.
2. **'Plugin Architecture Health' workflow still calls jest.**
.github/workflows/validate-orchestrator.yml had two 'npx jest'
steps (orchestrator-plugin unit tests + orchestrator-standalone
tests). The unity-builder + orchestrator codebases are both on
vitest now. Replaced both with 'yarn vitest run'.
3. **jest-fail-on-console + src/jest.setup.ts left over.**
The earlier vitest port missed the jest-fail-on-console
integration. yarn install in CI surfaced
YN0002: doesn't provide @jest/globals (requested by
jest-fail-on-console). Removed jest-fail-on-console + jest.setup.ts;
added src/test/setup.ts with the equivalent vitest beforeEach
spies (same as unity-test-runner).
---------
Co-authored-by: frostebite <jas.f.ukcmti@gmail.com>
101 lines
3.6 KiB
TypeScript
101 lines
3.6 KiB
TypeScript
import { Command } from 'commander-ts';
|
|
import { Input } from '..';
|
|
import * as core from '@actions/core';
|
|
import { ActionYamlReader } from '../input-readers/action-yaml';
|
|
import { CliFunction, CliFunctionsRepository } from './cli-functions-repository';
|
|
import { OptionValues } from 'commander';
|
|
import { InputKey } from '../input';
|
|
|
|
export class Cli {
|
|
public static options: OptionValues | undefined;
|
|
static get isCliMode() {
|
|
return Cli.options !== undefined && Cli.options.mode !== undefined && Cli.options.mode !== '';
|
|
}
|
|
public static query(key: string, alternativeKey: string) {
|
|
if (Cli.options && Cli.options[key] !== undefined) {
|
|
return Cli.options[key];
|
|
}
|
|
if (Cli.options && alternativeKey && Cli.options[alternativeKey] !== undefined) {
|
|
return Cli.options[alternativeKey];
|
|
}
|
|
|
|
return;
|
|
}
|
|
|
|
public static InitCliMode() {
|
|
const program = new Command();
|
|
program.version('0.0.1');
|
|
|
|
const actionYamlReader: ActionYamlReader = new ActionYamlReader();
|
|
const properties = Object.getOwnPropertyNames(Input).filter(
|
|
(p) => p !== 'length' && p !== 'prototype' && p !== 'name',
|
|
);
|
|
for (const element of properties) {
|
|
program.option(`--${element} <${element}>`, actionYamlReader.GetActionYamlValue(element));
|
|
}
|
|
program.option(
|
|
'-m, --mode <mode>',
|
|
CliFunctionsRepository.GetAllCliModes()
|
|
.map((x) => `${x.key} (${x.description})`)
|
|
.join(` | `),
|
|
);
|
|
program.option(
|
|
'--populateOverride <populateOverride>',
|
|
'should use override query to pull input false by default',
|
|
);
|
|
program.option('--cachePushFrom <cachePushFrom>', 'cache push from source folder');
|
|
program.option('--cachePushTo <cachePushTo>', 'cache push to caching folder');
|
|
program.option('--artifactName <artifactName>', 'caching artifact name');
|
|
program.option('--select <select>', 'select a particular resource');
|
|
program.option('--logFile <logFile>', 'output to log file (log stream only)');
|
|
program.option('--profilePath <profilePath>', 'path to submodule profile YAML');
|
|
program.option('--variantPath <variantPath>', 'path to submodule variant YAML');
|
|
program.option('--agentPath <agentPath>', 'path to custom LFS transfer agent');
|
|
program.option('--agentArgs <agentArgs>', 'arguments for custom LFS transfer agent');
|
|
program.option(
|
|
'--storagePaths <storagePaths>',
|
|
'semicolon-separated storage paths for LFS agent',
|
|
);
|
|
program.parse(process.argv);
|
|
Cli.options = program.opts();
|
|
|
|
return Cli.isCliMode;
|
|
}
|
|
|
|
static async RunCli(): Promise<void> {
|
|
const results = CliFunctionsRepository.GetCliFunctions(Cli.options?.mode);
|
|
if (!results) {
|
|
throw new Error(
|
|
`Unknown CLI mode: ${Cli.options?.mode}. Orchestrator CLI features require @game-ci/orchestrator.`,
|
|
);
|
|
}
|
|
core.info(`Entrypoint: ${results.key}`);
|
|
Cli.options!.versioning = 'None';
|
|
|
|
return await results.target[results.propertyKey](Cli.options);
|
|
}
|
|
|
|
@CliFunction(`print-input`, `prints all input`)
|
|
private static logInput() {
|
|
core.info(`\n`);
|
|
core.info(`INPUT:`);
|
|
const properties = Object.getOwnPropertyNames(Input).filter(
|
|
(p) => p !== 'length' && p !== 'prototype' && p !== 'name',
|
|
);
|
|
for (const element of properties) {
|
|
if (
|
|
element in Input &&
|
|
Input[element as InputKey] !== undefined &&
|
|
Input[element as InputKey] !== '' &&
|
|
typeof Input[element as InputKey] !== `function` &&
|
|
element !== 'length' &&
|
|
element !== 'cliOptions' &&
|
|
element !== 'prototype'
|
|
) {
|
|
core.info(`${element} ${Input[element as InputKey]}`);
|
|
}
|
|
}
|
|
core.info(`\n`);
|
|
}
|
|
}
|