test/tools/sjavac/OptionDecoding.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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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.
 */

import static util.OptionTestUtil.assertEquals;
import static util.OptionTestUtil.checkFilesFound;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

import com.sun.tools.sjavac.CopyFile;
import com.sun.tools.sjavac.Main;
import com.sun.tools.sjavac.Module;
import com.sun.tools.sjavac.Source;
import com.sun.tools.sjavac.options.Options;
import com.sun.tools.sjavac.options.SourceLocation;

public class OptionDecoding {

    public static void main(String[] args) throws IOException {

        testPaths();
        testDupPaths();
        testSourceLocations();
        testSimpleOptions();
        testServerConf();
        testSearchPaths();
        testTranslationRules();

    }

    // Test decoding of output paths
    static void testPaths() throws IOException {

        final String H = "headers";
        final String G = "gensrc";
        final String D = "dest";
        final String CMP = "srcRefList.txt";

        Options options = Options.parseArgs("-h", H, "-s", G, "-d", D,
                                            "--compare-found-sources", CMP);

        assertEquals(Paths.get(H).toAbsolutePath(), options.getHeaderDir());
        assertEquals(Paths.get(G).toAbsolutePath(), options.getGenSrcDir());
        assertEquals(Paths.get(D).toAbsolutePath(), options.getDestDir());
        assertEquals(Paths.get(CMP), options.getSourceReferenceList());

    }

    // Providing duplicate header / dest / gensrc paths should produce an error.
    static void testDupPaths() throws IOException {

        try {
            Options.parseArgs("-h", "dir1", "-h", "dir2");
            throw new RuntimeException("Duplicate header directories should fail.");
        } catch (IllegalArgumentException iae) {
            // Expected
        }

        try {
            Options.parseArgs("-s", "dir1", "-s", "dir2");
            throw new RuntimeException("Duplicate paths for generated sources should fail.");
        } catch (IllegalArgumentException iae) {
            // Expected
        }

        try {
            Options.parseArgs("-d", "dir1", "-d", "dir2");
            throw new RuntimeException("Duplicate destination directories should fail.");
        } catch (IllegalArgumentException iae) {
            // Expected
        }

    }

    // Test source locations and -x, -i, -xf, -if filters
    static void testSourceLocations() throws IOException {

        Path a1 = Paths.get("root/pkg1/ClassA1.java");
        Path a2 = Paths.get("root/pkg1/ClassA2.java");
        Path b1 = Paths.get("root/pkg1/pkg2/ClassB1.java");
        Path b2 = Paths.get("root/pkg1/pkg2/ClassB2.java");
        Path c1 = Paths.get("root/pkg3/ClassC1.java");
        Path c2 = Paths.get("root/pkg3/ClassC2.java");

        for (Path p : Arrays.asList(a1, a2, b1, b2, c1, c2)) {
            Files.createDirectories(p.getParent());
            Files.createFile(p);
        }

        // Test -if
        {
            Options options = Options.parseArgs("-if", "root/pkg1/ClassA1.java", "root");

            Map<String, Source> foundFiles = new HashMap<>();
            Main.findSourceFiles(options.getSources(), Collections.singleton(".java"), foundFiles,
                    new HashMap<String, Module>(), new Module("", ""), false, true);

            checkFilesFound(foundFiles.keySet(), a1);
        }

        // Test -i
        System.out.println("--------------------------- CHECKING -i ----------------");
        {
            Options options = Options.parseArgs("-i", "pkg1/*", "root");

            Map<String, Source> foundFiles = new HashMap<>();
            Main.findSourceFiles(options.getSources(), Collections.singleton(".java"), foundFiles,
                    new HashMap<String, Module>(), new Module("", ""), false, true);

            checkFilesFound(foundFiles.keySet(), a1, a2, b1, b2);
        }
        System.out.println("--------------------------------------------------------");

        // Test -xf
        {
            Options options = Options.parseArgs("-xf", "root/pkg1/ClassA1.java", "root");

            Map<String, Source> foundFiles = new HashMap<>();
            Main.findSourceFiles(options.getSources(), Collections.singleton(".java"), foundFiles,
                    new HashMap<String, Module>(), new Module("", ""), false, true);

            checkFilesFound(foundFiles.keySet(), a2, b1, b2, c1, c2);
        }

        // Test -x
        {
            Options options = Options.parseArgs("-i", "pkg1/*", "root");

            Map<String, Source> foundFiles = new HashMap<>();
            Main.findSourceFiles(options.getSources(), Collections.singleton(".java"), foundFiles,
                    new HashMap<String, Module>(), new Module("", ""), false, true);

            checkFilesFound(foundFiles.keySet(), a1, a2, b1, b2);
        }

        // Test -x and -i
        {
            Options options = Options.parseArgs("-i", "pkg1/*", "-x", "pkg1/pkg2/*", "root");

            Map<String, Source> foundFiles = new HashMap<>();
            Main.findSourceFiles(options.getSources(), Collections.singleton(".java"), foundFiles,
                    new HashMap<String, Module>(), new Module("", ""), false, true);

            checkFilesFound(foundFiles.keySet(), a1, a2);
        }

    }

    // Test basic options
    static void testSimpleOptions() {

        Options options = Options.parseArgs("-j", "17", "--log=debug");
        assertEquals(17, options.getNumCores());
        assertEquals("debug", options.getLogLevel());
        assertEquals(false, options.isDefaultPackagePermitted());
        assertEquals(false, options.isUnidentifiedArtifactPermitted());

        options = Options.parseArgs("--permit-unidentified-artifacts",
                                    "--permit-sources-without-package");
        assertEquals("info", options.getLogLevel());
        assertEquals(true, options.isDefaultPackagePermitted());
        assertEquals(true, options.isUnidentifiedArtifactPermitted());
    }

    // Test server configuration options
    static void testServerConf() {
        Options options = Options.parseArgs("--server:someServerConfiguration");
        assertEquals("someServerConfiguration", options.getServerConf());
        assertEquals(false, options.startServerFlag());

        options = Options.parseArgs("--startserver:someServerConfiguration");
        assertEquals("someServerConfiguration", options.getServerConf());
        assertEquals(true, options.startServerFlag());
    }

    // Test input paths
    static void testSearchPaths() {

        List<String> i, x, iF, xF;
        i = x = iF = xF = new ArrayList<>();

        SourceLocation dir1 = new SourceLocation(Paths.get("dir1"), i, x, iF, xF);
        SourceLocation dir2 = new SourceLocation(Paths.get("dir2"), i, x, iF, xF);

        Options options = Options.parseArgs("-sourcepath", "dir1:dir2");
        assertEquals(options.getSourceSearchPaths(), Arrays.asList(dir1, dir2));

        options = Options.parseArgs("-modulepath", "dir1:dir2");
        assertEquals(options.getModuleSearchPaths(), Arrays.asList(dir1, dir2));

        options = Options.parseArgs("-classpath", "dir1:dir2");
        assertEquals(options.getClassSearchPath(), Arrays.asList(dir1, dir2));
    }

    // Test -tr option
    static void testTranslationRules() {

        Class<?> cls = com.sun.tools.sjavac.CompileJavaPackages.class;

        Options options = Options.parseArgs(
                "-tr", ".exa=" + cls.getName(),
                "-tr", ".exb=" + cls.getName(),
                "-copy", ".html");

        assertEquals(cls, options.getTranslationRules().get(".exa").getClass());
        assertEquals(cls, options.getTranslationRules().get(".exb").getClass());
        assertEquals(CopyFile.class, options.getTranslationRules().get(".html").getClass());

    }
}