Merge pull request #247 from technote-space/release/v1.1.8

Release/v1.1.8

Author: technote-space

__tests__/context-helper.test.ts

@@ -7,8 +7,8 @@ import {
 import { testEnv, getContext } from '@technote-space/github-action-test-helper';
 import { Logger, ContextHelper } from '../src';
 
-const {isRelease, isPush, isPr, isIssue, isCron, isCustomEvent, isCreateTag}         = ContextHelper;
-const {getGitUrl, getRepository, getTagName, getSender, removeToken, showActionInfo} = ContextHelper;
+const {isRelease, isPush, isPr, isIssue, isCron, isCustomEvent, isCreateTag} = ContextHelper;
+const {getGitUrl, getRepository, getTagName, getSender, showActionInfo}      = ContextHelper;
 
 describe('isRelease', () => {
 	it('should return true', () => {
@@ -222,52 +222,6 @@ describe('getSender', () => {
 	});
 });
 
-describe('removeToken', () => {
-	it('should remove token', () => {
-		expect(removeToken({})).toEqual({});
-		expect(removeToken({
-			test1: {
-				token: 'test',
-			},
-			test2: 2,
-			test3: {
-				test: 3,
-
-			},
-		})).toEqual({
-			test1: {},
-			test2: 2,
-			test3: {
-				test: 3,
-			},
-		});
-		expect(removeToken({
-			token: 'test',
-			test1: {
-				token: 'test',
-				test2: 2,
-				test3: 3,
-				test4: {
-					test5: {
-						token: 'test',
-						test6: 6,
-					},
-				},
-			},
-		})).toEqual({
-			test1: {
-				test2: 2,
-				test3: 3,
-				test4: {
-					test5: {
-						test6: 6,
-					},
-				},
-			},
-		});
-	});
-});
-
 describe('showActionInfo', () => {
 	beforeEach(() => {
 		Logger.resetForTesting();

__tests__/utils.test.ts

@@ -6,7 +6,7 @@ import { Utils } from '../src';
 const {getWorkspace, getActor, escapeRegExp, getRegExp, getPrefixRegExp, getSuffixRegExp, useNpm, versionCompare, getOctokit} = Utils;
 const {isSemanticVersioningTagName, isPrRef, getPrMergeRef, getBoolValue, replaceAll, getPrHeadRef, arrayChunk, sleep}        = Utils;
 const {getBranch, getRefForUpdate, uniqueArray, getBuildInfo, split, getArrayInput, generateNewPatchVersion, getPrBranch}     = Utils;
-const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec}                      = Utils;
+const {isBranch, isTagRef, normalizeRef, trimRef, getTag, getRefspec, getRemoteRefspec, getLocalRefspec, mask}                      = Utils;
 
 jest.useFakeTimers();
 
@@ -548,3 +548,54 @@ describe('getLocalRefspec', () => {
 		expect(getLocalRefspec('refs/pull/123/merge')).toBe('pull/123/merge');
 	});
 });
+
+describe('mask', () => {
+	it('should remove token', () => {
+		expect(mask({})).toEqual({});
+		expect(mask({
+			test1: {
+				token: 'test',
+			},
+			test2: 2,
+			test3: {
+				test: 3,
+
+			},
+		})).toEqual({
+			test1: {
+				token: '***'
+			},
+			test2: 2,
+			test3: {
+				test: 3,
+			},
+		});
+		expect(mask({
+			abc: 'test',
+			test1: {
+				abc: 'test',
+				test2: 2,
+				test3: 3,
+				test4: {
+					test5: {
+						abc: 'test',
+						test6: 6,
+					},
+				},
+			},
+		}, 'abc')).toEqual({
+			abc: '***',
+			test1: {
+				abc: '***',
+				test2: 2,
+				test3: 3,
+				test4: {
+					test5: {
+						abc: '***',
+						test6: 6,
+					},
+				},
+			},
+		});
+	});
+});

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@technote-space/github-action-helper",
-  "version": "1.1.7",
+  "version": "1.1.8",
   "description": "Helper to filter GitHub Action.",
   "author": {
     "name": "Technote",

src/context-helper.ts

@@ -1,7 +1,7 @@
 import path from 'path';
 import { Context } from '@actions/github/lib/context';
 import { Logger } from './index';
-import { getAccessToken, getActor, getBuildInfo } from './utils';
+import { getAccessToken, getActor, getBuildInfo, mask } from './utils';
 
 export const isRelease = (context: Context): boolean => 'release' === context.eventName;
 
@@ -29,18 +29,6 @@ export const getGitUrlWithToken = (context: Context, token?: string | undefined)
 
 export const getGitUrl = (context: Context, accessTokenRequired = true): string => getGitUrlWithToken(context, getAccessToken(accessTokenRequired));
 
-export const removeToken = (value: object): object => {
-	Object.keys(value).forEach(key => {
-		if (typeof value[key] === 'object') {
-			value[key] = removeToken(value[key]);
-		} else if ('token' === key) {
-			delete value[key];
-		}
-	});
-
-	return value;
-};
-
 export const showActionInfo = (rootDir: string, logger: Logger, context: Context): void => {
 	const info      = getBuildInfo(path.resolve(rootDir, 'build.json'));
 	const tagName   = getTagName(context);
@@ -76,9 +64,9 @@ export const showActionInfo = (rootDir: string, logger: Logger, context: Context
 	logger.log('repo:     %s', context.repo.repo);
 	logger.log();
 	logger.startProcess('Dump context');
-	console.log(removeToken(context));
+	console.log(mask(context));
 	logger.startProcess('Dump Payload');
-	console.log(removeToken(context.payload));
+	console.log(mask(context.payload));
 	logger.endProcess();
 	logger.log(separator);
 	logger.log();

src/utils.ts

@@ -167,3 +167,15 @@ export const versionCompare = (version1: string, version2: string, checkDifferen
 	};
 	return compare(splitVersion(version1.replace(/^v/, '')), splitVersion(version2.replace(/^v/, '')));
 };
+
+export const mask = (value: object, target = 'token'): object => {
+	Object.keys(value).forEach(key => {
+		if (typeof value[key] === 'object') {
+			value[key] = mask(value[key], target);
+		} else if (target === key) {
+			value[key] = '***';
+		}
+	});
+
+	return value;
+};