mirror of
https://github.com/microsoft/vscode.git
synced 2026-08-16 11:17:35 +01:00
Giuseppe CianciandCopilot
9cc5463d10
Add a build-script unit test that fails when an agent SDK's pinned version drifts between the runtime pin (repo-root package.json devDependencies), the build pin (build/agent-sdk/agents/<sdk>/package.json), and the resolved version in that SDK's package-lock.json. The lockstep was previously documented as a manual procedure only. Extend the build test glob to include agent-sdk/ and note the new enforcement in the README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
72 lines
2.8 KiB
TypeScript
72 lines
2.8 KiB
TypeScript
/*---------------------------------------------------------------------------------------------
|
|
* Copyright (c) Microsoft Corporation. All rights reserved.
|
|
* Licensed under the MIT License. See License.txt in the project root for license information.
|
|
*--------------------------------------------------------------------------------------------*/
|
|
|
|
import assert from 'assert';
|
|
import * as fs from 'fs';
|
|
import * as path from 'path';
|
|
import { suite, test } from 'node:test';
|
|
import { fileURLToPath } from 'url';
|
|
import { getAgentDir, getAgentMeta, getSdks } from '../common.ts';
|
|
|
|
const THIS_DIR = path.dirname(fileURLToPath(import.meta.url));
|
|
|
|
/** Repo-root package.json — holds the runtime pins in `devDependencies`. */
|
|
const ROOT_PACKAGE_JSON = path.join(THIS_DIR, '..', '..', '..', 'package.json');
|
|
|
|
interface IRootPackageJson {
|
|
readonly devDependencies?: Readonly<Record<string, string>>;
|
|
}
|
|
|
|
function getRootDevDependencies(): Readonly<Record<string, string>> {
|
|
const json = JSON.parse(fs.readFileSync(ROOT_PACKAGE_JSON, 'utf8')) as IRootPackageJson;
|
|
return json.devDependencies ?? {};
|
|
}
|
|
|
|
/**
|
|
* Reads the version `npm ci` would resolve for `name` from an SDK's
|
|
* `package-lock.json` (the root package entry under `node_modules/<name>`).
|
|
* Guards against the lockfile lagging a `package.json` version bump.
|
|
*/
|
|
function getLockedVersion(sdk: string, name: string): string | undefined {
|
|
const lockPath = path.join(getAgentDir(sdk), 'package-lock.json');
|
|
const lock = JSON.parse(fs.readFileSync(lockPath, 'utf8')) as {
|
|
readonly packages?: Readonly<Record<string, { readonly version?: string }>>;
|
|
};
|
|
return lock.packages?.[`node_modules/${name}`]?.version;
|
|
}
|
|
|
|
suite('agent SDK version pins stay in lockstep', () => {
|
|
test('build pin, runtime pin, and lockfile all match for every SDK', () => {
|
|
const rootDevDeps = getRootDevDependencies();
|
|
|
|
const actual: Record<string, { name: string; buildPin: string; runtimePin: string | undefined; lockPin: string | undefined }> = {};
|
|
const expected: typeof actual = {};
|
|
|
|
for (const sdk of getSdks()) {
|
|
const { name, version } = getAgentMeta(sdk);
|
|
actual[sdk] = {
|
|
name,
|
|
buildPin: version,
|
|
runtimePin: rootDevDeps[name],
|
|
lockPin: getLockedVersion(sdk, name),
|
|
};
|
|
// The build pin (agents/<sdk>/package.json) is the source of truth;
|
|
// the runtime pin (root devDependencies) and lockfile MUST match it.
|
|
expected[sdk] = {
|
|
name,
|
|
buildPin: version,
|
|
runtimePin: version,
|
|
lockPin: version,
|
|
};
|
|
}
|
|
|
|
assert.deepStrictEqual(
|
|
actual,
|
|
expected,
|
|
`An agent SDK version pin drifted. The build pin in build/agent-sdk/agents/<sdk>/package.json must match the runtime pin in repo-root package.json devDependencies and the resolved version in agents/<sdk>/package-lock.json. See "Bumping an SDK version" in build/agent-sdk/README.md.`,
|
|
);
|
|
});
|
|
});
|