cli-node: lift over git

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-04-06 11:34:53 +02:00
parent 65a7a7620d
commit b396202ac6
4 changed files with 38 additions and 1 deletions
@@ -1,52 +0,0 @@
-/*
- * Copyright 2022 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { runGit, listChangedFiles } from './git';
-
-describe('runGit', () => {
-  it('runs a git command', async () => {
-    await expect(runGit('log', 'HEAD..HEAD')).resolves.toEqual(['']);
-  });
-
-  it('fails for unknown commands', async () => {
-    await expect(runGit('ryckbegäran')).rejects.toThrow(
-      /^git ryckbegäran failed, git: 'ryckbegäran' is not a git command/,
-    );
-  });
-
-  it('forwards failures', async () => {
-    await expect(
-      runGit(
-        'show',
-        '--quiet',
-        '--pretty=format:%s',
-        '0000000000000000000000000000000000000000',
-      ),
-    ).rejects.toThrow(
-      'git show failed, fatal: bad object 0000000000000000000000000000000000000000',
-    );
-  });
-});
-
-describe('listChangedFiles', () => {
-  it('requires a ref', async () => {
-    await expect(listChangedFiles('')).rejects.toThrow('ref is required');
-  });
-
-  it('should return something', async () => {
-    await expect(listChangedFiles('HEAD')).resolves.toEqual(expect.any(Array));
-  });
-});
@@ -1,86 +0,0 @@
-/*
- * Copyright 2022 The Backstage Authors
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { assertError, ForwardedError } from '@backstage/errors';
-import { execFile as execFileCb } from 'child_process';
-import { promisify } from 'util';
-import { paths } from './paths';
-
-const execFile = promisify(execFileCb);
-
-/**
- * Run a git command, trimming the output splitting it into lines.
- */
-export async function runGit(...args: string[]) {
-  try {
-    const { stdout } = await execFile('git', args, {
-      shell: true,
-      cwd: paths.targetRoot,
-    });
-    return stdout.trim().split(/\r\n|\r|\n/);
-  } catch (error) {
-    assertError(error);
-    if (error.stderr || typeof error.code === 'number') {
-      const stderr = (error.stderr as undefined | Buffer)?.toString('utf8');
-      const msg = stderr?.trim() ?? `with exit code ${error.code}`;
-      throw new Error(`git ${args[0]} failed, ${msg}`);
-    }
-    throw new ForwardedError('Unknown execution error', error);
-  }
-}
-
-/**
- * Returns a sorted list of all files that have changed since the merge base
- * of the provided `ref` and HEAD, as well as all files that are not tracked by git.
- */
-export async function listChangedFiles(ref: string) {
-  if (!ref) {
-    throw new Error('ref is required');
-  }
-
-  let diffRef = ref;
-  try {
-    const [base] = await runGit('merge-base', 'HEAD', ref);
-    diffRef = base;
-  } catch {
-    // silently fall back to using the ref directly if merge base is not available
-  }
-
-  const tracked = await runGit('diff', '--name-only', diffRef);
-  const untracked = await runGit('ls-files', '--others', '--exclude-standard');
-
-  return Array.from(new Set([...tracked, ...untracked]));
-}
-
-/**
- * Returns the contents of a file at a specific ref.
- */
-export async function readFileAtRef(path: string, ref: string) {
-  let showRef = ref;
-  try {
-    const [base] = await runGit('merge-base', 'HEAD', ref);
-    showRef = base;
-  } catch {
-    // silently fall back to using the ref directly if merge base is not available
-  }
-
-  const { stdout } = await execFile('git', ['show', `${showRef}:${path}`], {
-    shell: true,
-    cwd: paths.targetRoot,
-    maxBuffer: 1024 * 1024 * 50,
-  });
-  return stdout;
-}