-
Notifications
You must be signed in to change notification settings - Fork 2.8k
[ZEPPELIN-6482] Guarantee system restoration when execution fails #5418
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
gyowoo1113
wants to merge
8
commits into
apache:master
Choose a base branch
from
gyowoo1113:ZEPPELIN-6482-guarantee-system-restoration-when-execution-fails
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+128
−42
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
92cd7e9
[ZEPPELIN-6482] Ensure System streams are restored in StaticRepl
gyowoo1113 60eeedb
[ZEPPELIN-6482] Add Mockito dependency to java module
gyowoo1113 2ff5ced
[ZEPPELIN-6482] Add regression test for StaticRepl stream restoration
gyowoo1113 ef9c754
[ZEPPELIN-6482] Resolve Checkstyle violations
gyowoo1113 1b1c2d5
[ZEPPELIN-6482] Refactor execute to package-private
gyowoo1113 18247ac
[ZEPPELIN-6482] Remove trailing whitespace and fix opening brace spacing
gyowoo1113 39298aa
[ZEPPELIN-6482] Remove redundant else after compilation failure
gyowoo1113 bddc5fd
[ZEPPELIN-6482] Extract compile and run logic to isolate stream resto…
gyowoo1113 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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
66 changes: 66 additions & 0 deletions
66
java/src/test/java/org/apache/zeppelin/java/StaticReplTest.java
This file contains hidden or 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,66 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.zeppelin.java; | ||
|
|
||
| import javax.tools.JavaCompiler; | ||
| import javax.tools.JavaCompiler.CompilationTask; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertSame; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import java.io.PrintStream; | ||
|
|
||
| public class StaticReplTest { | ||
|
|
||
| @Test | ||
| void shouldRestoreSystemStreamsWhenCompilationThrows() { | ||
| PrintStream originalOut = System.out; | ||
| PrintStream originalErr = System.err; | ||
|
|
||
| JavaCompiler compiler = mock(JavaCompiler.class); | ||
| CompilationTask task = mock(CompilationTask.class); | ||
|
|
||
| when(compiler.getTask(any(), any(), any(), any(), any(), any())) | ||
| .thenReturn(task); | ||
|
|
||
| when(task.call()) | ||
| .thenThrow(new RuntimeException("Compilation failed unexpectedly")); | ||
|
|
||
| String code = "public class TestClass {" | ||
| + " public static void main(String[] args) {}" | ||
| + "}"; | ||
|
|
||
| try { | ||
| assertThrows(RuntimeException.class, () -> StaticRepl.execute("TestClass", code, compiler)); | ||
|
|
||
| assertSame(originalOut, System.out); | ||
| assertSame(originalErr, System.err); | ||
|
|
||
| } finally { | ||
| System.setOut(originalOut); | ||
| System.setErr(originalErr); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
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.
Would you consider pulling the redirected section out into a private helper?
The bug you are fixing is really "restoration was scattered across three places". After this change the restoration is in one place, but the body still sits in a scope where
oldOut/oldErrare visible, so it can be scattered again later. Moving the body into a helper takes those variables out of scope entirely, which makes the regression structurally impossible rather than a matter of discipline, and it shrinks the try/finally that carries the invariant down to something you can verify at a glance.The trade-off is a 6-parameter helper. If that feels worse to you, the current form is functionally correct as is. I compiled this variant locally and all 7 tests pass.
Unrelated, but since
if (!success)always ends in athrow, theelseon line 142 is redundant. That is pre-existing cleanup rather than part of this PR, so I will leave it to you.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.
@tbonelee Thanks for the suggestions! I addressed all the review comments in the latest commits.
For the helper extraction, I chose to pass the replaced
codeinstead ofcompilationUnits, and create theJavaFileObjectandcompilationUnitsinsidecompileAndRun(). Since they are part of the compilation setup, keeping their creation inside the helper seemed to better isolate the compile/run logic from the stream redirection and restoration.