test/jdk/tools/jpackage/helpers/jdk/jpackage/test/JPackageCommand.java
author herrick
Mon, 30 Sep 2019 19:11:19 -0400
branchJDK-8200758-branch
changeset 58416 f09bf58c1f17
parent 58304 7a61351edad2
child 58648 3bf53ffa9ae7
permissions -rw-r--r--
8231605: Improve test helpers Submitted-by: asemenyuk Reviewed-by: herrick
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     1
/*
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     2
 * Copyright (c) 2019, Oracle and/or its affiliates. All rights reserved.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     4
 *
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     7
 * published by the Free Software Foundation.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     8
 *
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    13
 * accompanied this code).
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    14
 *
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    18
 *
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    21
 * questions.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    22
 */
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    23
package jdk.jpackage.test;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    24
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    25
import java.io.FileOutputStream;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    26
import java.io.IOException;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    27
import java.nio.file.Files;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    28
import java.nio.file.Path;
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    29
import java.security.SecureRandom;
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    30
import java.util.*;
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    31
import java.util.function.Consumer;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    32
import java.util.function.Function;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    33
import java.util.function.Supplier;
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    34
import java.util.regex.Pattern;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    35
import java.util.stream.Collectors;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    36
import java.util.stream.Stream;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    37
import jdk.jpackage.test.Functional.ThrowingConsumer;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    38
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    39
/**
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    40
 * jpackage command line with prerequisite actions. Prerequisite actions can be
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    41
 * anything. The simplest is to compile test application and pack in a jar for
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    42
 * use on jpackage command line.
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    43
 */
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    44
public final class JPackageCommand extends CommandArguments<JPackageCommand> {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    45
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    46
    public JPackageCommand() {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    47
        actions = new ArrayList<>();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    48
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    49
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    50
    JPackageCommand createImmutableCopy() {
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    51
        JPackageCommand reply = new JPackageCommand();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    52
        reply.immutable = true;
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    53
        reply.args.addAll(args);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    54
        return reply;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    55
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    56
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    57
    public JPackageCommand setArgumentValue(String argName, String newValue) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
    58
        verifyMutable();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
    59
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    60
        String prevArg = null;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    61
        ListIterator<String> it = args.listIterator();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    62
        while (it.hasNext()) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    63
            String value = it.next();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    64
            if (prevArg != null && prevArg.equals(argName)) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    65
                if (newValue != null) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    66
                    it.set(newValue);
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    67
                } else {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    68
                    it.remove();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    69
                    it.previous();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    70
                    it.remove();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    71
                }
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    72
                return this;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    73
            }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    74
            prevArg = value;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    75
        }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    76
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    77
        if (newValue != null) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    78
            addArguments(argName, newValue);
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    79
        }
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    80
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    81
        return this;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    82
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    83
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    84
    public JPackageCommand setArgumentValue(String argName, Path newValue) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    85
        return setArgumentValue(argName, newValue.toString());
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    86
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    87
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    88
    public JPackageCommand removeArgumentWithValue(String argName) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    89
        return setArgumentValue(argName, (String)null);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    90
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    91
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
    92
    public JPackageCommand removeArgument(String argName) {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    93
        args = args.stream().filter(arg -> !arg.equals(argName)).collect(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    94
                Collectors.toList());
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
    95
        return this;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    96
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
    97
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
    98
    public boolean hasArgument(String argName) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
    99
        return args.contains(argName);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   100
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   101
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   102
    public <T> T getArgumentValue(String argName,
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   103
            Function<JPackageCommand, T> defaultValueSupplier,
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   104
            Function<String, T> stringConverter) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   105
        String prevArg = null;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   106
        for (String arg : args) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   107
            if (prevArg != null && prevArg.equals(argName)) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   108
                return stringConverter.apply(arg);
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   109
            }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   110
            prevArg = arg;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   111
        }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   112
        if (defaultValueSupplier != null) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   113
            return defaultValueSupplier.apply(this);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   114
        }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   115
        return null;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   116
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   117
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   118
    public String getArgumentValue(String argName,
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   119
            Function<JPackageCommand, String> defaultValueSupplier) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   120
        return getArgumentValue(argName, defaultValueSupplier, v -> v);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   121
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   122
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   123
    public <T> T getArgumentValue(String argName,
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   124
            Supplier<T> defaultValueSupplier,
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   125
            Function<String, T> stringConverter) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   126
        return getArgumentValue(argName, (unused) -> defaultValueSupplier.get(),
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   127
                stringConverter);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   128
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   129
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   130
    public String getArgumentValue(String argName,
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   131
            Supplier<String> defaultValueSupplier) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   132
        return getArgumentValue(argName, defaultValueSupplier, v -> v);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   133
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   134
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   135
    public String getArgumentValue(String argName) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   136
        return getArgumentValue(argName, (Supplier<String>)null);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   137
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   138
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   139
    public String[] getAllArgumentValues(String argName) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   140
        List<String> values = new ArrayList<>();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   141
        String prevArg = null;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   142
        for (String arg : args) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   143
            if (prevArg != null && prevArg.equals(argName)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   144
                values.add(arg);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   145
            }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   146
            prevArg = arg;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   147
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   148
        return values.toArray(String[]::new);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   149
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   150
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   151
    public JPackageCommand addArguments(String name, Path value) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   152
        return addArguments(name, value.toString());
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   153
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   154
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   155
    public PackageType packageType() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   156
        // Don't try to be in sync with jpackage defaults. Keep it simple:
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   157
        // if no `--package-type` explicitely set on the command line, consider
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   158
        // this is operator's fault.
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   159
        return getArgumentValue("--package-type",
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   160
                () -> {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   161
                    throw new IllegalStateException("Package type not set");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   162
                }, PACKAGE_TYPES::get);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   163
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   164
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   165
    public Path outputDir() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   166
        return getArgumentValue("--dest", () -> Path.of("."), Path::of);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   167
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   168
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   169
    public Path inputDir() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   170
        return getArgumentValue("--input", () -> null, Path::of);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   171
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   172
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   173
    public String version() {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   174
        return getArgumentValue("--app-version", () -> "1.0");
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   175
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   176
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   177
    public String name() {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   178
        return getArgumentValue("--name", () -> getArgumentValue("--main-class"));
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   179
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   180
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   181
    public boolean isRuntime() {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   182
        return  hasArgument("--runtime-image")
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   183
                && !hasArgument("--main-jar")
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   184
                && !hasArgument("--module")
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   185
                && !hasArgument("--app-image");
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   186
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   187
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   188
    public JPackageCommand setDefaultInputOutput() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   189
        addArguments("--input", TKit.defaultInputDir());
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   190
        addArguments("--dest", TKit.defaultOutputDir());
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   191
        return this;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   192
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   193
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   194
    public JPackageCommand setFakeRuntime() {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   195
        verifyMutable();
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   196
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   197
        try {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   198
            Path fakeRuntimeDir = TKit.workDir().resolve("fake_runtime");
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   199
            Files.createDirectories(fakeRuntimeDir);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   200
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   201
            if (TKit.isWindows() || TKit.isLinux()) {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   202
                // Needed to make WindowsAppBundler happy as it copies MSVC dlls
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   203
                // from `bin` directory.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   204
                // Need to make the code in rpm spec happy as it assumes there is
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   205
                // always something in application image.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   206
                fakeRuntimeDir.resolve("bin").toFile().mkdir();
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   207
            }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   208
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   209
            Path bulk = fakeRuntimeDir.resolve(Path.of("bin", "bulk"));
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   210
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   211
            // Mak sure fake runtime takes some disk space.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   212
            // Package bundles with 0KB size are unexpected and considered
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   213
            // an error by PackageTest.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   214
            Files.createDirectories(bulk.getParent());
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   215
            try (FileOutputStream out = new FileOutputStream(bulk.toFile())) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   216
                byte[] bytes = new byte[4 * 1024];
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   217
                new SecureRandom().nextBytes(bytes);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   218
                out.write(bytes);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   219
            }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   220
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   221
            addArguments("--runtime-image", fakeRuntimeDir);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   222
        } catch (IOException ex) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   223
            throw new RuntimeException(ex);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   224
        }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   225
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   226
        return this;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   227
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   228
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   229
    JPackageCommand addAction(ThrowingConsumer<JPackageCommand> action) {
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   230
        verifyMutable();
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   231
        actions.add(ThrowingConsumer.toConsumer(action));
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   232
        return this;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   233
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   234
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   235
    public static JPackageCommand helloAppImage() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   236
        return helloAppImage(null);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   237
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   238
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   239
    /**
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   240
     * Creates new JPackageCommand instance configured with the test Java app.
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   241
     * For the explanation of `javaAppDesc` parameter, see documentation for
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   242
     * HelloApp.addTo() method.
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   243
     *
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   244
     * @param javaAppDesc Java application description
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   245
     * @return this
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   246
     */
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   247
    public static JPackageCommand helloAppImage(String javaAppDesc) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   248
        JPackageCommand cmd = new JPackageCommand();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   249
        cmd.setDefaultInputOutput().setDefaultAppName();
58115
4a27283b542d /home/aherrick/comment
herrick
parents: 58114
diff changeset
   250
        PackageType.IMAGE.applyTo(cmd);
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   251
        HelloApp.addTo(cmd, javaAppDesc);
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   252
        return cmd;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   253
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   254
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   255
    public JPackageCommand setPackageType(PackageType type) {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   256
        verifyMutable();
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   257
        type.applyTo(this);
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   258
        return this;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   259
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   260
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   261
    JPackageCommand setDefaultAppName() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   262
        return addArguments("--name", TKit.getCurrentDefaultAppName());
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   263
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   264
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   265
    public Path outputBundle() {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   266
        final PackageType type = packageType();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   267
        if (PackageType.IMAGE == type) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   268
            return null;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   269
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   270
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   271
        String bundleName = null;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   272
        if (PackageType.LINUX.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   273
            bundleName = LinuxHelper.getBundleName(this);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   274
        } else if (PackageType.WINDOWS.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   275
            bundleName = WindowsHelper.getBundleName(this);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   276
        } else if (PackageType.MAC.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   277
            bundleName = MacHelper.getBundleName(this);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   278
        }
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   279
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   280
        return outputDir().resolve(bundleName);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   281
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   282
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   283
    /**
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   284
     * Returns path to directory where application will be installed.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   285
     *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   286
     * E.g. on Linux for app named Foo default the function will return
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   287
     * `/opt/foo`
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   288
     */
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   289
    public Path appInstallationDirectory() {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   290
        final PackageType type = packageType();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   291
        if (PackageType.IMAGE == type) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   292
            return null;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   293
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   294
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   295
        if (PackageType.LINUX.contains(type)) {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   296
            if (isRuntime()) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   297
                // Not fancy, but OK.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   298
                return Path.of(getArgumentValue("--install-dir", () -> "/opt"),
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   299
                        LinuxHelper.getPackageName(this));
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   300
            }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   301
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   302
            // Launcher is in "bin" subfolder of the installation directory.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   303
            return launcherInstallationPath().getParent().getParent();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   304
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   305
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   306
        if (PackageType.WINDOWS.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   307
            return WindowsHelper.getInstallationDirectory(this);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   308
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   309
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   310
        if (PackageType.MAC.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   311
            return MacHelper.getInstallationDirectory(this);
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   312
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   313
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   314
        throw throwUnexpectedPackageTypeError();
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   315
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   316
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   317
    /**
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   318
     * Returns path where application's Java runtime will be installed.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   319
     * If the command will package Java run-time only, still returns path to
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   320
     * runtime subdirectory.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   321
     *
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   322
     * E.g. on Linux for app named `Foo` the function will return
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   323
     * `/opt/foo/runtime`
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   324
     */
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   325
    public Path appRuntimeInstallationDirectory() {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   326
        if (PackageType.IMAGE == packageType()) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   327
            return null;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   328
        }
58302
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   329
        return appInstallationDirectory().resolve(appRuntimePath(packageType()));
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   330
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   331
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   332
    /**
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   333
     * Returns path where application launcher will be installed.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   334
     * If the command will package Java run-time only, still returns path to
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   335
     * application launcher.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   336
     *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   337
     * E.g. on Linux for app named Foo default the function will return
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   338
     * `/opt/foo/bin/Foo`
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   339
     */
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   340
    public Path launcherInstallationPath() {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   341
        final PackageType type = packageType();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   342
        if (PackageType.IMAGE == type) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   343
            return null;
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   344
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   345
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   346
        if (PackageType.LINUX.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   347
            return outputDir().resolve(LinuxHelper.getLauncherPath(this));
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   348
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   349
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   350
        if (PackageType.WINDOWS.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   351
            return appInstallationDirectory().resolve(name() + ".exe");
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   352
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   353
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   354
        if (PackageType.MAC.contains(type)) {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   355
            return appInstallationDirectory().resolve(Path.of("Contents", "MacOS", name()));
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   356
        }
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   357
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   358
        throw throwUnexpectedPackageTypeError();
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   359
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   360
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   361
    /**
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   362
     * Returns path to application image directory.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   363
     *
58147
45a9084fe981 8230521: rename --output/-o option and add default value (".")
herrick
parents: 58115
diff changeset
   364
     * E.g. if --dest is set to `foo` and --name is set to `bar` the function
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   365
     * will return `foo/bar` path on Linux and Windows and `foo/bar.app` on macOS.
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   366
     *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   367
     * @throws IllegalArgumentException is command is doing platform packaging
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   368
     */
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   369
    public Path appImage() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   370
        verifyIsOfType(PackageType.IMAGE);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   371
        String dirName = name();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   372
        if (TKit.isOSX()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   373
            dirName = dirName + ".app";
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   374
        }
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   375
        return outputDir().resolve(dirName);
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   376
    }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   377
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   378
    /**
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   379
     * Returns path to application launcher relative to image directory.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   380
     *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   381
     * E.g. if --name is set to `Foo` the function will return `bin/Foo` path on
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   382
     * Linux, and `Foo.exe` on Windows.
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   383
     *
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   384
     * @throws IllegalArgumentException is command is doing platform packaging
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   385
     */
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   386
    public Path launcherPathInAppImage() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   387
        verifyIsOfType(PackageType.IMAGE);
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   388
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   389
        if (TKit.isLinux()) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   390
            return Path.of("bin", name());
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   391
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   392
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   393
        if (TKit.isOSX()) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   394
            return Path.of("Contents", "MacOS", name());
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   395
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   396
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   397
        if (TKit.isWindows()) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   398
            return Path.of(name() + ".exe");
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   399
        }
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   400
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   401
        throw TKit.throwUnknownPlatformError();
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   402
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   403
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   404
    /**
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   405
     * Returns path to runtime directory relative to image directory.
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   406
     *
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   407
     * @throws IllegalArgumentException if command is configured for platform
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   408
     * packaging
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   409
     */
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   410
    public Path appRuntimeDirectoryInAppImage() {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   411
        verifyIsOfType(PackageType.IMAGE);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   412
        return appRuntimePath(packageType());
58302
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   413
    }
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   414
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   415
    private static Path appRuntimePath(PackageType type) {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   416
        if (TKit.isLinux()) {
58302
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   417
            return Path.of("lib/runtime");
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   418
        }
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   419
        if (TKit.isOSX()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   420
            return Path.of("Contents/runtime");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   421
        }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   422
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   423
        return Path.of("runtime");
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   424
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   425
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   426
    public boolean isFakeRuntimeInAppImage(String msg) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   427
        return isFakeRuntime(appImage().resolve(
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   428
                appRuntimeDirectoryInAppImage()), msg);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   429
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   430
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   431
    public boolean isFakeRuntimeInstalled(String msg) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   432
        return isFakeRuntime(appRuntimeInstallationDirectory(), msg);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   433
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   434
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   435
    private static boolean isFakeRuntime(Path runtimeDir, String msg) {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   436
        final Collection<Path> criticalRuntimeFiles;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   437
        if (TKit.isWindows()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   438
            criticalRuntimeFiles = WindowsHelper.CRITICAL_RUNTIME_FILES;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   439
        } else if (TKit.isLinux()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   440
            criticalRuntimeFiles = LinuxHelper.CRITICAL_RUNTIME_FILES;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   441
        } else if (TKit.isOSX()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   442
            criticalRuntimeFiles = MacHelper.CRITICAL_RUNTIME_FILES;
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   443
        } else {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   444
            throw TKit.throwUnknownPlatformError();
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   445
        }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   446
58302
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   447
        if (criticalRuntimeFiles.stream().filter(
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   448
                v -> runtimeDir.resolve(v).toFile().exists()).findFirst().orElse(
718bd56695b3 8231277 : Adjust Linux application image layout
herrick
parents: 58301
diff changeset
   449
                        null) == null) {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   450
            // Fake runtime
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   451
            TKit.trace(String.format(
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   452
                    "%s because application runtime directory [%s] is incomplete",
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   453
                    msg, runtimeDir));
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   454
            return true;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   455
        }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   456
        return false;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   457
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   458
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   459
    public static void useToolProviderByDefault() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   460
        defaultWithToolProvider = true;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   461
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   462
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   463
    public static void useExecutableByDefault() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   464
        defaultWithToolProvider = false;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   465
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   466
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   467
    public JPackageCommand useToolProvider(boolean v) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   468
        verifyMutable();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   469
        withToolProvider = v;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   470
        return this;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   471
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   472
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   473
    public JPackageCommand saveConsoleOutput(boolean v) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   474
        verifyMutable();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   475
        saveConsoleOutput = v;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   476
        return this;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   477
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   478
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   479
    public JPackageCommand dumpOutput(boolean v) {
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   480
        verifyMutable();
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   481
        suppressOutput = !v;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   482
        return this;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   483
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   484
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   485
    public boolean isWithToolProvider() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   486
        return Optional.ofNullable(withToolProvider).orElse(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   487
                defaultWithToolProvider);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   488
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   489
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   490
    public void executePrerequisiteActions() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   491
        verifyMutable();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   492
        if (!actionsExecuted) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   493
            actionsExecuted = true;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   494
            if (actions != null) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   495
                actions.stream().forEach(r -> r.accept(this));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   496
            }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   497
        }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   498
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   499
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   500
    public Executor.Result execute() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   501
        executePrerequisiteActions();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   502
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   503
        if (packageType() == PackageType.IMAGE) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   504
            TKit.deleteDirectoryContentsRecursive(outputDir());
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   505
        }
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   506
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   507
        Executor exec = new Executor()
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   508
                .saveOutput(saveConsoleOutput).dumpOutput(!suppressOutput)
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   509
                .addArguments(new JPackageCommand().addArguments(
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   510
                                args).adjustArgumentsBeforeExecution().args);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   511
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   512
        if (isWithToolProvider()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   513
            exec.setToolProvider(JavaTool.JPACKAGE.asToolProvider());
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   514
        } else {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   515
            exec.setExecutable(JavaTool.JPACKAGE);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   516
        }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   517
        return exec.execute();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   518
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   519
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   520
    public JPackageCommand executeAndAssertHelloAppImageCreated() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   521
        executeAndAssertImageCreated();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   522
        HelloApp.executeLauncherAndVerifyOutput(this);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   523
        return this;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   524
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   525
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   526
    public JPackageCommand executeAndAssertImageCreated() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   527
        execute().assertExitCodeIsZero();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   528
        return assertImageCreated();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   529
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   530
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   531
    public JPackageCommand assertImageCreated() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   532
        verifyIsOfType(PackageType.IMAGE);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   533
        TKit.assertExecutableFileExists(appImage().resolve(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   534
                launcherPathInAppImage()));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   535
        TKit.assertDirectoryExists(appImage().resolve(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   536
                appRuntimeDirectoryInAppImage()));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   537
        return this;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   538
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   539
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   540
    private JPackageCommand adjustArgumentsBeforeExecution() {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   541
        if (!hasArgument("--runtime-image") && !hasArgument("--app-image") && DEFAULT_RUNTIME_IMAGE != null) {
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   542
            addArguments("--runtime-image", DEFAULT_RUNTIME_IMAGE);
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   543
        }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   544
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   545
        if (!hasArgument("--verbose") && TKit.VERBOSE_JPACKAGE) {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   546
            addArgument("--verbose");
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   547
        }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   548
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   549
        return this;
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   550
    }
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   551
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   552
    private static RuntimeException throwUnexpectedPackageTypeError() {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   553
        throw new IllegalArgumentException("Unexpected package type");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   554
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   555
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   556
    String getPrintableCommandLine() {
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   557
        return new Executor()
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   558
                .setExecutable(JavaTool.JPACKAGE)
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   559
                .addArguments(args)
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   560
                .getPrintableCommandLine();
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   561
    }
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   562
58304
7a61351edad2 8231282 : Revisit --linux-deb-copyright option
herrick
parents: 58302
diff changeset
   563
    public void verifyIsOfType(Collection<PackageType> types) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   564
        verifyIsOfType(types.toArray(PackageType[]::new));
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   565
    }
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   566
58304
7a61351edad2 8231282 : Revisit --linux-deb-copyright option
herrick
parents: 58302
diff changeset
   567
    public void verifyIsOfType(PackageType ... types) {
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   568
        if (!Arrays.asList(types).contains(packageType())) {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   569
            throwUnexpectedPackageTypeError();
58113
885b0543f6e4 8230726: Improve jpackage jtreg tests
herrick
parents: 58036
diff changeset
   570
        }
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   571
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   572
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   573
    public static String escapeAndJoin(String... args) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   574
        return escapeAndJoin(List.of(args));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   575
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   576
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   577
    public static String escapeAndJoin(List<String> args) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   578
        Pattern whitespaceRegexp = Pattern.compile("\\s");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   579
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   580
        return args.stream().map(v -> {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   581
            String str = v;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   582
            // Escape quotes.
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   583
            str = str.replace("\"", "\\\"");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   584
            // Escape backslashes.
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   585
            str = str.replace("\\", "\\\\");
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   586
            // If value contains whitespace characters, put the value in quotes
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   587
            if (whitespaceRegexp.matcher(str).find()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   588
                str = "\"" + str + "\"";
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   589
            }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   590
            return str;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   591
        }).collect(Collectors.joining(" "));
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   592
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   593
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   594
    public static Path relativePathInRuntime(JavaTool tool) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   595
        Path path = tool.relativePathInJavaHome();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   596
        if (TKit.isOSX()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   597
            path = Path.of("Contents/Home").resolve(path);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   598
        }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   599
        return path;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   600
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   601
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   602
    public static Stream<String> filterOutput(Stream<String> jpackageOutput) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   603
        // Skip "WARNING: Using experimental tool jpackage" first line of output
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   604
        return jpackageOutput.skip(1);
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   605
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   606
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   607
    public static List<String> filterOutput(List<String> jpackageOutput) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   608
        return filterOutput(jpackageOutput.stream()).collect(Collectors.toList());
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   609
    }
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   610
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   611
    @Override
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   612
    protected boolean isMutable() {
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   613
        return !immutable;
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   614
    }
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   615
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   616
    private Boolean withToolProvider;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   617
    private boolean saveConsoleOutput;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   618
    private boolean suppressOutput;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   619
    private boolean immutable;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   620
    private boolean actionsExecuted;
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   621
    private final List<Consumer<JPackageCommand>> actions;
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   622
    private static boolean defaultWithToolProvider;
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   623
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   624
    private final static Map<String, PackageType> PACKAGE_TYPES = Functional.identity(
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   625
            () -> {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   626
                Map<String, PackageType> reply = new HashMap<>();
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   627
                for (PackageType type : PackageType.values()) {
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   628
                    reply.put(type.getName(), type);
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   629
                }
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   630
                return reply;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   631
            }).get();
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   632
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   633
    public final static Path DEFAULT_RUNTIME_IMAGE = Functional.identity(() -> {
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   634
        // Set the property to the path of run-time image to speed up
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   635
        // building app images and platform bundles by avoiding running jlink
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   636
        // The value of the property will be automativcally appended to
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   637
        // jpackage command line if the command line doesn't have
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   638
        // `--runtime-image` parameter set.
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   639
        String val = TKit.getConfigProperty("runtime-image");
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   640
        if (val != null) {
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   641
            return Path.of(val);
58301
e0efb29609bd 8225249 : LinuxDebBundler and LinuxRpmBundler should share more code
herrick
parents: 58147
diff changeset
   642
        }
58416
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   643
        return null;
f09bf58c1f17 8231605: Improve test helpers
herrick
parents: 58304
diff changeset
   644
    }).get();
58036
f7f10023f7c0 8229840 : Add jtreg test for --linux-app-category option
herrick
parents:
diff changeset
   645
}