apify-test-tools 0.10.2-beta.1 → 0.10.2-beta.3

package/test/unit/bin/slack.test.ts

@@ -0,0 +1,65 @@
+import { WebClient } from '@slack/web-api';
+import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { notifyToSlack } from '../../../bin/slack.js';
+
+vi.mock('@slack/web-api', () => ({ WebClient: vi.fn() }));
+
+const TOKEN_ENV_VAR = 'SLACK_TOKEN_RELEASES_BOT';
+const postMessage = vi.fn();
+const authTest = vi.fn();
+
+const notify = async (overrides: Partial<Parameters<typeof notifyToSlack>[0]> = {}) =>
+    notifyToSlack({
+        repository: 'owner/repo',
+        changedFiles: ['src/main.ts'],
+        changelog: '- Fixed a bug',
+        commits: [{ sha: '1', author: 'Test<test@example.com>', date: '', message: 'fix: bug' }],
+        author: 'Test<test@example.com>',
+        dryRun: true,
+        releaseSlackChannel: '#releases',
+        reportSlackChannel: '#notif',
+        ...overrides,
+    });
+
+describe('notifyToSlack', () => {
+    beforeEach(() => {
+        vi.stubEnv(TOKEN_ENV_VAR, 'token');
+        vi.mocked(WebClient).mockImplementation(function () {
+            return { chat: { postMessage }, auth: { test: authTest } };
+        } as never);
+    });
+
+    afterEach(() => {
+        vi.unstubAllEnvs();
+        vi.clearAllMocks();
+    });
+
+    it('should verify the token but post nothing in a dry run', async () => {
+        await notify();
+        expect(authTest).toHaveBeenCalledTimes(1);
+        expect(postMessage).not.toHaveBeenCalled();
+    });
+
+    it('should still require the token in a dry run', async () => {
+        vi.stubEnv(TOKEN_ENV_VAR, '');
+        await expect(notify()).rejects.toThrow(`${TOKEN_ENV_VAR} not defined`);
+    });
+
+    it('should fail a dry run when Slack rejects the token', async () => {
+        authTest.mockRejectedValueOnce(new Error('An API error occurred: invalid_auth'));
+        await expect(notify()).rejects.toThrow(`${TOKEN_ENV_VAR} was rejected by Slack`);
+    });
+
+    it('should not need a token when no channel is passed', async () => {
+        vi.stubEnv(TOKEN_ENV_VAR, '');
+        await notify({ dryRun: false, releaseSlackChannel: undefined, reportSlackChannel: undefined });
+        expect(WebClient).not.toHaveBeenCalled();
+    });
+
+    it('should post to both channels outside of a dry run', async () => {
+        await notify({ dryRun: false });
+        expect(authTest).not.toHaveBeenCalled();
+        expect(postMessage).toHaveBeenCalledTimes(2);
+    });
+});

package/test/unit/should-built-and-test.test.ts

@@ -41,6 +41,16 @@ const actorConfig = (
     };
 };
 
+// What a PR (functional changes only) or a release (isLatest, all changes) builds, in config order
+const changedActorsFor = async ({
+    isLatest = false,
+    ...options
+}: Parameters<typeof getChangedActors>[0] & { isLatest?: boolean }): Promise<ActorConfig[]> => {
+    const { functional, cosmetic } = await getChangedActors(options);
+    const changed = isLatest ? [...functional, ...cosmetic] : functional;
+    return options.actorConfigs.filter((config) => changed.includes(config));
+};
+
 describe('Should build and test parser', () => {
     // From https://github.com/apify-store/testing-repo-for-github-actions
     const ACTOR_CONFIGS: ActorConfig[] = [
@@ -70,7 +80,7 @@ describe('Should build and test parser', () => {
     test('Ignores dev-only readme', async () => {
         const FILES = ['README.md', 'code/README.md', 'shared/README.md'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -83,7 +93,7 @@ describe('Should build and test parser', () => {
     test('Ignores other ignored files and folders', async () => {
         const FILES = ['.vscode/settings.json', '.gitignore', '.husky/pre-commit', '.eslintrc', '.editorconfig'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -96,7 +106,7 @@ describe('Should build and test parser', () => {
     test('.actor/ changes trigger builds for broad-context actors', async () => {
         const FILES = ['.actor/actor.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -109,7 +119,7 @@ describe('Should build and test parser', () => {
     test('Configured changelog is cosmetic for every actor, only on latest', async () => {
         const FILES = ['CHANGELOG.md'];
 
-        const actorsChangedNotLatest = await getChangedActors({
+        const actorsChangedNotLatest = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -117,7 +127,7 @@ describe('Should build and test parser', () => {
         });
         expect(actorsChangedNotLatest).toEqual([]);
 
-        const actorsChangedLatest = await getChangedActors({
+        const actorsChangedLatest = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: true,
             filepathsChanged: FILES,
@@ -129,7 +139,7 @@ describe('Should build and test parser', () => {
     test('A changelog nested inside one actor own folder is excluded for sibling actors', async () => {
         const FILES = ['actors/lukaskrivka_testing-github-integration-1/CHANGELOG.md'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: true,
             filepathsChanged: FILES,
@@ -142,7 +152,7 @@ describe('Should build and test parser', () => {
     test('Code updated, tests broad-context actors', async () => {
         const FILES = ['code/src/main.ts', 'package.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -158,7 +168,7 @@ describe('Should build and test parser', () => {
             'standalone-actors/lukaskrivka_test-standalone/Dockerfile',
         ];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -171,7 +181,7 @@ describe('Should build and test parser', () => {
     test('src/main.ts updated', async () => {
         const FILES = ['src/main.ts'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: true,
             filepathsChanged: FILES,
@@ -188,7 +198,7 @@ describe('Should build and test parser', () => {
             'standalone-actors/lukaskrivka_test-standalone/Dockerfile',
         ];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -204,7 +214,7 @@ describe('Should build and test parser', () => {
             'standalone-actors/lukaskrivka_test-standalone/README.md',
         ];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -217,7 +227,7 @@ describe('Should build and test parser', () => {
     test('Actor JSON changes in PR context trigger tests', async () => {
         const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -230,7 +240,7 @@ describe('Should build and test parser', () => {
     test('Actor JSON changes in latest context trigger builds', async () => {
         const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: true,
             filepathsChanged: FILES,
@@ -243,7 +253,7 @@ describe('Should build and test parser', () => {
     test('JSON file with functional changes triggers tests', async () => {
         const FILES = ['actors/lukaskrivka_testing-github-integration-1/.actor/actor.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -259,7 +269,7 @@ describe('Should build and test parser', () => {
             'actors/lukaskrivka_testing-github-integration-2/.actor/input_schema.json',
         ];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -272,7 +282,7 @@ describe('Should build and test parser', () => {
     test('Narrow-context actor JSON change in PR context triggers tests', async () => {
         const FILES = ['standalone-actors/lukaskrivka_test-standalone/.actor/actor.json'];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS,
             isLatest: false,
             filepathsChanged: FILES,
@@ -331,7 +341,7 @@ describe('Should build and test parser', () => {
             ),
         ];
 
-        const actorsChanged = await getChangedActors({
+        const actorsChanged = await changedActorsFor({
             actorConfigs: ACTOR_CONFIGS_GOOGLE_MAPS,
             isLatest: false,
             filepathsChanged: FILES,

package/.github/scripts/check-package-version-bump.mjs

@@ -1,74 +0,0 @@
-#!/usr/bin/env node
-// Reads changed file paths on stdin (one per line) and fails if a PR changes both a consumer-facing
-// workflow and the package code it calls, without repinning in workflows-package-version.
-//
-// The case this catches: a workflow starts using a CLI feature from the same PR. On merge the tag
-// moves, the workflow goes live, and it calls something that is not on npm yet — breaking every
-// consumer's CI at once. Pinning the unreleased version instead holds the tag until it publishes.
-//
-// It deliberately only looks at one PR. A workflow could also start depending on package code that
-// landed in an *earlier*, still-unreleased PR, which this will not see — that needs someone to ship
-// a breaking CLI change and then sit on it unreleased, and catching it means flagging every workflow
-// edit made while any package change is unreleased, which is far more noise than the case is worth.
-
-const PUBLIC_WORKFLOW = /^\.github\/workflows\/public_.*\.ya?ml$/;
-// The composite action is consumer-facing too, and it is what installs the package.
-const PUBLIC_ACTION = /^\.github\/actions\//;
-// What `npx apify-test-tools ...` runs, and the library the platform tests import.
-const PACKAGE_CODE = /^(bin\/|lib\/|index\.ts$)/;
-const PIN_FILE = '.github/workflows-package-version';
-const OVERRIDE_LABEL = 'no-version-bump-needed';
-
-const changed = await new Promise((resolve) => {
-    let buffer = '';
-    process.stdin.setEncoding('utf8');
-    process.stdin.on('data', (chunk) => (buffer += chunk));
-    process.stdin.on('end', () =>
-        resolve(
-            buffer
-                .split('\n')
-                .map((l) => l.trim())
-                .filter(Boolean),
-        ),
-    );
-});
-
-const publicSurface = changed.filter((f) => PUBLIC_WORKFLOW.test(f) || PUBLIC_ACTION.test(f));
-const packageCode = changed.filter((f) => PACKAGE_CODE.test(f));
-const versionRepinned = changed.includes(PIN_FILE);
-
-if (publicSurface.length === 0 || packageCode.length === 0) {
-    console.log('No consumer-facing workflow and package change in the same PR; nothing to check.');
-    process.exit(0);
-}
-
-if (versionRepinned) {
-    console.log(`Both sides changed and ${PIN_FILE} was repinned. The tag will hold until that version ships.`);
-    process.exit(0);
-}
-
-if (
-    (process.env.PR_LABELS ?? '')
-        .split(',')
-        .map((l) => l.trim())
-        .includes(OVERRIDE_LABEL)
-) {
-    console.log(`Both sides changed without a version bump, allowed by the "${OVERRIDE_LABEL}" label.`);
-    process.exit(0);
-}
-
-console.error(`This PR changes consumer-facing workflows and the package code they call:
-
-  workflows: ${publicSurface.join(', ')}
-  package:   ${packageCode.join(', ')}
-
-On merge the tag moves and those workflows go live immediately, against whatever is on npm today.
-If they rely on anything from the package change in this PR, that is not published yet and every
-consumer's CI breaks.
-
-If they do rely on it, set ${PIN_FILE} to the version that will contain it. The tag is then held
-until you cut that release, and moves on its own once it is published.
-
-If they do not rely on it — the two changes just happen to be in one PR — add the
-"${OVERRIDE_LABEL}" label.`);
-process.exit(1);

package/.github/workflows-package-version

@@ -1 +0,0 @@
-0.11.0