Skip to content

Commit

Permalink
8290313: Produce warning when user specified java.io.tmpdir directory…
Browse files Browse the repository at this point in the history
… doesn't exist

Reviewed-by: rriggs, naoto, coffeys
  • Loading branch information
weibxiao authored and coffeys committed Nov 23, 2022
1 parent 086763a commit 8df3bc4
Show file tree
Hide file tree
Showing 4 changed files with 140 additions and 4 deletions.
6 changes: 3 additions & 3 deletions src/java.base/share/classes/java/io/File.java
Expand Up @@ -35,7 +35,7 @@
import java.security.SecureRandom;
import java.util.ArrayList;
import java.util.List;
import sun.security.action.GetPropertyAction;
import jdk.internal.util.StaticProperty;

/**
* An abstract representation of file and directory pathnames.
Expand Down Expand Up @@ -1986,8 +1986,8 @@ private static class TempDirectory {
private TempDirectory() { }

// temporary directory location
private static final File tmpdir = new File(
GetPropertyAction.privilegedGetProperty("java.io.tmpdir"));
private static final File tmpdir = new File(StaticProperty.javaIoTmpDir());

static File location() {
return tmpdir;
}
Expand Down
6 changes: 6 additions & 0 deletions src/java.base/share/classes/java/lang/System.java
Expand Up @@ -2244,6 +2244,12 @@ private static void initPhase3() {
// SecurityManager
Unsafe.getUnsafe().ensureClassInitialized(StringConcatFactory.class);

// Emit a warning if java.io.tmpdir is set via the command line
// to a directory that doesn't exist
if (SystemProps.isBadIoTmpdir()) {
System.err.println("WARNING: java.io.tmpdir directory does not exist");
}

String smProp = System.getProperty("java.security.manager");
boolean needWarning = false;
if (smProp != null) {
Expand Down
17 changes: 16 additions & 1 deletion src/java.base/share/classes/jdk/internal/util/SystemProps.java
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2018, 2021, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2018, 2022, 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
Expand Down Expand Up @@ -28,6 +28,7 @@
import java.lang.annotation.Native;
import java.util.HashMap;
import java.util.Map;
import java.io.File;

/**
* System Property initialization for internal use only
Expand All @@ -40,6 +41,18 @@ public final class SystemProps {
// no instances
private SystemProps() {}

// Custom java.io.tmpdir via command line.
private static String customTmpdir;

/**
* Check if warning for custom java.io.tmpdir is required.
*
* @return a boolean value
*/
public static boolean isBadIoTmpdir() {
return customTmpdir != null && !(new File(customTmpdir).isDirectory());
}

/**
* Create and initialize the system properties from the native properties
* and command line properties.
Expand Down Expand Up @@ -95,6 +108,8 @@ public static Map<String, String> initProperties() {
putIfAbsent(props, "line.separator", raw.propDefault(Raw._line_separator_NDX));
putIfAbsent(props, "file.separator", raw.propDefault(Raw._file_separator_NDX));
putIfAbsent(props, "path.separator", raw.propDefault(Raw._path_separator_NDX));

customTmpdir = props.get("java.io.tmpdir");
putIfAbsent(props, "java.io.tmpdir", raw.propDefault(Raw._java_io_tmpdir_NDX));
putIfAbsent(props, "http.proxyHost", raw.propDefault(Raw._http_proxyHost_NDX));
putIfAbsent(props, "http.proxyPort", raw.propDefault(Raw._http_proxyPort_NDX));
Expand Down
115 changes: 115 additions & 0 deletions test/jdk/java/io/File/TempDirDoesNotExist.java
@@ -0,0 +1,115 @@
/*
* Copyright (c) 2022, 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 8290313
* @library /test/lib
* @summary Produce warning when user specified java.io.tmpdir directory doesn't exist
*/

import jdk.test.lib.process.ProcessTools;
import jdk.test.lib.process.OutputAnalyzer;

import java.io.File;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.stream.Collectors;

public class TempDirDoesNotExist {
final static String ioWarningMsg = "WARNING: java.io.tmpdir directory does not exist";

public static void main(String... args) throws Exception {

String userDir = System.getProperty("user.home");
String timeStamp = java.time.Instant.now().toString();
String tempDir = Path.of(userDir,"non-existing-", timeStamp).toString();

for (String arg : args) {
if (arg.equals("io")) {
try {
File.createTempFile("prefix", ".suffix");
} catch (Exception e) {
e.printStackTrace();
}
} else if (arg.equals("nio")) {
try {
Files.createTempFile("prefix", ".suffix");
} catch (Exception e) {
e.printStackTrace();
}
} else {
throw new Exception("unknown case: " + arg);
}
}

if (args.length == 0) {
// standard test with default setting for java.io.tmpdir
testMessageNotExist(0, ioWarningMsg, "TempDirDoesNotExist", "io");
testMessageNotExist(0, ioWarningMsg, "TempDirDoesNotExist", "nio");

// valid custom java.io.tmpdir
testMessageNotExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + userDir,
"TempDirDoesNotExist", "io");
testMessageNotExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + userDir,
"TempDirDoesNotExist", "nio");

// invalid custom java.io.tmpdir
testMessageExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + tempDir,
"TempDirDoesNotExist", "io");
testMessageExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + tempDir,
"TempDirDoesNotExist", "nio");

// test with security manager
testMessageExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + tempDir
+ " -Djava.security.manager",
"TempDirDoesNotExist", "io");

testMessageExist(0, ioWarningMsg, "-Djava.io.tmpdir=" + tempDir
+ " -Djava.security.manager",
"TempDirDoesNotExist", "nio");

// error message printed only once
testMessageCounter(0, "-Djava.io.tmpdir=" + tempDir,
"TempDirDoesNotExist", "io", "nio");
}
}

private static void testMessageExist(int exitValue, String errorMsg, String... options) throws Exception {
ProcessTools.executeTestJvm(options).shouldContain(errorMsg)
.shouldHaveExitValue(exitValue);
}

private static void testMessageNotExist(int exitValue, String errorMsg,String... options) throws Exception {
ProcessTools.executeTestJvm(options).shouldNotContain(errorMsg).shouldHaveExitValue(exitValue);
}

private static void testMessageCounter(int exitValue,String... options) throws Exception {
OutputAnalyzer originalOutput = ProcessTools.executeTestJvm(options);
List<String> list = originalOutput.asLines().stream().filter(line
-> line.equalsIgnoreCase(ioWarningMsg)).collect(Collectors.toList());
if (list.size() != 1 || originalOutput.getExitValue() != exitValue)
throw new Exception("counter of messages is not one, but " + list.size()
+ "\n" + originalOutput.asLines().toString() + "\n");
}
}

1 comment on commit 8df3bc4

@openjdk-notifier
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.