diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/CompilationException.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/CompilationException.java new file mode 100644 index 0000000..a12ab5e --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/CompilationException.java @@ -0,0 +1,10 @@ +package com.alibaba.testable.core.compile; + +public class CompilationException extends RuntimeException { + private static final long serialVersionUID = 5272588827551900536L; + + public CompilationException(String msg) { + super(msg); + } + +} diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/CompiledCode.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/CompiledCode.java new file mode 100644 index 0000000..6cff13f --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/CompiledCode.java @@ -0,0 +1,33 @@ +package com.alibaba.testable.core.compile; + +import javax.tools.SimpleJavaFileObject; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.OutputStream; +import java.net.URI; + +/** + * Created by trung on 5/3/15. + */ +public class CompiledCode extends SimpleJavaFileObject { + private ByteArrayOutputStream baos = new ByteArrayOutputStream(); + private String className; + + public CompiledCode(String className) throws Exception { + super(new URI(className), Kind.CLASS); + this.className = className; + } + + public String getClassName() { + return className; + } + + @Override + public OutputStream openOutputStream() throws IOException { + return baos; + } + + public byte[] getByteCode() { + return baos.toByteArray(); + } +} diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/DynamicClassLoader.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/DynamicClassLoader.java new file mode 100644 index 0000000..c2833b2 --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/DynamicClassLoader.java @@ -0,0 +1,27 @@ +package com.alibaba.testable.core.compile; + +import java.util.HashMap; +import java.util.Map; + +public class DynamicClassLoader extends ClassLoader { + + private Map customCompiledCode = new HashMap<>(); + + public DynamicClassLoader(ClassLoader parent) { + super(parent); + } + + public void addCode(CompiledCode cc) { + customCompiledCode.put(cc.getName(), cc); + } + + @Override + protected Class findClass(String name) throws ClassNotFoundException { + CompiledCode cc = customCompiledCode.get(name); + if (cc == null) { + return super.findClass(name); + } + byte[] byteCode = cc.getByteCode(); + return defineClass(name, byteCode, 0, byteCode.length); + } +} diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/ExtendedStandardJavaFileManager.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/ExtendedStandardJavaFileManager.java new file mode 100644 index 0000000..b44d904 --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/ExtendedStandardJavaFileManager.java @@ -0,0 +1,56 @@ +package com.alibaba.testable.core.compile; + +import java.io.IOException; +import java.util.ArrayList; +import java.util.List; + +import javax.tools.FileObject; +import javax.tools.ForwardingJavaFileManager; +import javax.tools.JavaFileManager; +import javax.tools.JavaFileObject; + +/** + * Created by trung on 5/3/15. Edited by turpid-monkey on 9/25/15, completed + * support for multiple compile units. + */ +public class ExtendedStandardJavaFileManager extends + ForwardingJavaFileManager { + + private List compiledCode = new ArrayList(); + private DynamicClassLoader cl; + + /** + * Creates a new instance of ForwardingJavaFileManager. + * + * @param fileManager + * delegate to this file manager + * @param cl + */ + protected ExtendedStandardJavaFileManager(JavaFileManager fileManager, + DynamicClassLoader cl) { + super(fileManager); + this.cl = cl; + } + + @Override + public JavaFileObject getJavaFileForOutput( + JavaFileManager.Location location, String className, + JavaFileObject.Kind kind, FileObject sibling) throws IOException { + + try { + CompiledCode innerClass = new CompiledCode(className); + compiledCode.add(innerClass); + cl.addCode(innerClass); + return innerClass; + } catch (Exception e) { + throw new RuntimeException( + "Error while creating in-memory output file for " + + className, e); + } + } + + @Override + public ClassLoader getClassLoader(JavaFileManager.Location location) { + return cl; + } +} diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/InMemoryJavaCompiler.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/InMemoryJavaCompiler.java new file mode 100644 index 0000000..923d645 --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/InMemoryJavaCompiler.java @@ -0,0 +1,142 @@ +package com.alibaba.testable.core.compile; + +import java.util.*; + +import javax.tools.*; + +/** + * Compile Java sources in-memory + */ +public class InMemoryJavaCompiler { + private JavaCompiler javac; + private DynamicClassLoader classLoader; + private Iterable options; + boolean ignoreWarnings = false; + + private Map sourceCodes = new HashMap(); + + public static InMemoryJavaCompiler newInstance() { + return new InMemoryJavaCompiler(); + } + + private InMemoryJavaCompiler() { + this.javac = ToolProvider.getSystemJavaCompiler(); + this.classLoader = new DynamicClassLoader(ClassLoader.getSystemClassLoader()); + } + + public InMemoryJavaCompiler useParentClassLoader(ClassLoader parent) { + this.classLoader = new DynamicClassLoader(parent); + return this; + } + + /** + * @return the class loader used internally by the compiler + */ + public ClassLoader getClassloader() { + return classLoader; + } + + /** + * Options used by the compiler, e.g. '-Xlint:unchecked'. + * + * @param options + * @return + */ + public InMemoryJavaCompiler useOptions(String... options) { + this.options = Arrays.asList(options); + return this; + } + + /** + * Ignore non-critical compiler output, like unchecked/unsafe operation + * warnings. + * + * @return + */ + public InMemoryJavaCompiler ignoreWarnings() { + ignoreWarnings = true; + return this; + } + + /** + * Compile all sources + * + * @return Map containing instances of all compiled classes + * @throws Exception + */ + public Map> compileAll() throws Exception { + if (sourceCodes.size() == 0) { + throw new CompilationException("No source code to compile"); + } + Collection compilationUnits = sourceCodes.values(); + CompiledCode[] code; + + code = new CompiledCode[compilationUnits.size()]; + Iterator iter = compilationUnits.iterator(); + for (int i = 0; i < code.length; i++) { + code[i] = new CompiledCode(iter.next().getClassName()); + } + DiagnosticCollector collector = new DiagnosticCollector<>(); + ExtendedStandardJavaFileManager fileManager = new ExtendedStandardJavaFileManager(javac.getStandardFileManager(null, null, null), classLoader); + JavaCompiler.CompilationTask task = javac.getTask(null, fileManager, collector, options, null, compilationUnits); + boolean result = task.call(); + if (!result || collector.getDiagnostics().size() > 0) { + StringBuffer exceptionMsg = new StringBuffer(); + exceptionMsg.append("Unable to compile the source"); + boolean hasWarnings = false; + boolean hasErrors = false; + for (Diagnostic d : collector.getDiagnostics()) { + switch (d.getKind()) { + case NOTE: + case MANDATORY_WARNING: + case WARNING: + hasWarnings = true; + break; + case OTHER: + case ERROR: + default: + hasErrors = true; + break; + } + exceptionMsg.append("\n").append("[kind=").append(d.getKind()); + exceptionMsg.append(", ").append("line=").append(d.getLineNumber()); + exceptionMsg.append(", ").append("message=").append(d.getMessage(Locale.US)).append("]"); + } + if (hasWarnings && !ignoreWarnings || hasErrors) { + throw new CompilationException(exceptionMsg.toString()); + } + } + + Map> classes = new HashMap>(); + for (String className : sourceCodes.keySet()) { + classes.put(className, classLoader.loadClass(className)); + } + return classes; + } + + /** + * Compile single source + * + * @param className + * @param sourceCode + * @return + * @throws Exception + */ + public Class compile(String className, String sourceCode) throws Exception { + return addSource(className, sourceCode).compileAll().get(className); + } + + /** + * Add source code to the compiler + * + * @param className + * @param sourceCode + * @return + * @throws Exception + * @see {@link #compileAll()} + */ + public InMemoryJavaCompiler addSource(String className, String sourceCode) throws Exception { + sourceCodes.put(className, new SourceCode(className, sourceCode)); + return this; + } +} diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/LICENSE b/testable-core/src/main/java/com/alibaba/testable/core/compile/LICENSE new file mode 100644 index 0000000..8dada3e --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright {yyyy} {name of copyright owner} + + Licensed 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. diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/README.md b/testable-core/src/main/java/com/alibaba/testable/core/compile/README.md new file mode 100644 index 0000000..a2f284d --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/README.md @@ -0,0 +1,9 @@ +This part of code is under [Apache License Version 2.0](LICENSE), modified from [InMemoryJavaCompiler](https://github.com/trung/InMemoryJavaCompiler) with several PRs merged and other refactorings (e.g. dropping unnecessary dependence and avoid throwing raw Exception). + +Many thanks to the origin author and contributors of this lovely library: +- [trung](https://github.com/trung) +- [turpid-monkey](https://github.com/turpid-monkey) +- [PKeidel](https://github.com/PKeidel) +- [fossabot](https://github.com/fossabot) +- [KOLANICH](https://github.com/KOLANICH) +- [hammadirshad](https://github.com/hammadirshad) diff --git a/testable-core/src/main/java/com/alibaba/testable/core/compile/SourceCode.java b/testable-core/src/main/java/com/alibaba/testable/core/compile/SourceCode.java new file mode 100644 index 0000000..e882e15 --- /dev/null +++ b/testable-core/src/main/java/com/alibaba/testable/core/compile/SourceCode.java @@ -0,0 +1,29 @@ +package com.alibaba.testable.core.compile; + +import javax.tools.SimpleJavaFileObject; +import java.io.IOException; +import java.net.URI; + +/** + * Created by trung on 5/3/15. + */ +public class SourceCode extends SimpleJavaFileObject { + private String contents = null; + private String className; + + public SourceCode(String className, String contents) throws Exception { + super(URI.create("string:///" + className.replace('.', '/') + + Kind.SOURCE.extension), Kind.SOURCE); + this.contents = contents; + this.className = className; + } + + public String getClassName() { + return className; + } + + public CharSequence getCharContent(boolean ignoreEncodingErrors) + throws IOException { + return contents; + } +} diff --git a/testable-core/src/test/java/com/alibaba/testable/core/compile/InMemoryJavaCompilerTest.java b/testable-core/src/test/java/com/alibaba/testable/core/compile/InMemoryJavaCompilerTest.java new file mode 100644 index 0000000..37ec0ed --- /dev/null +++ b/testable-core/src/test/java/com/alibaba/testable/core/compile/InMemoryJavaCompilerTest.java @@ -0,0 +1,109 @@ +package com.alibaba.testable.core.compile; + +import org.junit.jupiter.api.Test; + +import java.util.List; +import java.util.Map; + +import static org.junit.jupiter.api.Assertions.*; + +class InMemoryJavaCompilerTest { + + @Test + public void compile_WhenTypical() throws Exception { + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public class HelloClass {\n"); + sourceCode.append(" public String hello() { return \"hello\"; }"); + sourceCode.append("}"); + + Class helloClass = InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); + assertNotNull(helloClass); + assertEquals(1, helloClass.getDeclaredMethods().length); + } + + @Test + public void compileAll_WhenTypical() throws Exception { + String cls1 = "public class A{ public B b() { return new B(); }}"; + String cls2 = "public class B{ public String toString() { return \"B!\"; }}"; + + Map> compiled = com.alibaba.testable.core.compile.InMemoryJavaCompiler.newInstance().addSource("A", cls1).addSource("B", cls2).compileAll(); + + assertNotNull(compiled.get("A")); + assertNotNull(compiled.get("B")); + + Class aClass = compiled.get("A"); + Object a = aClass.newInstance(); + assertEquals("B!", aClass.getMethod("b").invoke(a).toString()); + } + + @Test + public void compile_WhenSourceContainsInnerClasses() throws Exception { + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public class HelloClass {\n"); + sourceCode.append(" private static class InnerHelloWorld { int inner; }\n"); + sourceCode.append(" public String hello() { return \"hello\"; }"); + sourceCode.append("}"); + + Class helloClass = com.alibaba.testable.core.compile.InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); + assertNotNull(helloClass); + assertEquals(1, helloClass.getDeclaredMethods().length); + } + + @Test + public void compile_whenError() throws Exception { + thrown.expect(com.alibaba.testable.core.compile.CompilationException.class); + thrown.expectMessage("Unable to compile the source"); + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public classHelloClass {\n"); + sourceCode.append(" public String hello() { return \"hello\"; }"); + sourceCode.append("}"); + com.alibaba.testable.core.compile.InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); + } + + @Test + public void compile_WhenFailOnWarnings() throws Exception { + thrown.expect(com.alibaba.testable.core.compile.CompilationException.class); + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public class HelloClass {\n"); + sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); + sourceCode.append("}"); + com.alibaba.testable.core.compile.InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); + } + + @Test + public void compile_WhenIgnoreWarnings() throws Exception { + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public class HelloClass {\n"); + sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); + sourceCode.append("}"); + Class helloClass = com.alibaba.testable.core.compile.InMemoryJavaCompiler.newInstance().ignoreWarnings().compile("org.mdkt.HelloClass", sourceCode.toString()); + List res = (List) helloClass.getMethod("hello").invoke(helloClass.newInstance()); + assertEquals(0, res.size()); + } + + @Test + public void compile_WhenWarningsAndErrors() throws Exception { + thrown.expect(CompilationException.class); + StringBuffer sourceCode = new StringBuffer(); + + sourceCode.append("package org.mdkt;\n"); + sourceCode.append("public class HelloClass extends xxx {\n"); + sourceCode.append(" public java.util.List hello() { return new java.util.ArrayList(); }"); + sourceCode.append("}"); + try { + InMemoryJavaCompiler.newInstance().compile("org.mdkt.HelloClass", sourceCode.toString()); + } catch (Exception e) { + throw e; + } + } +}