apify-test-tools 0.10.2-beta.7 → 0.10.2-beta.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. package/.github/actions/checkout-restore-dependencies/action.yaml +13 -0
  2. package/.github/cli/apify-test-tools.mjs +1 -1
  3. package/.github/scripts/check-major-tag-refs.mjs +1 -1
  4. package/.github/scripts/mask-config-secrets.sh +17 -0
  5. package/.github/scripts/run-with-apify-tokens.mjs +36 -11
  6. package/.github/workflows/public_platform-tests-claude-investigate-and-fix.yaml +6 -2
  7. package/.github/workflows/public_platform-tests.yaml +23 -0
  8. package/.github/workflows/public_pr-build-test.yaml +30 -1
  9. package/.github/workflows/public_push-build-latest.yaml +20 -3
  10. package/CHANGELOG.md +1 -0
  11. package/CONTRIBUTING.md +99 -8
  12. package/README.md +218 -699
  13. package/bin/git.ts +1 -1
  14. package/dist/bin/git.js +1 -1
  15. package/dist/bin/git.js.map +1 -1
  16. package/dist/lib/extend-expect.d.ts.map +1 -1
  17. package/dist/lib/extend-expect.js +37 -218
  18. package/dist/lib/extend-expect.js.map +1 -1
  19. package/dist/lib/lib.d.ts +1 -2
  20. package/dist/lib/lib.d.ts.map +1 -1
  21. package/dist/lib/lib.js +15 -22
  22. package/dist/lib/lib.js.map +1 -1
  23. package/dist/lib/run-checks.d.ts +14 -0
  24. package/dist/lib/run-checks.d.ts.map +1 -0
  25. package/dist/lib/run-checks.js +82 -0
  26. package/dist/lib/run-checks.js.map +1 -0
  27. package/dist/lib/run-test-result.d.ts +3 -6
  28. package/dist/lib/run-test-result.d.ts.map +1 -1
  29. package/dist/lib/run-test-result.js +41 -54
  30. package/dist/lib/run-test-result.js.map +1 -1
  31. package/dist/test/unit/github-scripts/mask-config-secrets.test.d.ts +2 -0
  32. package/dist/test/unit/github-scripts/mask-config-secrets.test.d.ts.map +1 -0
  33. package/dist/test/unit/github-scripts/mask-config-secrets.test.js +50 -0
  34. package/dist/test/unit/github-scripts/mask-config-secrets.test.js.map +1 -0
  35. package/dist/test/unit/github-scripts/run-with-apify-tokens.test.d.ts +2 -0
  36. package/dist/test/unit/github-scripts/run-with-apify-tokens.test.d.ts.map +1 -0
  37. package/dist/test/unit/github-scripts/run-with-apify-tokens.test.js +102 -0
  38. package/dist/test/unit/github-scripts/run-with-apify-tokens.test.js.map +1 -0
  39. package/dist/test/unit/run-checks.test.d.ts +2 -0
  40. package/dist/test/unit/run-checks.test.d.ts.map +1 -0
  41. package/dist/test/unit/run-checks.test.js +62 -0
  42. package/dist/test/unit/run-checks.test.js.map +1 -0
  43. package/dist/test/unit/run-test-result.test.d.ts +2 -0
  44. package/dist/test/unit/run-test-result.test.d.ts.map +1 -0
  45. package/dist/test/unit/run-test-result.test.js +34 -0
  46. package/dist/test/unit/run-test-result.test.js.map +1 -0
  47. package/dist/tsconfig.tsbuildinfo +1 -1
  48. package/docs/cli.md +358 -0
  49. package/docs/lib.md +271 -0
  50. package/docs/workflows.md +366 -0
  51. package/lib/extend-expect.ts +48 -258
  52. package/lib/lib.ts +24 -28
  53. package/lib/run-checks.ts +101 -0
  54. package/lib/run-test-result.ts +45 -55
  55. package/package.json +1 -1
  56. package/test/unit/github-scripts/mask-config-secrets.test.ts +61 -0
  57. package/test/unit/github-scripts/run-with-apify-tokens.test.ts +115 -0
  58. package/test/unit/run-checks.test.ts +76 -0
  59. package/test/unit/run-test-result.test.ts +44 -0
@@ -3,18 +3,15 @@ import type { Dataset, SdkCrawlerStatistics } from './types.js';
3
3
  export declare class RunTestResult {
4
4
  private readonly apifyClient;
5
5
  private readonly run;
6
- private log;
7
- private dataset;
8
- private keyValueStoreClient;
9
- private statistics;
10
- private runInfo;
11
- private input;
12
6
  constructor(apifyClient: ApifyClient, run: ActorRun);
13
7
  getStatistics: () => Promise<SdkCrawlerStatistics | undefined>;
14
8
  getLog: () => Promise<string>;
9
+ private readonly datasetItems;
15
10
  getDataset: <T>() => Promise<Dataset<T>>;
16
11
  getKeyValueStoreClient: () => KeyValueStoreClient;
12
+ private readonly inputRecord;
17
13
  getInput: <T>() => Promise<T>;
14
+ /** Fetches the run again, so unlike `id` and `status` it also reflects what changed after the run finished. */
18
15
  getRunInfo: () => Promise<ActorRun>;
19
16
  get id(): string;
20
17
  get status(): string;
@@ -1 +1 @@
1
- {"version":3,"file":"run-test-result.d.ts","sourceRoot":"","sources":["../../lib/run-test-result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAE/E,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAEhE,qBAAa,aAAa;IASlB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,GAAG;IATxB,OAAO,CAAC,GAAG,CAAqB;IAChC,OAAO,CAAC,OAAO,CAA+B;IAC9C,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,UAAU,CAAmC;IACrD,OAAO,CAAC,OAAO,CAAuB;IACtC,OAAO,CAAC,KAAK,CAAsB;gBAGd,WAAW,EAAE,WAAW,EACxB,GAAG,EAAE,QAAQ;IAKlC,aAAa,QAAa,OAAO,CAAC,oBAAoB,GAAG,SAAS,CAAC,CAQjE;IAEF,MAAM,QAAa,OAAO,CAAC,MAAM,CAAC,CAOhC;IAEF,UAAU,GAAU,CAAC,OAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAQ3C;IAEF,sBAAsB,QAAO,mBAAmB,CAO9C;IAEF,QAAQ,GAAU,CAAC,OAAK,OAAO,CAAC,CAAC,CAAC,CAQhC;IAEF,UAAU,QAAa,OAAO,CAAC,QAAQ,CAAC,CAOtC;IAEF,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;CACJ"}
1
+ {"version":3,"file":"run-test-result.d.ts","sourceRoot":"","sources":["../../lib/run-test-result.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAE/E,OAAO,KAAK,EAAE,OAAO,EAAE,oBAAoB,EAAE,MAAM,YAAY,CAAC;AAoBhE,qBAAa,aAAa;IAElB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,GAAG;gBADH,WAAW,EAAE,WAAW,EACxB,GAAG,EAAE,QAAQ;IAKlC,aAAa,kDAGV;IAEH,MAAM,wBAEH;IAEH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAU1B;IAEH,UAAU,GAAU,CAAC,OAAK,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAoD;IAEjG,sBAAsB,QAAO,mBAAmB,CAE9C;IAEF,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAqF;IAEjH,QAAQ,GAAU,CAAC,OAAK,OAAO,CAAC,CAAC,CAAC,CAAoC;IAEtE,+GAA+G;IAC/G,UAAU,0BAEP;IAEH,IAAI,EAAE,IAAI,MAAM,CAEf;IAED,IAAI,MAAM,IAAI,MAAM,CAEnB;CACJ"}
@@ -1,68 +1,55 @@
1
+ /** Items fetched per request, so no single response can exceed Node's string limit on large datasets. */
2
+ const DATASET_PAGE_SIZE = 1000;
3
+ /**
4
+ * Runs `fn` at most once and shares its promise, so repeated and concurrent calls are one request.
5
+ * A failure is not cached, the next call retries.
6
+ */
7
+ const once = (fn) => {
8
+ let promise;
9
+ return async () => {
10
+ promise ??= fn().catch((error) => {
11
+ promise = undefined;
12
+ throw error;
13
+ });
14
+ return promise;
15
+ };
16
+ };
1
17
  export class RunTestResult {
2
18
  apifyClient;
3
19
  run;
4
- log;
5
- dataset;
6
- keyValueStoreClient;
7
- statistics;
8
- runInfo;
9
- input;
10
20
  constructor(apifyClient, run) {
11
21
  this.apifyClient = apifyClient;
12
22
  this.run = run;
13
23
  /**/
14
24
  }
15
- getStatistics = async () => {
16
- if (this.statistics) {
17
- return this.statistics;
18
- }
19
- const kvs = this.apifyClient.keyValueStore(this.run.defaultKeyValueStoreId);
20
- const stats = await kvs.getRecord('SDK_CRAWLER_STATISTICS_0');
21
- this.statistics = stats?.value;
22
- return this.statistics;
23
- };
24
- getLog = async () => {
25
- if (this.log) {
26
- return this.log;
27
- }
28
- const runLog = await this.apifyClient.run(this.id).log().get();
29
- this.log = runLog;
30
- return runLog;
31
- };
32
- getDataset = async () => {
33
- if (this.dataset) {
34
- return this.dataset;
35
- }
25
+ getStatistics = once(async () => {
26
+ const record = await this.getKeyValueStoreClient().getRecord('SDK_CRAWLER_STATISTICS_0');
27
+ return record?.value;
28
+ });
29
+ getLog = once(async () => {
30
+ return (await this.apifyClient.run(this.id).log().get());
31
+ });
32
+ datasetItems = once(async () => {
36
33
  const dataset = this.apifyClient.dataset(this.run.defaultDatasetId);
37
- const items = (await dataset.listItems()).items;
38
- this.dataset = { items };
39
- return this.dataset;
40
- };
41
- getKeyValueStoreClient = () => {
42
- if (this.keyValueStoreClient) {
43
- return this.keyValueStoreClient;
44
- }
45
- const keyValueStoreClient = this.apifyClient.keyValueStore(this.run.defaultKeyValueStoreId);
46
- this.keyValueStoreClient = keyValueStoreClient;
47
- return keyValueStoreClient;
48
- };
49
- getInput = async () => {
50
- if (this.input) {
51
- return this.input;
34
+ const items = [];
35
+ for (;;) {
36
+ const page = await dataset.listItems({ offset: items.length, limit: DATASET_PAGE_SIZE });
37
+ items.push(...page.items);
38
+ if (page.items.length === 0 || items.length >= page.total) {
39
+ return items;
40
+ }
52
41
  }
53
- const kvs = this.apifyClient.keyValueStore(this.run.defaultKeyValueStoreId);
54
- const input = await kvs.getRecord('INPUT');
55
- this.input = input?.value;
56
- return this.input;
57
- };
58
- getRunInfo = async () => {
59
- if (this.runInfo) {
60
- return this.runInfo;
61
- }
62
- const run = this.apifyClient.run(this.run.id);
63
- this.runInfo = await run.get();
64
- return this.runInfo;
42
+ });
43
+ getDataset = async () => ({ items: (await this.datasetItems()) });
44
+ getKeyValueStoreClient = () => {
45
+ return this.apifyClient.keyValueStore(this.run.defaultKeyValueStoreId);
65
46
  };
47
+ inputRecord = once(async () => (await this.getKeyValueStoreClient().getRecord('INPUT'))?.value);
48
+ getInput = async () => (await this.inputRecord());
49
+ /** Fetches the run again, so unlike `id` and `status` it also reflects what changed after the run finished. */
50
+ getRunInfo = once(async () => {
51
+ return (await this.apifyClient.run(this.run.id).get());
52
+ });
66
53
  get id() {
67
54
  return this.run.id;
68
55
  }
@@ -1 +1 @@
1
- {"version":3,"file":"run-test-result.js","sourceRoot":"","sources":["../../lib/run-test-result.ts"],"names":[],"mappings":"AAIA,MAAM,OAAO,aAAa;IASD;IACA;IATb,GAAG,CAAqB;IACxB,OAAO,CAA+B;IACtC,mBAAmB,CAAkC;IACrD,UAAU,CAAmC;IAC7C,OAAO,CAAuB;IAC9B,KAAK,CAAsB;IAEnC,YACqB,WAAwB,EACxB,GAAa;QADb,gBAAW,GAAX,WAAW,CAAa;QACxB,QAAG,GAAH,GAAG,CAAU;QAE9B,IAAI;IACR,CAAC;IAED,aAAa,GAAG,KAAK,IAA+C,EAAE;QAClE,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAClB,OAAO,IAAI,CAAC,UAAU,CAAC;QAC3B,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QAC9D,IAAI,CAAC,UAAU,GAAG,KAAK,EAAE,KAAwC,CAAC;QAClE,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC,CAAC;IAEF,MAAM,GAAG,KAAK,IAAqB,EAAE;QACjC,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACX,OAAO,IAAI,CAAC,GAAG,CAAC;QACpB,CAAC;QACD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAC;QAC/D,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC;QAClB,OAAO,MAAgB,CAAC;IAC5B,CAAC,CAAC;IAEF,UAAU,GAAG,KAAK,IAA4B,EAAE;QAC5C,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,OAAqB,CAAC;QACtC,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE,CAAC,CAAC,KAAY,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,EAAE,KAAK,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,OAAqB,CAAC;IACtC,CAAC,CAAC;IAEF,sBAAsB,GAAG,GAAwB,EAAE;QAC/C,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;QACpC,CAAC;QACD,MAAM,mBAAmB,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAC5F,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAC;QAC/C,OAAO,mBAAmB,CAAC;IAC/B,CAAC,CAAC;IAEF,QAAQ,GAAG,KAAK,IAAmB,EAAE;QACjC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YACb,OAAO,IAAI,CAAC,KAAU,CAAC;QAC3B,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;QAC5E,MAAM,KAAK,GAAG,MAAM,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAC3C,IAAI,CAAC,KAAK,GAAG,KAAK,EAAE,KAAK,CAAC;QAC1B,OAAO,IAAI,CAAC,KAAU,CAAC;IAC3B,CAAC,CAAC;IAEF,UAAU,GAAG,KAAK,IAAuB,EAAE;QACvC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YACf,OAAO,IAAI,CAAC,OAAO,CAAC;QACxB,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC9C,IAAI,CAAC,OAAO,GAAG,MAAM,GAAG,CAAC,GAAG,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC,OAAQ,CAAC;IACzB,CAAC,CAAC;IAEF,IAAI,EAAE;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IAC3B,CAAC;CACJ"}
1
+ {"version":3,"file":"run-test-result.js","sourceRoot":"","sources":["../../lib/run-test-result.ts"],"names":[],"mappings":"AAIA,yGAAyG;AACzG,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAE/B;;;GAGG;AACH,MAAM,IAAI,GAAG,CAAI,EAAoB,EAAsB,EAAE;IACzD,IAAI,OAA+B,CAAC;IACpC,OAAO,KAAK,IAAI,EAAE;QACd,OAAO,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;YAC7B,OAAO,GAAG,SAAS,CAAC;YACpB,MAAM,KAAK,CAAC;QAChB,CAAC,CAAC,CAAC;QACH,OAAO,OAAO,CAAC;IACnB,CAAC,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,OAAO,aAAa;IAED;IACA;IAFrB,YACqB,WAAwB,EACxB,GAAa;QADb,gBAAW,GAAX,WAAW,CAAa;QACxB,QAAG,GAAH,GAAG,CAAU;QAE9B,IAAI;IACR,CAAC;IAED,aAAa,GAAG,IAAI,CAAC,KAAK,IAA+C,EAAE;QACvE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC,SAAS,CAAC,0BAA0B,CAAC,CAAC;QACzF,OAAO,MAAM,EAAE,KAAyC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,MAAM,GAAG,IAAI,CAAC,KAAK,IAAqB,EAAE;QACtC,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,EAAE,CAAW,CAAC;IACvE,CAAC,CAAC,CAAC;IAEc,YAAY,GAAG,IAAI,CAAC,KAAK,IAAwB,EAAE;QAChE,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAC;QACpE,MAAM,KAAK,GAAc,EAAE,CAAC;QAC5B,SAAS,CAAC;YACN,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,CAAC,CAAC;YACzF,KAAK,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACxD,OAAO,KAAK,CAAC;YACjB,CAAC;QACL,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,UAAU,GAAG,KAAK,IAA4B,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,MAAM,IAAI,CAAC,YAAY,EAAE,CAAQ,EAAE,CAAC,CAAC;IAEjG,sBAAsB,GAAG,GAAwB,EAAE;QAC/C,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,CAAC;IAC3E,CAAC,CAAC;IAEe,WAAW,GAAG,IAAI,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,sBAAsB,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC;IAEjH,QAAQ,GAAG,KAAK,IAAmB,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAM,CAAC;IAEtE,+GAA+G;IAC/G,UAAU,GAAG,IAAI,CAAC,KAAK,IAAuB,EAAE;QAC5C,OAAO,CAAC,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,EAAE,CAAE,CAAC;IAC5D,CAAC,CAAC,CAAC;IAEH,IAAI,EAAE;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;IACvB,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;IAC3B,CAAC;CACJ"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=mask-config-secrets.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mask-config-secrets.test.d.ts","sourceRoot":"","sources":["../../../../test/unit/github-scripts/mask-config-secrets.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,50 @@
1
+ import { spawnSync } from 'node:child_process';
2
+ import process from 'node:process';
3
+ import { fileURLToPath } from 'node:url';
4
+ import { describe, expect, it } from 'vitest';
5
+ const SCRIPT = fileURLToPath(new URL('../../../.github/scripts/mask-config-secrets.sh', import.meta.url));
6
+ const run = (configSecrets) => spawnSync('bash', [SCRIPT], {
7
+ encoding: 'utf8',
8
+ env: { PATH: process.env.PATH, ...(configSecrets === undefined ? {} : { CONFIG_SECRETS: configSecrets }) },
9
+ });
10
+ const masks = (stdout) => stdout.split('\n').filter((line) => line !== '');
11
+ describe('mask-config-secrets.sh', () => {
12
+ it('registers every value as a mask', () => {
13
+ const { status, stdout, stderr } = run(JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' }));
14
+ expect(status, stderr).toBe(0);
15
+ expect(masks(stdout)).toStrictEqual(['::add-mask::one', '::add-mask::two']);
16
+ });
17
+ it('registers a multi-line value line by line, skipping empty lines', () => {
18
+ const { status, stdout, stderr } = run(JSON.stringify({ DEPLOY_KEY: '-----BEGIN KEY-----\nabc\n\n-----END KEY-----\n' }));
19
+ expect(status, stderr).toBe(0);
20
+ expect(masks(stdout)).toStrictEqual([
21
+ '::add-mask::-----BEGIN KEY-----',
22
+ '::add-mask::abc',
23
+ '::add-mask::-----END KEY-----',
24
+ ]);
25
+ });
26
+ it('skips values that are not strings', () => {
27
+ const { status, stdout, stderr } = run(JSON.stringify({ TOKEN_ONE: 'one', COUNT: 1 }));
28
+ expect(status, stderr).toBe(0);
29
+ expect(masks(stdout)).toStrictEqual(['::add-mask::one']);
30
+ });
31
+ it.each([
32
+ ['is unset', undefined],
33
+ ['is empty', ''],
34
+ ])('does nothing when CONFIG_SECRETS %s', (_, configSecrets) => {
35
+ const { status, stdout, stderr } = run(configSecrets);
36
+ expect(status, stderr).toBe(0);
37
+ expect(stdout).toBe('');
38
+ });
39
+ it.each([
40
+ ['is not JSON', 'apify_api_xyzzy'],
41
+ ['is a JSON string', '"apify_api_xyzzy"'],
42
+ ['is a JSON array', '["apify_api_xyzzy"]'],
43
+ ])('fails without printing the value when the secret %s', (_, configSecrets) => {
44
+ const { status, stdout, stderr } = run(configSecrets);
45
+ expect(status).toBe(1);
46
+ expect(stdout).toContain('::error::The CONFIG_SECRETS secret must be a JSON object.');
47
+ expect(stdout + stderr).not.toContain('xyzzy');
48
+ });
49
+ });
50
+ //# sourceMappingURL=mask-config-secrets.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mask-config-secrets.test.js","sourceRoot":"","sources":["../../../../test/unit/github-scripts/mask-config-secrets.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,iDAAiD,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE1G,MAAM,GAAG,GAAG,CAAC,aAAsB,EAAE,EAAE,CACnC,SAAS,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE;IACxB,QAAQ,EAAE,MAAM;IAChB,GAAG,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,aAAa,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC,EAAE;CAC7G,CAAC,CAAC;AAEP,MAAM,KAAK,GAAG,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;AAEnF,QAAQ,CAAC,wBAAwB,EAAE,GAAG,EAAE;IACpC,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACvC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/F,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,iBAAiB,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,GAAG,EAAE;QACvE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAClC,IAAI,CAAC,SAAS,CAAC,EAAE,UAAU,EAAE,iDAAiD,EAAE,CAAC,CACpF,CAAC;QACF,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC;YAChC,iCAAiC;YACjC,iBAAiB;YACjB,+BAA+B;SAClC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACzC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;QACvF,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACJ,CAAC,UAAU,EAAE,SAAS,CAAC;QACvB,CAAC,UAAU,EAAE,EAAE,CAAC;KACnB,CAAC,CAAC,qCAAqC,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,EAAE;QAC3D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAC5B,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACJ,CAAC,aAAa,EAAE,iBAAiB,CAAC;QAClC,CAAC,kBAAkB,EAAE,mBAAmB,CAAC;QACzC,CAAC,iBAAiB,EAAE,qBAAqB,CAAC;KAC7C,CAAC,CAAC,qDAAqD,EAAE,CAAC,CAAC,EAAE,aAAa,EAAE,EAAE;QAC3E,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,2DAA2D,CAAC,CAAC;QACtF,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=run-with-apify-tokens.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-with-apify-tokens.test.d.ts","sourceRoot":"","sources":["../../../../test/unit/github-scripts/run-with-apify-tokens.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,102 @@
1
+ import { spawnSync } from 'node:child_process';
2
+ import { mkdtemp, rm, writeFile } from 'node:fs/promises';
3
+ import os from 'node:os';
4
+ import path from 'node:path';
5
+ import process from 'node:process';
6
+ import { fileURLToPath } from 'node:url';
7
+ import { afterAll, beforeAll, describe, expect, it } from 'vitest';
8
+ const SCRIPT = fileURLToPath(new URL('../../../.github/scripts/run-with-apify-tokens.mjs', import.meta.url));
9
+ // Three Actors, each with its own token, so a test can leave any of them out.
10
+ const CONFIG = {
11
+ actors: [
12
+ { actorFullName: 'team/one', tokenEnvVar: 'TOKEN_ONE' },
13
+ { actorFullName: 'team/two', tokenEnvVar: 'TOKEN_TWO' },
14
+ { actorFullName: 'team/three', tokenEnvVar: 'TOKEN_THREE' },
15
+ ],
16
+ };
17
+ // The command the wrapper runs prints what it was handed, so a test sees exactly what got through.
18
+ const PRINT_ENV = `console.log(JSON.stringify({
19
+ TOKEN_ONE: process.env.TOKEN_ONE,
20
+ TOKEN_TWO: process.env.TOKEN_TWO,
21
+ TOKEN_THREE: process.env.TOKEN_THREE,
22
+ NPM_TOKEN: process.env.NPM_TOKEN,
23
+ WORKFLOW_SECRETS: process.env.WORKFLOW_SECRETS,
24
+ }))`;
25
+ let cwd;
26
+ // `workflowSecrets` is what the step's `toJSON(secrets)` holds inside the reusable workflow.
27
+ const run = (workflowSecrets) => {
28
+ const result = spawnSync(process.execPath, [SCRIPT, process.execPath, '-e', PRINT_ENV], {
29
+ cwd,
30
+ encoding: 'utf8',
31
+ env: { PATH: process.env.PATH, WORKFLOW_SECRETS: JSON.stringify(workflowSecrets) },
32
+ });
33
+ return { ...result, env: result.status === 0 ? JSON.parse(result.stdout) : undefined };
34
+ };
35
+ describe('run-with-apify-tokens.mjs', () => {
36
+ beforeAll(async () => {
37
+ cwd = await mkdtemp(path.join(os.tmpdir(), 'run-with-apify-tokens-'));
38
+ await writeFile(path.join(cwd, 'apify-test-tools.config.json'), JSON.stringify(CONFIG));
39
+ });
40
+ afterAll(async () => {
41
+ await rm(cwd, { recursive: true, force: true });
42
+ });
43
+ it('passes on inherited secrets, as `secrets: inherit` sends them', () => {
44
+ const { status, stderr, env } = run({
45
+ TOKEN_ONE: 'one',
46
+ TOKEN_TWO: 'two',
47
+ TOKEN_THREE: 'three',
48
+ NPM_TOKEN: 'npm',
49
+ });
50
+ expect(status, stderr).toBe(0);
51
+ expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
52
+ });
53
+ it('unpacks the tokens from the CONFIG_SECRETS secret', () => {
54
+ const { status, stderr, env } = run({
55
+ CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' }),
56
+ NPM_TOKEN: 'npm',
57
+ });
58
+ expect(status, stderr).toBe(0);
59
+ expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
60
+ });
61
+ it('passes on only the config names when CONFIG_SECRETS holds every secret of the caller', () => {
62
+ const { status, stderr, env } = run({
63
+ CONFIG_SECRETS: JSON.stringify({
64
+ TOKEN_ONE: 'one',
65
+ TOKEN_TWO: 'two',
66
+ TOKEN_THREE: 'three',
67
+ NPM_TOKEN: 'npm',
68
+ github_token: 'gh',
69
+ }),
70
+ });
71
+ expect(status, stderr).toBe(0);
72
+ expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
73
+ });
74
+ it('prefers CONFIG_SECRETS over an inherited secret of the same name', () => {
75
+ const { status, stderr, env } = run({
76
+ CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'from-config-secrets' }),
77
+ TOKEN_ONE: 'inherited',
78
+ TOKEN_TWO: 'inherited',
79
+ });
80
+ expect(status, stderr).toBe(0);
81
+ expect(env).toStrictEqual({ TOKEN_ONE: 'from-config-secrets', TOKEN_TWO: 'inherited' });
82
+ });
83
+ it('warns about a token the config declares but nothing passes, and runs anyway', () => {
84
+ const { status, stderr, env } = run({
85
+ CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' }),
86
+ });
87
+ expect(status, stderr).toBe(0);
88
+ expect(stderr).toContain('declares TOKEN_THREE, but no such secret was passed');
89
+ expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' });
90
+ });
91
+ it.each([
92
+ ['is not JSON', 'apify_api_xyzzy', 'The CONFIG_SECRETS secret is not valid JSON.'],
93
+ ['is a JSON string', '"apify_api_xyzzy"', 'The CONFIG_SECRETS secret must be a JSON object.'],
94
+ ['is a JSON array', '["apify_api_xyzzy"]', 'The CONFIG_SECRETS secret must be a JSON object.'],
95
+ ])('fails without printing the value when CONFIG_SECRETS %s', (_, packed, message) => {
96
+ const { status, stdout, stderr } = run({ CONFIG_SECRETS: packed });
97
+ expect(status).toBe(1);
98
+ expect(stderr).toContain(message);
99
+ expect(stdout + stderr).not.toContain('xyzzy');
100
+ });
101
+ });
102
+ //# sourceMappingURL=run-with-apify-tokens.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-with-apify-tokens.test.js","sourceRoot":"","sources":["../../../../test/unit/github-scripts/run-with-apify-tokens.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAC/C,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC1D,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,OAAO,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAEzC,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAEnE,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,oDAAoD,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAE7G,8EAA8E;AAC9E,MAAM,MAAM,GAAG;IACX,MAAM,EAAE;QACJ,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE;QACvD,EAAE,aAAa,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,EAAE;QACvD,EAAE,aAAa,EAAE,YAAY,EAAE,WAAW,EAAE,aAAa,EAAE;KAC9D;CACJ,CAAC;AAEF,mGAAmG;AACnG,MAAM,SAAS,GAAG;;;;;;IAMd,CAAC;AAEL,IAAI,GAAW,CAAC;AAEhB,6FAA6F;AAC7F,MAAM,GAAG,GAAG,CAAC,eAAuC,EAAE,EAAE;IACpD,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,QAAQ,EAAE,IAAI,EAAE,SAAS,CAAC,EAAE;QACpF,GAAG;QACH,QAAQ,EAAE,MAAM;QAChB,GAAG,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,gBAAgB,EAAE,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,EAAE;KACrF,CAAC,CAAC;IACH,OAAO,EAAE,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,SAAS,EAAE,CAAC;AAC3F,CAAC,CAAC;AAEF,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;IACvC,SAAS,CAAC,KAAK,IAAI,EAAE;QACjB,GAAG,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,EAAE,wBAAwB,CAAC,CAAC,CAAC;QACtE,MAAM,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,8BAA8B,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAChB,MAAM,EAAE,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;QACrE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;YAChC,SAAS,EAAE,KAAK;YAChB,SAAS,EAAE,KAAK;YAChB,WAAW,EAAE,OAAO;YACpB,SAAS,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;QACzD,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;YAChC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC;YAC5F,SAAS,EAAE,KAAK;SACnB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sFAAsF,EAAE,GAAG,EAAE;QAC5F,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;YAChC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC;gBAC3B,SAAS,EAAE,KAAK;gBAChB,SAAS,EAAE,KAAK;gBAChB,WAAW,EAAE,OAAO;gBACpB,SAAS,EAAE,KAAK;gBAChB,YAAY,EAAE,IAAI;aACrB,CAAC;SACL,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,kEAAkE,EAAE,GAAG,EAAE;QACxE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;YAChC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,qBAAqB,EAAE,CAAC;YACpE,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;SACzB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,qBAAqB,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACnF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,CAAC;YAChC,cAAc,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC;SACzE,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC/B,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,qDAAqD,CAAC,CAAC;QAChF,MAAM,CAAC,GAAG,CAAC,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACJ,CAAC,aAAa,EAAE,iBAAiB,EAAE,8CAA8C,CAAC;QAClF,CAAC,kBAAkB,EAAE,mBAAmB,EAAE,kDAAkD,CAAC;QAC7F,CAAC,iBAAiB,EAAE,qBAAqB,EAAE,kDAAkD,CAAC;KACjG,CAAC,CAAC,yDAAyD,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,EAAE;QACjF,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,GAAG,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAC;QACnE,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACvB,MAAM,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=run-checks.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-checks.test.d.ts","sourceRoot":"","sources":["../../../test/unit/run-checks.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,62 @@
1
+ import { describe, expect, it } from 'vitest';
2
+ import { checkRun } from '../../lib/run-checks.js';
3
+ const fakeRun = (overrides = {}) => ({
4
+ status: overrides.status ?? 'SUCCEEDED',
5
+ getRunInfo: async () => ({
6
+ stats: { durationMillis: 5_000 },
7
+ chargedEventCounts: overrides.chargedEventCounts,
8
+ }),
9
+ getDataset: async () => ({ items: new Array(10) }),
10
+ getStatistics: async () => ({
11
+ requestsFailed: 0,
12
+ requestsRetries: 1,
13
+ requestRetryHistogram: [5, 1],
14
+ ...overrides.stats,
15
+ }),
16
+ getLog: async () => overrides.log ?? 'all good',
17
+ });
18
+ const failures = async (run, options) => (await checkRun(run, options)).filter(({ pass }) => !pass).map(({ name }) => name);
19
+ describe('checkRun()', () => {
20
+ it('passes a run matching the defaults', async () => {
21
+ expect(await failures(fakeRun(), { datasetItemCount: 10 })).toEqual([]);
22
+ });
23
+ it('reports every failing check at once', async () => {
24
+ const run = fakeRun({ status: 'FAILED', log: 'TypeError: x', stats: { requestsFailed: 2 } });
25
+ expect(await failures(run, { datasetItemCount: { min: 11 } })).toEqual([
26
+ 'status',
27
+ 'datasetItemCount',
28
+ 'failedRequests',
29
+ 'forbiddenLogs',
30
+ ]);
31
+ });
32
+ it('disables a check with null', async () => {
33
+ const run = fakeRun({ stats: { requestsFailed: 2 } });
34
+ expect(await failures(run, { datasetItemCount: 10, failedRequests: null })).toEqual([]);
35
+ });
36
+ it('treats explicitly undefined options as disabled checks', async () => {
37
+ const options = { datasetItemCount: 10, duration: undefined, maxRetriesPerRequest: undefined };
38
+ expect(await failures(fakeRun(), options)).toEqual([]);
39
+ });
40
+ it('checks the longest retry chain only when asked to', async () => {
41
+ expect(await failures(fakeRun(), { datasetItemCount: 10, maxRetriesPerRequest: 0 })).toEqual([
42
+ 'maxRetriesPerRequest',
43
+ ]);
44
+ expect(await failures(fakeRun(), { datasetItemCount: 10, maxRetriesPerRequest: 1 })).toEqual([]);
45
+ });
46
+ describe('chargedEventCounts', () => {
47
+ const run = fakeRun({ chargedEventCounts: { start: 1, item: 7 } });
48
+ it('passes matching counts and intervals', async () => {
49
+ const options = { datasetItemCount: 10, chargedEventCounts: { start: 1, item: { min: 5 } } };
50
+ expect(await failures(run, options)).toEqual([]);
51
+ });
52
+ it('expects unlisted charged events to not happen', async () => {
53
+ const options = { datasetItemCount: 10, chargedEventCounts: { start: 1 } };
54
+ expect(await failures(run, options)).toEqual(['chargedEventCounts.item']);
55
+ });
56
+ it('fails an expected event that was never charged', async () => {
57
+ const options = { datasetItemCount: 10, chargedEventCounts: { start: 1, item: 7, extra: { min: 0 } } };
58
+ expect(await failures(run, options)).toEqual(['chargedEventCounts.extra']);
59
+ });
60
+ });
61
+ });
62
+ //# sourceMappingURL=run-checks.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-checks.test.js","sourceRoot":"","sources":["../../../test/unit/run-checks.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAE9C,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AAGnD,MAAM,OAAO,GAAG,CAAC,YAA4F,EAAE,EAAE,EAAE,CAC/G,CAAC;IACG,MAAM,EAAE,SAAS,CAAC,MAAM,IAAI,WAAW;IACvC,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;QACrB,KAAK,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE;QAChC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;KACnD,CAAC;IACF,UAAU,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;IAClD,aAAa,EAAE,KAAK,IAAI,EAAE,CAAC,CAAC;QACxB,cAAc,EAAE,CAAC;QACjB,eAAe,EAAE,CAAC;QAClB,qBAAqB,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAC7B,GAAG,SAAS,CAAC,KAAK;KACrB,CAAC;IACF,MAAM,EAAE,KAAK,IAAI,EAAE,CAAC,SAAS,CAAC,GAAG,IAAI,UAAU;CAClD,CAA6B,CAAC;AAEnC,MAAM,QAAQ,GAAG,KAAK,EAAE,GAAkB,EAAE,OAAuC,EAAE,EAAE,CACnF,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;AAEvF,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IACxB,EAAE,CAAC,oCAAoC,EAAE,KAAK,IAAI,EAAE;QAChD,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qCAAqC,EAAE,KAAK,IAAI,EAAE;QACjD,MAAM,GAAG,GAAG,OAAO,CAAC,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,cAAc,EAAE,KAAK,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAC7F,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACnE,QAAQ;YACR,kBAAkB;YAClB,gBAAgB;YAChB,eAAe;SAClB,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,GAAG,GAAG,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,cAAc,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,cAAc,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,KAAK,IAAI,EAAE;QACpE,MAAM,OAAO,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,QAAQ,EAAE,SAAS,EAAE,oBAAoB,EAAE,SAAS,EAAE,CAAC;QAC/F,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,oBAAoB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;YACzF,sBAAsB;SACzB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,QAAQ,CAAC,OAAO,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,oBAAoB,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACrG,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAChC,MAAM,GAAG,GAAG,OAAO,CAAC,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;QAEnE,EAAE,CAAC,sCAAsC,EAAE,KAAK,IAAI,EAAE;YAClD,MAAM,OAAO,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;YAC7F,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;QACrD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,KAAK,IAAI,EAAE;YAC3D,MAAM,OAAO,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,EAA4B,EAAE,CAAC;YACrG,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gDAAgD,EAAE,KAAK,IAAI,EAAE;YAC5D,MAAM,OAAO,GAAG,EAAE,gBAAgB,EAAE,EAAE,EAAE,kBAAkB,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,CAAC;YACvG,MAAM,CAAC,MAAM,QAAQ,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC;QAC/E,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=run-test-result.test.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-test-result.test.d.ts","sourceRoot":"","sources":["../../../test/unit/run-test-result.test.ts"],"names":[],"mappings":""}
@@ -0,0 +1,34 @@
1
+ import { describe, expect, it, vi } from 'vitest';
2
+ import { RunTestResult } from '../../lib/run-test-result.js';
3
+ const run = { id: 'run', status: 'SUCCEEDED', defaultDatasetId: 'ds', defaultKeyValueStoreId: 'kvs' };
4
+ describe('RunTestResult', () => {
5
+ it('fetches the log once, even when empty or requested concurrently', async () => {
6
+ const get = vi.fn(async () => '');
7
+ const client = { run: () => ({ log: () => ({ get }) }) };
8
+ const result = new RunTestResult(client, run);
9
+ await Promise.all([result.getLog(), result.getLog()]);
10
+ await result.getLog();
11
+ expect(get).toHaveBeenCalledTimes(1);
12
+ });
13
+ it('retries after a failed fetch', async () => {
14
+ const get = vi.fn().mockRejectedValueOnce(new Error('boom')).mockResolvedValueOnce('log');
15
+ const client = { run: () => ({ log: () => ({ get }) }) };
16
+ const result = new RunTestResult(client, run);
17
+ await expect(result.getLog()).rejects.toThrow('boom');
18
+ expect(await result.getLog()).toBe('log');
19
+ });
20
+ it('pages through the dataset instead of listing it in one response', async () => {
21
+ const total = 25_000;
22
+ const listItems = vi.fn(async ({ offset, limit }) => ({
23
+ total,
24
+ items: Array.from({ length: Math.min(limit, total - offset) }, (_, i) => offset + i),
25
+ }));
26
+ const client = { dataset: () => ({ listItems }) };
27
+ const result = new RunTestResult(client, run);
28
+ const { items } = await result.getDataset();
29
+ expect(items).toHaveLength(total);
30
+ expect(items[24_999]).toBe(24_999);
31
+ expect(listItems).toHaveBeenCalledTimes(25);
32
+ });
33
+ });
34
+ //# sourceMappingURL=run-test-result.test.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"run-test-result.test.js","sourceRoot":"","sources":["../../../test/unit/run-test-result.test.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAElD,OAAO,EAAE,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE7D,MAAM,GAAG,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,gBAAgB,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAc,CAAC;AAElH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,GAAG,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC;QAClC,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAA4B,CAAC;QACnF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE9C,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACtD,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC;QAEtB,MAAM,CAAC,GAAG,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8BAA8B,EAAE,KAAK,IAAI,EAAE;QAC1C,MAAM,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QAC1F,MAAM,MAAM,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAA4B,CAAC;QACnF,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE9C,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QACtD,MAAM,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iEAAiE,EAAE,KAAK,IAAI,EAAE;QAC7E,MAAM,KAAK,GAAG,MAAM,CAAC;QACrB,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,CAAC,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,EAAqC,EAAE,EAAE,CAAC,CAAC;YACrF,KAAK;YACL,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;SACvF,CAAC,CAAC,CAAC;QACJ,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,CAAC,EAA4B,CAAC;QAC5E,MAAM,MAAM,GAAG,IAAI,aAAa,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAE9C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,EAAU,CAAC;QAEpD,MAAM,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;QAClC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACnC,MAAM,CAAC,SAAS,CAAC,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAC;IAChD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}