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