Skip to content
6 changes: 6 additions & 0 deletions java/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@
<version>2.0-M3</version>
</dependency>

<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-core</artifactId>
<scope>test</scope>
</dependency>

</dependencies>

<build>
Expand Down
98 changes: 56 additions & 42 deletions java/src/main/java/org/apache/zeppelin/java/StaticRepl.java
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,12 @@ public class StaticRepl {
private static final Logger LOGGER = LoggerFactory.getLogger(StaticRepl.class);

public static String execute(String generatedClassName, String code) throws Exception {
return execute(generatedClassName, code, ToolProvider.getSystemJavaCompiler());
}

static String execute(String generatedClassName, String code, JavaCompiler compiler)
throws Exception {

JavaCompiler compiler = ToolProvider.getSystemJavaCompiler();
if (compiler == null) {
throw new Exception(
"Java compiler not available. Make sure Zeppelin is running on JDK (not JRE).");
Expand Down Expand Up @@ -90,9 +94,6 @@ public static String execute(String generatedClassName, String code) throws Exce
// replace name of class containing Main method with generated name
code = code.replace(mainClassName, generatedClassName);

JavaFileObject file = new JavaSourceFromString(generatedClassName, code);
Iterable<? extends JavaFileObject> compilationUnits = List.of(file);

ByteArrayOutputStream baosOut = new ByteArrayOutputStream();
ByteArrayOutputStream baosErr = new ByteArrayOutputStream();

Expand All @@ -102,12 +103,41 @@ public static String execute(String generatedClassName, String code) throws Exce
// Save the old System.out!
PrintStream oldOut = System.out;
PrintStream oldErr = System.err;
// Tell Java to use your special stream
System.setOut(newOut);
System.setErr(newErr);

try {

Copy link
Copy Markdown
Contributor

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 / oldErr are 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.

    try {
      System.setOut(newOut);
      System.setErr(newErr);
      return compileAndRun(generatedClassName, compiler, compilationUnits, baosOut, baosErr,
          newErr);
    } finally {
      System.setOut(oldOut);
      System.setErr(oldErr);
    }
  }

  private static String compileAndRun(String generatedClassName,
                                      JavaCompiler compiler,
                                      Iterable<? extends JavaFileObject> compilationUnits,
                                      ByteArrayOutputStream baosOut,
                                      ByteArrayOutputStream baosErr,
                                      PrintStream newErr) throws Exception {
    // body unchanged, only the scattered setOut/setErr restores and the inner finally are dropped
  }

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 a throw, the else on line 142 is redundant. That is pre-existing cleanup rather than part of this PR, so I will leave it to you.

Copy link
Copy Markdown
Contributor Author

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 code instead of compilationUnits, and create the JavaFileObject and compilationUnits inside compileAndRun(). 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.

// Tell Java to use your special stream
System.setOut(newOut);
System.setErr(newErr);

return compileAndRun(generatedClassName, code, compiler, baosOut, baosErr, newErr);
} finally {
System.out.flush();
System.err.flush();

System.setOut(oldOut);
System.setErr(oldErr);
}

}

private static String compileAndRun(
String generatedClassName,
String code,
JavaCompiler compiler,
ByteArrayOutputStream baosOut,
ByteArrayOutputStream baosErr,
PrintStream newErr) throws Exception {

JavaFileObject file = new JavaSourceFromString(generatedClassName, code);
Iterable<? extends JavaFileObject> compilationUnits = List.of(file);

DiagnosticCollector<JavaFileObject> diagnostics = new DiagnosticCollector<>();
CompilationTask task = compiler.getTask(null, null, diagnostics, null, null, compilationUnits);
CompilationTask task = compiler.getTask(null,
null,
diagnostics,
null,
null,
compilationUnits);

// executing the compilation process
boolean success = task.call();
Expand All @@ -124,47 +154,31 @@ public static String execute(String generatedClassName, String code) throws Exce
System.out.flush();
System.err.flush();

System.setOut(oldOut);
System.setErr(oldErr);
LOGGER.error("Exception in Interpreter while compilation", baosErr.toString());
throw new Exception(baosErr.toString());
} else {
try {

// creating new class loader
URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{new File("").toURI()
.toURL()});
// execute the Main method
Class.forName(generatedClassName, true, classLoader)
.getDeclaredMethod("main", new Class[]{String[].class})
.invoke(null, new Object[]{null});

System.out.flush();
System.err.flush();

// set the stream to old stream
System.setOut(oldOut);
System.setErr(oldErr);

return baosOut.toString();
}

} catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException
| InvocationTargetException e) {
LOGGER.error("Exception in Interpreter while execution", e);
System.err.println(e);
e.printStackTrace(newErr);
throw new Exception(baosErr.toString(), e);
try {
// creating new class loader
URLClassLoader classLoader = URLClassLoader.newInstance(new URL[]{new File("").toURI()
.toURL()});
// execute the Main method
Class.forName(generatedClassName, true, classLoader)
.getDeclaredMethod("main", new Class[]{String[].class})
.invoke(null, new Object[]{null});

} finally {
System.out.flush();
System.err.flush();

System.out.flush();
System.err.flush();
return baosOut.toString();

System.setOut(oldOut);
System.setErr(oldErr);
}
} catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException
| InvocationTargetException e) {
LOGGER.error("Exception in Interpreter while execution", e);
System.err.println(e);
e.printStackTrace(newErr);
throw new Exception(baosErr.toString(), e);
}

}

}
Expand Down
66 changes: 66 additions & 0 deletions java/src/test/java/org/apache/zeppelin/java/StaticReplTest.java
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);
}

}

}
Loading