From c29821586c49989347c4acac0fb13042921bc0ea Mon Sep 17 00:00:00 2001 From: Peter Evans <18365890+peter-evans@users.noreply.github.com> Date: Wed, 31 Jul 2024 21:28:37 +0000 Subject: [PATCH] add tests for building file changes --- __test__/create-or-update-branch.int.test.ts | 49 ++++++++++- dist/index.js | 60 +++++++------- src/create-or-update-branch.ts | 86 ++++++++++---------- 3 files changed, 123 insertions(+), 72 deletions(-) diff --git a/__test__/create-or-update-branch.int.test.ts b/__test__/create-or-update-branch.int.test.ts index 3e8414b..9955fdd 100644 --- a/__test__/create-or-update-branch.int.test.ts +++ b/__test__/create-or-update-branch.int.test.ts @@ -1,7 +1,8 @@ import { createOrUpdateBranch, tryFetch, - getWorkingBaseAndType + getWorkingBaseAndType, + buildFileChanges } from '../lib/create-or-update-branch' import * as fs from 'fs' import {GitCommandManager} from '../lib/git-command-manager' @@ -229,6 +230,52 @@ describe('create-or-update-branch tests', () => { expect(workingBaseType).toEqual('commit') }) + it('tests buildFileChanges with addition and modification', async () => { + await git.checkout(BRANCH, BASE) + const changes = await createChanges() + await git.exec(['add', '-A']) + await git.commit(['-m', 'Test changes']) + + const fileChanges = await buildFileChanges(git, BASE, BRANCH) + + expect(fileChanges.additions).toEqual([ + { + path: TRACKED_FILE, + contents: Buffer.from(changes.tracked, 'binary').toString('base64') + }, + { + path: UNTRACKED_FILE, + contents: Buffer.from(changes.untracked, 'binary').toString('base64') + } + ]) + expect(fileChanges.deletions.length).toEqual(0) + }) + + it('tests buildFileChanges with addition and deletion', async () => { + await git.checkout(BRANCH, BASE) + const changes = await createChanges() + const TRACKED_FILE_NEW_PATH = 'c/tracked-file.txt' + const filepath = path.join(REPO_PATH, TRACKED_FILE_NEW_PATH) + await fs.promises.mkdir(path.dirname(filepath), {recursive: true}) + await fs.promises.rename(path.join(REPO_PATH, TRACKED_FILE), filepath) + await git.exec(['add', '-A']) + await git.commit(['-m', 'Test changes']) + + const fileChanges = await buildFileChanges(git, BASE, BRANCH) + + expect(fileChanges.additions).toEqual([ + { + path: UNTRACKED_FILE, + contents: Buffer.from(changes.untracked, 'binary').toString('base64') + }, + { + path: TRACKED_FILE_NEW_PATH, + contents: Buffer.from(changes.tracked, 'binary').toString('base64') + } + ]) + expect(fileChanges.deletions).toEqual([{path: TRACKED_FILE}]) + }) + it('tests no changes resulting in no new branch being created', async () => { const commitMessage = uuidv4() const result = await createOrUpdateBranch( diff --git a/dist/index.js b/dist/index.js index d0a3284..fc70335 100644 --- a/dist/index.js +++ b/dist/index.js @@ -42,6 +42,7 @@ Object.defineProperty(exports, "__esModule", ({ value: true })); exports.WorkingBaseType = void 0; exports.getWorkingBaseAndType = getWorkingBaseAndType; exports.tryFetch = tryFetch; +exports.buildFileChanges = buildFileChanges; exports.createOrUpdateBranch = createOrUpdateBranch; const core = __importStar(__nccwpck_require__(2186)); const uuid_1 = __nccwpck_require__(5840); @@ -82,6 +83,35 @@ function tryFetch(git, remote, branch, depth) { } }); } +function buildFileChanges(git, base, branch) { + return __awaiter(this, void 0, void 0, function* () { + const fileChanges = { + additions: [], + deletions: [] + }; + const changedFiles = yield git.getChangedFiles([ + '--diff-filter=AM', + `${base}..${branch}` + ]); + const deletedFiles = yield git.getChangedFiles([ + '--diff-filter=D', + `${base}..${branch}` + ]); + const repoPath = git.getWorkingDirectory(); + for (const file of changedFiles) { + fileChanges.additions.push({ + path: file, + contents: utils.readFileBase64([repoPath, file]) + }); + } + for (const file of deletedFiles) { + fileChanges.deletions.push({ + path: file + }); + } + return fileChanges; + }); +} // Return the number of commits that branch2 is ahead of branch1 function commitsAhead(git, branch1, branch2) { return __awaiter(this, void 0, void 0, function* () { @@ -261,35 +291,7 @@ function createOrUpdateBranch(git, commitMessage, base, branch, branchRemoteName result.hasDiffWithBase = yield isAhead(git, base, branch); } if (result.hasDiffWithBase) { - // Build file changes - result.fileChanges = { - additions: [], - deletions: [] - }; - const changedFiles = yield git.getChangedFiles([ - '--diff-filter=M', - `${base}..${branch}` - ]); - const deletedFiles = yield git.getChangedFiles([ - '--diff-filter=D', - `${base}..${branch}` - ]); - core.debug(`Changed files: '${JSON.stringify(changedFiles)}'`); - core.debug(`Deleted files: '${JSON.stringify(deletedFiles)}'`); - const repoPath = git.getWorkingDirectory(); - for (const file of changedFiles) { - core.debug(`Reading contents of file: '${file}'`); - result.fileChanges.additions.push({ - path: file, - contents: utils.readFileBase64([repoPath, file]) - }); - } - for (const file of deletedFiles) { - core.debug(`Marking file as deleted: '${file}'`); - result.fileChanges.deletions.push({ - path: file - }); - } + result.fileChanges = yield buildFileChanges(git, base, branch); } // Get the pull request branch SHA result.headSha = yield git.revParse('HEAD'); diff --git a/src/create-or-update-branch.ts b/src/create-or-update-branch.ts index 9ee8829..e31dde6 100644 --- a/src/create-or-update-branch.ts +++ b/src/create-or-update-branch.ts @@ -48,6 +48,38 @@ export async function tryFetch( } } +export async function buildFileChanges( + git: GitCommandManager, + base: string, + branch: string +): Promise { + const fileChanges: FileChanges = { + additions: [], + deletions: [] + } + const changedFiles = await git.getChangedFiles([ + '--diff-filter=AM', + `${base}..${branch}` + ]) + const deletedFiles = await git.getChangedFiles([ + '--diff-filter=D', + `${base}..${branch}` + ]) + const repoPath = git.getWorkingDirectory() + for (const file of changedFiles) { + fileChanges.additions!.push({ + path: file, + contents: utils.readFileBase64([repoPath, file]) + }) + } + for (const file of deletedFiles) { + fileChanges.deletions!.push({ + path: file + }) + } + return fileChanges +} + // Return the number of commits that branch2 is ahead of branch1 async function commitsAhead( git: GitCommandManager, @@ -111,20 +143,22 @@ function splitLines(multilineString: string): string[] { .filter(x => x !== '') } +interface FileChanges { + additions: { + path: string + contents: string + }[] + deletions: { + path: string + }[] +} + interface CreateOrUpdateBranchResult { action: string base: string hasDiffWithBase: boolean headSha: string - fileChanges?: { - additions: { - path: string - contents: string - }[] - deletions: { - path: string - }[] - } + fileChanges?: FileChanges } export async function createOrUpdateBranch( @@ -300,39 +334,7 @@ export async function createOrUpdateBranch( } if (result.hasDiffWithBase) { - // Build file changes - result.fileChanges = { - additions: [], - deletions: [] - } - - const changedFiles = await git.getChangedFiles([ - '--diff-filter=M', - `${base}..${branch}` - ]) - const deletedFiles = await git.getChangedFiles([ - '--diff-filter=D', - `${base}..${branch}` - ]) - - core.debug(`Changed files: '${JSON.stringify(changedFiles)}'`) - core.debug(`Deleted files: '${JSON.stringify(deletedFiles)}'`) - - const repoPath = git.getWorkingDirectory() - for (const file of changedFiles) { - core.debug(`Reading contents of file: '${file}'`) - result.fileChanges.additions!.push({ - path: file, - contents: utils.readFileBase64([repoPath, file]) - }) - } - - for (const file of deletedFiles) { - core.debug(`Marking file as deleted: '${file}'`) - result.fileChanges.deletions!.push({ - path: file - }) - } + result.fileChanges = await buildFileChanges(git, base, branch) } // Get the pull request branch SHA