apify-test-tools 0.5.0 → 0.5.2

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

@@ -0,0 +1,109 @@
+import { beforeEach, describe, expect, it, MockInstance, vi } from 'vitest';
+import { getChangedFiles, getCommits } from '../../../bin/git.js';
+import * as Utils from '../../../bin/utils.js';
+
+describe('getCommits', () => {
+    const sourceBranch = 'feature-branch';
+    const targetBranch = 'main';
+
+    const commit1 = 'Commit1»¦«Author1»¦«Date1»¦«First Change On Feature';
+    const commit2 = 'Commit2»¦«Author1»¦«Date2»¦«Second Change On Feature';
+    const commit3 = 'Commit3»¦«Author1»¦«Date3»¦«Third Change On Feature';
+
+    let gitCommandSpy: MockInstance;
+
+    beforeEach(() => {
+        gitCommandSpy = vi
+            .spyOn(Utils, 'spawnCommandInGhWorkspace')
+            .mockReturnValue(`${commit3}\n${commit2}\n${commit1}`);
+    });
+
+    it('should return commits between source and target branches', () => {
+        // Act
+        const commits = getCommits({ sourceBranch, targetBranch });
+
+        // Assert
+        expect(commits).toStrictEqual([
+            { sha: 'Commit1', author: 'Author1', date: 'Date1', message: 'First Change On Feature' },
+            { sha: 'Commit2', author: 'Author1', date: 'Date2', message: 'Second Change On Feature' },
+            { sha: 'Commit3', author: 'Author1', date: 'Date3', message: 'Third Change On Feature' },
+        ]);
+
+        expect(gitCommandSpy).toHaveBeenCalledTimes(1);
+        expect(gitCommandSpy).toHaveBeenCalledWith(
+            `git log --pretty=format:'%H»¦«%aN<%aE>»¦«%aD»¦«%s' main..feature-branch`,
+        );
+    });
+
+    it('should return commits after the base commit if provided', () => {
+        // Act
+        const commits = getCommits({ sourceBranch, targetBranch, baseCommit: 'Commit1' });
+
+        // Assert
+        expect(commits).toStrictEqual([
+            { sha: 'Commit2', author: 'Author1', date: 'Date2', message: 'Second Change On Feature' },
+            { sha: 'Commit3', author: 'Author1', date: 'Date3', message: 'Third Change On Feature' },
+        ]);
+
+        expect(gitCommandSpy).toHaveBeenCalledTimes(1);
+        expect(gitCommandSpy).toHaveBeenCalledWith(
+            `git log --pretty=format:'%H»¦«%aN<%aE>»¦«%aD»¦«%s' main..feature-branch`,
+        );
+    });
+
+    it('should return all commits if base commit is not found', () => {
+        // Act
+        const commits = getCommits({ sourceBranch, targetBranch, baseCommit: 'NonExistingCommit' });
+
+        // Assert
+        expect(commits).toStrictEqual([
+            { sha: 'Commit1', author: 'Author1', date: 'Date1', message: 'First Change On Feature' },
+            { sha: 'Commit2', author: 'Author1', date: 'Date2', message: 'Second Change On Feature' },
+            { sha: 'Commit3', author: 'Author1', date: 'Date3', message: 'Third Change On Feature' },
+        ]);
+
+        expect(gitCommandSpy).toHaveBeenCalledTimes(1);
+        expect(gitCommandSpy).toHaveBeenCalledWith(
+            `git log --pretty=format:'%H»¦«%aN<%aE>»¦«%aD»¦«%s' main..feature-branch`,
+        );
+    });
+});
+
+describe('getChangedFiles', () => {
+    let gitCommandSpy: MockInstance;
+
+    beforeEach(() => {
+        gitCommandSpy = vi.spyOn(Utils, 'spawnCommandInGhWorkspace').mockReturnValue('file1.txt\nfolder/file2.txt');
+    });
+
+    it('should return changed files between commits', () => {
+        // Arrange
+        const commits = [
+            { sha: 'Commit1', author: '', date: '', message: '' },
+            { sha: 'Commit3', author: '', date: '', message: '' },
+        ];
+
+        // Act
+        const changedFiles = getChangedFiles(commits);
+
+        // Assert
+        expect(changedFiles).toStrictEqual(['file1.txt', 'folder/file2.txt']);
+
+        expect(gitCommandSpy).toHaveBeenCalledTimes(1);
+        expect(gitCommandSpy).toHaveBeenCalledWith(`git diff --name-only Commit1~..Commit3`);
+    });
+
+    it('should handle only one commit', () => {
+        // Arrange
+        const commits = [{ sha: 'Commit1', author: '', date: '', message: '' }];
+
+        // Act
+        const changedFiles = getChangedFiles(commits);
+
+        // Assert
+        expect(changedFiles).toStrictEqual(['file1.txt', 'folder/file2.txt']);
+
+        expect(gitCommandSpy).toHaveBeenCalledTimes(1);
+        expect(gitCommandSpy).toHaveBeenCalledWith(`git diff --name-only Commit1~..Commit1`);
+    });
+});

package/test/unit/custom-matchers.test.ts

@@ -2,13 +2,10 @@ import process from 'process';
 import { describe } from 'vitest';
 
 import { ApifyClient } from 'apify-client';
-import { testStandbyActor, testTestActor } from '../../lib/lib';
-import { RunTestResult } from '../../lib/run-test-result';
+import { testStandbyActor, testTestActor } from '../../lib/lib.js';
+import { RunTestResult } from '../../lib/run-test-result.js';
 
-type PpeEventType =
-    | 'actor-start'
-    | 'search-page-scraped'
-    | 'ads-scraped'
+type PpeEventType = 'actor-start' | 'search-page-scraped' | 'ads-scraped';
 enum PpeEventEnum {
     ACTOR_START = 'actor-start',
     SEARCH_PAGE_SCRAPED = 'search-page-scraped',
@@ -45,7 +42,7 @@ describe('custom-matchers', { timeout: 100_000 }, () => {
             },
         });
 
-        await expect(runResult).toFinishWith<typeof PPE_EVENT_CONST[keyof typeof PPE_EVENT_CONST]>({
+        await expect(runResult).toFinishWith<(typeof PPE_EVENT_CONST)[keyof typeof PPE_EVENT_CONST]>({
             datasetItemCount: { min: 1, max: 20 },
             chargedEventCounts: {
                 'actor-start': 1,
@@ -67,7 +64,7 @@ describe('custom-matchers', { timeout: 100_000 }, () => {
                     maxRequests: 3,
                     aggregateContacts: true,
                 },
-            })
+            });
             expect(status).toBe(200);
             expect(data[0].domain).toEqual('apify.com');
         }
@@ -78,7 +75,7 @@ describe('custom-matchers', { timeout: 100_000 }, () => {
                 maxRequests: 3,
                 aggregateContacts: true,
             },
-        })
+        });
         expect(status).toBe(200);
         expect(data[0].domain).toEqual('apify.com');
     });

package/test/unit/parse-commit.test.ts

@@ -1,8 +1,7 @@
 import { describe, it, expect } from 'vitest';
-import { GIT_FORMAT_SEPARATOR, parseCommit } from '../../bin/git';
+import { GIT_FORMAT_SEPARATOR, parseCommit } from '../../bin/git.js';
 
 describe('parseCommit', () => {
-
     describe('valid commit strings', () => {
         it('should parse a basic commit string correctly', () => {
             const commitString = `abc123${GIT_FORMAT_SEPARATOR}John Doe<john@example.com>${GIT_FORMAT_SEPARATOR}Mon, 25 Dec 2023 10:30:00 +0100${GIT_FORMAT_SEPARATOR}Add new feature`;
@@ -13,7 +12,7 @@ describe('parseCommit', () => {
                 sha: 'abc123',
                 author: 'John Doe<john@example.com>',
                 date: 'Mon, 25 Dec 2023 10:30:00 +0100',
-                message: 'Add new feature'
+                message: 'Add new feature',
             });
         });
 
@@ -26,7 +25,7 @@ describe('parseCommit', () => {
                 sha: 'def456',
                 author: 'Jane Smith<jane@example.com>',
                 date: 'Tue, 26 Dec 2023 14:15:00 +0100',
-                message: 'test: commit with double quotes: \"'
+                message: 'test: commit with double quotes: "',
             });
         });
 
@@ -39,7 +38,7 @@ describe('parseCommit', () => {
                 sha: 'jkl012',
                 author: 'María García<maria@example.com>',
                 date: 'Thu, 28 Dec 2023 16:20:00 +0100',
-                message: 'Add émojis 🚀 and "special" chars'
+                message: 'Add émojis 🚀 and "special" chars',
             });
         });
 
@@ -52,7 +51,7 @@ describe('parseCommit', () => {
                 sha: 'mno345',
                 author: 'Test User<test@example.com>',
                 date: 'Fri, 29 Dec 2023 11:00:00 +0100',
-                message: ''
+                message: '',
             });
         });
     });
@@ -70,4 +69,4 @@ describe('parseCommit', () => {
             expect(() => parseCommit(commitString)).toThrow(`Failed to parse commit string: ${commitString}`);
         });
     });
-});
+});

package/tsconfig.json

@@ -2,19 +2,15 @@
     "extends": "@apify/tsconfig",
     "compilerOptions": {
         "declaration": true,
-        "module": "ES2022",
+        "module": "nodenext",
+        "moduleResolution": "nodenext",
         "target": "ES2022",
         "outDir": "dist",
         "noUnusedLocals": false,
         "strict": true,
         "esModuleInterop": true,
         "lib": ["DOM", "es2021"],
-        "skipLibCheck": true,
+        "skipLibCheck": true
     },
-    "include": [
-        "./index.ts",
-        "./bin/**/*",
-        "./lib/**/*",
-        "./test/**/*",
-    ]
+    "include": ["./index.ts", "./bin/**/*", "./lib/**/*", "./test/**/*"]
 }

package/test/unit/test-actor.test.ts

@@ -1,17 +0,0 @@
-import { describe, testActor } from '../../lib/lib';
-
-describe('testActor tests', async () => {
-    testActor('compass/google-maps-extractor', 'basic', async ({ expect, run }) => {
-        const runResult = await run({
-            input: {},
-            prefilledInput: true,
-            options: {
-                memory: 512,
-            },
-        })
-        const input = await runResult.getInput<{ maxCrawledPlacesPerSearch: number }>();
-        await expect(runResult).toFinishWith({
-            datasetItemCount: input.maxCrawledPlacesPerSearch,
-        })
-    });
-});