Merge pull request #4 from advanced-security/address-breaking-change-pack-ls

Address breaking change pack ls

Author: rvermeulen

.github/workflows/test.yml

@@ -1,6 +1,12 @@
 name: Test action
 on:
   workflow_dispatch:
+    inputs:
+      bundle-version:
+        description: "Tag of the bundle to use for testing"
+        required: true
+        default: "latest"
+        type: string
 
 jobs:
   create-test-bundle:

lib/bundle.js

@@ -7,20 +7,9 @@ import * as fs from "fs"
 import * as tar from "tar"
 import * as yaml from "js-yaml"
 import * as async from "async"
-import { CodeQL, CodeQLPack, CodeQLPackDependency } from "./codeql"
+import { CodeQL, CodeQLPack, CodeQLPackYmlSpec } from "./codeql"
 import internal = require("stream")
 
-interface QLPackDependencies {
-    [key: string]: string
-}
-
-interface QLPack {
-    name: string;
-    version: string;
-    library: boolean;
-    dependencies?: QLPackDependencies
-}
-
 export class Bundle {
     private octokit: any
     private tag: string
@@ -84,6 +73,7 @@ export class Bundle {
             customization: []
         } as { query: CodeQLPack[]; library: CodeQLPack[], customization: CodeQLPack[] })
 
+        core.debug(`Found ${groupedPacks.query.length} query pack(s), ${groupedPacks.library.length} library pack(s), ${groupedPacks.customization.length} customization pack(s)`)
         const codeqlCli = this.getCodeQL()
         const qlpacksPath = path.join(this.bundlePath, 'qlpacks')
         await Promise.all(groupedPacks.library.map(async pack => await codeqlCli.bundlePack(pack.path, qlpacksPath, [workspace])))
@@ -106,7 +96,7 @@ export class Bundle {
 
             const standardPack = compatibleStandardPacks[0]
             core.debug(`Found compatible standard pack ${standardPack.name} as a target for customization.`)
-            const packDefinition = (yaml.load(fs.readFileSync(pack.path, 'utf-8'))) as QLPack
+            const packDefinition = (yaml.load(fs.readFileSync(pack.path, 'utf-8'))) as CodeQLPackYmlSpec
             if (packDefinition.dependencies) {
                 core.debug(`Removing dependency on ${standardPack.name} to prevent circular dependency.`)
                 delete packDefinition.dependencies[standardPack.name]
@@ -127,7 +117,7 @@ export class Bundle {
             core.debug(`Copying ${standardPackVersionDir} to  ${tempStandardPackVersionDir}.`)
             await io.cp(standardPackVersionDir, tempStandardPackVersionDir, { recursive: true })
 
-            const standardPackDefinition = (yaml.load(fs.readFileSync(standardPack.path, 'utf-8'))) as QLPack
+            const standardPackDefinition = (yaml.load(fs.readFileSync(standardPack.path, 'utf-8'))) as CodeQLPackYmlSpec
             standardPackDefinition.dependencies = standardPackDefinition.dependencies || {}
             standardPackDefinition.dependencies[pack.name] = pack.version
 
@@ -205,7 +195,7 @@ export class Bundle {
     */
     patchDependencyOnSuiteHelpers(pack: CodeQLPack) {
         const suiteHelpersPackName = 'codeql/suite-helpers'
-        const packDefinition = (yaml.load(fs.readFileSync(pack.path, 'utf-8'))) as QLPack
+        const packDefinition = (yaml.load(fs.readFileSync(pack.path, 'utf-8'))) as CodeQLPackYmlSpec
         if (packDefinition.dependencies) {
             core.debug(`Patching dependency on 'codeql/suite-helpers' to prevent resolution error.`)
             packDefinition.dependencies[suiteHelpersPackName] = "*"

lib/bundle.js.map

@@ -3,6 +3,8 @@ import * as exec from "@actions/exec"
 import * as io from "@actions/io"
 import * as path from "path"
 import * as crypto from "crypto"
+import * as yaml from "js-yaml"
+import * as fs from "fs"
 
 export interface CodeQLVersion {
     productName: string;
@@ -19,7 +21,6 @@ export interface CodeQLVersion {
 export interface CodeQLPackDependency {
     name: string;
     version: string;
-    inclusive: boolean
 }
 export interface CodeQLPack {
     path: string;
@@ -44,6 +45,18 @@ interface RunResult {
     stderr: string;
 }
 
+export interface QLPackDependencyYmlSpec {
+    [key: string]: string
+}
+
+export interface CodeQLPackYmlSpec {
+    name: string;
+    version?: string;
+    library: boolean;
+    dependencies?: QLPackDependencyYmlSpec
+    extractor?: string;
+}
+
 export class CodeQL {
     private codeqlHome: string;
 
@@ -88,21 +101,20 @@ export class CodeQL {
         const packs = JSON.parse(result.stdout).packs
         return Object.keys(packs).map(path => {
             console.debug(`Listing pack at ${path}`)
-            const extractor = packs[path].extractor || undefined
-            const dependencies = packs[path].dependencies ? Object.keys(packs[path].dependencies).map(pack => {
+            const packDefinition = (yaml.load(fs.readFileSync(path, 'utf-8'))) as CodeQLPackYmlSpec
+            const dependencies = packDefinition.dependencies ? Object.keys(packDefinition.dependencies).map(pack => {
                 return {
                     name: pack,
-                    version: packs[path].dependencies[pack].text,
-                    inclusive: packs[path].dependencies[pack].inclusive
+                    version: (packDefinition.dependencies as QLPackDependencyYmlSpec)[pack]
                 }
             }) : []
             return {
-                name: packs[path].name,
+                name: packDefinition.name,
                 path: path,
-                library: packs[path].library,
-                version: packs[path].version || "0.0.0",
+                library: packDefinition.library,
+                version: packDefinition.version || "0.0.0",
                 dependencies: dependencies,
-                extractor: extractor
+                extractor: packDefinition.extractor
             }
         })
     }