release: v4.3.0

__tests__/git-helper.test.ts

@@ -8,10 +8,16 @@ import {
   testChildProcess,
   spyOnSpawn,
   execCalledWith,
+  spyOnStdout,
+  stdoutCalledWith,
 } from '@technote-space/github-action-test-helper';
 import {Logger} from '@technote-space/github-action-log-helper';
+import {ExecException} from 'child_process';
 import {GitHelper} from '../src';
 
+beforeEach(() => {
+  Logger.resetForTesting();
+});
 const workDir   = '.work';
 const setExists = testFs(true);
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -895,3 +901,75 @@ describe('GitHelper without params', () => {
     });
   });
 });
+
+describe('Debug', () => {
+  testEnv();
+  testChildProcess();
+
+  const helper = new GitHelper(new Logger(), {token: 'token1'});
+
+  it('should add command to suppress error and output', async() => {
+    const mockExec   = spyOnSpawn();
+    const mockStdout = spyOnStdout();
+    mockExec.mockImplementation(() => {
+      const error: ExecException = new Error('test error');
+      error.code                 = 123;
+      throw error;
+    });
+
+    await expect(helper.addOrigin(workDir, context())).rejects.toThrow('command [git remote add origin] exited with code 123.');
+
+    execCalledWith(mockExec, [
+      'git remote add origin \'https://octocat:[email protected]/hello/world.git\' > /dev/null 2>&1 || :',
+    ]);
+    stdoutCalledWith(mockStdout, [
+      '[command]git remote add origin',
+      'undefined',
+      '{}',
+    ]);
+  });
+
+  it('should not add command to suppress error', async() => {
+    process.env.ACTIONS_UTILS_DEBUG = 'true';
+    const mockExec                  = spyOnSpawn();
+    const mockStdout                = spyOnStdout();
+    mockExec.mockImplementation(() => {
+      const error: ExecException = new Error('test error');
+      error.code                 = 123;
+      throw error;
+    });
+
+    await expect(helper.addOrigin(workDir, context())).rejects.toThrow('command [git remote add origin] exited with code 123.');
+
+    execCalledWith(mockExec, [
+      'git remote add origin \'https://octocat:[email protected]/hello/world.git\' > /dev/null 2>&1',
+    ]);
+    stdoutCalledWith(mockStdout, [
+      '[command]git remote add origin',
+      'undefined',
+      '{}',
+    ]);
+  });
+
+  it('should not add command to suppress error output', async() => {
+    process.env.ACTIONS_STEP_DEBUG = 'true';
+    const mockExec                 = spyOnSpawn();
+    const mockStdout               = spyOnStdout();
+    mockExec.mockImplementation(() => {
+      const error: ExecException = new Error('test error');
+      error.code                 = 123;
+      throw error;
+    });
+
+    await expect(helper.addOrigin(workDir, context())).rejects.toThrow('command [git remote add origin] exited with code 123.');
+
+    execCalledWith(mockExec, [
+      'git remote add origin \'https://octocat:[email protected]/hello/world.git\' || :',
+    ]);
+    stdoutCalledWith(mockStdout, [
+      '[command]git remote add origin',
+      'undefined',
+      '{}',
+    ]);
+  });
+});

__tests__/utils2.test.ts

@@ -2,8 +2,8 @@
 import {testEnv} from '@technote-space/github-action-test-helper';
 import {Utils} from '../src';
 
-const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, mask}                    = Utils;
-const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit, replaceVariables} = Utils;
+const {generateNewPatchVersion, generateNewMinorVersion, generateNewMajorVersion, arrayChunk, versionCompare, mask, isActionsStepDebug}         = Utils;
+const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, getOctokit, replaceVariables, isDebug} = Utils;
 
 jest.useFakeTimers();
 
@@ -263,3 +263,59 @@ describe('replaceVariables', () => {
     ])).toBe('1/2/3/${test4}');
   });
 });
+
+describe('isDebug', () => {
+  testEnv();
+
+  it('should return true', () => {
+    process.env.ACTIONS_UTILS_DEBUG = 'true';
+    expect(isDebug()).toBe(true);
+  });
+
+  it('should return false 1', () => {
+    expect(isDebug()).toBe(false);
+  });
+
+  it('should return false 2', () => {
+    process.env.ACTIONS_UTILS_DEBUG = '';
+    expect(isDebug()).toBe(false);
+  });
+
+  it('should return false 3', () => {
+    process.env.ACTIONS_UTILS_DEBUG = '1';
+    expect(isDebug()).toBe(false);
+  });
+
+  it('should return false 4', () => {
+    process.env.ACTIONS_UTILS_DEBUG = 'abc';
+    expect(isDebug()).toBe(false);
+  });
+});
+
+describe('isActionsStepDebug', () => {
+  testEnv();
+
+  it('should return true', () => {
+    process.env.ACTIONS_STEP_DEBUG = 'true';
+    expect(isActionsStepDebug()).toBe(true);
+  });
+
+  it('should return false 1', () => {
+    expect(isActionsStepDebug()).toBe(false);
+  });
+
+  it('should return false 2', () => {
+    process.env.ACTIONS_STEP_DEBUG = '';
+    expect(isActionsStepDebug()).toBe(false);
+  });
+
+  it('should return false 3', () => {
+    process.env.ACTIONS_STEP_DEBUG = '1';
+    expect(isActionsStepDebug()).toBe(false);
+  });
+
+  it('should return false 4', () => {
+    process.env.ACTIONS_STEP_DEBUG = 'abc';
+    expect(isActionsStepDebug()).toBe(false);
+  });
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/github-action-helper",
-  "version": "4.2.7",
+  "version": "4.3.0",
   "description": "Helper for GitHub Action.",
   "keywords": [
     "github",
@@ -46,17 +46,17 @@
     "@commitlint/config-conventional": "^11.0.0",
     "@technote-space/github-action-test-helper": "^0.6.4",
     "@types/jest": "^26.0.15",
-    "@types/node": "^14.14.8",
+    "@types/node": "^14.14.9",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
-    "eslint": "^7.13.0",
+    "eslint": "^7.14.0",
     "husky": "^4.3.0",
     "jest": "^26.6.3",
     "jest-circus": "^26.6.3",
     "lint-staged": "^10.5.1",
     "nock": "^13.0.5",
     "ts-jest": "^26.4.4",
-    "typescript": "^4.0.5"
+    "typescript": "^4.1.2"
   },
   "publishConfig": {
     "access": "public"

src/git-helper.ts

@@ -15,6 +15,8 @@ import {
   getAccessToken,
   generateNewMinorVersion,
   generateNewMajorVersion,
+  isDebug,
+  isActionsStepDebug,
 } from './utils';
 import {getGitUrlWithToken} from './context-helper';
 
@@ -63,6 +65,16 @@ export default class GitHelper {
     }
   }
 
+  /**
+   * @return {boolean} should suppress error
+   */
+  private shouldSuppressError = (): boolean => !isDebug();
+
+  /**
+   * @return {boolean} is quiet?
+   */
+  private isQuiet = (): boolean => !isActionsStepDebug() && (!this.origin || this.quietIfNotOrigin);
+
   /**
    * @param {string} workDir work dir
    * @param {string[]} commands commands
@@ -147,15 +159,10 @@ export default class GitHelper {
       args: [this.getRemoteName(), getGitUrlWithToken(context, this.token)],
       quiet: this.isQuiet(),
       altCommand: `git remote add ${this.getRemoteName()}`,
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
     });
   };
 
-  /**
-   * @return {boolean} is quiet?
-   */
-  private isQuiet = (): boolean => !this.origin || this.quietIfNotOrigin;
-
   /**
    * @param {string} workDir work dir
    * @return {Promise<string>} branch name
@@ -167,7 +174,7 @@ export default class GitHelper {
     return (await this.runCommand(workDir, {
       command: 'git rev-parse',
       args: ['--abbrev-ref', 'HEAD'],
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
       stderrToStdout: true,
     }))[0].stdout[0]?.trim() ?? '';
   };
@@ -184,7 +191,7 @@ export default class GitHelper {
       args: [`--branch=${branch}`, this.cloneDepth, this.getRemote(context), '.'],
       quiet: this.isQuiet(),
       altCommand: `git clone --branch=${branch}`,
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
     });
   };
 
@@ -200,7 +207,7 @@ export default class GitHelper {
         args: [this.cloneDepth, this.getRemote(context), '.'],
         quiet: this.isQuiet(),
         altCommand: 'git clone',
-        suppressError: true,
+        suppressError: this.shouldSuppressError(),
       },
       {
         command: 'git fetch',
@@ -261,7 +268,7 @@ export default class GitHelper {
         this.getRemoteName(),
         ...(refspec ?? []),
       ],
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
       stderrToStdout: true,
     });
   };
@@ -295,7 +302,7 @@ export default class GitHelper {
       args: ['--prune', '--no-recurse-submodules', this.cloneDepth, this.getRemote(context), `+refs/heads/${branchName}:refs/remotes/${this.getRemoteName()}/${branchName}`],
       quiet: this.isQuiet(),
       altCommand: `git fetch --prune --no-recurse-submodules${this.cloneDepth} ${this.getRemoteName()} +refs/heads/${branchName}:refs/remotes/${this.getRemoteName()}/${branchName}`,
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
     });
   };
 
@@ -317,7 +324,7 @@ export default class GitHelper {
     await this.runCommand(workDir, {
       command: 'git checkout',
       args: ['-b', branch, `${this.getRemoteName()}/${branch}`],
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
       stderrToStdout: true,
     });
   };
@@ -465,7 +472,7 @@ export default class GitHelper {
         args: [this.getRemote(context), '--delete', ...tags],
         quiet: this.isQuiet(),
         altCommand: `git push ${this.getRemoteName()} --delete ${tags.join(' ')}`,
-        suppressError: true,
+        suppressError: this.shouldSuppressError(),
       })),
     );
     await this.deleteLocalTag(workDir, tags, splitSize);
@@ -506,7 +513,7 @@ export default class GitHelper {
       tags => ({
         command: 'git tag',
         args: ['-d', ...tags],
-        suppressError: true,
+        suppressError: this.shouldSuppressError(),
         stderrToStdout: true,
       }),
     ));
@@ -550,7 +557,7 @@ export default class GitHelper {
       args: args.concat([this.getRemote(context), `${branch}:refs/heads/${branch}`]),
       quiet: this.isQuiet(),
       altCommand: `git push ${args.concat([this.getRemoteName(), `${branch}:refs/heads/${branch}`]).join(' ')}`,
-      suppressError: true,
+      suppressError: this.shouldSuppressError(),
     });
   };
 

src/utils.ts

@@ -252,3 +252,7 @@ export const replaceVariables = async(string: string, variables: { key: string;
 
   return replaced;
 };
+
+export const isDebug = (): boolean => process.env.ACTIONS_UTILS_DEBUG === 'true';
+
+export const isActionsStepDebug = (): boolean => process.env.ACTIONS_STEP_DEBUG === 'true';