Skip to content

Commit 1764e3d

Browse files
committed
Use defaultAugmentationProperties in tests
Using defaultAugmentationProperties to generated expected test output eliminates the need to change individual tests when we add a new field to AugmentationProperties.
1 parent ef36b69 commit 1764e3d

File tree

2 files changed

+28
-53
lines changed

2 files changed

+28
-53
lines changed

src/codeql.test.ts

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@ import * as actionsUtil from "./actions-util";
1414
import { GitHubApiDetails } from "./api-client";
1515
import { CliError } from "./cli-errors";
1616
import * as codeql from "./codeql";
17-
import { AugmentationProperties, Config } from "./config-utils";
17+
import {
18+
AugmentationProperties,
19+
Config,
20+
defaultAugmentationProperties,
21+
} from "./config-utils";
1822
import * as defaults from "./defaults.json";
1923
import { DocUrl } from "./doc-url";
2024
import { FeatureEnablement } from "./feature-flags";
@@ -537,8 +541,7 @@ test(
537541
"basic",
538542
injectedConfigMacro,
539543
{
540-
queriesInputCombines: false,
541-
packsInputCombines: false,
544+
...defaultAugmentationProperties,
542545
},
543546
{},
544547
{},
@@ -548,8 +551,7 @@ test(
548551
"injected packs from input",
549552
injectedConfigMacro,
550553
{
551-
queriesInputCombines: false,
552-
packsInputCombines: false,
554+
...defaultAugmentationProperties,
553555
packsInput: ["xxx", "yyy"],
554556
},
555557
{},
@@ -562,7 +564,7 @@ test(
562564
"injected packs from input with existing packs combines",
563565
injectedConfigMacro,
564566
{
565-
queriesInputCombines: false,
567+
...defaultAugmentationProperties,
566568
packsInputCombines: true,
567569
packsInput: ["xxx", "yyy"],
568570
},
@@ -584,8 +586,7 @@ test(
584586
"injected packs from input with existing packs overrides",
585587
injectedConfigMacro,
586588
{
587-
queriesInputCombines: false,
588-
packsInputCombines: false,
589+
...defaultAugmentationProperties,
589590
packsInput: ["xxx", "yyy"],
590591
},
591592
{
@@ -605,8 +606,7 @@ test(
605606
"injected queries from input",
606607
injectedConfigMacro,
607608
{
608-
queriesInputCombines: false,
609-
packsInputCombines: false,
609+
...defaultAugmentationProperties,
610610
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
611611
},
612612
{},
@@ -626,8 +626,7 @@ test(
626626
"injected queries from input overrides",
627627
injectedConfigMacro,
628628
{
629-
queriesInputCombines: false,
630-
packsInputCombines: false,
629+
...defaultAugmentationProperties,
631630
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
632631
},
633632
{
@@ -651,8 +650,8 @@ test(
651650
"injected queries from input combines",
652651
injectedConfigMacro,
653652
{
653+
...defaultAugmentationProperties,
654654
queriesInputCombines: true,
655-
packsInputCombines: false,
656655
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
657656
},
658657
{
@@ -679,6 +678,7 @@ test(
679678
"injected queries from input combines 2",
680679
injectedConfigMacro,
681680
{
681+
...defaultAugmentationProperties,
682682
queriesInputCombines: true,
683683
packsInputCombines: true,
684684
queriesInput: [{ uses: "xxx" }, { uses: "yyy" }],
@@ -700,6 +700,7 @@ test(
700700
"injected queries and packs, but empty",
701701
injectedConfigMacro,
702702
{
703+
...defaultAugmentationProperties,
703704
queriesInputCombines: true,
704705
packsInputCombines: true,
705706
queriesInput: [],

src/config-utils.test.ts

Lines changed: 14 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -834,13 +834,8 @@ test(
834834
undefined,
835835
[Language.javascript],
836836
{
837-
queriesInputCombines: false,
838-
queriesInput: undefined,
839-
qualityQueriesInput: undefined,
840-
packsInputCombines: false,
841-
packsInput: undefined,
842-
defaultQueryFilters: [],
843-
} as configUtils.AugmentationProperties,
837+
...configUtils.defaultAugmentationProperties,
838+
},
844839
);
845840

846841
test(
@@ -851,13 +846,9 @@ test(
851846
undefined,
852847
[Language.javascript],
853848
{
854-
queriesInputCombines: false,
849+
...configUtils.defaultAugmentationProperties,
855850
queriesInput: [{ uses: "a" }, { uses: "b" }, { uses: "c" }, { uses: "d" }],
856-
qualityQueriesInput: undefined,
857-
packsInputCombines: false,
858-
packsInput: undefined,
859-
defaultQueryFilters: [],
860-
} as configUtils.AugmentationProperties,
851+
},
861852
);
862853

863854
test(
@@ -868,13 +859,10 @@ test(
868859
undefined,
869860
[Language.javascript],
870861
{
862+
...configUtils.defaultAugmentationProperties,
871863
queriesInputCombines: true,
872864
queriesInput: [{ uses: "a" }, { uses: "b" }, { uses: "c" }, { uses: "d" }],
873-
qualityQueriesInput: undefined,
874-
packsInputCombines: false,
875-
packsInput: undefined,
876-
defaultQueryFilters: [],
877-
} as configUtils.AugmentationProperties,
865+
},
878866
);
879867

880868
test(
@@ -885,18 +873,14 @@ test(
885873
" a, b , c, d",
886874
[Language.javascript],
887875
{
888-
queriesInputCombines: false,
889-
queriesInput: undefined,
876+
...configUtils.defaultAugmentationProperties,
890877
qualityQueriesInput: [
891878
{ uses: "a" },
892879
{ uses: "b" },
893880
{ uses: "c" },
894881
{ uses: "d" },
895882
],
896-
packsInputCombines: false,
897-
packsInput: undefined,
898-
defaultQueryFilters: [],
899-
} as configUtils.AugmentationProperties,
883+
},
900884
);
901885

902886
test(
@@ -907,18 +891,15 @@ test(
907891
"e, f , g,h",
908892
[Language.javascript],
909893
{
910-
queriesInputCombines: false,
894+
...configUtils.defaultAugmentationProperties,
911895
queriesInput: [{ uses: "a" }, { uses: "b" }, { uses: "c" }, { uses: "d" }],
912896
qualityQueriesInput: [
913897
{ uses: "e" },
914898
{ uses: "f" },
915899
{ uses: "g" },
916900
{ uses: "h" },
917901
],
918-
packsInputCombines: false,
919-
packsInput: undefined,
920-
defaultQueryFilters: [],
921-
} as configUtils.AugmentationProperties,
902+
},
922903
);
923904

924905
test(
@@ -929,13 +910,9 @@ test(
929910
undefined,
930911
[Language.javascript],
931912
{
932-
queriesInputCombines: false,
933-
queriesInput: undefined,
934-
qualityQueriesInput: undefined,
935-
packsInputCombines: false,
913+
...configUtils.defaultAugmentationProperties,
936914
packsInput: ["codeql/a", "codeql/b", "codeql/c", "codeql/d"],
937-
defaultQueryFilters: [],
938-
} as configUtils.AugmentationProperties,
915+
},
939916
);
940917

941918
test(
@@ -946,13 +923,10 @@ test(
946923
undefined,
947924
[Language.javascript],
948925
{
949-
queriesInputCombines: false,
950-
queriesInput: undefined,
951-
qualityQueriesInput: undefined,
926+
...configUtils.defaultAugmentationProperties,
952927
packsInputCombines: true,
953928
packsInput: ["codeql/a", "codeql/b", "codeql/c", "codeql/d"],
954-
defaultQueryFilters: [],
955-
} as configUtils.AugmentationProperties,
929+
},
956930
);
957931

958932
const calculateAugmentationErrorMacro = test.macro({

0 commit comments

Comments
 (0)