Improve type checking of test macros

src/codeql.test.ts

@@ -17,6 +17,7 @@ import {
   AugmentationProperties,
   generateCodeScanningConfig,
   defaultAugmentationProperties,
+  UserConfig,
 } from "./config/db-config";
 import type { Config } from "./config-utils";
 import * as defaults from "./defaults.json";
@@ -545,7 +546,7 @@ const injectedConfigMacro = test.macro({
     t: ExecutionContext<unknown>,
     augmentationProperties: AugmentationProperties,
     configOverride: Partial<Config>,
-    expectedConfig: any,
+    expectedConfig: UserConfig,
   ) => {
     await util.withTmpDir(async (tempDir) => {
       sinon.stub(actionsUtil, "isDefaultSetup").resolves(false);
@@ -590,19 +591,38 @@ const injectedConfigMacro = test.macro({
     `databaseInitCluster() injected config: ${providedTitle}`,
 });
 
-test.serial(
+/**
+ * Wraps `injectedConfigMacro` to improve type checking.
+ *
+ * When the macro is invoked directly, e.g. via `test.serial(macro, ...)`, the
+ * precise types of the arguments are erased.
+ */
+function testInjectedConfig(
+  title: string,
+  augmentationProperties: AugmentationProperties,
+  configOverride: Partial<Config>,
+  expectedConfig: UserConfig,
+) {
+  test.serial(
+    title,
+    injectedConfigMacro,
+    augmentationProperties,
+    configOverride,
+    expectedConfig,
+  );
+}
+
+testInjectedConfig(
   "basic",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
   },
   {},
   {},
 );
 
-test.serial(
+testInjectedConfig(
   "injected packs from input",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     packsInput: ["xxx", "yyy"],
@@ -613,9 +633,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected packs from input with existing packs combines",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     packsInputCombines: true,
@@ -635,9 +654,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected packs from input with existing packs overrides",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     packsInput: ["xxx", "yyy"],
@@ -655,9 +673,8 @@ test.serial(
 );
 
 // similar, but with queries
-test.serial(
+testInjectedConfig(
   "injected queries from input",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
@@ -675,9 +692,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected queries from input overrides",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
@@ -699,9 +715,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected queries from input combines",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: true,
@@ -727,9 +742,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected queries from input combines 2",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: true,
@@ -749,9 +763,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "injected queries and packs, but empty",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: true,
@@ -768,9 +781,8 @@ test.serial(
   {},
 );
 
-test.serial(
+testInjectedConfig(
   "repo property queries have the highest precedence",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: true,
@@ -790,9 +802,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "repo property queries combines with queries input",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: false,
@@ -817,9 +828,8 @@ test.serial(
   },
 );
 
-test.serial(
+testInjectedConfig(
   "repo property queries combines everything else",
-  injectedConfigMacro,
   {
     ...defaultAugmentationProperties,
     queriesInputCombines: true,