jdk/test/java/util/ServiceLoader/modules/BadProvidersTest.java
changeset 45741 ee4958177e69
parent 45740 224d0d2dd36e
parent 45736 3532c702cd17
child 45759 8327d73befff
equal deleted inserted replaced
45740:224d0d2dd36e 45741:ee4958177e69
     1 /*
       
     2  * Copyright (c) 2016, 2017, 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 /**
       
    25  * @test
       
    26  * @library /lib/testlibrary /test/lib
       
    27  * @modules jdk.compiler
       
    28  * @build jdk.test.lib.compiler.CompilerUtils
       
    29  * @run testng/othervm BadProvidersTest
       
    30  * @summary Basic test of ServiceLoader with bad provider and bad provider
       
    31  *          factories deployed on the module path
       
    32  */
       
    33 
       
    34 import java.lang.module.Configuration;
       
    35 import java.lang.module.ModuleFinder;
       
    36 import java.nio.file.Files;
       
    37 import java.nio.file.Path;
       
    38 import java.nio.file.Paths;
       
    39 import java.nio.file.StandardCopyOption;
       
    40 import java.util.List;
       
    41 import java.util.ServiceConfigurationError;
       
    42 import java.util.ServiceLoader;
       
    43 import java.util.ServiceLoader.Provider;
       
    44 import java.util.Set;
       
    45 import java.util.stream.Collectors;
       
    46 
       
    47 import jdk.test.lib.compiler.CompilerUtils;
       
    48 
       
    49 import org.testng.annotations.Test;
       
    50 import org.testng.annotations.DataProvider;
       
    51 import static org.testng.Assert.*;
       
    52 
       
    53 /**
       
    54  * Basic test of `provides S with PF` and `provides S with P` where the provider
       
    55  * factory or provider
       
    56  */
       
    57 
       
    58 public class BadProvidersTest {
       
    59 
       
    60     private static final String TEST_SRC = System.getProperty("test.src");
       
    61 
       
    62     private static final Path USER_DIR   = Paths.get(System.getProperty("user.dir"));
       
    63     private static final Path SRC_DIR    = Paths.get(TEST_SRC, "modules");
       
    64 
       
    65     private static final Path BADFACTORIES_DIR = Paths.get(TEST_SRC, "badfactories");
       
    66     private static final Path BADPROVIDERS_DIR = Paths.get(TEST_SRC, "badproviders");
       
    67 
       
    68     private static final String TEST1_MODULE = "test1";
       
    69     private static final String TEST2_MODULE = "test2";
       
    70 
       
    71     private static final String TEST_SERVICE = "p.Service";
       
    72 
       
    73     /**
       
    74      * Compiles a module, returning a module path with the compiled module.
       
    75      */
       
    76     private Path compileTest(String moduleName) throws Exception {
       
    77         Path dir = Files.createTempDirectory(USER_DIR, "mods");
       
    78         Path output = Files.createDirectory(dir.resolve(moduleName));
       
    79         boolean compiled = CompilerUtils.compile(SRC_DIR.resolve(moduleName), output);
       
    80         assertTrue(compiled);
       
    81         return dir;
       
    82     }
       
    83 
       
    84     /**
       
    85      * Resolves a test module and loads it into its own layer. ServiceLoader
       
    86      * is then used to load all providers.
       
    87      */
       
    88     private List<Provider> loadProviders(Path mp, String moduleName) throws Exception {
       
    89         ModuleFinder finder = ModuleFinder.of(mp);
       
    90 
       
    91         ModuleLayer bootLayer = ModuleLayer.boot();
       
    92 
       
    93         Configuration cf = bootLayer.configuration()
       
    94                 .resolveAndBind(finder, ModuleFinder.of(), Set.of(moduleName));
       
    95 
       
    96         ClassLoader scl = ClassLoader.getSystemClassLoader();
       
    97 
       
    98         ModuleLayer layer = ModuleLayer.boot().defineModulesWithOneLoader(cf, scl);
       
    99 
       
   100         Class<?> service = layer.findLoader(moduleName).loadClass(TEST_SERVICE);
       
   101 
       
   102         return ServiceLoader.load(layer, service)
       
   103                 .stream()
       
   104                 .collect(Collectors.toList());
       
   105     }
       
   106 
       
   107     @Test
       
   108     public void sanityTest1() throws Exception {
       
   109         Path mods = compileTest(TEST1_MODULE);
       
   110         List<Provider> list = loadProviders(mods, TEST1_MODULE);
       
   111         assertTrue(list.size() == 1);
       
   112 
       
   113         // the provider is a singleton, enforced by the provider factory
       
   114         Object p1 = list.get(0).get();
       
   115         Object p2 = list.get(0).get();
       
   116         assertTrue(p1 != null);
       
   117         assertTrue(p1 == p2);
       
   118     }
       
   119 
       
   120     @Test
       
   121     public void sanityTest2() throws Exception {
       
   122         Path mods = compileTest(TEST2_MODULE);
       
   123         List<Provider> list = loadProviders(mods, TEST2_MODULE);
       
   124         assertTrue(list.size() == 1);
       
   125         Object p = list.get(0).get();
       
   126         assertTrue(p != null);
       
   127     }
       
   128 
       
   129 
       
   130     @DataProvider(name = "badfactories")
       
   131     public Object[][] createBadFactories() {
       
   132         return new Object[][] {
       
   133                 { "classnotpublic",     null },
       
   134                 { "methodnotpublic",    null },
       
   135                 { "badreturntype",      null },
       
   136                 { "returnsnull",        null },
       
   137                 { "throwsexception",    null },
       
   138         };
       
   139     }
       
   140 
       
   141 
       
   142     @Test(dataProvider = "badfactories",
       
   143           expectedExceptions = ServiceConfigurationError.class)
       
   144     public void testBadFactory(String testName, String ignore) throws Exception {
       
   145         Path mods = compileTest(TEST1_MODULE);
       
   146 
       
   147         // compile the bad factory
       
   148         Path source = BADFACTORIES_DIR.resolve(testName);
       
   149         Path output = Files.createTempDirectory(USER_DIR, "tmp");
       
   150         boolean compiled = CompilerUtils.compile(source, output);
       
   151         assertTrue(compiled);
       
   152 
       
   153         // copy the compiled class into the module
       
   154         Path classFile = Paths.get("p", "ProviderFactory.class");
       
   155         Files.copy(output.resolve(classFile),
       
   156                    mods.resolve(TEST1_MODULE).resolve(classFile),
       
   157                    StandardCopyOption.REPLACE_EXISTING);
       
   158 
       
   159         // load providers and instantiate each one
       
   160         loadProviders(mods, TEST1_MODULE).forEach(Provider::get);
       
   161     }
       
   162 
       
   163 
       
   164     @DataProvider(name = "badproviders")
       
   165     public Object[][] createBadProviders() {
       
   166         return new Object[][] {
       
   167                 { "notpublic",          null },
       
   168                 { "ctornotpublic",      null },
       
   169                 { "notasubtype",        null },
       
   170                 { "throwsexception",    null }
       
   171         };
       
   172     }
       
   173 
       
   174 
       
   175     @Test(dataProvider = "badproviders",
       
   176           expectedExceptions = ServiceConfigurationError.class)
       
   177     public void testBadProvider(String testName, String ignore) throws Exception {
       
   178         Path mods = compileTest(TEST2_MODULE);
       
   179 
       
   180         // compile the bad provider
       
   181         Path source = BADPROVIDERS_DIR.resolve(testName);
       
   182         Path output = Files.createTempDirectory(USER_DIR, "tmp");
       
   183         boolean compiled = CompilerUtils.compile(source, output);
       
   184         assertTrue(compiled);
       
   185 
       
   186         // copy the compiled class into the module
       
   187         Path classFile = Paths.get("p", "Provider.class");
       
   188         Files.copy(output.resolve(classFile),
       
   189                    mods.resolve(TEST2_MODULE).resolve(classFile),
       
   190                    StandardCopyOption.REPLACE_EXISTING);
       
   191 
       
   192         // load providers and instantiate each one
       
   193         loadProviders(mods, TEST2_MODULE).forEach(Provider::get);
       
   194     }
       
   195 
       
   196 }
       
   197