mirror of
https://github.com/github/awesome-copilot.git
synced 2026-08-13 12:49:49 +00:00
runVersionMatchGate and runCanvasStructureGate read locator content with git show/cat-file. For a tag-name locator, `git fetch origin <tag>` only updates FETCH_HEAD and never creates refs/tags/<tag>, so `git show <tag>:...` died with 'invalid object name' and produced a false infra_error. Read the primary locator via HEAD (already checked out during clone) and non-primary locators via FETCH_HEAD after fetching, instead of the bare locator. This handles SHAs, short tag names, and fully-qualified tag refs uniformly without classifying the locator. Adds regression coverage for the tag-locator path in both gates. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
@@ -4,7 +4,7 @@ import os from "os";
|
||||
import path from "path";
|
||||
import { spawnSync } from "child_process";
|
||||
import { after, test } from "node:test";
|
||||
import { runCanvasStructureGate } from "./external-plugin-quality-gates.mjs";
|
||||
import { runCanvasStructureGate, runVersionMatchGate } from "./external-plugin-quality-gates.mjs";
|
||||
|
||||
const tempDirs = [];
|
||||
|
||||
@@ -99,3 +99,118 @@ test("runCanvasStructureGate fails when extension entrypoint path is a directory
|
||||
assert.equal(result.status, "fail");
|
||||
assert.match(result.output, /"extensions\/extension\.mjs" must be a file/);
|
||||
});
|
||||
|
||||
// Regression tests for issue #2397: a tag-name locator (e.g. "v1.0.0") must be
|
||||
// readable by the version-match and canvas-structure gates. `git fetch origin <tag>`
|
||||
// only updates FETCH_HEAD and never creates a local `refs/tags/<tag>`, so reading via
|
||||
// `git show <tag>:...` used to die with "fatal: invalid object name" and roll up to a
|
||||
// bogus infra_error/fail even though the referenced content was valid.
|
||||
|
||||
function initRemoteRepo() {
|
||||
const repoDir = fs.mkdtempSync(path.join(os.tmpdir(), "external-plugin-quality-remote-"));
|
||||
tempDirs.push(repoDir);
|
||||
runGit(repoDir, "init", "-q");
|
||||
runGit(repoDir, "config", "user.name", "Copilot Test");
|
||||
runGit(repoDir, "config", "user.email", "copilot@example.com");
|
||||
// Mirror github.com: allow the submission repo to shallow-fetch an arbitrary SHA.
|
||||
runGit(repoDir, "config", "uploadpack.allowAnySHA1InWant", "true");
|
||||
return repoDir;
|
||||
}
|
||||
|
||||
function writeValidPluginContent(repoDir) {
|
||||
fs.mkdirSync(path.join(repoDir, ".github", "plugin"), { recursive: true });
|
||||
fs.writeFileSync(
|
||||
path.join(repoDir, ".github", "plugin", "plugin.json"),
|
||||
`${JSON.stringify({ name: "tag-plugin", version: "1.0.0" }, null, 2)}\n`,
|
||||
);
|
||||
fs.mkdirSync(path.join(repoDir, "extensions"), { recursive: true });
|
||||
fs.writeFileSync(path.join(repoDir, "extensions", "extension.mjs"), "export default {};\n");
|
||||
}
|
||||
|
||||
// Mirrors cloneSubmissionRepository in external-plugin-quality-gates.mjs: fetch only the
|
||||
// primary locator and detach HEAD onto it. The tag ref is deliberately never created
|
||||
// locally, reproducing the CI environment where `git show <tag>:...` fails.
|
||||
function cloneSubmissionRepo(remoteDir, primaryFetchSpec) {
|
||||
const repoDir = fs.mkdtempSync(path.join(os.tmpdir(), "external-plugin-quality-sub-"));
|
||||
tempDirs.push(repoDir);
|
||||
runGit(repoDir, "init", "-q");
|
||||
runGit(repoDir, "remote", "add", "origin", remoteDir);
|
||||
runGit(repoDir, "fetch", "--depth=1", "origin", primaryFetchSpec);
|
||||
runGit(repoDir, "checkout", "--detach", "FETCH_HEAD");
|
||||
return repoDir;
|
||||
}
|
||||
|
||||
test("runVersionMatchGate passes for a tag ref alongside a sha", () => {
|
||||
const remoteDir = initRemoteRepo();
|
||||
writeValidPluginContent(remoteDir);
|
||||
const sha = commitAll(remoteDir, "Add plugin manifest");
|
||||
runGit(remoteDir, "tag", "-a", "v1.0.0", "-m", "release 1.0.0");
|
||||
|
||||
const repoDir = cloneSubmissionRepo(remoteDir, sha);
|
||||
const plugin = {
|
||||
name: "tag-plugin",
|
||||
version: "1.0.0",
|
||||
source: { source: "github", repo: "owner/repo", ref: "v1.0.0", sha },
|
||||
};
|
||||
|
||||
const result = runVersionMatchGate(repoDir, plugin, sha);
|
||||
assert.equal(result.status, "pass", result.output);
|
||||
// Both the tag ref and the sha must be verified.
|
||||
assert.match(result.output, /- v1\.0\.0: matched version "1\.0\.0"/);
|
||||
assert.match(result.output, new RegExp(`- ${sha}: matched version "1\\.0\\.0"`));
|
||||
});
|
||||
|
||||
test("runCanvasStructureGate passes for a tag ref alongside a sha", () => {
|
||||
const remoteDir = initRemoteRepo();
|
||||
writeValidPluginContent(remoteDir);
|
||||
const sha = commitAll(remoteDir, "Add canvas extension container");
|
||||
runGit(remoteDir, "tag", "-a", "v1.0.0", "-m", "release 1.0.0");
|
||||
|
||||
const repoDir = cloneSubmissionRepo(remoteDir, sha);
|
||||
const plugin = {
|
||||
name: "tag-plugin",
|
||||
keywords: ["canvas"],
|
||||
source: { source: "github", repo: "owner/repo", ref: "v1.0.0", sha },
|
||||
};
|
||||
|
||||
const result = runCanvasStructureGate(repoDir, plugin, sha);
|
||||
assert.equal(result.status, "pass", result.output);
|
||||
assert.match(result.output, /- v1\.0\.0: found "extensions"/);
|
||||
assert.match(result.output, new RegExp(`- ${sha}: found "extensions"`));
|
||||
});
|
||||
|
||||
test("runVersionMatchGate passes when the primary locator is a tag ref", () => {
|
||||
const remoteDir = initRemoteRepo();
|
||||
writeValidPluginContent(remoteDir);
|
||||
commitAll(remoteDir, "Add plugin manifest");
|
||||
runGit(remoteDir, "tag", "-a", "v1.0.0", "-m", "release 1.0.0");
|
||||
|
||||
const repoDir = cloneSubmissionRepo(remoteDir, "v1.0.0");
|
||||
const plugin = {
|
||||
name: "tag-plugin",
|
||||
version: "1.0.0",
|
||||
source: { source: "github", repo: "owner/repo", ref: "v1.0.0" },
|
||||
};
|
||||
|
||||
const result = runVersionMatchGate(repoDir, plugin, "v1.0.0");
|
||||
assert.equal(result.status, "pass", result.output);
|
||||
assert.match(result.output, /- v1\.0\.0: matched version "1\.0\.0"/);
|
||||
});
|
||||
|
||||
test("runCanvasStructureGate passes when the primary locator is a tag ref", () => {
|
||||
const remoteDir = initRemoteRepo();
|
||||
writeValidPluginContent(remoteDir);
|
||||
commitAll(remoteDir, "Add canvas extension container");
|
||||
runGit(remoteDir, "tag", "-a", "v1.0.0", "-m", "release 1.0.0");
|
||||
|
||||
const repoDir = cloneSubmissionRepo(remoteDir, "v1.0.0");
|
||||
const plugin = {
|
||||
name: "tag-plugin",
|
||||
keywords: ["canvas"],
|
||||
source: { source: "github", repo: "owner/repo", ref: "v1.0.0" },
|
||||
};
|
||||
|
||||
const result = runCanvasStructureGate(repoDir, plugin, "v1.0.0");
|
||||
assert.equal(result.status, "pass", result.output);
|
||||
assert.match(result.output, /- v1\.0\.0: found "extensions"/);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user