test/langtools/tools/lib/toolbox/ExecTask.java
author erikj
Tue, 12 Sep 2017 19:03:39 +0200
changeset 47216 71c04702a3d5
parent 36778 langtools/test/tools/lib/toolbox/ExecTask.java@e04318f39f92
permissions -rw-r--r--
8187443: Forest Consolidation: Move files to unified layout Reviewed-by: darcy, ihse
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36778
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     1
/*
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     2
 * Copyright (c) 2013, 2016, Oracle and/or its affiliates. All rights reserved.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     4
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     7
 * published by the Free Software Foundation.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     8
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    13
 * accompanied this code).
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    14
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    18
 *
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    21
 * questions.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    22
 */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    23
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    24
package toolbox;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    25
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    26
import java.io.IOException;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    27
import java.nio.file.Path;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    28
import java.util.ArrayList;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    29
import java.util.Arrays;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    30
import java.util.List;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    31
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    32
/**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    33
 * A task to configure and run a general command.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    34
 */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    35
public class ExecTask extends AbstractTask<ExecTask> {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    36
    private final String command;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    37
    private List<String> args;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    38
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    39
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    40
     * Create a task to execute a given command, to be run using {@code EXEC} mode.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    41
     * @param toolBox the {@code ToolBox} to use
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    42
     * @param command the command to be executed
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    43
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    44
    public ExecTask(ToolBox toolBox, String command) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    45
        super(toolBox, Task.Mode.EXEC);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    46
        this.command = command;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    47
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    48
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    49
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    50
     * Create a task to execute a given command, to be run using {@code EXEC} mode.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    51
     * @param toolBox the {@code ToolBox} to use
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    52
     * @param command the command to be executed
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    53
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    54
    public ExecTask(ToolBox toolBox, Path command) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    55
        super(toolBox, Task.Mode.EXEC);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    56
        this.command = command.toString();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    57
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    58
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    59
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    60
     * Sets the arguments for the command to be executed
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    61
     * @param args the arguments
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    62
     * @return this task object
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    63
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    64
    public ExecTask args(String... args) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    65
        this.args = Arrays.asList(args);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    66
        return this;
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    67
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    68
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    69
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    70
     * {@inheritDoc}
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    71
     * @return the name "exec"
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    72
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    73
    @Override
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    74
    public String name() {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    75
        return "exec";
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    76
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    77
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    78
    /**
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    79
     * Calls the command with the arguments as currently configured.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    80
     * @return a Result object indicating the outcome of the task
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    81
     * and the content of any output written to stdout or stderr.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    82
     * @throws TaskError if the outcome of the task is not as expected.
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    83
     */
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    84
    @Override
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    85
    public Task.Result run() {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    86
        List<String> cmdArgs = new ArrayList<>();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    87
        cmdArgs.add(command);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    88
        if (args != null)
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    89
            cmdArgs.addAll(args);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    90
        ProcessBuilder pb = getProcessBuilder();
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    91
        pb.command(cmdArgs);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    92
        try {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    93
            return runProcess(toolBox, this, pb.start());
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    94
        } catch (IOException | InterruptedException e) {
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    95
            throw new Error(e);
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    96
        }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    97
    }
e04318f39f92 8152897: refactor ToolBox to allow reduced documented dependencies
jjg
parents:
diff changeset
    98
}