File: ExecCommand.java

package info (click to toggle)
openjdk-24 24.0.2%2B12-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 831,900 kB
  • sloc: java: 5,677,020; cpp: 1,323,154; xml: 1,320,524; ansic: 486,889; asm: 405,131; objc: 21,025; sh: 15,221; javascript: 11,049; python: 8,222; makefile: 2,504; perl: 357; awk: 351; sed: 172; pascal: 103; exp: 54; jsp: 24; csh: 3
file content (205 lines) | stat: -rw-r--r-- 7,798 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
/*
 * Copyright (c) 2013, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


/**
 * @test
 * @bug 8012453 8016046
 * @requires (os.family == "windows")
 * @run testng/othervm ExecCommand
 * @summary workaround for legacy applications with Runtime.getRuntime().exec(String command)
 */

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.Permission;
import java.util.Arrays;
import java.util.List;
import java.util.Properties;

import org.testng.Assert;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.DataProvider;
import org.testng.annotations.Test;


@SuppressWarnings("removal")
public class ExecCommand {

    private static final String JDK_LANG_PROCESS_ALLOW_AMBIGUOUS_COMMANDS =
            "jdk.lang.Process.allowAmbiguousCommands";

    private static final List<String> doCmdCopy = List.of(
        ".\\Program.cmd",
        ".\\Program Files\\doNot.cmd",
        ".\\Program Files\\do.cmd");

    @BeforeClass
    void setup() throws Exception {

        // Create files to be executed
        try {
            new File(".\\Program Files").mkdirs();
            for (String cmdFile : doCmdCopy) {
                try (BufferedWriter outCmd = new BufferedWriter(
                        new FileWriter(cmdFile))) {
                    outCmd.write("@echo %1");
                }
            }
        } catch (IOException e) {
            throw new Error(e.getMessage());
        }
    }

    /**
     * Sequence of tests and test results in the TEST_RTE_ARGS DataProvider below.
     * The ordinals are used as indices in the lists of expected results.
     */
    private enum AmbiguousMode {
        UNSET,      // 0) default allowAmbiguousCommands; equivalent to true
        EMPTY,      // 1) allowAmbiguousCommand is empty; equivalent to true
        FALSE,      // 2) allowAmbiguousCommands = false
    };

    /**
     * The command for Runtime.exec calls to execute in each of 4 modes,
     * and the expected exception for each mode.
     * Modes above define the indices in the List of expected results for each mode.
     */
    @DataProvider(name = "TEST_RTE_ARGS")
    Object[][] TEST_RTE_ARGS() {
        return new Object[][]{
                {"cmd /C dir > dirOut.txt",
                        "dirOut.txt",
                        Arrays.asList(null,
                                null,
                                FileNotFoundException.class)
                },
                {"cmd /C dir > \".\\Program Files\\dirOut.txt\"",
                        "./Program Files/dirOut.txt",
                        Arrays.asList(null,
                                null,
                                FileNotFoundException.class)
                },
                {".\\Program Files\\do.cmd",
                        null,
                        Arrays.asList(null,
                                null,
                                IOException.class)
                },
                {"\".\\Program Files\\doNot.cmd\" arg",
                        null,
                        Arrays.asList(null, null, null)
                },
                {"\".\\Program Files\\do.cmd\" arg",
                        null,
                        Arrays.asList(null, null, null)
                },
                {"\".\\Program.cmd\" arg",
                        null,
                        Arrays.asList(null, null, null)
                },
                {".\\Program.cmd arg",
                        null,
                        Arrays.asList(null, null, null)
                },
        };
    }

    /**
     * Test each command with no SM and default allowAmbiguousCommands.
     * @param command a command
     * @param perModeExpected an expected Exception class or null
     */
    @Test(dataProvider = "TEST_RTE_ARGS")
    void testCommandAmbiguousUnset(String command, String testFile, List<Class<Exception>> perModeExpected) {
        // the JDK_LANG_PROCESS_ALLOW_AMBIGUOUS_COMMANDS is undefined
        // "true" by default with the legacy verification procedure
        Properties props = System.getProperties();
        props.remove(JDK_LANG_PROCESS_ALLOW_AMBIGUOUS_COMMANDS);

        testCommandMode(command, "Ambiguous Unset", testFile,
                perModeExpected.get(AmbiguousMode.UNSET.ordinal()));
    }

    /**
     * Test each command with no SM and allowAmbiguousCommand is empty.
     * @param command a command
     * @param perModeExpected an expected Exception class or null
     */
    @Test(dataProvider = "TEST_RTE_ARGS")
    void testCommandAmbiguousEmpty(String command, String testFile, List<Class<Exception>> perModeExpected) {
        Properties props = System.getProperties();
        props.setProperty(JDK_LANG_PROCESS_ALLOW_AMBIGUOUS_COMMANDS, "");
        testCommandMode(command, "Ambiguous Empty", testFile,
                perModeExpected.get(AmbiguousMode.EMPTY.ordinal()));
    }

    /**
     * Test each command with no SM and allowAmbiguousCommands = false.
     * @param command a command
     * @param perModeExpected an expected Exception class or null
     */
    @Test(dataProvider = "TEST_RTE_ARGS")
    void testCommandAmbiguousFalse(String command, String testFile, List<Class<Exception>> perModeExpected) {
        Properties props = System.getProperties();
        props.setProperty(JDK_LANG_PROCESS_ALLOW_AMBIGUOUS_COMMANDS, "false");

        testCommandMode(command, "Ambiguous false", testFile,
                perModeExpected.get(AmbiguousMode.FALSE.ordinal()));
    }

    private void testCommandMode(String command, String kind,
                                 String testFile,
                                 Class<Exception> perModeExpected) {
        try {
            // Ensure the file that will be created does not exist.
            if (testFile != null) {
                Files.deleteIfExists(Path.of(testFile));
            }

            Process exec = Runtime.getRuntime().exec(command);
            exec.waitFor();

            // extended check
            if (testFile != null) {
                if (Files.notExists(FileSystems.getDefault().getPath(testFile)))
                    throw new FileNotFoundException(testFile);
            }
            Assert.assertNull(perModeExpected, "Missing exception");
        } catch (Exception ex) {
            if (!ex.getClass().equals(perModeExpected)) {
                Assert.fail("Unexpected exception! Step " + kind + ":"
                        + "\nArgument: " + command
                        + "\nExpected: " + perModeExpected
                        + "\n  Output: " + ex, ex);
            }
        }
    }
}