1 /*
2 * Copyright (c) 2014, 2016, 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 jdk.test.lib.Asserts;
25 import jdk.test.lib.Platform;
26
27 import java.lang.reflect.InvocationTargetException;
28 import java.lang.reflect.Method;
29 import java.util.Arrays;
30 import java.util.Collections;
31 import java.util.EnumSet;
32 import java.util.HashSet;
33 import java.util.List;
34 import java.util.Set;
35
36 /**
37 * @test
38 * @summary Verify that for each group of mutually exclusive predicates defined
39 * in jdk.test.lib.Platform one and only one predicate
40 * evaluates to true.
41 * @library /test/lib
42 * @modules java.base/jdk.internal.misc
43 * java.management
44 * @run main TestMutuallyExclusivePlatformPredicates
45 */
46 public class TestMutuallyExclusivePlatformPredicates {
47 private static enum MethodGroup {
48 ARCH("isAArch64", "isARM", "isPPC", "isS390x", "isSparc", "isX64", "isX86"),
49 BITNESS("is32bit", "is64bit"),
50 OS("isAix", "isLinux", "isOSX", "isSolaris", "isWindows"),
51 VM_TYPE("isClient", "isServer", "isGraal", "isMinimal", "isZero", "isEmbedded"),
52 MODE("isInt", "isMixed", "isComp"),
53 IGNORED("isEmulatedClient", "isDebugBuild", "isFastDebugBuild", "isSlowDebugBuild",
54 "hasSA", "shouldSAAttach", "isTieredSupported", "areCustomLoadersSupportedForCDS");
55
56 public final List<String> methodNames;
57
58 private MethodGroup(String... methodNames) {
59 this.methodNames = Collections.unmodifiableList(
60 Arrays.asList(methodNames));
61 }
62 }
63
64 public static void main(String args[]) {
65 EnumSet<MethodGroup> notIgnoredMethodGroups
66 = EnumSet.complementOf(EnumSet.of(MethodGroup.IGNORED));
67
68 notIgnoredMethodGroups.forEach(
69 TestMutuallyExclusivePlatformPredicates::verifyPredicates);
70
71 TestMutuallyExclusivePlatformPredicates.verifyCoverage();
72 }
73
74 /**
75 * Verifies that one and only one predicate method defined in
76 * {@link jdk.test.lib.Platform}, whose name included into
77 * methodGroup will return {@code true}.
78 * @param methodGroup The group of methods that should be tested.
79 */
80 private static void verifyPredicates(MethodGroup methodGroup) {
81 System.out.println("Verifying method group: " + methodGroup.name());
82 long truePredicatesCount = methodGroup.methodNames.stream()
83 .filter(TestMutuallyExclusivePlatformPredicates
84 ::evaluatePredicate)
85 .count();
86
87 Asserts.assertEQ(truePredicatesCount, 1L, String.format(
88 "Only one predicate from group %s should be evaluated to true "
89 + "(Actually %d predicates were evaluated to true).",
90 methodGroup.name(), truePredicatesCount));
91 }
92
93 /**
94 * Verifies that all predicates defined in
95 * {@link jdk.test.lib.Platform} were either tested or
96 * explicitly ignored.
97 */
98 private static void verifyCoverage() {
99 Set<String> allMethods = new HashSet<>();
100 for (MethodGroup group : MethodGroup.values()) {
101 allMethods.addAll(group.methodNames);
102 }
103
104 for (Method m : Platform.class.getMethods()) {
105 if (m.getParameterCount() == 0
106 && m.getReturnType() == boolean.class) {
107 Asserts.assertTrue(allMethods.contains(m.getName()),
108 "All Platform's methods with signature '():Z' should "
109 + "be tested. Missing: " + m.getName());
110 }
111 }
112 }
113
114 /**
115 * Evaluates predicate method with name {@code name} defined in
116 * {@link jdk.test.lib.Platform}.
117 *
118 * @param name The name of a predicate to be evaluated.
119 * @return evaluated predicate's value.
120 * @throws java.lang.Error if predicate is not defined or could not be
121 * evaluated.
122 */
123 private static boolean evaluatePredicate(String name) {
124 try {
125 System.out.printf("Trying to evaluate predicate with name %s%n",
126 name);
127 boolean value
128 = (Boolean) Platform.class.getMethod(name).invoke(null);
129 System.out.printf("Predicate evaluated to: %s%n", value);
130 return value;
131 } catch (NoSuchMethodException e) {
132 throw new Error("Predicate with name " + name
133 + " is not defined in " + Platform.class.getName(), e);
134 } catch (IllegalAccessException | InvocationTargetException e) {
135 throw new Error("Unable to evaluate predicate " + name, e);
136 }
137 }
138 }