test/tools/javac/api/taskListeners/CompileEvent.java

/*
 * Copyright (c) 2014, 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 8033414
 * @summary Verify that the TaskEvent.COMPILATION is fired properly.
 * @run main CompileEvent
 */

import java.io.*;
import java.util.*;

import javax.tools.*;

import com.sun.source.util.*;
import com.sun.tools.javac.Main;
import com.sun.tools.javac.api.BasicJavacTask;
import com.sun.tools.javac.util.Context;
import com.sun.tools.javac.util.Log;
import com.sun.tools.javac.util.Log.WriterKind;

public class CompileEvent {

    public static void main(String... args) throws IOException {
        new CompileEvent().run();
    }

    void run() throws IOException {
        String testClasses = System.getProperty("test.classes");
        File pluginRegistration =
                new File(testClasses + "/META-INF/services/com.sun.source.util.Plugin");
        pluginRegistration.getParentFile().mkdirs();
        try (Writer metaInfRegistration = new FileWriter(pluginRegistration)) {
            metaInfRegistration.write("CompileEvent$PluginImpl");
        }
        File test = new File(testClasses + "/Test.java");
        test.getParentFile().mkdirs();
        try (Writer testFileWriter = new FileWriter(test)) {
            testFileWriter.write("public class Test { }");
        }

        StringWriter out;

        //test events fired to listeners registered from plugins
        //when starting compiler using Main.compile
        out = new StringWriter();
        int mainResult = Main.compile(new String[] {
            "-Xplugin:compile-event", "-processorpath", testClasses, test.getAbsolutePath()
        }, new PrintWriter(out, true));
        if (mainResult != 0)
            throw new AssertionError("Compilation failed unexpectedly, exit code: " + mainResult);
        assertOutput(out);

        JavaCompiler comp = ToolProvider.getSystemJavaCompiler();
        StandardJavaFileManager fm = comp.getStandardFileManager(null, null, null);
        Iterable<? extends JavaFileObject> testFileObjects = fm.getJavaFileObjects(test);

        //test events fired to listeners registered from plugins
        //when starting compiler using JavaCompiler.getTak(...).call
        List<String> options =
                Arrays.asList("-Xplugin:compile-event", "-processorpath", testClasses);
        out = new StringWriter();
        boolean compResult = comp.getTask(out, null, null, options, null, testFileObjects).call();
        if (!compResult)
            throw new AssertionError("Compilation failed unexpectedly.");
        assertOutput(out);
    }

    void assertOutput(StringWriter out) {
        String lineSeparator = System.getProperty("line.separator");
        if (!out.toString().trim().replace(lineSeparator, "\n").equals(EXPECTED)) {
            throw new AssertionError("Unexpected events: " + out.toString());
        }
    }

    private static final String EXPECTED =
        "started(COMPILATION)\n" +
        "started(PARSE:Test.java)\n" +
        "finished(PARSE:Test.java)\n" +
        "started(ENTER:Test.java)\n" +
        "finished(ENTER:Test.java)\n" +
        "started(ANALYZE:Test.java:Test)\n" +
        "finished(ANALYZE:Test.java:Test)\n" +
        "started(GENERATE:Test.java:Test)\n" +
        "finished(GENERATE:Test.java:Test)\n" +
        "finished(COMPILATION)";

    private static class TaskListenerImpl implements TaskListener {
        private final PrintWriter out;
        public TaskListenerImpl(PrintWriter out) {
            this.out = out;
        }
        @Override public void started(TaskEvent e) {
            dumpTaskEvent("started", e);
        }
        @Override public void finished(TaskEvent e) {
            dumpTaskEvent("finished", e);
        }
        private void dumpTaskEvent(String type, TaskEvent e) {
            StringBuilder data = new StringBuilder();
            data.append(type);
            data.append("(");
            data.append(e.getKind());
            if (e.getSourceFile() != null) {
                data.append(":");
                data.append(new File(e.getSourceFile().getName()).getName());
            }
            if (e.getTypeElement()!= null) {
                data.append(":");
                data.append(e.getTypeElement().getQualifiedName());
            }
            data.append(")");
            out.println(data);
        }
    }

    public static final class PluginImpl implements Plugin {
        @Override public String getName() {
            return "compile-event";
        }
        @Override public void init(JavacTask task, String... args) {
            Context context = ((BasicJavacTask) task).getContext();
            Log log = Log.instance(context);
            task.addTaskListener(new TaskListenerImpl(log.getWriter(WriterKind.NOTICE)));
        }
    }
}