Correct subtest placement #50
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
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 |
|---|---|---|
|
|
@@ -23,6 +23,18 @@ | |
| */ | ||
| package org.tap4j.parser; | ||
|
|
||
| import org.tap4j.model.BailOut; | ||
| import org.tap4j.model.Comment; | ||
| import org.tap4j.model.Footer; | ||
| import org.tap4j.model.Header; | ||
| import org.tap4j.model.Plan; | ||
| import org.tap4j.model.TapElement; | ||
| import org.tap4j.model.TapElementFactory; | ||
| import org.tap4j.model.TestResult; | ||
| import org.tap4j.model.TestSet; | ||
| import org.tap4j.model.Text; | ||
| import org.yaml.snakeyaml.Yaml; | ||
|
|
||
| import java.io.File; | ||
| import java.io.FileInputStream; | ||
| import java.io.FileNotFoundException; | ||
|
|
@@ -38,18 +50,6 @@ | |
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
|
|
||
| /** | ||
| * TAP 13 parser. | ||
| * | ||
|
|
@@ -72,7 +72,7 @@ public class Tap13Parser implements Parser { | |
| * Stack of stream status information bags. Every bag stores state of the parser | ||
| * related to certain indentation level. This is to support subtest feature. | ||
| */ | ||
| private Stack<StreamStatus> states = new Stack<>(); | ||
|
|
||
| /** | ||
| * The current state. | ||
|
|
@@ -97,6 +97,11 @@ public class Tap13Parser implements Parser { | |
| */ | ||
| private boolean enableSubtests = true; | ||
|
|
||
| /** | ||
| * A stack that holds subtests for which we don't know exact parent yet. | ||
| */ | ||
| private Stack<StreamStatus> subStack = new Stack<>(); | ||
|
|
||
| /** | ||
| * Parser Constructor. | ||
| * | ||
|
|
@@ -280,31 +285,24 @@ public void parseLine(String tapLine) { | |
| baseIndentation = indentation; | ||
| } | ||
|
|
||
| StreamStatus prevState = null; | ||
| if (indentation != state.getIndentationLevel() && enableSubtests) { // indentation changed | ||
|
|
||
| if (indentation > state.getIndentationLevel()) { | ||
| int prevIndent = state.getIndentationLevel(); | ||
| pushState(indentation); // make room for children | ||
| if (indentation - prevIndent > 4) | ||
|
There was a problem hiding this comment. Could we use There was a problem hiding this comment.
Well, specification is not the strong point of TAP at all... I see at least a long conversation at TestAnything/Specification#2. But the thing is, all origin sources of truth(e.g. Perl) are using exact four spaces, not de jure, but de facto standard. It is up to you, of course, but I think If someone is doing weird indentation, it is theirs thing to patch.
Yes, We cannot use and That's why we are checking exact more than 4 spaces. |
||
| subStack.push(state); | ||
| } else { | ||
| // going down | ||
| if (states.peek().getIndentationLevel() == indentation) { | ||
| prevState = state; | ||
| state = states.pop(); | ||
| } else { | ||
| state = new StreamStatus(); | ||
| state.setIndentationLevel(indentation); | ||
| subStack.push(state); | ||
| } | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -343,7 +341,7 @@ public void parseLine(String tapLine) { | |
|
|
||
| final TestResult testResult = (TestResult) tapElement; | ||
| if (testResult.getTestNumber() == 0) { | ||
| if (state.getTestSet().getPlan() != null && !state.isPlanBeforeTestResult()) { | ||
| return; // done testing mark | ||
| } | ||
| if (state.getTestSet().getPlan() != null && | ||
|
|
@@ -354,9 +352,21 @@ public void parseLine(String tapLine) { | |
| } | ||
|
|
||
| state.getTestSet().addTestResult(testResult); | ||
|
|
||
| if (prevState != null && enableSubtests) { | ||
| state.getTestSet().getTestResults().get( | ||
| state.getTestSet().getNumberOfTestResults() - 1) | ||
| .setSubtest(prevState.getTestSet()); | ||
| } | ||
|
|
||
| if (indentation == 0 && enableSubtests) { | ||
| TestResult currLast = state.getTestSet().getTestResults().get( | ||
| state.getTestSet().getNumberOfTestResults() - 1); | ||
| while (!subStack.empty()) { | ||
| StreamStatus nextLevel = subStack.pop(); | ||
| currLast.setSubtest(nextLevel.getTestSet()); | ||
| currLast = nextLevel.getTestSet().getTestResults().get(0); | ||
| } | ||
| } | ||
|
|
||
| } else if (tapElement instanceof Footer) { | ||
|
|
||
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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason why we should remove tabs here too?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The thing is
\sincludes\t, so it's redundant to use alternating matching between them. See https://docs.oracle.com/javase/tutorial/essential/regex/pre_char_classes.htmlThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And this minor issue is present in other regexes too, but I didn't fix it, because not sure if wanted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just past midnight here, so the new day barely started and I can proudly say Today-I-Learned.
Had no idea they were redundant. I've been using both in Perl, shell, java... might have a few places to fix besides tap4j.
This change is definitely wanted. But we can fix in another issue if that's easier.
Thanks!!!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also,
*takes exactly zero or more elements, so you can omit redundant?.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right. I think you are talking about this part:
([^#]*)?I thought that it would resolve
[^#]*as zero or more of[^#]in a group()?. And so the group was receiving the?, and thus would appear zero or at most once?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wrote about e.g.
((\\s|\\t)*)?(putting \t symbol aside) - in this case,?is redundant.We capture "zero or more space characters" for "zero or one time". It could be meaningful with
(.+)?("one or more any character" could or could not occur), but it's roughly a wordy equivalent of just(.*).That's what I meant.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Aahh! Sure. You fixed that one already, but I agree for the remaining regular expressions. Gonna start thinking a bit more when writing regexes now :)