Skip to content

Commit b4506cf

Browse files
committed
Use the original pack name for generated pack
Generated variant analysis packs will use the original name of the pack that the query is located in. This is to support some future work where we do extra validation of data extensions. If the query is not in a pack, the default name is used.
1 parent ff88a8d commit b4506cf

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

extensions/ql-vscode/src/variant-analysis/run-remote-query.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,8 @@ async function fixPackFile(
379379
}
380380
const qlpack = load(await readFile(packPath, "utf8")) as QlPack;
381381

382-
qlpack.name = QUERY_PACK_NAME;
382+
// Use original name
383+
// qlpack.name = QUERY_PACK_NAME;
383384
updateDefaultSuite(qlpack, packRelativePath);
384385
removeWorkspaceRefs(qlpack);
385386

extensions/ql-vscode/test/vscode-tests/cli-integration/variant-analysis/variant-analysis-manager.test.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ describe("Variant Analysis Manager", () => {
222222
it("should run a remote query that is part of a qlpack", async () => {
223223
await doVariantAnalysisTest({
224224
queryPath: "data-remote-qlpack/in-pack.ql",
225+
expectedPackName: "codeql-remote/query",
225226
filesThatExist: ["in-pack.ql", "lib.qll"],
226227
filesThatDoNotExist: [],
227228
qlxFilesThatExist: ["in-pack.qlx"],
@@ -231,6 +232,7 @@ describe("Variant Analysis Manager", () => {
231232
it("should run a remote query that is not part of a qlpack", async () => {
232233
await doVariantAnalysisTest({
233234
queryPath: "data-remote-no-qlpack/in-pack.ql",
235+
expectedPackName: "",
234236
filesThatExist: ["in-pack.ql"],
235237
filesThatDoNotExist: ["lib.qll", "not-in-pack.ql"],
236238
qlxFilesThatExist: ["in-pack.qlx"],
@@ -240,6 +242,7 @@ describe("Variant Analysis Manager", () => {
240242
it("should run a remote query that is nested inside a qlpack", async () => {
241243
await doVariantAnalysisTest({
242244
queryPath: "data-remote-qlpack-nested/subfolder/in-pack.ql",
245+
expectedPackName: "github/remote-query-pack",
243246
filesThatExist: ["subfolder/in-pack.ql", "otherfolder/lib.qll"],
244247
filesThatDoNotExist: ["subfolder/not-in-pack.ql"],
245248
qlxFilesThatExist: ["subfolder/in-pack.qlx"],
@@ -256,6 +259,7 @@ describe("Variant Analysis Manager", () => {
256259
await cli.setUseExtensionPacks(true);
257260
await doVariantAnalysisTest({
258261
queryPath: "data-remote-qlpack-nested/subfolder/in-pack.ql",
262+
expectedPackName: "github/remote-query-pack",
259263
filesThatExist: [
260264
"subfolder/in-pack.ql",
261265
"otherfolder/lib.qll",
@@ -273,12 +277,14 @@ describe("Variant Analysis Manager", () => {
273277

274278
async function doVariantAnalysisTest({
275279
queryPath,
280+
expectedPackName,
276281
filesThatExist,
277282
qlxFilesThatExist,
278283
filesThatDoNotExist,
279284
dependenciesToCheck = ["codeql/javascript-all"],
280285
}: {
281286
queryPath: string;
287+
expectedPackName: string;
282288
filesThatExist: string[];
283289
qlxFilesThatExist: string[];
284290
filesThatDoNotExist: string[];
@@ -332,7 +338,7 @@ describe("Variant Analysis Manager", () => {
332338
const qlpackContents = load(
333339
packFS.fileContents(packFileName).toString("utf-8"),
334340
);
335-
expect(qlpackContents.name).toEqual("codeql-remote/query");
341+
expect(qlpackContents.name).toEqual(expectedPackName);
336342
expect(qlpackContents.version).toEqual("0.0.0");
337343
expect(qlpackContents.dependencies?.["codeql/javascript-all"]).toEqual(
338344
"*",

0 commit comments

Comments
 (0)