fix(git): checkout fails if branch does not exist (#1333)

* fix(git): checkout fails if branch does not exist

* fix the issue

Author: mrgrain

src/help/git.ts

@@ -136,7 +136,7 @@ export function push(ref: string) {
 export function checkout(branch: string, options: { createIfMissing?: boolean } ) {
   if (options.createIfMissing) {
     try {
-      shell.run(`git show-branch origin/${branch}`);
+      shell.run(`git show-branch origin/${branch}`, { capture: true });
     } catch (e) {
       if (e instanceof Error && e.message.includes('fatal: bad sha1 reference')) {
         console.log('Remote branch not found, creating new branch.');

test/targets/git-mocked.test.ts

@@ -0,0 +1,70 @@
+import * as git from '../../src/help/git';
+import * as shell from '../../src/help/shell';
+
+// mock shell.run
+jest.mock('../../src/help/shell');
+const mockedShellRun = (shell.run as unknown) as jest.Mock<typeof shell.run>;
+
+// restore env after each test
+const OLD_ENV = process.env;
+
+beforeEach(() => {
+  jest.resetModules(); // Most important - it clears the cache
+  process.env = { ...OLD_ENV }; // Make a copy
+});
+
+afterAll(() => {
+  process.env = OLD_ENV; // Restore old environment
+});
+
+// test
+test('clone with token', () => {
+  process.env.GITHUB_TOKEN = 'my-token';
+
+  git.clone('github.com/cdklabs/publib', 'target');
+
+  expect(mockedShellRun.mock.calls).toHaveLength(1);
+  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
+});
+
+test('clone with ssh', () => {
+  process.env.GITHUB_USE_SSH = '1';
+
+  git.clone('github.com/cdklabs/publib', 'target');
+
+  expect(mockedShellRun.mock.calls).toHaveLength(1);
+  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone [email protected]:cdklabs/publib.git target']);
+});
+
+test('throw exception without token or ssh', () => {
+  const t = () => git.clone('github.com/cdklabs/publib', 'target');
+  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
+});
+
+test('throw exception without ghe authentication for github enterprise repo', () => {
+  const t = () => git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
+  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
+});
+
+test('throw exception with incomplete ghe authentication for github enterprise repo', () => {
+  process.env.GITHUB_ENTERPRISE_TOKEN = 'valid-token';
+  const t = () => git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
+  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
+});
+
+test('clone with provided ghe authentication for github enterprise repo but no set github api url', () => {
+  process.env.GH_ENTERPRISE_TOKEN = 'valid-token';
+  process.env.GH_HOST = 'github.corporate-enterprise.com';
+  git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
+  expect(mockedShellRun.mock.calls).toHaveLength(1);
+  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
+});
+
+test('clone with provided ghe authentication for github enterprise repo and with non-public github api url', () => {
+  process.env.GH_ENTERPRISE_TOKEN = 'valid-token';
+  process.env.GH_HOST = 'github.corporate-enterprise.com';
+  process.env.GITHUB_API_URL = 'https://api.github.corporate-enterprise.com';
+  git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
+  expect(mockedShellRun.mock.calls).toHaveLength(1);
+  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
+});

test/targets/git.test.ts

@@ -1,70 +1,35 @@
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
 import * as git from '../../src/help/git';
 import * as shell from '../../src/help/shell';
 
-// mock shell.run
-jest.mock('../../src/help/shell');
-const mockedShellRun = (shell.run as unknown) as jest.Mock<typeof shell.run>;
-
-// restore env after each test
-const OLD_ENV = process.env;
-
+let shellRunSpy: jest.SpyInstance<string, Parameters<typeof shell.run>>;
 beforeEach(() => {
-  jest.resetModules(); // Most important - it clears the cache
-  process.env = { ...OLD_ENV }; // Make a copy
+  shellRunSpy = jest.spyOn(shell, 'run');
 });
-
-afterAll(() => {
-  process.env = OLD_ENV; // Restore old environment
+afterEach(() => {
+  jest.clearAllMocks();
 });
 
-// test
-test('clone with token', () => {
-  process.env.GITHUB_TOKEN = 'my-token';
 
-  git.clone('github.com/cdklabs/publib', 'target');
-
-  expect(mockedShellRun.mock.calls).toHaveLength(1);
-  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
+test('checkout with createIfMissing', () => {
+  withTmpDir(() => {
+    git.init();
+    git.checkout('main', { createIfMissing: true });
+  });
+  expect(shellRunSpy.mock.calls).toHaveLength(3); // init, show-branch, checkout -B
+  expect(shellRunSpy.mock.calls[2]).toEqual(['git checkout -B main']);
 });
 
-test('clone with ssh', () => {
-  process.env.GITHUB_USE_SSH = '1';
-
-  git.clone('github.com/cdklabs/publib', 'target');
-
-  expect(mockedShellRun.mock.calls).toHaveLength(1);
-  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone [email protected]:cdklabs/publib.git target']);
-});
-
-test('throw exception without token or ssh', () => {
-  const t = () => git.clone('github.com/cdklabs/publib', 'target');
-  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
-});
-
-test('throw exception without ghe authentication for github enterprise repo', () => {
-  const t = () => git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
-  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
-});
-
-test('throw exception with incomplete ghe authentication for github enterprise repo', () => {
-  process.env.GITHUB_ENTERPRISE_TOKEN = 'valid-token';
-  const t = () => git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
-  expect(t).toThrow('GITHUB_TOKEN env variable is required when GITHUB_USE_SSH env variable is not used');
-});
-
-test('clone with provided ghe authentication for github enterprise repo but no set github api url', () => {
-  process.env.GH_ENTERPRISE_TOKEN = 'valid-token';
-  process.env.GH_HOST = 'github.corporate-enterprise.com';
-  git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
-  expect(mockedShellRun.mock.calls).toHaveLength(1);
-  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
-});
-
-test('clone with provided ghe authentication for github enterprise repo and with non-public github api url', () => {
-  process.env.GH_ENTERPRISE_TOKEN = 'valid-token';
-  process.env.GH_HOST = 'github.corporate-enterprise.com';
-  process.env.GITHUB_API_URL = 'https://api.github.corporate-enterprise.com';
-  git.clone('github.corporate-enterprise.com/cdklabs/publib', 'target');
-  expect(mockedShellRun.mock.calls).toHaveLength(1);
-  expect(mockedShellRun.mock.calls[0]).toEqual(['git clone https://[email protected]/cdklabs/publib.git target']);
-});
+function withTmpDir(fn: (tmpDir: string) => void) {
+  const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'test-'));
+  const cwd = process.cwd();
+  try {
+    process.chdir(tmpDir);
+    fn(tmpDir);
+  } finally {
+    fs.rmSync(tmpDir, { recursive: true, force: true });
+    process.chdir(cwd);
+  }
+}