[Core, TestNg] Clean up stream closing #1175
Merged
Conversation
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
mpkorstanje
commented
Jul 9, 2017
| @@ -65,7 +65,7 @@ public NiceAppendable println(CharSequence csq) { | |||
| public void close() { | |||
| try { | |||
| tryFlush(); | |||
| if (out instanceof Closeable && out != System.out && out != System.err) { | |||
| if (out instanceof Closeable) { | |||
There was a problem hiding this comment.
This is the responsibility of TestNGCucumberRunner. It knows it is passing ownership of System.out
mpkorstanje
commented
Jul 9, 2017
| @@ -119,11 +120,11 @@ public void receive(TestRunFinished event) { | |||
| }; | |||
|
|
|||
| public HTMLFormatter(URL htmlReportDir) { | |||
| this.htmlReportDir = htmlReportDir; | |||
| this(htmlReportDir, createJsOut(htmlReportDir)); | |||
mpkorstanje
commented
Jul 9, 2017
|
|
||
| private static void writeStreamToURL(InputStream in, URL url) { | ||
| OutputStream out = createReportFileOutputStream(url); | ||
|
|
There was a problem hiding this comment.
Minimizes the ownership scope of the output stream
mpkorstanje
commented
Jul 9, 2017
| } catch (IOException e) { | ||
| throw new CucumberException("Unable to write to report file item: ", e); | ||
| } finally { | ||
| closeQuietly(out); |
There was a problem hiding this comment.
Idiomatic java. For lack of being able to use try-with-resources
mpkorstanje
commented
Jul 9, 2017
| } | ||
| } | ||
|
|
||
| private void writeBytesAndClose(byte[] buf, OutputStream out) { | ||
| private static void writeBytesToURL(byte[] buf, URL url) throws CucumberException { | ||
| OutputStream reportFileOutputStream = createReportFileOutputStream(url); |
There was a problem hiding this comment.
Minimizes the ownership scope of the output stream
Refactored the code around streams so it follows these rules: - Streams should be closed by their owners - A stream is owned by its creator or when provided as a constructor argument - Stream ownership should be the smallest possible unit. The method, class, process, system. - System.out and System.error may never be closed Fixes #1108
mpkorstanje
force-pushed
the
stream-closing
branch
from
9edd86b to
486b82c
Compare
mpkorstanje
commented
Jul 9, 2017
| } catch (IOException ignored) { | ||
| // go gentle into that good night | ||
| } | ||
| } |
There was a problem hiding this comment.
3rd duplication but I'd rather wait for java7 try-with-resources
|
Yes, this looks like a better solution than the one I did in 51f0c9b. |
|
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary
Refactored the code around streams so it follows these rules:
Fixes #1108
How Has This Been Tested?
Checked the code for all occurrences of
.close(),System.out,System.error,new NiceAppendable,new .*OutputStreamandnew .*Writerin non-test code.Automated tests should be passing.
Screenshots (if appropriate):
Types of changes
Checklist: