hotspot/test/testlibrary_tests/RandomGeneratorTest.java
author ykantser
Thu, 26 Mar 2015 16:36:56 +0100
changeset 29678 dd2f3932c21e
parent 29350 8029ab8b2ec5
child 30604 b8d532cb6420
permissions -rw-r--r--
8075586: Add @modules as needed to the open hotspot tests Reviewed-by: sla, ctornqvi, lfoltan, mchung, alanb Contributed-by: alexander.kulyakhtin@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
27453
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     1
/*
29678
dd2f3932c21e 8075586: Add @modules as needed to the open hotspot tests
ykantser
parents: 29350
diff changeset
     2
 * Copyright (c) 2014, 2015, Oracle and/or its affiliates. All rights reserved.
27453
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     4
 *
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     7
 * published by the Free Software Foundation.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     8
 *
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
     9
 * This code is distributed in the hope that it will be useful, but WITHOUT
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    10
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    11
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    12
 * version 2 for more details (a copy is included in the LICENSE file that
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    13
 * accompanied this code).
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    14
 *
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    15
 * You should have received a copy of the GNU General Public License version
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    16
 * 2 along with this work; if not, write to the Free Software Foundation,
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    17
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    18
 *
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    19
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    20
 * or visit www.oracle.com if you need additional information or have any
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    21
 * questions.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    22
 */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    23
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    24
/*
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    25
 * @test
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    26
 * @summary Verify correctnes of the random generator from Utility.java
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    27
 * @library /testlibrary
29678
dd2f3932c21e 8075586: Add @modules as needed to the open hotspot tests
ykantser
parents: 29350
diff changeset
    28
 * @modules java.base/sun.misc
dd2f3932c21e 8075586: Add @modules as needed to the open hotspot tests
ykantser
parents: 29350
diff changeset
    29
 *          java.management
27453
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    30
 * @run driver RandomGeneratorTest SAME_SEED
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    31
 * @run driver RandomGeneratorTest NO_SEED
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    32
 * @run driver RandomGeneratorTest DIFFERENT_SEED
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    33
 */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    34
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    35
import com.oracle.java.testlibrary.ProcessTools;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    36
import com.oracle.java.testlibrary.Utils;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    37
import java.util.ArrayList;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    38
import java.util.List;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    39
import java.util.Random;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    40
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    41
/**
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    42
 * The test verifies correctness of work {@link com.oracle.java.testlibrary.Utils#getRandomInstance()}.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    43
 * Test works in three modes: same seed provided, no seed provided and
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    44
 * different seed provided. In the first case the test expects that all random numbers
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    45
 * will be repeated in all next iterations. For other two modes test expects that
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    46
 * randomly generated numbers differ from original.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    47
 */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    48
public class RandomGeneratorTest {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    49
    private static final String SEED_VM_OPTION = "-D" + Utils.SEED_PROPERTY_NAME + "=";
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    50
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    51
    public static void main( String[] args) throws Throwable {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    52
        if (args.length == 0) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    53
            throw new Error("TESTBUG: No test mode provided.");
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    54
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    55
        SeedOption seedOpt = SeedOption.valueOf(args[0]);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    56
        List<String> jvmArgs = new ArrayList<String>();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    57
        String optStr = seedOpt.getSeedOption();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    58
        if (optStr != null) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    59
            jvmArgs.add(optStr);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    60
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    61
        jvmArgs.add(RandomRunner.class.getName());
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    62
        String[] cmdLineArgs = jvmArgs.toArray(new String[jvmArgs.size()]);
29350
8029ab8b2ec5 8067822: test/testlibrary_tests/RandomGeneratorTest.java failed on Assert Unexpected random number sequence for mode: NO_SEED
skovalev
parents: 27453
diff changeset
    63
        String etalon = ProcessTools.executeTestJvm(cmdLineArgs).getStdout().trim();
27453
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    64
        seedOpt.verify(etalon, cmdLineArgs);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    65
    }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    66
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    67
    /**
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    68
     * The utility enum helps to generate an appropriate string that should be passed
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    69
     * to the command line depends on the testing mode. It is also responsible for the result
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    70
     * validation.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    71
     */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    72
    private enum SeedOption {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    73
        SAME_SEED {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    74
            @Override
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    75
            public String getSeedOption() {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    76
                return SEED_VM_OPTION + Utils.SEED;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    77
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    78
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    79
            @Override
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    80
            protected boolean isOutputExpected(String orig, String output) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    81
                return output.equals(orig);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    82
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    83
        },
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    84
        DIFFERENT_SEED {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    85
            @Override
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    86
            public String getSeedOption() {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    87
                return SEED_VM_OPTION + Utils.getRandomInstance().nextLong();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    88
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    89
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    90
            @Override
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    91
            public void verify(String orig, String[] cmdLine) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    92
                cmdLine[0] = getSeedOption();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    93
                super.verify(orig, cmdLine);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    94
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    95
        },
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    96
        NO_SEED {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    97
            @Override
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    98
            public String getSeedOption() {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
    99
                return null;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   100
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   101
        };
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   102
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   103
        /**
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   104
         * Generates a string to be added as a command line argument.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   105
         * It contains "-D" prefix, system property name, '=' sign
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   106
         * and seed value.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   107
         * @return command line argument
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   108
         */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   109
        public abstract String getSeedOption();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   110
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   111
        protected boolean isOutputExpected(String orig, String output) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   112
            return !output.equals(orig);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   113
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   114
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   115
        /**
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   116
         * Verifies that the original output meets expectations
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   117
         * depending on the test mode. It compares the output of second execution
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   118
         * to original one.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   119
         * @param orig original output
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   120
         * @param cmdLine command line arguments
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   121
         * @throws Throwable - Throws an exception in case test failure.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   122
         */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   123
        public void verify(String orig, String[] cmdLine) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   124
            String lastLineOrig = getLastLine(orig);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   125
            String lastLine;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   126
            try {
29350
8029ab8b2ec5 8067822: test/testlibrary_tests/RandomGeneratorTest.java failed on Assert Unexpected random number sequence for mode: NO_SEED
skovalev
parents: 27453
diff changeset
   127
                lastLine = getLastLine(ProcessTools.executeTestJvm(cmdLine).getStdout().trim());
27453
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   128
            } catch (Throwable t) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   129
                throw new Error("TESTBUG: Unexpedted exception during jvm execution.", t);
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   130
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   131
            if (!isOutputExpected(lastLineOrig, lastLine)) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   132
                    throw new AssertionError("Unexpected random number sequence for mode: " + this.name());
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   133
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   134
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   135
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   136
        private static String getLastLine(String output) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   137
            return output.substring(output.lastIndexOf(Utils.NEW_LINE)).trim();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   138
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   139
    }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   140
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   141
    /**
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   142
     * The helper class generates several random numbers
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   143
     * and prints them out.
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   144
     */
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   145
    public static class RandomRunner {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   146
        private static final int COUNT = 10;
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   147
        public static void main(String[] args) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   148
            StringBuilder sb = new StringBuilder();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   149
            Random rng = Utils.getRandomInstance();
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   150
            for (int i = 0; i < COUNT; i++) {
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   151
                sb.append(rng.nextLong()).append(' ');
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   152
            }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   153
            System.out.println(sb.toString());
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   154
        }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   155
    }
9aeb9b97bef6 8044186: Introduce a reproducible random generator
iignatyev
parents:
diff changeset
   156
}