langtools/test/tools/javadoc/api/basic/GetTask_OptionsTest.java
author jjg
Wed, 29 Oct 2014 17:25:23 -0700
changeset 27319 030080f03e4f
parent 14545 2e7bab0639b8
child 30730 d3ce7619db2c
permissions -rw-r--r--
8062348: langtools tests should close file manager (group 1) Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     1
/*
27319
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
     2
 * Copyright (c) 2012, 2014, Oracle and/or its affiliates. All rights reserved.
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     4
 *
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     8
 *
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    13
 * accompanied this code).
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    14
 *
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    18
 *
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    21
 * questions.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    22
 */
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    23
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    24
/*
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    25
 * @test
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    26
 * @bug 6493690
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    27
 * @summary javadoc should have a javax.tools.Tool service provider
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    28
 * @build APITest
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    29
 * @run main GetTask_OptionsTest
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    30
 */
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    31
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    32
import java.io.File;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    33
import java.util.Arrays;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    34
import java.util.Set;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    35
import java.util.TreeSet;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    36
import javax.tools.DocumentationTool;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    37
import javax.tools.DocumentationTool.DocumentationTask;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    38
import javax.tools.JavaFileObject;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    39
import javax.tools.StandardJavaFileManager;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    40
import javax.tools.ToolProvider;
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    41
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    42
/**
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    43
 * Tests for DocumentationTool.getTask  options  parameter.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    44
 */
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    45
public class GetTask_OptionsTest extends APITest {
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    46
    public static void main(String... args) throws Exception {
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    47
        new GetTask_OptionsTest().run();
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    48
    }
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    49
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    50
    /**
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    51
     * Verify that expected output files are written for given options.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    52
     */
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    53
    @Test
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    54
    public void testNoIndex() throws Exception {
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    55
        JavaFileObject srcFile = createSimpleJavaFileObject();
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    56
        DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
27319
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    57
        try (StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null)) {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    58
            File outDir = getOutDir();
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    59
            fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    60
            Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    61
            Iterable<String> options = Arrays.asList("-noindex");
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    62
            DocumentationTask t = tool.getTask(null, fm, null, null, options, files);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    63
            if (t.call()) {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    64
                System.err.println("task succeeded");
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    65
                Set<String> expectFiles = new TreeSet<String>(standardExpectFiles);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    66
                expectFiles.remove("index-all.html");
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    67
                checkFiles(outDir, expectFiles);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    68
            } else {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    69
                error("task failed");
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    70
            }
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    71
        }
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    72
    }
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    73
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    74
    /**
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    75
     * Verify null is handled correctly.
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    76
     */
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    77
    @Test
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    78
    public void testNull() throws Exception {
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    79
        JavaFileObject srcFile = createSimpleJavaFileObject();
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    80
        DocumentationTool tool = ToolProvider.getSystemDocumentationTool();
27319
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    81
        try (StandardJavaFileManager fm = tool.getStandardFileManager(null, null, null)) {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    82
            File outDir = getOutDir();
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    83
            fm.setLocation(DocumentationTool.Location.DOCUMENTATION_OUTPUT, Arrays.asList(outDir));
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    84
            Iterable<String> options = Arrays.asList((String) null);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    85
            Iterable<? extends JavaFileObject> files = Arrays.asList(srcFile);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    86
            try {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    87
                DocumentationTask t = tool.getTask(null, fm, null, null, options, files);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    88
                error("getTask succeeded, no exception thrown");
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    89
            } catch (NullPointerException e) {
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    90
                System.err.println("exception caught as expected: " + e);
030080f03e4f 8062348: langtools tests should close file manager (group 1)
jjg
parents: 14545
diff changeset
    91
            }
14545
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    92
        }
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    93
    }
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    94
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    95
}
2e7bab0639b8 6493690: javadoc should have a javax.tools.Tool service provider installed in tools.jar
jjg
parents:
diff changeset
    96