@apexdevtools/git-ops 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# test-runner - Changelog
+
+## 1.0.0 - 2023-02-20
+
+- Initial release.

package/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c), FinancialForce.com, inc
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+- Neither the name of the FinancialForce.com, inc nor the names of its contributors
+  may be used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,41 @@
+# git-ops
+
+Library to do git operations to find changed files in a given git repository.
+
+## Getting Started
+
+To build run
+
+```bash
+pnpm install
+pnpm build
+```
+
+Jest unit tests can be run with
+
+```bash
+pnpm test
+```
+
+##  Usage
+
+**Prerequisite**: The head mus tbe set on the repo otherwise any functions using default branch will fail
+
+### 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.
+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.
+
+```TypeScript
+getDefaultBranchDiffByRef(repoRootDir: string, ref: string): Promise<Set<string>>
+```
+
+Getting changed files using the default branch in that repo.
+
+This command is same as calling `getDefaultBranchDiffByRef(repoRootDir, 'HEAD')`.
+
+```TypeScript
+getDefaultBranchDiff(repoRootDir: string): Promise<Set<string>>
+```

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

@@ -0,0 +1,2 @@
+export declare function getDefaultBranchDiff(dir: string): Promise<Set<string>>;
+export declare function getDefaultBranchDiffByRef(dir: string, ref: string): Promise<Set<string>>;

package/lib/src/FilesChanged/BranchChanges.js

@@ -0,0 +1,50 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
+const Git_1 = require("../Git/Git");
+function getDefaultBranchDiff(dir) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return getDefaultBranchDiffByRef(dir, 'HEAD');
+    });
+}
+exports.getDefaultBranchDiff = getDefaultBranchDiff;
+function getDefaultBranchDiffByRef(dir, ref) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const git = new Git_1.Git(dir);
+        return git
+            .getDefaultBranchName()
+            .then((branchName) => __awaiter(this, void 0, void 0, function* () {
+            return yield getChanges(git, branchName, ref);
+        }))
+            .catch(er => {
+            if (er instanceof Error)
+                throw Error(`Failed getting diff: ${er.message}`);
+            else
+                throw Error('Failed getting diff');
+        });
+    });
+}
+exports.getDefaultBranchDiffByRef = getDefaultBranchDiffByRef;
+function getChanges(git, branchName, ref) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const changes = yield Promise.all([
+            git.diffRange(branchName, ref),
+            git.getLocalChangedAndCreated(),
+        ]);
+        const allChanges = new Set();
+        changes.forEach(set => set.forEach(file => allChanges.add(file)));
+        return allChanges;
+    });
+}

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

@@ -0,0 +1,27 @@
+import { SimpleGit } from 'simple-git';
+import { IGit } from '../api/IGit';
+export declare enum FileStatus {
+    Unmodified = " ",
+    Modified = "M",
+    TypeChanged = "T",
+    Added = "A",
+    Deleted = "D",
+    Renamed = "R",
+    Copied = "C",
+    Updated = "U",
+    Untracked = "?",
+    Ignore = "!"
+}
+export declare class Git implements IGit {
+    private static MIN_GIT_VERSION_MAJOR;
+    private static MIN_GIT_VERSION_MINOR;
+    private static MIN_GIT_VERSION_PATCH;
+    private static gitInstance;
+    private dir;
+    constructor(dir: string);
+    static versionCheck(git: SimpleGit): Promise<void>;
+    private get git();
+    getDefaultBranchName(): Promise<string>;
+    diffRange(fromRef: string, toRef: string): Promise<Set<string>>;
+    getLocalChangedAndCreated(): Promise<Set<string>>;
+}

package/lib/src/Git/Git.js

@@ -0,0 +1,104 @@
+"use strict";
+/*
+ * Copyright (c) 2022, FinancialForce.com, inc. All rights reserved.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = exports.FileStatus = void 0;
+const simple_git_1 = require("simple-git");
+var FileStatus;
+(function (FileStatus) {
+    FileStatus["Unmodified"] = " ";
+    FileStatus["Modified"] = "M";
+    FileStatus["TypeChanged"] = "T";
+    FileStatus["Added"] = "A";
+    FileStatus["Deleted"] = "D";
+    FileStatus["Renamed"] = "R";
+    FileStatus["Copied"] = "C";
+    FileStatus["Updated"] = "U";
+    FileStatus["Untracked"] = "?";
+    FileStatus["Ignore"] = "!";
+})(FileStatus = exports.FileStatus || (exports.FileStatus = {}));
+class Git {
+    constructor(dir) {
+        this.dir = dir;
+    }
+    static versionCheck(git) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const version = yield git.version();
+            const isSupported = version.major >= this.MIN_GIT_VERSION_MAJOR &&
+                version.minor >= this.MIN_GIT_VERSION_MINOR &&
+                version.patch >= this.MIN_GIT_VERSION_PATCH;
+            if (!isSupported)
+                throw new Error(`Unsupported version of git. Min version must be ${this.MIN_GIT_VERSION_MAJOR}.${this.MIN_GIT_VERSION_MINOR}.${this.MIN_GIT_VERSION_PATCH}`);
+        });
+    }
+    get git() {
+        if (Git.gitInstance)
+            return Promise.resolve(Git.gitInstance);
+        //eslint-disable-next-line
+        const git = (0, simple_git_1.simpleGit)(this.dir);
+        return Git.versionCheck(git).then(() => {
+            Git.gitInstance = git;
+            return git;
+        });
+    }
+    getDefaultBranchName() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.git
+                .then(git => git.raw(['symbolic-ref', 'refs/remotes/origin/HEAD', '--short']))
+                .catch(error => {
+                if (error instanceof Error)
+                    throw Error(`Failed to find symbolic ref no remote HEAD with message: '${error.message.trim()}'`);
+                else
+                    throw new Error('Failed to find symbolic ref no remote HEAD');
+            })
+                .then(branch => {
+                if (branch.startsWith('origin/'))
+                    return branch.trim();
+                else
+                    throw new Error(`Expected default branch '${branch}' to start with 'origin/'`);
+            });
+        });
+    }
+    diffRange(fromRef, toRef) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.git
+                .then(git => git.diff([`${fromRef}...${toRef}`, '--name-only', '-z']))
+                .then(diff => {
+                const files = diff
+                    .split('\u0000')
+                    .map(s => s.trim())
+                    .filter(s => s); //Removes any falsy values
+                return new Set([...files]);
+            });
+        });
+    }
+    getLocalChangedAndCreated() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const excludeStatus = [FileStatus.Deleted, FileStatus.Ignore];
+            return this.git
+                .then(git => git.status())
+                .then(status => {
+                const changedFiles = status.files
+                    .filter(f => !excludeStatus.includes(f.index) &&
+                    !excludeStatus.includes(f.working_dir))
+                    .map(f => f.path);
+                return new Set(...[changedFiles]);
+            });
+        });
+    }
+}
+exports.Git = Git;
+Git.MIN_GIT_VERSION_MAJOR = 2;
+Git.MIN_GIT_VERSION_MINOR = 37;
+Git.MIN_GIT_VERSION_PATCH = 0;
+Git.gitInstance = undefined;

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

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

package/lib/src/api/IGit.js

@@ -0,0 +1,5 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/src/index.d.ts

@@ -0,0 +1,3 @@
+export { getDefaultBranchDiff, getDefaultBranchDiffByRef, } from './FilesChanged/BranchChanges';
+export { IGit } from './api/IGit';
+export { Git } from './Git/Git';

package/lib/src/index.js

@@ -0,0 +1,11 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Git = exports.getDefaultBranchDiffByRef = exports.getDefaultBranchDiff = void 0;
+var BranchChanges_1 = require("./FilesChanged/BranchChanges");
+Object.defineProperty(exports, "getDefaultBranchDiff", { enumerable: true, get: function () { return BranchChanges_1.getDefaultBranchDiff; } });
+Object.defineProperty(exports, "getDefaultBranchDiffByRef", { enumerable: true, get: function () { return BranchChanges_1.getDefaultBranchDiffByRef; } });
+var Git_1 = require("./Git/Git");
+Object.defineProperty(exports, "Git", { enumerable: true, get: function () { return Git_1.Git; } });

package/lib/test/BranchChanges/BranchChanges.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,86 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Git_1 = require("../../src/Git/Git");
+const BranchChanges_1 = require("../../src/FilesChanged/BranchChanges");
+const mockGitImpl = {
+    getDefaultBranchName: jest.fn(),
+    getLocalChangedAndCreated: jest.fn(),
+    diffRange: jest.fn(),
+};
+jest.mock('../../src/Git/Git', () => {
+    return {
+        Git: jest.fn().mockImplementation(() => mockGitImpl),
+    };
+});
+const mockedGit = jest.mocked(Git_1.Git, { shallow: true });
+describe('Branch changes', () => {
+    afterEach(() => {
+        jest.clearAllMocks();
+    });
+    describe('getDefaultBranchDiffByRef', () => {
+        it('returns the correct set of files when git ops resolve', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockResolvedValue('default/branch/name');
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockResolvedValue(new Set(['SomeFile.txt']));
+            //When
+            const res = yield (0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd');
+            //Then
+            expect(mockedGit).toHaveBeenCalledWith('./some/path/to/dir');
+            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']));
+        }));
+        it('rejects and throws error when "getDefaultBranchName" fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockRejectedValue(Error('no head ref error'));
+            //When/Then
+            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error('Failed getting diff: no head ref error'));
+        }));
+        it('rejects and throws error when "getLocalChangedAndCreated" fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockResolvedValue('default/branch/name');
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
+            //When/Then
+            yield expect((0, BranchChanges_1.getDefaultBranchDiffByRef)('./some/path/to/dir', 'abc12fcd')).rejects.toEqual(Error('Failed getting diff: op failed'));
+        }));
+    });
+    describe('getDefaultBranchDiff', () => {
+        it('returns the correct set of files', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockResolvedValue('default/branch/name');
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockResolvedValue(new Set(['SomeFile.txt']));
+            //When
+            const res = yield (0, BranchChanges_1.getDefaultBranchDiff)('./some/path/to/dir');
+            //Then
+            expect(mockedGit).toHaveBeenCalledWith('./some/path/to/dir');
+            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']));
+        }));
+        it('rejects and throws error when "getLocalChangedAndCreated" fails', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            mockGitImpl.getDefaultBranchName.mockResolvedValue('default/branch/name');
+            mockGitImpl.diffRange.mockResolvedValue(new Set(['File.txt', 'AnotherClass.txt']));
+            mockGitImpl.getLocalChangedAndCreated.mockRejectedValue(Error('op failed'));
+            //When/Then
+            yield expect((0, BranchChanges_1.getDefaultBranchDiff)('./some/path/to/dir')).rejects.toEqual(Error('Failed getting diff: op failed'));
+        }));
+    });
+});

package/lib/test/FsUtils/RepoManager.d.ts

@@ -0,0 +1,24 @@
+export declare class RepoManager {
+    private isInit;
+    private rootDir;
+    private remoteRepoDir;
+    private testRepoDir;
+    private static instances;
+    private constructor();
+    static getInstance(rootDir: string): RepoManager;
+    private get git();
+    private initRemoteRepo;
+    private cloneRepo;
+    get repoDir(): string;
+    init(): Promise<void>;
+    setHead(): Promise<string | void>;
+    push(): Promise<void | import("simple-git").PushResult>;
+    checkout(branchName: string, from: string): Promise<void>;
+    stageAll(files?: string[]): Promise<string>;
+    getGitLog(): Promise<readonly (import("simple-git").DefaultLogFields & import("simple-git").ListLogLine)[]>;
+    stageAndCommitAll(files?: string[]): Promise<import("simple-git").CommitResult>;
+    tearDown(): Promise<void>;
+    createOrUpdateFile(fileName: string, content: string): Promise<void>;
+    rmFile(file: string): void;
+    renameFileInRepo(from: string, to: string): void;
+}

package/lib/test/FsUtils/RepoManager.js

@@ -0,0 +1,133 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        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.RepoManager = void 0;
+const simple_git_1 = __importDefault(require("simple-git"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+class RepoManager {
+    constructor(rootDir) {
+        this.isInit = false;
+        this.rootDir = rootDir;
+        this.remoteRepoDir = rootDir + '/remote.git';
+        this.testRepoDir = rootDir + '/test-repo';
+    }
+    static getInstance(rootDir) {
+        if (!this.instances.has(rootDir)) {
+            this.instances.set(rootDir, new RepoManager(rootDir));
+        }
+        return this.instances.get(rootDir);
+    }
+    get git() {
+        if (!this.isInit) {
+            throw new Error('Cannot perform git operation before calling init()');
+        }
+        // eslint-disable-next-line
+        return (0, simple_git_1.default)(this.testRepoDir);
+    }
+    initRemoteRepo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!fs_1.default.existsSync(this.remoteRepoDir)) {
+                fs_1.default.mkdirSync(this.remoteRepoDir, { recursive: true });
+                // eslint-disable-next-line
+                const git = (0, simple_git_1.default)(this.remoteRepoDir);
+                yield git.init(true);
+            }
+        });
+    }
+    cloneRepo() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (fs_1.default.existsSync(this.remoteRepoDir) && !fs_1.default.existsSync(this.testRepoDir)) {
+                // eslint-disable-next-line
+                yield (0, simple_git_1.default)().clone(this.remoteRepoDir, this.testRepoDir);
+            }
+        });
+    }
+    get repoDir() {
+        return this.testRepoDir;
+    }
+    init() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.initRemoteRepo();
+            yield this.cloneRepo();
+            this.isInit = true;
+            yield this.git.raw(['checkout', '-b', 'main']);
+        });
+    }
+    setHead() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.git
+                .raw(['symbolic-ref', 'HEAD', 'refs/heads/main'])
+                .then(() => this.git.remote(['set-head', 'origin', 'main']))
+                .catch(err => console.log('set head failed ', err));
+        });
+    }
+    push() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield this.git
+                .push('origin', 'main', ['-u'])
+                .catch(err => console.log('push failed ', err));
+        });
+    }
+    checkout(branchName, from) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.git.checkoutBranch(branchName, from);
+        });
+    }
+    stageAll(files = ['.']) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.git.add(files);
+        });
+    }
+    getGitLog() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const log = yield this.git.log();
+            return log.all;
+        });
+    }
+    stageAndCommitAll(files) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.stageAll(files).then(() => this.git.commit('commit message'));
+        });
+    }
+    tearDown() {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield fs_1.default.promises.rm(this.rootDir, { recursive: true, force: true });
+        });
+    }
+    createOrUpdateFile(fileName, content) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const fPath = path_1.default.join(this.testRepoDir, fileName);
+            if (fs_1.default.existsSync(fPath)) {
+                yield fs_1.default.promises.appendFile(fPath, content);
+            }
+            else {
+                yield fs_1.default.promises.writeFile(fPath, content);
+            }
+        });
+    }
+    rmFile(file) {
+        fs_1.default.unlinkSync(path_1.default.join(this.testRepoDir, file));
+    }
+    renameFileInRepo(from, to) {
+        const fromPath = path_1.default.join(this.testRepoDir, from);
+        const toPath = path_1.default.join(this.testRepoDir, to);
+        fs_1.default.renameSync(fromPath, toPath);
+    }
+}
+exports.RepoManager = RepoManager;
+RepoManager.instances = new Map();

package/lib/test/Git/Git.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,177 @@
+"use strict";
+/*
+ * Copyright (c) 2023, FinancialForce.com, inc. All rights reserved.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const Git_1 = require("../../src/Git/Git");
+const RepoManager_1 = require("../FsUtils/RepoManager");
+describe('Git', () => {
+    const repoManager = RepoManager_1.RepoManager.getInstance('./test/repos');
+    beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        yield repoManager.init();
+    }));
+    afterEach(() => __awaiter(void 0, void 0, void 0, function* () {
+        yield repoManager.tearDown();
+    }));
+    describe('version check', () => {
+        it('does not fail when Git version is equal to 2.37.0', () => {
+            //Given/When
+            const mock = {
+                version: jest.fn().mockReturnValue({ major: 2, minor: 37, patch: 0 }),
+            };
+            expect(Git_1.Git.versionCheck(mock)).resolves;
+        });
+        it('fails when Git major version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given/When
+            const mock = {
+                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'));
+        }));
+        it('fails when Git minor version is lower', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given/When
+            const mock = {
+                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'));
+        }));
+        it('fails when Git patch version is more than 0', () => {
+            //Given/When
+            const mock = {
+                version: jest.fn().mockReturnValue({ major: 3, minor: 38, patch: 1 }),
+            };
+            //Then
+            expect(Git_1.Git.versionCheck(mock)).resolves;
+        });
+    });
+    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
+            yield expect(new Git_1.Git(repoManager.repoDir).getDefaultBranchName()).rejects.toThrow(Error("Failed to find symbolic ref no remote HEAD with message: 'fatal: ref refs/remotes/origin/HEAD is not a symbolic ref'"));
+        }));
+        it('find default branch name when head is set', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            yield repoManager
+                .createOrUpdateFile('file.txt', 'Test Text')
+                .then(() => repoManager.stageAndCommitAll(['file.txt']))
+                .then(() => repoManager.push())
+                .then(() => repoManager.setHead());
+            //When
+            const branchName = yield new Git_1.Git(repoManager.repoDir).getDefaultBranchName();
+            //Then
+            expect(branchName).toBe('origin/main');
+        }));
+        it('find default branch name when head is set', () => __awaiter(void 0, void 0, void 0, function* () {
+            //Given
+            yield repoManager
+                .createOrUpdateFile('file.txt', 'Test Text')
+                .then(() => repoManager.stageAndCommitAll(['file.txt']))
+                .then(() => repoManager.push())
+                .then(() => repoManager.setHead());
+            //When
+            const branchName = yield new Git_1.Git(repoManager.repoDir).getDefaultBranchName();
+            //Then
+            expect(branchName).toBe('origin/main');
+        }));
+    });
+    describe('file change operations', () => {
+        beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+            yield repoManager
+                .createOrUpdateFile('file.txt', 'text')
+                .then(() => repoManager.stageAndCommitAll(['file.txt']))
+                .then(() => repoManager.push())
+                .then(() => repoManager.setHead());
+        }));
+        describe('local changes', () => {
+            it('finds modified files', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                yield repoManager.createOrUpdateFile('file.txt', 'modify');
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).getLocalChangedAndCreated();
+                //Then
+                expect(files).toEqual(new Set(['file.txt']));
+            }));
+            it('finds unstaged renamed files', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                repoManager.renameFileInRepo('file.txt', 'renamed.txt');
+                // await repoManager.gitStage();
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).getLocalChangedAndCreated();
+                //Then
+                expect(files).toEqual(new Set(['renamed.txt']));
+            }));
+            it('finds unstaged new files', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                yield repoManager.createOrUpdateFile('newFile.txt', 'content');
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).getLocalChangedAndCreated();
+                //Then
+                expect(files).toEqual(new Set(['newFile.txt']));
+            }));
+            it('does not include deleted files', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                repoManager.rmFile('file.txt');
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).getLocalChangedAndCreated();
+                //Then
+                expect(files).toEqual(new Set());
+            }));
+            it('finds staged renamed, modified and new files ', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Setup for renamed file
+                yield repoManager
+                    .createOrUpdateFile('second.txt', 'txt')
+                    .then(() => repoManager.stageAndCommitAll(['second.txt']));
+                //Given
+                yield repoManager
+                    .createOrUpdateFile('file.txt', 'modifiy')
+                    .then(() => repoManager.renameFileInRepo('second.txt', 'renamed.txt'))
+                    .then(() => repoManager.createOrUpdateFile('newFile.txt', 'content'))
+                    .then(() => repoManager.stageAll());
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).getLocalChangedAndCreated();
+                //Then
+                expect(files).toEqual(new Set(['file.txt', 'renamed.txt', 'newFile.txt']));
+            }));
+        });
+        describe('branch diff changes', () => {
+            beforeEach(() => __awaiter(void 0, void 0, void 0, function* () {
+                yield repoManager
+                    .checkout('dev', 'main')
+                    .then(() => repoManager.createOrUpdateFile('newFile.txt', 'text'))
+                    .then(() => repoManager.stageAndCommitAll(['newFile.txt']));
+            }));
+            it('finds diff against for default branch and HEAD', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                yield repoManager
+                    .createOrUpdateFile('anotherFileForCommit.txt', 'text')
+                    .then(() => repoManager.stageAndCommitAll(['anotherFileForCommit.txt']));
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).diffRange('origin/main', 'HEAD');
+                //Then
+                expect(files).toEqual(new Set(['newFile.txt', 'anotherFileForCommit.txt']));
+            }));
+            it('finds diff against default branch and commit ref', () => __awaiter(void 0, void 0, void 0, function* () {
+                //Given
+                const currentRef = (yield repoManager.getGitLog())[0].hash;
+                yield repoManager
+                    .createOrUpdateFile('anotherFileForCommit.txt', 'text')
+                    .then(() => repoManager.stageAndCommitAll(['anotherFileForCommit.txt']));
+                //When
+                const files = yield new Git_1.Git(repoManager.repoDir).diffRange('origin/main', currentRef);
+                //Then
+                expect(files).toEqual(new Set(['newFile.txt']));
+            }));
+        });
+    });
+});

package/package.json

@@ -0,0 +1,119 @@
+{
+  "name": "@apexdevtools/git-ops",
+  "version": "1.0.0",
+  "description": "Library to do git operations to find changed files in a given git repository",
+  "author": {
+    "name": "Apex Dev Tools Team",
+    "email": "apexdevtools@gmail.com",
+    "url": "https://github.com/apex-dev-tools"
+  },
+  "main": "./lib/src/index.js",
+  "license": "BSD-3-Clause",
+  "files": [
+    "lib/**/*",
+    "CHANGELOG.md"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/apex-dev-tools/git-ops.git"
+  },
+  "engines": {
+    "node": ">=14.0"
+  },
+  "keywords": [
+    "salesforce",
+    "apex",
+    "apexlink"
+  ],
+  "bugs": {
+    "url": "https://github.com/apex-dev-tools/git-ops/issues"
+  },
+  "homepage": "https://github.com/apex-dev-tools/git-ops#readme",
+  "devDependencies": {
+    "@ryansonshine/commitizen": "4.2.8",
+    "@ryansonshine/cz-conventional-changelog": "3.3.4",
+    "@types/jest": "^29.4.0",
+    "@types/node": "^18.11.19",
+    "@typescript-eslint/eslint-plugin": "^5.52.0",
+    "@typescript-eslint/parser": "^5.0.0",
+    "conventional-changelog-conventionalcommits": "5.0.0",
+    "eslint": "7.25.0",
+    "eslint-config-prettier": "8.3.0",
+    "eslint-plugin-node": "11.1.0",
+    "eslint-plugin-prettier": "3.4.0",
+    "husky": "^8.0.0",
+    "jest": "^29.4.2",
+    "lint-staged": "10.5.4",
+    "prettier": "2.2.1",
+    "semantic-release": "19.0.2",
+    "ts-jest": "^29.0.5",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "install": "^0.13.0",
+    "simple-git": "^3.16.0"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/@ryansonshine/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.ts": "eslint --cache --cache-location .eslintcache --fix"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "type": "build",
+              "scope": "deps",
+              "release": "patch"
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "build",
+                "section": "Dependencies and Other Build Updates",
+                "hidden": false
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/npm",
+      "@semantic-release/github"
+    ]
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf ./lib/",
+    "cm": "cz",
+    "lint": "eslint ./src/ --fix",
+    "semantic-release": "semantic-release",
+    "test:watch": "jest --watch",
+    "test": "jest --coverage --runInBand",
+    "typecheck": "tsc --noEmit"
+  }
+}