Fix the qlpack json schema

This schema was incorrectly tagging `defaultSuite` properties that aren't arrays as errors. I think there are more, similar errors in this schema, but I only fixed this one so that I can get `github/semmle-code` working with test discovery.
github · Mar 29, 2024 · bb23de9 · bb23de9
1 parent a5239fb
commit bb23de9
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 27 deletions.
diff --git a/extensions/ql-vscode/src/model-editor/extension-pack-metadata.schema.json b/extensions/ql-vscode/src/model-editor/extension-pack-metadata.schema.json
@@ -67,6 +67,9 @@
                 "$ref": "#/definitions/SuiteInstruction"
               }
             },
+            {
+              "$ref": "#/definitions/SuiteInstruction"
+            },
             {
               "type": "null"
             }
@@ -91,22 +94,42 @@
           "type": "string"
         },
         "include": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "array",
-            "items": {
-              "type": "string"
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
             }
-          }
+          ]
         },
         "exclude": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "array",
-            "items": {
-              "type": "string"
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
             }
-          }
+          ]
         },
         "description": {
           "type": "string"

diff --git a/extensions/ql-vscode/src/packaging/qlpack-file.schema.json b/extensions/ql-vscode/src/packaging/qlpack-file.schema.json
@@ -51,6 +51,9 @@
                 "$ref": "#/definitions/SuiteInstruction"
               }
             },
+            {
+              "$ref": "#/definitions/SuiteInstruction"
+            },
             {
               "type": "null"
             }
@@ -91,22 +94,42 @@
           "type": "string"
         },
         "include": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "array",
-            "items": {
-              "type": "string"
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
             }
-          }
+          ]
         },
         "exclude": {
-          "type": "object",
-          "additionalProperties": {
-            "type": "array",
-            "items": {
-              "type": "string"
+          "anyOf": [
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              }
+            },
+            {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string"
+              }
             }
-          }
+          ]
         },
         "description": {
           "type": "string"

diff --git a/extensions/ql-vscode/src/packaging/qlpack-file.ts b/extensions/ql-vscode/src/packaging/qlpack-file.ts
@@ -10,7 +10,7 @@ export interface QlPackFile {
   extensionTargets?: Record<string, string> | null;
   dbscheme?: string | null;
   library?: boolean | null;
-  defaultSuite?: SuiteInstruction[] | null;
+  defaultSuite?: SuiteInstruction[] | SuiteInstruction | null;
   defaultSuiteFile?: string | null;
   dataExtensions?: string[] | string | null;
 }
diff --git a/extensions/ql-vscode/src/packaging/suite-instruction.ts b/extensions/ql-vscode/src/packaging/suite-instruction.ts
@@ -5,8 +5,8 @@ export interface SuiteInstruction {
   qlpack?: string;
   query?: string;
   queries?: string;
-  include?: Record<string, string[]>;
-  exclude?: Record<string, string[]>;
+  include?: Record<string, string[]> | Record<string, string>;
+  exclude?: Record<string, string[]> | Record<string, string>;
   description?: string;
   import?: string;
   from?: string;