1 /*
   2  * Copyright (c) 2014, 2015 Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 import com.sun.tools.attach.*;
  25 
  26 import java.nio.file.Files;
  27 import java.nio.file.Path;
  28 import java.util.Properties;
  29 import java.util.List;
  30 import java.io.File;
  31 
  32 import jdk.testlibrary.OutputAnalyzer;
  33 import jdk.testlibrary.ProcessTools;
  34 import jdk.testlibrary.ProcessThread;
  35 
  36 /*
  37  * @test
  38  * @bug 8033104
  39  * @summary Test to make sure attach and jvmstat works correctly when java.io.tmpdir is set
  40  * @library /lib/testlibrary
  41  * @modules java.management
  42  *          jdk.jartool/sun.tools.jar
  43  * @run build jdk.testlibrary.* Application RunnerUtil
  44  * @run main/timeout=200 TempDirTest
  45  */
  46 
  47 /*
  48  * This test runs with an extra long timeout since it takes a really long time with -Xcomp
  49  * when starting many processes.
  50  */
  51 
  52 public class TempDirTest {
  53 
  54     private static long startTime;
  55 
  56     public static void main(String args[]) throws Throwable {
  57 
  58         startTime = System.currentTimeMillis();
  59 
  60         Path clientTmpDir = Files.createTempDirectory("TempDirTest-client");
  61         clientTmpDir.toFile().deleteOnExit();
  62         Path targetTmpDir = Files.createTempDirectory("TempDirTest-target");
  63         targetTmpDir.toFile().deleteOnExit();
  64 
  65         // run the test with all possible combinations of setting java.io.tmpdir
  66         runExperiment(null, null);
  67         runExperiment(clientTmpDir, null);
  68         runExperiment(clientTmpDir, targetTmpDir);
  69         runExperiment(null, targetTmpDir);
  70 
  71     }
  72 
  73     private static int counter = 0;
  74 
  75     /*
  76      * The actual test is in the nested class TestMain.
  77      * The responsibility of this class is to:
  78      * 1. Start the Application class in a separate process.
  79      * 2. Find the pid and shutdown port of the running Application.
  80      * 3. Launches the tests in nested class TestMain that will attach to the Application.
  81      * 4. Shut down the Application.
  82      */
  83     public static void runExperiment(Path clientTmpDir, Path targetTmpDir) throws Throwable {
  84 
  85         System.out.print("### Running tests with overridden tmpdir for");
  86         System.out.print(" client: " + (clientTmpDir == null ? "no" : "yes"));
  87         System.out.print(" target: " + (targetTmpDir == null ? "no" : "yes"));
  88         System.out.println(" ###");
  89 
  90         long elapsedTime = (System.currentTimeMillis() - startTime) / 1000;
  91         System.out.println("Started after " + elapsedTime + "s");
  92 
  93         final String pidFile = "TempDirTest.Application.pid-" + counter++;
  94         ProcessThread processThread = null;
  95         try {
  96             String[] tmpDirArg = null;
  97             if (targetTmpDir != null) {
  98                 tmpDirArg = new String[] {"-Djava.io.tmpdir=" + targetTmpDir};
  99             }
 100             processThread = RunnerUtil.startApplication(tmpDirArg);
 101             launchTests(processThread.getPid(), clientTmpDir);
 102         } catch (Throwable t) {
 103             System.out.println("TempDirTest got unexpected exception: " + t);
 104             t.printStackTrace();
 105             throw t;
 106         } finally {
 107             // Make sure the Application process is stopped.
 108             RunnerUtil.stopApplication(processThread);
 109         }
 110 
 111         elapsedTime = (System.currentTimeMillis() - startTime) / 1000;
 112         System.out.println("Completed after " + elapsedTime + "s");
 113 
 114     }
 115 
 116     /**
 117      * Runs the actual tests in nested class TestMain.
 118      * The reason for running the tests in a separate process
 119      * is that we need to modify the class path and
 120      * the -Djava.io.tmpdir property.
 121      */
 122     private static void launchTests(long pid, Path clientTmpDir) throws Throwable {
 123         final String sep = File.separator;
 124 
 125         String classpath =
 126             System.getProperty("test.class.path", "");
 127 
 128         String[] tmpDirArg = null;
 129         if (clientTmpDir != null) {
 130             tmpDirArg = new String [] {"-Djava.io.tmpdir=" + clientTmpDir};
 131         }
 132 
 133         // Arguments : [-Djava.io.tmpdir=] -classpath cp TempDirTest$TestMain pid
 134         String[] args = RunnerUtil.concat(
 135                 tmpDirArg,
 136                 new String[] {
 137                     "-classpath",
 138                     classpath,
 139                     "TempDirTest$TestMain",
 140                     Long.toString(pid) });
 141         OutputAnalyzer output = ProcessTools.executeTestJvm(args);
 142         output.shouldHaveExitValue(0);
 143     }
 144 
 145     /**
 146      * This is the actual test. It will attach to the running Application
 147      * and perform a number of basic attach tests.
 148      */
 149     public static class TestMain {
 150         public static void main(String args[]) throws Exception {
 151             String pid = args[0];
 152 
 153             // Test 1 - list method should list the target VM
 154             System.out.println(" - Test: VirtualMachine.list");
 155             List<VirtualMachineDescriptor> l = VirtualMachine.list();
 156             boolean found = false;
 157             for (VirtualMachineDescriptor vmd: l) {
 158                 if (vmd.id().equals(pid)) {
 159                     found = true;
 160                     break;
 161                 }
 162             }
 163             if (found) {
 164                 System.out.println(" - " + pid + " found.");
 165             } else {
 166                 throw new RuntimeException(pid + " not found in VM list");
 167             }
 168 
 169             // Test 2 - try to attach and verify connection
 170 
 171             System.out.println(" - Attaching to application ...");
 172             VirtualMachine vm = VirtualMachine.attach(pid);
 173 
 174             System.out.println(" - Test: system properties in target VM");
 175             Properties props = vm.getSystemProperties();
 176             String value = props.getProperty("attach.test");
 177             if (value == null || !value.equals("true")) {
 178                 throw new RuntimeException("attach.test property not set");
 179             }
 180             System.out.println(" - attach.test property set as expected");
 181         }
 182     }
 183 }