Skip to content
This repository has been archived by the owner on Nov 24, 2023. It is now read-only.

Feature/#137 #145

Merged
merged 2 commits into from
Mar 16, 2021
Merged

Feature/#137 #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
71c94e6
chore: tweaks
technote-space Mar 16, 2021
76678df
feat: add json format (#137)
technote-space Mar 16, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 55 additions & 28 deletions __tests__/utils/command.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable no-magic-numbers */
import nock from 'nock';
import path, {resolve} from 'path';
import path, { resolve } from 'path';
import {
generateContext,
testEnv,
Expand All @@ -12,8 +12,8 @@ import {
disableNetConnect,
getApiFixture,
} from '@technote-space/github-action-test-helper';
import {Logger} from '@technote-space/github-action-log-helper';
import {getGitDiff, getFileDiff, getDiffFiles, sumResults} from '../../src/utils/command';
import { Logger } from '@technote-space/github-action-log-helper';
import { getGitDiff, getFileDiff, getDiffFiles, sumResults } from '../../src/utils/command';

const rootDir = path.resolve(__dirname, '../..');
const fixtureRootDir = resolve(__dirname, '..', 'fixtures');
Expand Down Expand Up @@ -612,42 +612,69 @@ describe('getFileDiff', () => {
describe('getDiffFiles', () => {
testEnv(rootDir);

it('get git diff output 1', () => {
expect(getDiffFiles([], false)).toEqual('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toEqual('test1');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toEqual('test1 test2');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toEqual('test1 \'test2 test3\'');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toEqual('\'test1/test2.txt\'');
it('should get git diff output 1', () => {
expect(getDiffFiles([], false)).toBe('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toBe('test1');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toBe('test1 test2');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toBe('test1 \'test2 test3\'');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toBe('\'test1/test2.txt\'');
});

it('get git diff output 2', () => {
it('should get git diff output 2', () => {
process.env.INPUT_SEPARATOR = '\n';

expect(getDiffFiles([], false)).toEqual('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toEqual('test1');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toEqual('test1\ntest2');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toEqual('test1\n\'test2 test3\'');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toEqual('\'test1/test2.txt\'');
expect(getDiffFiles([], false)).toBe('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toBe('test1');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toBe('test1\ntest2');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toBe('test1\n\'test2 test3\'');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toBe('\'test1/test2.txt\'');
});

it('get git diff output 3', () => {
it('should get git diff output 3', () => {
delete process.env.INPUT_SEPARATOR;
process.env.INPUT_TEST = '';

expect(getDiffFiles([], false)).toEqual('');
expect(getDiffFiles([], false)).toBe('');
});

it('get git diff output 4', () => {
expect(getDiffFiles([], true)).toEqual('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult, isMatched: false}], true)).toEqual('');
expect(getDiffFiles([{
file: 'test1', ...defaultFileResult,
isMatched: false,
}, {file: 'test2', ...defaultFileResult}], true)).toEqual('test2');
expect(getDiffFiles([{
file: 'test1', ...defaultFileResult,
isMatched: false,
}, {file: 'test2 test3', ...defaultFileResult}], true)).toEqual('\'test2 test3\'');
it('should get git diff output 4', () => {
expect(getDiffFiles([], true)).toBe('');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult, isMatched: false}], true)).toBe('');
expect(getDiffFiles([
{
file: 'test1', ...defaultFileResult,
isMatched: false,
},
{file: 'test2', ...defaultFileResult},
], true)).toBe('test2');
expect(getDiffFiles([
{
file: 'test1', ...defaultFileResult,
isMatched: false,
},
{file: 'test2 test3', ...defaultFileResult},
], true)).toBe('\'test2 test3\'');
});

it('should get git diff output (json format)', () => {
process.env.INPUT_FORMAT = 'json';

expect(getDiffFiles([], true)).toBe('[]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toBe('["test1"]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toBe('["test1","test2"]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toBe('["test1","test2 test3"]');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toBe('["test1/test2.txt"]');
});

it('should get git diff output (escaped json format)', () => {
process.env.INPUT_FORMAT = 'json';
process.env.INPUT_ESCAPE_JSON = '1';

expect(getDiffFiles([], true)).toBe('[]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}], false)).toBe('["test1"]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2', ...defaultFileResult}], false)).toBe('["test1","test2"]');
expect(getDiffFiles([{file: 'test1', ...defaultFileResult}, {file: 'test2 test3', ...defaultFileResult}], false)).toBe('["test1","\'test2 test3\'"]');
expect(getDiffFiles([{file: 'test1/test2.txt', ...defaultFileResult}], false)).toBe('["\'test1/test2.txt\'"]');
});
});

Expand Down
7 changes: 7 additions & 0 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ inputs:
description: Diff filter.
default: 'AMRC'
required: true
FORMAT:
description: Output format (text or json)
default: text
required: true
ESCAPE_JSON:
description: Whether to escape when json format.
required: false
SEPARATOR:
description: Separator of diffs.
default: ' '
Expand Down
23 changes: 13 additions & 10 deletions src/utils/command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
import path from 'path';
import {getInput} from '@actions/core' ;
import {Context} from '@actions/github/lib/context';
import multimatch, {Options} from 'multimatch';
import {Command, Utils, GitHelper} from '@technote-space/github-action-helper';
import {Logger} from '@technote-space/github-action-log-helper';
import {escape, getDiffInfo} from './misc';
import {FileDiffResult, FileResult, DiffResult, DiffInfo} from '../types';
import {REMOTE_NAME} from '../constant';
import { getInput } from '@actions/core' ;
import { Context } from '@actions/github/lib/context';
import multimatch, { Options } from 'multimatch';
import { Command, Utils, GitHelper } from '@technote-space/github-action-helper';
import { Logger } from '@technote-space/github-action-log-helper';
import { escape, getDiffInfo } from './misc';
import { FileDiffResult, FileResult, DiffResult, DiffInfo } from '../types';
import { REMOTE_NAME } from '../constant';

const command = new Command(new Logger());
const getRawInput = (name: string): string => process.env[`INPUT_${name.replace(/ /g, '_').toUpperCase()}`] || '';
const getDot = (): string => getInput('DOT', {required: true});
const getFilter = (): string => getInput('DIFF_FILTER', {required: true});
const getOutputFormatType = (): string => getRawInput('FORMAT');
const escapeWhenJsonFormat = (): boolean => Utils.getBoolValue(getRawInput('ESCAPE_JSON'));
const getSeparator = (): string => getRawInput('SEPARATOR');
const getPatterns = (): string[] => Utils.getArrayInput('PATTERNS', undefined, '');
const getFiles = (): string[] => Utils.getArrayInput('FILES', undefined, '');
Expand Down Expand Up @@ -110,8 +112,9 @@ export const getGitDiff = async(logger: Logger, context: Context): Promise<Array
.map(item => ({...item, file: toAbsolute(item.file, workspace)}));
};

export const getDiffFiles = (diffs: FileResult[], filter: boolean): string => escape(diffs.filter(item => !filter || item.isMatched).map(item => item.file)).join(getSeparator());
export const getMatchedFiles = (diffs: FileResult[]): string => escape(diffs.filter(item => item.filterIgnored).map(item => item.file)).join(getSeparator());
const format = (items: string[]): string => getOutputFormatType() !== 'text' ? JSON.stringify(escapeWhenJsonFormat() ? escape(items) : items) : escape(items).join(getSeparator());
export const getDiffFiles = (diffs: FileResult[], filter: boolean): string => format(diffs.filter(item => !filter || item.isMatched).map(item => item.file));
export const getMatchedFiles = (diffs: FileResult[]): string => format(diffs.filter(item => item.filterIgnored).map(item => item.file));
export const sumResults = (diffs: DiffResult[], map: (item: DiffResult) => number): number => getSummaryIncludeFilesFlag() ?
diffs.map(map).reduce((acc, val) => acc + val, 0) : // eslint-disable-line no-magic-numbers
diffs.filter(item => !item.filterIgnored).map(map).reduce((acc, val) => acc + val, 0); // eslint-disable-line no-magic-numbers