Repository navigation
Expand file tree
/
Copy pathfetch-schemas.test.mjs
More file actions
255 lines (230 loc) · 10.5 KB
/
Copy pathfetch-schemas.test.mjs
File metadata and controls
255 lines (230 loc) · 10.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*---------------------------------------------------------------------------------------------
* Copyright (c) Microsoft Corporation. All rights reserved.
*--------------------------------------------------------------------------------------------*/
import assert from 'node:assert/strict';
import { createHash } from 'node:crypto';
import { execFileSync, spawnSync } from 'node:child_process';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
import test from 'node:test';
import { fileURLToPath } from 'node:url';
import { runtimeReleaseUrl } from '../../../scripts/runtime-release.mjs';
const scriptPath = path.join(path.dirname(fileURLToPath(import.meta.url)), 'fetch-schemas.mjs');
for (const [version, repository, tag] of [
['1.2.3', 'copilot-cli', 'v1.2.3'],
['1.2.3-4', 'copilot-cli', 'v1.2.3-4'],
['1.2.3-unstable.r123.gabcdef0', 'copilot-sdk', 'runtime-1.2.3-unstable.r123.gabcdef0'],
['1.2.3-4.unstable.r123.gabcdef0', 'copilot-sdk', 'runtime-1.2.3-4.unstable.r123.gabcdef0'],
['0.0.0-0.unstable.r1.g0000000', 'copilot-sdk', 'runtime-0.0.0-0.unstable.r1.g0000000'],
['01.2.3-unstable.r123.gabcdef0', 'copilot-cli', 'v01.2.3-unstable.r123.gabcdef0'],
['1.02.3-unstable.r123.gabcdef0', 'copilot-cli', 'v1.02.3-unstable.r123.gabcdef0'],
['1.2.03-unstable.r123.gabcdef0', 'copilot-cli', 'v1.2.03-unstable.r123.gabcdef0'],
['1.2.3-04.unstable.r123.gabcdef0', 'copilot-cli', 'v1.2.3-04.unstable.r123.gabcdef0'],
]) {
test(`resolves ${version} without changing mirror semantics`, () => {
assert.equal(runtimeReleaseUrl(version, null), `https://github.com/github/${repository}/releases/download/${tag}`);
assert.equal(runtimeReleaseUrl(version, 'https://mirror.example/releases/'), `https://mirror.example/releases/${tag}`);
});
}
test('downloads unstable schemas from the SDK runtime release with checksum verification', (t) => {
const fixture = createFixture(t);
const version = '1.2.3-4.unstable.r123.gabcdef0';
const releaseUrl = `https://github.com/github/copilot-sdk/releases/download/runtime-${version}`;
const asset = `github-copilot-${version}-linux-x64.tgz`;
const mockFetch = `data:text/javascript,${encodeURIComponent(`
import fs from 'node:fs';
globalThis.fetch = async (url) => {
if (url === ${JSON.stringify(`${releaseUrl}/SHA256SUMS.txt`)})
return new Response(${JSON.stringify(`${fixture.hash} ${asset}\n`)});
if (url === ${JSON.stringify(`${releaseUrl}/${asset}`)})
return new Response(fs.readFileSync(${JSON.stringify(fixture.archivePath)}));
throw new Error('Unexpected download: ' + url);
};
`)}`;
const output = path.join(fixture.root, 'downloaded');
const result = runFetch(fixture, output, {
COPILOT_CLI_VERSION: version,
COPILOT_CLI_SCHEMA_PLATFORM: 'linux-x64',
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_DOWNLOAD_BASE_URL: undefined,
NODE_OPTIONS: `--import=${mockFetch}`,
});
assert.equal(result.status, 0, result.stderr);
assert.deepEqual(JSON.parse(fs.readFileSync(path.join(output, 'api.schema.json'), 'utf8')), { title: 'API' });
});
test('extracts schemas from a verified release archive', (t) => {
const fixture = createFixture(t);
const outputDir = path.join(fixture.root, 'output');
const result = runFetch(fixture, outputDir);
assert.equal(result.status, 0, result.stderr);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'api.schema.json'), 'utf8')),
{ title: 'API' },
);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'session-events.schema.json'), 'utf8')),
{ title: 'Events' },
);
});
test('normal nested generation selects checked-out runtime schemas with a clean environment', (t) => {
const fixture = createFixture(t);
const outputDir = path.join(fixture.root, 'runtime-output');
const result = runFetch(fixture, outputDir, {
COPILOT_CLI_DOWNLOAD_BASE_URL: 'http://127.0.0.1:1/should-not-be-called',
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_RELEASE_SHA256: undefined,
COPILOT_RUNTIME_SOURCE: undefined,
});
assert.equal(result.status, 0, result.stderr);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'api.schema.json'), 'utf8')),
JSON.parse(
fs.readFileSync(
path.resolve(path.dirname(scriptPath), '../../../../..', 'generated/api.schema.json'),
'utf8',
),
),
);
});
test('copied standalone generation retains pinned published acquisition', (t) => {
const fixture = createFixture(t);
const standaloneRoot = path.join(fixture.root, 'standalone');
const standaloneScript = path.join(standaloneRoot, 'java/scripts/codegen/fetch-schemas.mjs');
const standaloneLayoutHelper = path.join(standaloneRoot, 'scripts/runtime-layout.mjs');
const outputDir = path.join(standaloneRoot, 'java/scripts/codegen/target/schemas');
fs.mkdirSync(path.dirname(standaloneScript), { recursive: true });
fs.mkdirSync(path.dirname(standaloneLayoutHelper), { recursive: true });
fs.mkdirSync(path.join(standaloneRoot, 'nodejs'), { recursive: true });
fs.copyFileSync(scriptPath, standaloneScript);
fs.copyFileSync(
path.resolve(path.dirname(scriptPath), '../../../scripts/runtime-layout.mjs'),
standaloneLayoutHelper,
);
fs.copyFileSync(
path.resolve(path.dirname(scriptPath), '../../../scripts/runtime-release.mjs'),
path.join(standaloneRoot, 'scripts/runtime-release.mjs'),
);
fs.writeFileSync(
path.join(standaloneRoot, 'nodejs/package.json'),
JSON.stringify({ copilotCliVersion: '1.0.83' }),
);
const result = runFetch(
fixture,
outputDir,
{
COPILOT_RUNTIME_SOURCE: undefined,
},
standaloneScript,
);
assert.equal(result.status, 0, result.stderr);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'api.schema.json'), 'utf8')),
{ title: 'API' },
);
});
test('rejects an archive with the wrong checksum', (t) => {
const fixture = createFixture(t);
const result = runFetch(
{ ...fixture, hash: '0'.repeat(64) },
path.join(fixture.root, 'output'),
);
assert.notEqual(result.status, 0);
assert.match(result.stderr, /Integrity verification failed/);
});
test('requires both schema files', (t) => {
const fixture = createFixture(t, { includeEvents: false });
const result = runFetch(fixture, path.join(fixture.root, 'output'));
assert.notEqual(result.status, 0);
assert.match(result.stderr, /must contain exactly one package\/schemas\/session-events\.schema\.json/);
});
test('stages explicit runtime schemas without acquiring a published archive', (t) => {
const fixture = createFixture(t);
const runtimeSchemas = path.join(fixture.root, 'runtime-schemas');
const outputDir = path.join(fixture.root, 'output');
fs.mkdirSync(runtimeSchemas, { recursive: true });
fs.mkdirSync(outputDir, { recursive: true });
fs.writeFileSync(path.join(runtimeSchemas, 'api.schema.json'), '{"title":"Runtime API"}\n');
fs.writeFileSync(path.join(runtimeSchemas, 'session-events.schema.json'), '{"title":"Runtime Events"}\n');
fs.writeFileSync(path.join(outputDir, 'api.schema.json'), '{"title":"Stale Published API"}\n');
const result = runFetch(fixture, outputDir, {
COPILOT_CLI_DOWNLOAD_BASE_URL: 'http://127.0.0.1:1/should-not-be-called',
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_RELEASE_SHA256: undefined,
COPILOT_CLI_SCHEMA_DIR: runtimeSchemas,
COPILOT_RUNTIME_SOURCE: 'checkout',
});
assert.equal(result.status, 0, result.stderr);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'api.schema.json'), 'utf8')),
{ title: 'Runtime API' },
);
assert.deepEqual(
JSON.parse(fs.readFileSync(path.join(outputDir, 'session-events.schema.json'), 'utf8')),
{ title: 'Runtime Events' },
);
});
test('fails closed when runtime schemas are missing or invalid', (t) => {
const fixture = createFixture(t);
const runtimeSchemas = path.join(fixture.root, 'runtime-schemas');
fs.mkdirSync(runtimeSchemas, { recursive: true });
fs.writeFileSync(path.join(runtimeSchemas, 'api.schema.json'), '{}\n');
let result = runFetch(fixture, path.join(fixture.root, 'missing-output'), {
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_RELEASE_SHA256: undefined,
COPILOT_CLI_SCHEMA_DIR: runtimeSchemas,
COPILOT_RUNTIME_SOURCE: 'checkout',
});
assert.notEqual(result.status, 0);
assert.match(result.stderr, /session-events\.schema\.json/);
fs.writeFileSync(path.join(runtimeSchemas, 'session-events.schema.json'), 'invalid json');
result = runFetch(fixture, path.join(fixture.root, 'invalid-output'), {
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_RELEASE_SHA256: undefined,
COPILOT_CLI_SCHEMA_DIR: runtimeSchemas,
COPILOT_RUNTIME_SOURCE: 'checkout',
});
assert.notEqual(result.status, 0);
assert.match(result.stderr, /Invalid runtime schema/);
});
test('rejects a selected missing schema directory in runtime mode', (t) => {
const fixture = createFixture(t);
const result = runFetch(fixture, path.join(fixture.root, 'output'), {
COPILOT_CLI_RELEASE_TARBALL: undefined,
COPILOT_CLI_RELEASE_SHA256: undefined,
COPILOT_CLI_SCHEMA_DIR: path.join(fixture.root, 'missing-schemas'),
COPILOT_RUNTIME_SOURCE: 'checkout',
});
assert.notEqual(result.status, 0);
assert.match(result.stderr, /Selected Copilot schema not found/);
});
function createFixture(t, { includeEvents = true } = {}) {
const root = fs.mkdtempSync(path.join(os.tmpdir(), 'copilot-java-schemas-'));
t.after(() => fs.rmSync(root, { recursive: true, force: true }));
const packageDir = path.join(root, 'package');
const schemasDir = path.join(packageDir, 'schemas');
fs.mkdirSync(schemasDir, { recursive: true });
fs.writeFileSync(path.join(schemasDir, 'api.schema.json'), '{"title":"API"}\n');
if (includeEvents) {
fs.writeFileSync(path.join(schemasDir, 'session-events.schema.json'), '{"title":"Events"}\n');
}
const archivePath = path.join(root, 'release.tgz');
execFileSync('tar', ['-czf', archivePath, '-C', root, 'package']);
const hash = createHash('sha256').update(fs.readFileSync(archivePath)).digest('hex');
return { root, archivePath, hash };
}
function runFetch(fixture, outputDir, environment = {}, executable = scriptPath) {
const env = {
...process.env,
COPILOT_CLI_SCHEMA_DIR: undefined,
COPILOT_CLI_RELEASE_TARBALL: fixture.archivePath,
COPILOT_CLI_RELEASE_SHA256: fixture.hash,
COPILOT_CLI_SCHEMA_OUTPUT: outputDir,
COPILOT_RUNTIME_SOURCE: 'published',
...environment,
};
return spawnSync(process.execPath, [executable], {
encoding: 'utf8',
env,
});
}