src/jdk.jpackage/share/classes/jdk/jpackage/internal/ToolValidator.java
author herrick
Fri, 18 Oct 2019 14:14:37 -0400
branchJDK-8200758-branch
changeset 58696 61c44899b4eb
parent 58417 67ffaf3a2b75
child 58890 6539ad1d90aa
permissions -rw-r--r--
8223325: Improve wix sources generated by jpackage Submitted-by: asemenyuk Reviewed-by: aherrick, almatvee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     1
/*
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     4
 *
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    10
 *
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    15
 * accompanied this code).
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    16
 *
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    20
 *
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    23
 * questions.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    24
 */
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    25
package jdk.jpackage.internal;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    26
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    27
import java.io.IOException;
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    28
import java.nio.file.Path;
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    29
import java.text.MessageFormat;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    30
import java.util.ArrayList;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    31
import java.util.List;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    32
import java.util.concurrent.atomic.AtomicBoolean;
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    33
import java.util.function.BiFunction;
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    34
import java.util.function.Function;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    35
import java.util.stream.Stream;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    36
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    37
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    38
public final class ToolValidator {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    39
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    40
    ToolValidator(String tool) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    41
        this(Path.of(tool));
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    42
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    43
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    44
    ToolValidator(Path toolPath) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    45
        this.toolPath = toolPath;
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    46
        args = new ArrayList<>();
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    47
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    48
        if (Platform.getPlatform() == Platform.LINUX) {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    49
            setCommandLine("--version");
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    50
        }
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    51
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    52
        setToolNotFoundErrorHandler(null);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    53
        setToolOldVersionErrorHandler(null);
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    54
    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    55
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    56
    ToolValidator setCommandLine(String... args) {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    57
        this.args = List.of(args);
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    58
        return this;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    59
    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    60
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    61
    ToolValidator setMinimalVersion(String v) {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    62
        minimalVersion = v;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    63
        return this;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    64
    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    65
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    66
    ToolValidator setVersionParser(Function<Stream<String>, String> v) {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    67
        versionParser = v;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    68
        return this;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    69
    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    70
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    71
    ToolValidator setToolNotFoundErrorHandler(
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    72
            BiFunction<String, IOException, ConfigException> v) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    73
        toolNotFoundErrorHandler = v;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    74
        return this;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    75
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    76
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    77
    ToolValidator setToolOldVersionErrorHandler(BiFunction<String, String, ConfigException> v) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    78
        toolOldVersionErrorHandler = v;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    79
        return this;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    80
    }
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    81
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    82
    ConfigException validate() {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    83
        List<String> cmdline = new ArrayList<>();
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    84
        cmdline.add(toolPath.toString());
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    85
        cmdline.addAll(args);
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    86
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    87
        String name = toolPath.getFileName().toString();
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    88
        try {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    89
            ProcessBuilder pb = new ProcessBuilder(cmdline);
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    90
            AtomicBoolean canUseTool = new AtomicBoolean();
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    91
            if (minimalVersion == null) {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    92
                // No version check.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    93
                canUseTool.setPlain(true);
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    94
            }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    95
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    96
            String[] version = new String[1];
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    97
            Executor.of(pb).setOutputConsumer(lines -> {
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
    98
                if (versionParser != null && minimalVersion != null) {
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
    99
                    version[0] = versionParser.apply(lines);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   100
                    if (minimalVersion.compareTo(version[0]) < 0) {
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   101
                        canUseTool.setPlain(true);
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   102
                    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   103
                }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   104
            }).execute();
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   105
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   106
            if (!canUseTool.getPlain()) {
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   107
                if (toolOldVersionErrorHandler != null) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   108
                    return toolOldVersionErrorHandler.apply(name, version[0]);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   109
                }
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   110
                return new ConfigException(MessageFormat.format(I18N.getString(
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   111
                        "error.tool-old-version"), name, minimalVersion),
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   112
                        MessageFormat.format(I18N.getString(
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   113
                                "error.tool-old-version.advice"), name,
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   114
                                minimalVersion));
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   115
            }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   116
        } catch (IOException e) {
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   117
            if (toolNotFoundErrorHandler != null) {
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   118
                return toolNotFoundErrorHandler.apply(name, e);
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   119
            }
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   120
            return new ConfigException(MessageFormat.format(I18N.getString(
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   121
                    "error.tool-not-found"), name, e.getMessage()),
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   122
                    MessageFormat.format(I18N.getString(
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   123
                            "error.tool-not-found.advice"), name), e);
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   124
        }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   125
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   126
        // All good. Tool can be used.
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   127
        return null;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   128
    }
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   129
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   130
    private final Path toolPath;
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   131
    private List<String> args;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   132
    private String minimalVersion;
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   133
    private Function<Stream<String>, String> versionParser;
58696
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   134
    private BiFunction<String, IOException, ConfigException> toolNotFoundErrorHandler;
61c44899b4eb 8223325: Improve wix sources generated by jpackage
herrick
parents: 58417
diff changeset
   135
    private BiFunction<String, String, ConfigException> toolOldVersionErrorHandler;
58417
67ffaf3a2b75 8231280: Linux packages produced by jpackage should have correct dependencies
herrick
parents:
diff changeset
   136
}