-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* refactored out extractRunOutput * implemented a separate class to handle output parsing. added group detection as well * bump up version and update readme
- Loading branch information
1 parent
6508570
commit 1eff951
Showing
8 changed files
with
266 additions
and
88 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| import { DEFAULT_JOB } from "@aj/act/act.constants"; | ||
| import { Group, Step } from "@aj/act/act.type"; | ||
|
|
||
| export class OutputParser { | ||
| private output: string; | ||
|
|
||
| // keep track of steps for each job | ||
| private stepMatrix: Record<string, Record<string, Step>>; | ||
|
|
||
| // keep track of output for the current step of a job | ||
| private outputMatrix: Record<string, string>; | ||
|
|
||
| // keep track of groups for the current step of a job | ||
| private groupMatrix: Record<string, Group[]>; | ||
|
|
||
| private isPartOfGroup: boolean; | ||
|
|
||
| constructor(output: string) { | ||
| this.output = output; | ||
| this.stepMatrix = {}; | ||
| this.outputMatrix = {}; | ||
| this.groupMatrix = {}; | ||
| this.isPartOfGroup = false; | ||
| } | ||
|
|
||
| /** | ||
| * Parse the output produced by running act successfully. Produces an object | ||
| * describing whether the job was successful or not and what was the output of the job | ||
| * @returns | ||
| */ | ||
| parseOutput(): Step[] { | ||
| const lines = this.output.split("\n").map((line) => line.trim()); | ||
| for (const line of lines) { | ||
| this.parseRun(line); | ||
| this.parseSuccess(line); | ||
| this.parseFailure(line); | ||
| this.parseStartGroup(line); | ||
| this.parseEndGroup(line); | ||
| this.parseStepOutput(line); | ||
| } | ||
|
|
||
| let result: Step[] = []; | ||
| Object.values(this.stepMatrix).forEach((jobs) => { | ||
| Object.values(jobs).forEach((step) => { | ||
| result.push(step); | ||
| }); | ||
| }); | ||
| return result; | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line indicates the start of a step. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseRun(line: string) { | ||
| // line that has a star followed by Run and step name | ||
| const runMatcher = /^\s*(\[.+\])\s*\u2B50\s*Run\s*(.*)/; | ||
| const runMatcherResult = runMatcher.exec(line); | ||
| // if the line indicates the start of a step | ||
| if (runMatcherResult !== null) { | ||
| // initialize bookkeeping variables | ||
| if (!this.stepMatrix[runMatcherResult[1]]) { | ||
| this.stepMatrix[runMatcherResult[1]] = {}; | ||
| this.outputMatrix[runMatcherResult[1]] = ""; | ||
| this.groupMatrix[runMatcherResult[1]] = []; | ||
| } | ||
|
|
||
| // create a step object | ||
| this.stepMatrix[runMatcherResult[1]][runMatcherResult[2].trim()] = { | ||
| ...DEFAULT_JOB, | ||
| name: runMatcherResult[2].trim(), | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line indicates that a step was successful. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseSuccess(line: string) { | ||
| // line that has a green tick mark | ||
| const successMatcher = /^\s*(\[.+\])\s*\u2705\s*Success\s*-\s*(.*)/; | ||
| const successMatcherResult = successMatcher.exec(line); | ||
| // if the line indicates that a step was successful | ||
| if (successMatcherResult !== null) { | ||
| const groups = this.groupMatrix[successMatcherResult[1]]; | ||
| // store output in step | ||
| this.stepMatrix[successMatcherResult[1]][successMatcherResult[2].trim()] = | ||
| { | ||
| ...this.stepMatrix[successMatcherResult[1]][ | ||
| successMatcherResult[2].trim() | ||
| ], | ||
| status: 0, | ||
| output: this.outputMatrix[successMatcherResult[1]].trim(), | ||
| // only add groups attribute if there are any. don't add empty array | ||
| ...(groups.length > 0 ? { groups } : {}), | ||
| }; | ||
| this.resetOutputAndGroupMatrix(successMatcherResult[1]); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line indicates that a step failed. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseFailure(line: string) { | ||
| // line that has a red cross | ||
| const failureMatcher = /^\s*(\[.+\])\s*\u274C\s*Failure\s*-\s*(.*)/; | ||
| const failureMatcherResult = failureMatcher.exec(line); | ||
|
|
||
| // if the line indicates that a step failed | ||
| if (failureMatcherResult !== null) { | ||
| // store output in step | ||
| this.stepMatrix[failureMatcherResult[1]][failureMatcherResult[2].trim()] = | ||
| { | ||
| ...this.stepMatrix[failureMatcherResult[1]][ | ||
| failureMatcherResult[2].trim() | ||
| ], | ||
| status: 1, | ||
| output: this.outputMatrix[failureMatcherResult[1]].trim(), | ||
| }; | ||
|
|
||
| this.resetOutputAndGroupMatrix(failureMatcherResult[1]); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line indicates the start of a group annotation. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseStepOutput(line: string) { | ||
| // lines that have no emoji | ||
| const stepOutputMatcher = /^\s*(\[.+\])\s*\|\s*(.*)/; | ||
| const stepOutputMatcherResult = stepOutputMatcher.exec(line); | ||
|
|
||
| // if the line is an output line | ||
| if (stepOutputMatcherResult !== null) { | ||
| // if output is part of some group then update it | ||
| if (this.isPartOfGroup) { | ||
| const length = this.groupMatrix[stepOutputMatcherResult[1]].length; | ||
| this.groupMatrix[stepOutputMatcherResult[1]][length - 1].output += | ||
| stepOutputMatcherResult[2] + "\n"; | ||
| } | ||
| this.outputMatrix[stepOutputMatcherResult[1]] += | ||
| stepOutputMatcherResult[2] + "\n"; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line indicates the end of a group annotation. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseStartGroup(line: string) { | ||
| // lines that have a question mark | ||
| const startGroupMatcher = /^\s*(\[.+\])\s*\u2753\s*::group::\s*(.*)/; | ||
|
|
||
| const startGroupMatcherResult = startGroupMatcher.exec(line); | ||
|
|
||
| // if the line indicates start of a group annotation | ||
| if (startGroupMatcherResult !== null) { | ||
| this.groupMatrix[startGroupMatcherResult[1]].push({ | ||
| name: startGroupMatcherResult[2], | ||
| output: "", | ||
| }); | ||
| this.isPartOfGroup = true; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Check if the line is an output line. If it does then accordingly | ||
| * update the bookkeeping variables | ||
| * @param line | ||
| */ | ||
| private parseEndGroup(line: string) { | ||
| // lines that have a question mark | ||
| const endGroupMatcher = /^\s*(\[.+\])\s*\u2753\s*::endgroup::\s*/; | ||
|
|
||
| const endGroupMatcherResult = endGroupMatcher.exec(line); | ||
|
|
||
| // if the line indicates stop of a group annotation then clean up trailing spaces | ||
| if (endGroupMatcherResult !== null) { | ||
| const length = this.groupMatrix[endGroupMatcherResult[1]].length; | ||
| this.groupMatrix[endGroupMatcherResult[1]][length - 1].output = | ||
| this.groupMatrix[endGroupMatcherResult[1]][length - 1].output.trim(); | ||
| this.isPartOfGroup = false; | ||
| } | ||
| } | ||
|
|
||
| private resetOutputAndGroupMatrix(job: string) { | ||
| this.outputMatrix[job] = ""; | ||
| this.groupMatrix[job] = []; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.