@apexdevtools/git-ops 1.0.0 → 1.0.2

package/CHANGELOG.md

@@ -1,4 +1,12 @@
-# test-runner - Changelog
+# git-ops - Changelog
+
+## 1.0.2 - 2023-03-20
+
+- downgrade min git version to 2.30.0
+
+## 1.0.1 - 2023-03-14
+
+- update to resolve absolute paths for changes
 
 ## 1.0.0 - 2023-02-20
 

package/README.md

@@ -2,6 +2,10 @@
 
 Library to do git operations to find changed files in a given git repository.
 
+## Prerequisite
+
+Minimum `git` version of `2.30.0` must already be installed on the host machine.
+
 ## Getting Started
 
 To build run
@@ -21,9 +25,15 @@ pnpm test
 
 **Prerequisite**: The head mus tbe set on the repo otherwise any functions using default branch will fail
 
+### Installation
+
+```shell
+npm i @apexdevtools/git-ops
+```
+
 ### Finding changed files
 
-Getting changed files using the default branch in that repo given a ref. This find the default branch ion the repo using `git symbolic-ref 'refs/remotes/origin/HEAD'` so the `HEAD` must be set.
+Getting changed files using the default branch in that repo given a ref. This finds the default branch in the repo using `git symbolic-ref 'refs/remotes/origin/HEAD'` so the `HEAD` must be set.
 The output of the command is same as running `git diff branchName...ref` combined with `git status`.
 
 **Note:** files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.

package/lib/src/FilesChanged/BranchChanges.d.ts

@@ -1,2 +1,17 @@
+/**
+ * Works out a set of changed files by performing getDefaultBranchDiffByRef(repoRootDir, 'HEAD')
+ * @param dir: string of the directory thr operation should be performed on
+ * @returns set of absolute paths of changed files
+ */
 export declare function getDefaultBranchDiff(dir: string): Promise<Set<string>>;
+/**
+ * Works out changed files using the default branch in that repo given a ref.
+ * This find the default branch in the repo using `git symbolic-ref 'refs/remotes/origin/HEAD'`
+ * so the `HEAD` must be set. The output of the command is same as running `git diff branchName...ref`
+ * combined with `git status`.
+ * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
+ * @param dir: string of the directory thr operation should be performed on
+ * @param red: string git ref. i.e HEAD, or commit hash
+ * @returns set of absolute paths of changed files
+ */
 export declare function getDefaultBranchDiffByRef(dir: string, ref: string): Promise<Set<string>>;

package/lib/src/FilesChanged/BranchChanges.js

@@ -11,23 +11,47 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
+const path_1 = __importDefault(require("path"));
 const Git_1 = require("../Git/Git");
+/**
+ * Works out a set of changed files by performing getDefaultBranchDiffByRef(repoRootDir, 'HEAD')
+ * @param dir: string of the directory thr operation should be performed on
+ * @returns set of absolute paths of changed files
+ */
 function getDefaultBranchDiff(dir) {
     return __awaiter(this, void 0, void 0, function* () {
         return getDefaultBranchDiffByRef(dir, 'HEAD');
     });
 }
 exports.getDefaultBranchDiff = getDefaultBranchDiff;
+/**
+ * Works out changed files using the default branch in that repo given a ref.
+ * This find the default branch in the repo using `git symbolic-ref 'refs/remotes/origin/HEAD'`
+ * so the `HEAD` must be set. The output of the command is same as running `git diff branchName...ref`
+ * combined with `git status`.
+ * Files with the status of deleted (`D`) and ignored (`!`) will not be included in the change set.
+ * @param dir: string of the directory thr operation should be performed on
+ * @param red: string git ref. i.e HEAD, or commit hash
+ * @returns set of absolute paths of changed files
+ */
 function getDefaultBranchDiffByRef(dir, ref) {
     return __awaiter(this, void 0, void 0, function* () {
         const git = new Git_1.Git(dir);
+        const root = yield git.gitRoot();
         return git
             .getDefaultBranchName()
             .then((branchName) => __awaiter(this, void 0, void 0, function* () {
             return yield getChanges(git, branchName, ref);
         }))
+            .then(changes => {
+            const fullPaths = [...changes].map(p => path_1.default.resolve(path_1.default.join(root, p)));
+            return new Set(fullPaths);
+        })
             .catch(er => {
             if (er instanceof Error)
                 throw Error(`Failed getting diff: ${er.message}`);

package/lib/src/Git/Git.d.ts

@@ -21,6 +21,7 @@ export declare class Git implements IGit {
     constructor(dir: string);
     static versionCheck(git: SimpleGit): Promise<void>;
     private get git();
+    gitRoot(): Promise<string>;
     getDefaultBranchName(): Promise<string>;
     diffRange(fromRef: string, toRef: string): Promise<Set<string>>;
     getLocalChangedAndCreated(): Promise<Set<string>>;

package/lib/src/Git/Git.js

@@ -51,6 +51,11 @@ class Git {
             return git;
         });
     }
+    gitRoot() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return (yield this.git).revparse('--show-toplevel');
+        });
+    }
     getDefaultBranchName() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.git
@@ -99,6 +104,6 @@ class Git {
 }
 exports.Git = Git;
 Git.MIN_GIT_VERSION_MAJOR = 2;
-Git.MIN_GIT_VERSION_MINOR = 37;
+Git.MIN_GIT_VERSION_MINOR = 30;
 Git.MIN_GIT_VERSION_PATCH = 0;
 Git.gitInstance = undefined;

package/lib/src/api/IGit.d.ts

@@ -2,4 +2,5 @@ export interface IGit {
     getDefaultBranchName(): Promise<string>;
     getLocalChangedAndCreated(): Promise<Set<string>>;
     diffRange(fromRef: string, toRef: string): Promise<Set<string>>;
+    gitRoot(): Promise<string>;
 }

package/lib/test/BranchChanges/BranchChanges.spec.js

@@ -11,13 +11,19 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 const Git_1 = require("../../src/Git/Git");
 const BranchChanges_1 = require("../../src/FilesChanged/BranchChanges");
+const path_1 = __importDefault(require("path"));
+jest.mock('path');
 const mockGitImpl = {
     getDefaultBranchName: jest.fn(),
     getLocalChangedAndCreated: jest.fn(),
     diffRange: jest.fn(),
+    gitRoot: jest.fn(),
 };
 jest.mock('../../src/Git/Git', () => {
     return {
@@ -26,6 +32,14 @@ jest.mock('../../src/Git/Git', () => {
 });
 const mockedGit = jest.mocked(Git_1.Git, { shallow: true });
 describe('Branch changes', () => {
+    const mockRootDir = 'user/fake/path';
+    beforeAll(() => {
+        mockGitImpl.gitRoot.mockResolvedValue('abs/path/to/repo');
+        jest
+            .spyOn(path_1.default, 'resolve')
+            .mockImplementation(dir => `${mockRootDir}/${dir}`);
+        jest.spyOn(path_1.default, 'join').mockImplementation((a, b) => `${a}/${b}`);
+    });
     afterEach(() => {
         jest.clearAllMocks();
     });
@@ -42,7 +56,11 @@ describe('Branch changes', () => {
             expect(mockGitImpl.getDefaultBranchName).toBeCalledTimes(1);
             expect(mockGitImpl.getLocalChangedAndCreated).toBeCalledTimes(1);
             expect(mockGitImpl.diffRange).toHaveBeenCalledWith('default/branch/name', 'abc12fcd');
-            expect(res).toEqual(new Set(['File.txt', 'AnotherClass.txt', 'SomeFile.txt']));
+            expect(res).toEqual(new Set([
+                `${mockRootDir}/abs/path/to/repo/File.txt`,
+                `${mockRootDir}/abs/path/to/repo/AnotherClass.txt`,
+                `${mockRootDir}/abs/path/to/repo/SomeFile.txt`,
+            ]));
         }));
         it('rejects and throws error when "getDefaultBranchName" fails', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given
@@ -72,7 +90,11 @@ describe('Branch changes', () => {
             expect(mockGitImpl.getDefaultBranchName).toBeCalledTimes(1);
             expect(mockGitImpl.getLocalChangedAndCreated).toBeCalledTimes(1);
             expect(mockGitImpl.diffRange).toHaveBeenCalledWith('default/branch/name', 'HEAD');
-            expect(res).toEqual(new Set(['File.txt', 'AnotherClass.txt', 'SomeFile.txt']));
+            expect(res).toEqual(new Set([
+                `${mockRootDir}/abs/path/to/repo/File.txt`,
+                `${mockRootDir}/abs/path/to/repo/AnotherClass.txt`,
+                `${mockRootDir}/abs/path/to/repo/SomeFile.txt`,
+            ]));
         }));
         it('rejects and throws error when "getLocalChangedAndCreated" fails', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given

package/lib/test/Git/Git.spec.js

@@ -11,11 +11,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+const path_1 = __importDefault(require("path"));
 const Git_1 = require("../../src/Git/Git");
 const RepoManager_1 = require("../FsUtils/RepoManager");
 describe('Git', () => {
-    const repoManager = RepoManager_1.RepoManager.getInstance('./test/repos');
+    const dir = './test/repos';
+    const repoManager = RepoManager_1.RepoManager.getInstance(dir);
     beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
         yield repoManager.init();
     }));
@@ -23,10 +28,10 @@ describe('Git', () => {
         yield repoManager.tearDown();
     }));
     describe('version check', () => {
-        it('does not fail when Git version is equal to 2.37.0', () => {
+        it('does not fail when Git version is equal to 2.30.0', () => {
             //Given/When
             const mock = {
-                version: jest.fn().mockReturnValue({ major: 2, minor: 37, patch: 0 }),
+                version: jest.fn().mockReturnValue({ major: 2, minor: 30, patch: 0 }),
             };
             expect(Git_1.Git.versionCheck(mock)).resolves;
         });
@@ -36,7 +41,7 @@ describe('Git', () => {
                 version: jest.fn().mockReturnValue({ major: 1 }),
             };
             //Then
-            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.37.0'));
+            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.30.0'));
         }));
         it('fails when Git minor version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given/When
@@ -44,7 +49,7 @@ describe('Git', () => {
                 version: jest.fn().mockReturnValue({ major: 3, minor: 36 }),
             };
             //Then
-            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.37.0'));
+            yield expect(Git_1.Git.versionCheck(mock)).rejects.toThrow(Error('Unsupported version of git. Min version must be 2.30.0'));
         }));
         it('fails when Git patch version is more than 0', () => {
             //Given/When
@@ -55,6 +60,13 @@ describe('Git', () => {
             expect(Git_1.Git.versionCheck(mock)).resolves;
         });
     });
+    describe('rev parse', () => {
+        it('get git root', () => __awaiter(void 0, void 0, void 0, function* () {
+            const repoDirPath = path_1.default.resolve(repoManager.repoDir);
+            const revParse = yield new Git_1.Git(repoManager.repoDir).gitRoot();
+            expect(revParse).toBe(repoDirPath);
+        }));
+    });
     describe('branch operation', () => {
         it('fails to find default branch name when head is not set', () => __awaiter(void 0, void 0, void 0, function* () {
             //Given/When/Then

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apexdevtools/git-ops",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Library to do git operations to find changed files in a given git repository",
   "author": {
     "name": "Apex Dev Tools Team",