changeset 56003:d9208a660094

8218152: [javac] fails and exits with no error if a bad annotation processor provided Summary: Handle exceptions thrown while loading annotation processors. Reviewed-by: jlahoda Contributed-by: groeges@uk.ibm.com
author jlahoda
date Tue, 30 Apr 2019 10:39:22 +0200
parents 73a87b1aacc2
children e6e327553024
files src/jdk.compiler/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler.properties test/langtools/tools/javac/annotations/8218152/MalformedAnnotationProcessorTests.java test/langtools/tools/javac/diags/examples.not-yet.txt
diffstat 4 files changed, 200 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/src/jdk.compiler/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java	Wed Apr 17 01:21:56 2019 -0700
+++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/processing/JavacProcessingEnvironment.java	Tue Apr 30 10:39:22 2019 +0200
@@ -444,7 +444,14 @@
             } catch(ServiceConfigurationError sce) {
                 log.error(Errors.ProcBadConfigFile(sce.getLocalizedMessage()));
                 throw new Abort(sce);
+            } catch (UnsupportedClassVersionError ucve) {
+                log.error(Errors.ProcCantLoadClass(ucve.getLocalizedMessage()));
+                throw new Abort(ucve);
+            } catch (ClassFormatError cfe) {
+                log.error(Errors.ProcCantLoadClass(cfe.getLocalizedMessage()));
+                throw new Abort(cfe);
             } catch (Throwable t) {
+                log.error(Errors.ProcBadConfigFile(t.getLocalizedMessage()));
                 throw new Abort(t);
             }
         }
@@ -461,6 +468,7 @@
                 log.error(Errors.ProcBadConfigFile(sce.getLocalizedMessage()));
                 throw new Abort(sce);
             } catch (Throwable t) {
+                log.error(Errors.ProcBadConfigFile(t.getLocalizedMessage()));
                 throw new Abort(t);
             }
         }
--- a/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler.properties	Wed Apr 17 01:21:56 2019 -0700
+++ b/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler.properties	Tue Apr 30 10:39:22 2019 +0200
@@ -1,5 +1,5 @@
 #
-# Copyright (c) 1999, 2018, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 1999, 2019, Oracle and/or its affiliates. All rights reserved.
 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 #
 # This code is free software; you can redistribute it and/or modify it
@@ -1051,6 +1051,10 @@
 compiler.err.proc.cant.find.class=\
     Could not find class file for ''{0}''.
 
+# 0: string
+compiler.err.proc.cant.load.class=\
+    Could not load processor class file due to ''{0}''.
+
 # Print a client-generated error message; assumed to be localized, no translation required
 # 0: string
 compiler.err.proc.messager=\
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/test/langtools/tools/javac/annotations/8218152/MalformedAnnotationProcessorTests.java	Tue Apr 30 10:39:22 2019 +0200
@@ -0,0 +1,186 @@
+/*
+ * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+/*
+ * @test
+ * @bug 8218152
+ * @summary A bad annotation processor class file should fail with an error
+ * @author Steven Groeger
+ *
+ * @library /tools/lib /tools/javac/lib
+ * @modules
+ *      jdk.compiler/com.sun.tools.javac.api
+ *      jdk.compiler/com.sun.tools.javac.main
+ * @build toolbox.ToolBox toolbox.JavacTask JavacTestingAbstractProcessor
+ * @run main MalformedAnnotationProcessorTests
+ */
+
+import java.io.RandomAccessFile;
+import java.nio.ByteBuffer;
+import java.nio.channels.FileChannel;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.List;
+
+import javax.annotation.processing.Processor;
+
+import toolbox.JavacTask;
+import toolbox.Task;
+import toolbox.Task.Expect;
+import toolbox.TestRunner;
+import toolbox.ToolBox;
+
+public class MalformedAnnotationProcessorTests extends TestRunner{
+    public static void main(String... args) throws Exception {
+        new MalformedAnnotationProcessorTests().runTests(
+                m -> new Object[] { Paths.get(m.getName()) }
+        );
+    }
+
+    private ToolBox tb = new ToolBox();
+
+    public MalformedAnnotationProcessorTests() {
+        super(System.err);
+    }
+
+    @Test
+    public void testBadAnnotationProcessor(Path base) throws Exception {
+        Path apDir = base.resolve("annoprocessor");
+        tb.writeFile(apDir.resolve("META-INF").resolve("services")
+                          .resolve(Processor.class.getCanonicalName()), "BadAnnoProcessor");
+        tb.writeFile(apDir.resolve("BadAnnoProcessor.class"), "badannoprocessor");
+
+        Path src = base.resolve("src");
+        Path classes = base.resolve("classes");
+
+        Files.createDirectories(classes);
+
+        tb.writeJavaFiles(src, "package test; public class Test {}");
+
+        List<String> actualErrors =
+                new JavacTask(tb)
+                    .options("-XDrawDiagnostics",
+                             "-classpath", "",
+                             "-sourcepath", src.toString(),
+                             "-processorpath", apDir.toString())
+                    .outdir(classes)
+                    .files(tb.findJavaFiles(src))
+                    .run(Expect.FAIL)
+                    .writeAll()
+                    .getOutputLines(Task.OutputKind.DIRECT);
+
+        System.out.println(actualErrors.get(0));
+        if (!actualErrors.get(0).contains("- compiler.err.proc.cant.load.class: " +
+                                          "Incompatible magic value")) {
+            throw new AssertionError("Unexpected errors reported: " + actualErrors);
+        }
+    }
+
+    @Test
+    public void testMissingAnnotationProcessor(Path base) throws Exception {
+        Path apDir = base.resolve("annoprocessor");
+        tb.writeFile(apDir.resolve("META-INF").resolve("services").resolve(Processor.class.getCanonicalName()),
+                     "MissingAnnoProcessor");
+
+        Path src = base.resolve("src");
+        Path classes = base.resolve("classes");
+
+        Files.createDirectories(classes);
+
+        tb.writeJavaFiles(src, "package test; public class Test {}");
+
+        List<String> actualErrors =
+                new JavacTask(tb)
+                    .options("-XDrawDiagnostics",
+                             "-classpath", "",
+                             "-sourcepath", src.toString(),
+                             "-processorpath", apDir.toString())
+                    .outdir(classes)
+                    .files(tb.findJavaFiles(src))
+                    .run(Expect.FAIL)
+                    .writeAll()
+                    .getOutputLines(Task.OutputKind.DIRECT);
+
+        if (!actualErrors.get(0).contains("- compiler.err.proc.bad.config.file: " +
+            "javax.annotation.processing.Processor: Provider MissingAnnoProcessor not found")) {
+            throw new AssertionError("Unexpected errors reported: " + actualErrors);
+        }
+    }
+
+    @Test
+    public void testWrongClassFileVersion(Path base) throws Exception {
+        Path apDir = base.resolve("ap");
+        tb.writeFile(apDir.resolve("META-INF").resolve("services").resolve(Processor.class.getCanonicalName()),
+                     "WrongClassFileVersion");
+
+        new JavacTask(tb)
+                .outdir(apDir)
+                .sources("class WrongClassFileVersion {}")
+                .run()
+                .writeAll();
+
+        increaseMajor(apDir.resolve("WrongClassFileVersion.class"), 1);
+
+        Path src = base.resolve("src");
+        Path classes = base.resolve("classes");
+
+        Files.createDirectories(classes);
+
+        tb.writeJavaFiles(src, "package test; public class Test {}");
+
+        List<String> actualErrors =
+                new JavacTask(tb)
+                    .options("-XDrawDiagnostics",
+                             "-classpath", "",
+                             "-sourcepath", src.toString(),
+                             "-processorpath", apDir.toString())
+                    .outdir(classes)
+                    .files(tb.findJavaFiles(src))
+                    .run(Expect.FAIL)
+                    .writeAll()
+                    .getOutputLines(Task.OutputKind.DIRECT);
+
+        if (!actualErrors.get(0).contains("- compiler.err.proc.cant.load.class: " +
+            "WrongClassFileVersion has been compiled by a more recent version")) {
+            throw new AssertionError("Unexpected errors reported: " + actualErrors);
+        }
+    }
+
+    // Increase class file cfile's major version by delta
+    // (note: based on test/langtools/tools/javac/6330997/T6330997.java)
+    static void increaseMajor(Path cfile, int delta) {
+        try (RandomAccessFile cls =
+             new RandomAccessFile(cfile.toFile(), "rw");
+             FileChannel fc = cls.getChannel()) {
+            ByteBuffer rbuf = ByteBuffer.allocate(2);
+            fc.read(rbuf, 6);
+            ByteBuffer wbuf = ByteBuffer.allocate(2);
+            wbuf.putShort(0, (short)(rbuf.getShort(0) + delta));
+            fc.write(wbuf, 6);
+            fc.force(false);
+        } catch (Exception e){
+            throw new RuntimeException("Failed: unexpected exception");
+         }
+     }
+}
--- a/test/langtools/tools/javac/diags/examples.not-yet.txt	Wed Apr 17 01:21:56 2019 -0700
+++ b/test/langtools/tools/javac/diags/examples.not-yet.txt	Tue Apr 30 10:39:22 2019 +0200
@@ -35,6 +35,7 @@
 compiler.err.proc.no.service                            # JavacProcessingEnvironment: no service loader available
 compiler.err.proc.processor.bad.option.name             # cannot happen? masked by javac.err.invalid.A.key
 compiler.err.proc.service.problem                       # JavacProcessingEnvironment: catch Throwable from service loader
+compiler.err.proc.cant.load.class                       # JavacProcessingEnvironment: cant load the class/jar file
 compiler.err.signature.doesnt.match.intf                # UNUSED
 compiler.err.signature.doesnt.match.supertype           # UNUSED
 compiler.err.source.cant.overwrite.input.file