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

package/test/unit/github-scripts/mask-config-secrets.test.ts

@@ -0,0 +1,61 @@
+import { spawnSync } from 'node:child_process';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+
+import { describe, expect, it } from 'vitest';
+
+const SCRIPT = fileURLToPath(new URL('../../../.github/scripts/mask-config-secrets.sh', import.meta.url));
+
+const run = (configSecrets?: string) =>
+    spawnSync('bash', [SCRIPT], {
+        encoding: 'utf8',
+        env: { PATH: process.env.PATH, ...(configSecrets === undefined ? {} : { CONFIG_SECRETS: configSecrets }) },
+    });
+
+const masks = (stdout: string) => stdout.split('\n').filter((line) => line !== '');
+
+describe('mask-config-secrets.sh', () => {
+    it('registers every value as a mask', () => {
+        const { status, stdout, stderr } = run(JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' }));
+        expect(status, stderr).toBe(0);
+        expect(masks(stdout)).toStrictEqual(['::add-mask::one', '::add-mask::two']);
+    });
+
+    it('registers a multi-line value line by line, skipping empty lines', () => {
+        const { status, stdout, stderr } = run(
+            JSON.stringify({ DEPLOY_KEY: '-----BEGIN KEY-----\nabc\n\n-----END KEY-----\n' }),
+        );
+        expect(status, stderr).toBe(0);
+        expect(masks(stdout)).toStrictEqual([
+            '::add-mask::-----BEGIN KEY-----',
+            '::add-mask::abc',
+            '::add-mask::-----END KEY-----',
+        ]);
+    });
+
+    it('skips values that are not strings', () => {
+        const { status, stdout, stderr } = run(JSON.stringify({ TOKEN_ONE: 'one', COUNT: 1 }));
+        expect(status, stderr).toBe(0);
+        expect(masks(stdout)).toStrictEqual(['::add-mask::one']);
+    });
+
+    it.each([
+        ['is unset', undefined],
+        ['is empty', ''],
+    ])('does nothing when CONFIG_SECRETS %s', (_, configSecrets) => {
+        const { status, stdout, stderr } = run(configSecrets);
+        expect(status, stderr).toBe(0);
+        expect(stdout).toBe('');
+    });
+
+    it.each([
+        ['is not JSON', 'apify_api_xyzzy'],
+        ['is a JSON string', '"apify_api_xyzzy"'],
+        ['is a JSON array', '["apify_api_xyzzy"]'],
+    ])('fails without printing the value when the secret %s', (_, configSecrets) => {
+        const { status, stdout, stderr } = run(configSecrets);
+        expect(status).toBe(1);
+        expect(stdout).toContain('::error::The CONFIG_SECRETS secret must be a JSON object.');
+        expect(stdout + stderr).not.toContain('xyzzy');
+    });
+});

package/test/unit/github-scripts/run-with-apify-tokens.test.ts

@@ -0,0 +1,115 @@
+import { spawnSync } from 'node:child_process';
+import { mkdtemp, rm, writeFile } from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+
+import { afterAll, beforeAll, describe, expect, it } from 'vitest';
+
+const SCRIPT = fileURLToPath(new URL('../../../.github/scripts/run-with-apify-tokens.mjs', import.meta.url));
+
+// Three Actors, each with its own token, so a test can leave any of them out.
+const CONFIG = {
+    actors: [
+        { actorFullName: 'team/one', tokenEnvVar: 'TOKEN_ONE' },
+        { actorFullName: 'team/two', tokenEnvVar: 'TOKEN_TWO' },
+        { actorFullName: 'team/three', tokenEnvVar: 'TOKEN_THREE' },
+    ],
+};
+
+// The command the wrapper runs prints what it was handed, so a test sees exactly what got through.
+const PRINT_ENV = `console.log(JSON.stringify({
+    TOKEN_ONE: process.env.TOKEN_ONE,
+    TOKEN_TWO: process.env.TOKEN_TWO,
+    TOKEN_THREE: process.env.TOKEN_THREE,
+    NPM_TOKEN: process.env.NPM_TOKEN,
+    WORKFLOW_SECRETS: process.env.WORKFLOW_SECRETS,
+}))`;
+
+let cwd: string;
+
+// `workflowSecrets` is what the step's `toJSON(secrets)` holds inside the reusable workflow.
+const run = (workflowSecrets: Record<string, string>) => {
+    const result = spawnSync(process.execPath, [SCRIPT, process.execPath, '-e', PRINT_ENV], {
+        cwd,
+        encoding: 'utf8',
+        env: { PATH: process.env.PATH, WORKFLOW_SECRETS: JSON.stringify(workflowSecrets) },
+    });
+    return { ...result, env: result.status === 0 ? JSON.parse(result.stdout) : undefined };
+};
+
+describe('run-with-apify-tokens.mjs', () => {
+    beforeAll(async () => {
+        cwd = await mkdtemp(path.join(os.tmpdir(), 'run-with-apify-tokens-'));
+        await writeFile(path.join(cwd, 'apify-test-tools.config.json'), JSON.stringify(CONFIG));
+    });
+
+    afterAll(async () => {
+        await rm(cwd, { recursive: true, force: true });
+    });
+
+    it('passes on inherited secrets, as `secrets: inherit` sends them', () => {
+        const { status, stderr, env } = run({
+            TOKEN_ONE: 'one',
+            TOKEN_TWO: 'two',
+            TOKEN_THREE: 'three',
+            NPM_TOKEN: 'npm',
+        });
+        expect(status, stderr).toBe(0);
+        expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
+    });
+
+    it('unpacks the tokens from the CONFIG_SECRETS secret', () => {
+        const { status, stderr, env } = run({
+            CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' }),
+            NPM_TOKEN: 'npm',
+        });
+        expect(status, stderr).toBe(0);
+        expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
+    });
+
+    it('passes on only the config names when CONFIG_SECRETS holds every secret of the caller', () => {
+        const { status, stderr, env } = run({
+            CONFIG_SECRETS: JSON.stringify({
+                TOKEN_ONE: 'one',
+                TOKEN_TWO: 'two',
+                TOKEN_THREE: 'three',
+                NPM_TOKEN: 'npm',
+                github_token: 'gh',
+            }),
+        });
+        expect(status, stderr).toBe(0);
+        expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two', TOKEN_THREE: 'three' });
+    });
+
+    it('prefers CONFIG_SECRETS over an inherited secret of the same name', () => {
+        const { status, stderr, env } = run({
+            CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'from-config-secrets' }),
+            TOKEN_ONE: 'inherited',
+            TOKEN_TWO: 'inherited',
+        });
+        expect(status, stderr).toBe(0);
+        expect(env).toStrictEqual({ TOKEN_ONE: 'from-config-secrets', TOKEN_TWO: 'inherited' });
+    });
+
+    it('warns about a token the config declares but nothing passes, and runs anyway', () => {
+        const { status, stderr, env } = run({
+            CONFIG_SECRETS: JSON.stringify({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' }),
+        });
+        expect(status, stderr).toBe(0);
+        expect(stderr).toContain('declares TOKEN_THREE, but no such secret was passed');
+        expect(env).toStrictEqual({ TOKEN_ONE: 'one', TOKEN_TWO: 'two' });
+    });
+
+    it.each([
+        ['is not JSON', 'apify_api_xyzzy', 'The CONFIG_SECRETS secret is not valid JSON.'],
+        ['is a JSON string', '"apify_api_xyzzy"', 'The CONFIG_SECRETS secret must be a JSON object.'],
+        ['is a JSON array', '["apify_api_xyzzy"]', 'The CONFIG_SECRETS secret must be a JSON object.'],
+    ])('fails without printing the value when CONFIG_SECRETS %s', (_, packed, message) => {
+        const { status, stdout, stderr } = run({ CONFIG_SECRETS: packed });
+        expect(status).toBe(1);
+        expect(stderr).toContain(message);
+        expect(stdout + stderr).not.toContain('xyzzy');
+    });
+});

package/test/unit/run-checks.test.ts

@@ -0,0 +1,76 @@
+import { describe, expect, it } from 'vitest';
+
+import { checkRun } from '../../lib/run-checks.js';
+import type { RunTestResult } from '../../lib/run-test-result.js';
+
+const fakeRun = (overrides: { status?: string; log?: string; stats?: object; chargedEventCounts?: object } = {}) =>
+    ({
+        status: overrides.status ?? 'SUCCEEDED',
+        getRunInfo: async () => ({
+            stats: { durationMillis: 5_000 },
+            chargedEventCounts: overrides.chargedEventCounts,
+        }),
+        getDataset: async () => ({ items: new Array(10) }),
+        getStatistics: async () => ({
+            requestsFailed: 0,
+            requestsRetries: 1,
+            requestRetryHistogram: [5, 1],
+            ...overrides.stats,
+        }),
+        getLog: async () => overrides.log ?? 'all good',
+    }) as unknown as RunTestResult;
+
+const failures = async (run: RunTestResult, options: Parameters<typeof checkRun>[1]) =>
+    (await checkRun(run, options)).filter(({ pass }) => !pass).map(({ name }) => name);
+
+describe('checkRun()', () => {
+    it('passes a run matching the defaults', async () => {
+        expect(await failures(fakeRun(), { datasetItemCount: 10 })).toEqual([]);
+    });
+
+    it('reports every failing check at once', async () => {
+        const run = fakeRun({ status: 'FAILED', log: 'TypeError: x', stats: { requestsFailed: 2 } });
+        expect(await failures(run, { datasetItemCount: { min: 11 } })).toEqual([
+            'status',
+            'datasetItemCount',
+            'failedRequests',
+            'forbiddenLogs',
+        ]);
+    });
+
+    it('disables a check with null', async () => {
+        const run = fakeRun({ stats: { requestsFailed: 2 } });
+        expect(await failures(run, { datasetItemCount: 10, failedRequests: null })).toEqual([]);
+    });
+
+    it('treats explicitly undefined options as disabled checks', async () => {
+        const options = { datasetItemCount: 10, duration: undefined, maxRetriesPerRequest: undefined };
+        expect(await failures(fakeRun(), options)).toEqual([]);
+    });
+
+    it('checks the longest retry chain only when asked to', async () => {
+        expect(await failures(fakeRun(), { datasetItemCount: 10, maxRetriesPerRequest: 0 })).toEqual([
+            'maxRetriesPerRequest',
+        ]);
+        expect(await failures(fakeRun(), { datasetItemCount: 10, maxRetriesPerRequest: 1 })).toEqual([]);
+    });
+
+    describe('chargedEventCounts', () => {
+        const run = fakeRun({ chargedEventCounts: { start: 1, item: 7 } });
+
+        it('passes matching counts and intervals', async () => {
+            const options = { datasetItemCount: 10, chargedEventCounts: { start: 1, item: { min: 5 } } };
+            expect(await failures(run, options)).toEqual([]);
+        });
+
+        it('expects unlisted charged events to not happen', async () => {
+            const options = { datasetItemCount: 10, chargedEventCounts: { start: 1 } as Record<string, number> };
+            expect(await failures(run, options)).toEqual(['chargedEventCounts.item']);
+        });
+
+        it('fails an expected event that was never charged', async () => {
+            const options = { datasetItemCount: 10, chargedEventCounts: { start: 1, item: 7, extra: { min: 0 } } };
+            expect(await failures(run, options)).toEqual(['chargedEventCounts.extra']);
+        });
+    });
+});

package/test/unit/run-test-result.test.ts

@@ -0,0 +1,44 @@
+import type { ActorRun, ApifyClient } from 'apify-client';
+import { describe, expect, it, vi } from 'vitest';
+
+import { RunTestResult } from '../../lib/run-test-result.js';
+
+const run = { id: 'run', status: 'SUCCEEDED', defaultDatasetId: 'ds', defaultKeyValueStoreId: 'kvs' } as ActorRun;
+
+describe('RunTestResult', () => {
+    it('fetches the log once, even when empty or requested concurrently', async () => {
+        const get = vi.fn(async () => '');
+        const client = { run: () => ({ log: () => ({ get }) }) } as unknown as ApifyClient;
+        const result = new RunTestResult(client, run);
+
+        await Promise.all([result.getLog(), result.getLog()]);
+        await result.getLog();
+
+        expect(get).toHaveBeenCalledTimes(1);
+    });
+
+    it('retries after a failed fetch', async () => {
+        const get = vi.fn().mockRejectedValueOnce(new Error('boom')).mockResolvedValueOnce('log');
+        const client = { run: () => ({ log: () => ({ get }) }) } as unknown as ApifyClient;
+        const result = new RunTestResult(client, run);
+
+        await expect(result.getLog()).rejects.toThrow('boom');
+        expect(await result.getLog()).toBe('log');
+    });
+
+    it('pages through the dataset instead of listing it in one response', async () => {
+        const total = 25_000;
+        const listItems = vi.fn(async ({ offset, limit }: { offset: number; limit: number }) => ({
+            total,
+            items: Array.from({ length: Math.min(limit, total - offset) }, (_, i) => offset + i),
+        }));
+        const client = { dataset: () => ({ listItems }) } as unknown as ApifyClient;
+        const result = new RunTestResult(client, run);
+
+        const { items } = await result.getDataset<number>();
+
+        expect(items).toHaveLength(total);
+        expect(items[24_999]).toBe(24_999);
+        expect(listItems).toHaveBeenCalledTimes(25);
+    });
+});