apify-test-tools 0.9.1-beta.11 → 0.9.1-beta.13

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-test-tools",
-  "version": "0.9.1-beta.11",
+  "version": "0.9.1-beta.13",
   "type": "module",
   "description": "TBD",
   "repository": {
@@ -47,7 +47,7 @@
   },
   "scripts": {
     "start": "npm run dist/bin/main.js",
-    "start:dev": "GITHUB_WORKSPACE=local-clone tsx bin/main.ts",
+    "start:dev": "tsx bin/main.ts --workspace local-clone",
     "build": "tsc && chmod +x ./dist/bin/main.js",
     "lint": "eslint",
     "lint:fix": "eslint --fix",

package/test/unit/bin/build.test.ts

@@ -0,0 +1,68 @@
+import type * as ApifyClientTypes from 'apify-client';
+import { ActorSourceType } from 'apify-client';
+import { describe, expect, it } from 'vitest';
+
+import { assertRepoUrlMatchesDefaultVersion, resolveDefaultVersion } from '../../../bin/build.js';
+
+const ACTOR = 'owner/actor';
+const REPO_URL = 'git@github.com:owner/repo';
+
+const makeActorInfo = (overrides: Partial<ApifyClientTypes.Actor> = {}): ApifyClientTypes.Actor =>
+    ({
+        defaultRunOptions: { build: 'latest' },
+        taggedBuilds: { latest: { buildNumber: '0.1.5' } },
+        versions: [
+            { versionNumber: '0.1', sourceType: ActorSourceType.GitRepo, gitRepoUrl: `${REPO_URL}#master:actors/a` },
+        ],
+        ...overrides,
+    }) as unknown as ApifyClientTypes.Actor;
+
+describe('resolveDefaultVersion', () => {
+    it('should resolve the version the default build tag points to', () => {
+        const { defaultBuildTag, defaultBuildNumber, defaultVersionNumber, defaultVersion } = resolveDefaultVersion(
+            ACTOR,
+            makeActorInfo(),
+        );
+        expect(defaultBuildTag).toBe('latest');
+        expect(defaultBuildNumber).toBe('0.1.5');
+        expect(defaultVersionNumber).toBe('0.1');
+        expect(defaultVersion?.versionNumber).toBe('0.1');
+    });
+
+    it('should explain the setup requirement when there is no default build', () => {
+        expect(() => resolveDefaultVersion(ACTOR, makeActorInfo({ taggedBuilds: {} }))).toThrow(
+            'every Actor needs at least one build under its default build tag',
+        );
+    });
+});
+
+describe('assertRepoUrlMatchesDefaultVersion', () => {
+    const { defaultVersion } = resolveDefaultVersion(ACTOR, makeActorInfo());
+
+    it('should pass when the repositories match in a different URL form', () => {
+        expect(() =>
+            assertRepoUrlMatchesDefaultVersion(ACTOR, defaultVersion, 'https://github.com/owner/repo.git'),
+        ).not.toThrow();
+    });
+
+    it('should throw when the remote points to a different repository', () => {
+        expect(() => assertRepoUrlMatchesDefaultVersion(ACTOR, defaultVersion, 'git@github.com:fork/repo')).toThrow(
+            'Repository mismatch',
+        );
+    });
+
+    it('should throw when the default version is not built from a Git repository', () => {
+        const sourceFilesVersion: ApifyClientTypes.ActorVersion = {
+            versionNumber: '0.1',
+            sourceType: ActorSourceType.SourceFiles,
+            sourceFiles: [],
+        };
+        expect(() => assertRepoUrlMatchesDefaultVersion(ACTOR, sourceFilesVersion, REPO_URL)).toThrow(
+            'has source type "SOURCE_FILES"',
+        );
+    });
+
+    it('should throw when the default version no longer exists', () => {
+        expect(() => assertRepoUrlMatchesDefaultVersion(ACTOR, undefined, REPO_URL)).toThrow('no longer exists');
+    });
+});

package/test/unit/bin/git.test.ts

@@ -5,8 +5,13 @@ import {
     getBranchOnlyChangedFiles,
     getChangedFiles,
     getCommits,
+    getCurrentBranch,
+    getReleaseChanges,
+    getRepoName,
     hasMergeFromTarget,
+    normalizeRepoUrl,
     parseBaseCommit,
+    resolveReleaseBaseCommit,
 } from '../../../bin/git.js';
 import * as Utils from '../../../bin/utils.js';
 
@@ -250,3 +255,120 @@ describe('parseBaseCommit', () => {
         expect(() => parseBaseCommit(badJson)).toThrow('Invalid base commit SHA');
     });
 });
+
+describe('getCurrentBranch', () => {
+    it('should return the checked-out branch', () => {
+        vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockReturnValue('master');
+        expect(getCurrentBranch()).toBe('master');
+    });
+
+    it('should throw on a detached HEAD', () => {
+        vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockReturnValue('HEAD');
+        expect(() => getCurrentBranch()).toThrow('HEAD is detached');
+    });
+});
+
+describe('normalizeRepoUrl', () => {
+    it.each([
+        'git@github.com:Apify-Store/google-maps.git',
+        'git@github.com:apify-store/google-maps',
+        'https://github.com/apify-store/google-maps',
+        'https://github.com/apify-store/google-maps.git/',
+        'ssh://git@github.com/apify-store/google-maps',
+        'git@github.com:apify-store/google-maps#master:actors/foo',
+        'https://github.com/apify-store/google-maps#master',
+    ])('should normalize %s', (url) => {
+        expect(normalizeRepoUrl(url)).toBe('github.com/apify-store/google-maps');
+    });
+
+    it('should tell different repositories apart', () => {
+        expect(normalizeRepoUrl('git@github.com:my-fork/google-maps.git')).not.toBe(
+            normalizeRepoUrl('git@github.com:apify-store/google-maps.git'),
+        );
+    });
+});
+
+describe('getRepoName', () => {
+    it('should return the repository name', () => {
+        expect(getRepoName('git@github.com:apify-store/google-maps.git')).toBe('google-maps');
+    });
+});
+
+describe('resolveReleaseBaseCommit', () => {
+    const baseSha = 'b'.repeat(40);
+
+    it('should return the base commit when it is an ancestor of HEAD', () => {
+        vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockImplementation((cmd: string) => {
+            if (cmd.startsWith('git rev-parse --verify')) return baseSha;
+            if (cmd.startsWith('git merge-base')) return baseSha;
+            return '';
+        });
+        expect(resolveReleaseBaseCommit(baseSha)).toBe(baseSha);
+    });
+
+    it('should throw on the all-zeros SHA of a newly created branch', () => {
+        const spy = vi.spyOn(Utils, 'spawnCommandInGhWorkspace');
+        expect(() => resolveReleaseBaseCommit('0'.repeat(40))).toThrow('the branch was just created');
+        expect(spy).not.toHaveBeenCalled();
+    });
+
+    it('should throw when the base commit is missing from the local history', () => {
+        vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockReturnValue('');
+        expect(() => resolveReleaseBaseCommit(baseSha)).toThrow('is not in the local git history');
+    });
+
+    it('should throw when the base commit is not an ancestor of HEAD (force push)', () => {
+        vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockImplementation((cmd: string) => {
+            if (cmd.startsWith('git rev-parse --verify')) return baseSha;
+            if (cmd.startsWith('git merge-base')) return 'c'.repeat(40);
+            return '';
+        });
+        expect(() => resolveReleaseBaseCommit(baseSha)).toThrow('is not an ancestor of HEAD');
+    });
+
+    it('should throw on an invalid SHA', () => {
+        expect(() => resolveReleaseBaseCommit('not-a-sha')).toThrow('Invalid base commit SHA');
+    });
+});
+
+describe('getReleaseChanges', () => {
+    const baseSha = 'b'.repeat(40);
+    const headSha = 'd'.repeat(40);
+    const mergedBranchCommit = `${'1'.repeat(40)}»¦«Dev<dev@example.com>»¦«Date1»¦«feat: branch change`;
+    const mergeCommit = `${headSha}»¦«Dev<dev@example.com>»¦«Date2»¦«Merge pull request #1`;
+
+    let gitCommandSpy: MockInstance;
+
+    beforeEach(() => {
+        gitCommandSpy = vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockImplementation((cmd: string) => {
+            if (cmd === 'git rev-parse HEAD') return headSha;
+            if (cmd.startsWith('git log')) return `${mergeCommit}\n${mergedBranchCommit}`;
+            if (cmd.startsWith('git diff --name-only')) return 'actors/foo/src/main.ts\nCHANGELOG.md';
+            if (cmd === 'git')
+                return 'diff --git a/CHANGELOG.md b/CHANGELOG.md\n--- a/CHANGELOG.md\n+++ b/CHANGELOG.md\n@@ -1 +1,2 @@\n+- Added foo\n # Changelog';
+            return '';
+        });
+    });
+
+    it('should diff the range directly and return the commits oldest first', () => {
+        const changes = getReleaseChanges(baseSha);
+
+        expect(changes).toStrictEqual({
+            commits: [
+                { sha: '1'.repeat(40), author: 'Dev<dev@example.com>', date: 'Date1', message: 'feat: branch change' },
+                { sha: headSha, author: 'Dev<dev@example.com>', date: 'Date2', message: 'Merge pull request #1' },
+            ],
+            changedFiles: ['actors/foo/src/main.ts', 'CHANGELOG.md'],
+            changelog: '- Added foo',
+        });
+        // Not from the parent of the oldest commit, which may predate the base commit for merge commits
+        expect(gitCommandSpy).toHaveBeenCalledWith(`git diff --name-only ${baseSha} HEAD`);
+        expect(gitCommandSpy).toHaveBeenCalledWith(
+            `git log --pretty=format:'%H»¦«%aN<%aE>»¦«%aD»¦«%s' ${baseSha}..HEAD`,
+        );
+    });
+
+    it('should return null when HEAD is the base commit', () => {
+        expect(getReleaseChanges(headSha)).toBeNull();
+    });
+});

package/bin/github.ts

@@ -1,69 +0,0 @@
-import fs from 'node:fs/promises';
-
-import type { Commit, GitHubEventPush } from './types.js';
-import { spawnCommandInGhWorkspace } from './utils.js';
-
-export const getPushData = async (path: string) => {
-    const event = await loadGitHubEvent(path);
-    const branch = event.ref.replace('refs/heads/', '');
-    const {
-        commits: ghCommits,
-        repository: { ssh_url: repoUrl, name },
-        head_commit: { author },
-    } = event;
-    const commits: Commit[] = ghCommits.map(({ author: commitAuthor, message, id, timestamp }) => ({
-        author: commitAuthor.username,
-        sha: id,
-        message,
-        date: timestamp,
-    }));
-    const changedFiles = getChangedFiles(event);
-    const changelog = getChangelogChanges(changedFiles, event);
-    return {
-        branch,
-        commits,
-        changedFiles,
-        repoUrl,
-        changelog,
-        repository: name,
-        author: author.name,
-    };
-};
-
-const loadGitHubEvent = async (path: string): Promise<GitHubEventPush> => {
-    const pushEvent = JSON.parse((await fs.readFile(path)).toString()) as GitHubEventPush;
-    return pushEvent;
-};
-
-const getChangedFiles = ({ after, before }: GitHubEventPush): string[] => {
-    const changedFiles = spawnCommandInGhWorkspace(`git diff --name-only ${after}..${before}`);
-    return changedFiles.split('\n');
-};
-
-const getChangelogChanges = (changedFiles: string[], event: GitHubEventPush): string | null => {
-    const changelogPath = 'CHANGELOG.md';
-    if (!changedFiles.includes(changelogPath)) {
-        return null;
-    }
-    const { after, before } = event;
-    const diff = spawnCommandInGhWorkspace('git', ['diff', before, after, '--', changelogPath]);
-
-    const added: string[] = [];
-    let startedChangelog = false;
-    for (const line of diff.split('\n')) {
-        // We should already get only files we care about from getLastCommitDiffForFile but better to double check
-        if (line.startsWith('+++') && line.toLowerCase().includes(changelogPath.toLowerCase())) {
-            startedChangelog = true;
-            continue;
-        }
-        if (startedChangelog) {
-            if (line.startsWith('diff')) {
-                break;
-            }
-            if (line.startsWith('+')) {
-                added.push(line.slice(1).trim());
-            }
-        }
-    }
-    return added.join('\n').trim();
-};

package/dist/bin/github.d.ts

@@ -1,11 +0,0 @@
-import type { Commit } from './types.js';
-export declare const getPushData: (path: string) => Promise<{
-    branch: string;
-    commits: Commit[];
-    changedFiles: string[];
-    repoUrl: string;
-    changelog: string | null;
-    repository: string;
-    author: string;
-}>;
-//# sourceMappingURL=github.d.ts.map

package/dist/bin/github.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"github.d.ts","sourceRoot":"","sources":["../../bin/github.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAmB,MAAM,YAAY,CAAC;AAG1D,eAAO,MAAM,WAAW,GAAU,MAAM,MAAM;;;;;;;;EAyB7C,CAAC"}

package/dist/bin/github.js

@@ -1,59 +0,0 @@
-import fs from 'node:fs/promises';
-import { spawnCommandInGhWorkspace } from './utils.js';
-export const getPushData = async (path) => {
-    const event = await loadGitHubEvent(path);
-    const branch = event.ref.replace('refs/heads/', '');
-    const { commits: ghCommits, repository: { ssh_url: repoUrl, name }, head_commit: { author }, } = event;
-    const commits = ghCommits.map(({ author: commitAuthor, message, id, timestamp }) => ({
-        author: commitAuthor.username,
-        sha: id,
-        message,
-        date: timestamp,
-    }));
-    const changedFiles = getChangedFiles(event);
-    const changelog = getChangelogChanges(changedFiles, event);
-    return {
-        branch,
-        commits,
-        changedFiles,
-        repoUrl,
-        changelog,
-        repository: name,
-        author: author.name,
-    };
-};
-const loadGitHubEvent = async (path) => {
-    const pushEvent = JSON.parse((await fs.readFile(path)).toString());
-    return pushEvent;
-};
-const getChangedFiles = ({ after, before }) => {
-    const changedFiles = spawnCommandInGhWorkspace(`git diff --name-only ${after}..${before}`);
-    return changedFiles.split('\n');
-};
-const getChangelogChanges = (changedFiles, event) => {
-    const changelogPath = 'CHANGELOG.md';
-    if (!changedFiles.includes(changelogPath)) {
-        return null;
-    }
-    const { after, before } = event;
-    const diff = spawnCommandInGhWorkspace('git', ['diff', before, after, '--', changelogPath]);
-    const added = [];
-    let startedChangelog = false;
-    for (const line of diff.split('\n')) {
-        // We should already get only files we care about from getLastCommitDiffForFile but better to double check
-        if (line.startsWith('+++') && line.toLowerCase().includes(changelogPath.toLowerCase())) {
-            startedChangelog = true;
-            continue;
-        }
-        if (startedChangelog) {
-            if (line.startsWith('diff')) {
-                break;
-            }
-            if (line.startsWith('+')) {
-                added.push(line.slice(1).trim());
-            }
-        }
-    }
-    return added.join('\n').trim();
-};
-//# sourceMappingURL=github.js.map

package/dist/bin/github.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"github.js","sourceRoot":"","sources":["../../bin/github.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAGlC,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,IAAY,EAAE,EAAE;IAC9C,MAAM,KAAK,GAAG,MAAM,eAAe,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;IACpD,MAAM,EACF,OAAO,EAAE,SAAS,EAClB,UAAU,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,EACtC,WAAW,EAAE,EAAE,MAAM,EAAE,GAC1B,GAAG,KAAK,CAAC;IACV,MAAM,OAAO,GAAa,SAAS,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC;QAC3F,MAAM,EAAE,YAAY,CAAC,QAAQ;QAC7B,GAAG,EAAE,EAAE;QACP,OAAO;QACP,IAAI,EAAE,SAAS;KAClB,CAAC,CAAC,CAAC;IACJ,MAAM,YAAY,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,mBAAmB,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;IAC3D,OAAO;QACH,MAAM;QACN,OAAO;QACP,YAAY;QACZ,OAAO;QACP,SAAS;QACT,UAAU,EAAE,IAAI;QAChB,MAAM,EAAE,MAAM,CAAC,IAAI;KACtB,CAAC;AACN,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,KAAK,EAAE,IAAY,EAA4B,EAAE;IACrE,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAoB,CAAC;IACtF,OAAO,SAAS,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,EAAE,KAAK,EAAE,MAAM,EAAmB,EAAY,EAAE;IACrE,MAAM,YAAY,GAAG,yBAAyB,CAAC,wBAAwB,KAAK,KAAK,MAAM,EAAE,CAAC,CAAC;IAC3F,OAAO,YAAY,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,YAAsB,EAAE,KAAsB,EAAiB,EAAE;IAC1F,MAAM,aAAa,GAAG,cAAc,CAAC;IACrC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IAChB,CAAC;IACD,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;IAChC,MAAM,IAAI,GAAG,yBAAyB,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IAE5F,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,IAAI,gBAAgB,GAAG,KAAK,CAAC;IAC7B,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC;QAClC,0GAA0G;QAC1G,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YACrF,gBAAgB,GAAG,IAAI,CAAC;YACxB,SAAS;QACb,CAAC;QACD,IAAI,gBAAgB,EAAE,CAAC;YACnB,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1B,MAAM;YACV,CAAC;YACD,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBACvB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;YACrC,CAAC;QACL,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;AACnC,CAAC,CAAC"}