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