/
HashesTest.java
480 lines (411 loc) · 15.5 KB
/
HashesTest.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
/*
* Copyright (c) 2015, 2021, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
/*
* @test
* @bug 8160286 8243666
* @summary Test the recording and checking of module hashes
* @library /test/lib
* @modules java.base/jdk.internal.misc
* java.base/jdk.internal.module
* jdk.compiler
* jdk.jartool
* jdk.jlink
* @build jdk.test.lib.compiler.ModuleInfoMaker
* jdk.test.lib.compiler.CompilerUtils
* @run testng HashesTest
*/
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.UncheckedIOException;
import java.lang.module.ModuleDescriptor;
import java.lang.module.ModuleFinder;
import java.lang.module.ModuleReader;
import java.lang.module.ModuleReference;
import java.nio.file.FileVisitResult;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.SimpleFileVisitor;
import java.nio.file.attribute.BasicFileAttributes;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.spi.ToolProvider;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import jdk.internal.module.ModuleInfo;
import jdk.internal.module.ModuleHashes;
import jdk.internal.module.ModulePath;
import jdk.test.lib.compiler.ModuleInfoMaker;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import static org.testng.Assert.*;
import static java.lang.module.ModuleDescriptor.Requires.Modifier.*;
public class HashesTest {
static final ToolProvider JMOD_TOOL = ToolProvider.findFirst("jmod")
.orElseThrow(() ->
new RuntimeException("jmod tool not found")
);
static final ToolProvider JAR_TOOL = ToolProvider.findFirst("jar")
.orElseThrow(() ->
new RuntimeException("jar tool not found")
);
static final AtomicInteger counter = new AtomicInteger(0);
private Path mods;
private Path lib;
private ModuleInfoMaker builder;
@BeforeMethod
public void setTestPath() throws IOException {
Path dest = Path.of("test" + counter.addAndGet(1));
if (Files.exists(dest)) {
deleteDirectory(dest);
}
this.mods = dest.resolve("mods");
this.lib = dest.resolve("lib");
this.builder = new ModuleInfoMaker(dest.resolve("src"));
Files.createDirectories(lib);
Files.createDirectories(mods);
}
@Test
public void test() throws IOException {
// create modules for test cases
makeModule("m2");
makeModule("m3");
makeModule("m1", "m2", "m3");
makeModule("org.bar", TRANSITIVE, "m1");
makeModule("org.foo", TRANSITIVE, "org.bar");
// create JMOD for m1, m2, m3
makeJmod("m2");
makeJmod("m3");
// no hash is recorded since m1 has outgoing edges
jmodHashModules("m1", ".*");
// no hash is recorded in m1, m2, m3
assertNull(hashes("m1"));
assertNull(hashes("m2"));
assertNull(hashes("m3"));
// hash m1 in m2
jmodHashModules("m2", "m1");
checkHashes("m2", Set.of("m1"));
// hash m1 in m2
jmodHashModules("m2", ".*");
checkHashes("m2", Set.of("m1"));
// create m2.jmod with no hash
makeJmod("m2");
// run jmod hash command to hash m1 in m2 and m3
runJmod(List.of("hash", "--module-path", lib.toString(),
"--hash-modules", ".*"));
checkHashes("m2", Set.of("m1"));
checkHashes("m3", Set.of("m1"));
// check transitive requires
makeJmod("org.bar");
makeJmod("org.foo");
jmodHashModules("org.bar", "org.*");
checkHashes("org.bar", Set.of("org.foo"));
jmodHashModules( "m3", ".*");
checkHashes("m3", Set.of("org.foo", "org.bar", "m1"));
}
@Test
public void multiBaseModules() throws IOException {
/*
* y2 -----------> y1
* |______
* | |
* V V
* z3 -> z2
* | |
* | V
* |---> z1
*/
makeModule("z1");
makeModule("z2", "z1");
makeModule("z3", "z1", "z2");
makeModule("y1");
makeModule("y2", "y1", "z2", "z3");
Set<String> ys = Set.of("y1", "y2");
Set<String> zs = Set.of("z1", "z2", "z3");
// create JMOD files
Stream.concat(ys.stream(), zs.stream()).forEach(this::makeJmod);
// run jmod hash command
runJmod(List.of("hash", "--module-path", lib.toString(),
"--hash-modules", ".*"));
/*
* z1 and y1 are the modules with hashes recorded.
*/
checkHashes("y1", Set.of("y2"));
checkHashes("z1", Set.of("z2", "z3", "y2"));
Stream.concat(ys.stream(), zs.stream())
.filter(mn -> !mn.equals("y1") && !mn.equals("z1"))
.forEach(mn -> assertNull(hashes(mn)));
}
@Test
public void mixJmodAndJarFile() throws IOException {
/*
* j3 -----------> j2
* |______
* | |
* V V
* m3 -> m2
* | |
* | V
* |---> m1 -> j1 -> jdk.jlink
*/
makeModule("j1");
makeModule("j2");
makeModule("m1", "j1");
makeModule("m2", "m1");
makeModule("m3", "m1", "m2");
makeModule("j3", "j2", "m2", "m3");
Set<String> jars = Set.of("j1", "j2", "j3");
Set<String> jmods = Set.of("m1", "m2", "m3");
// create JMOD and JAR files
jars.forEach(this::makeJar);
jmods.forEach(this::makeJmod);
// run jmod hash command
runJmod(List.of("hash", "--module-path", lib.toString(),
"--hash-modules", "^j.*|^m.*"));
/*
* j1 and j2 are the modules with hashes recorded.
*/
checkHashes("j2", Set.of("j3"));
checkHashes("j1", Set.of("m1", "m2", "m3", "j3"));
Stream.concat(jars.stream(), jmods.stream())
.filter(mn -> !mn.equals("j1") && !mn.equals("j2"))
.forEach(mn -> assertNull(hashes(mn)));
}
@Test
public void testImageJmods() throws IOException {
Path mpath = Paths.get(System.getProperty("java.home"), "jmods");
if (!Files.exists(mpath)) {
return;
}
makeModule("m1", "jdk.compiler", "jdk.attach");
makeModule("m2", "m1");
makeModule("m3", "java.compiler");
makeJmod("m1");
makeJmod("m2");
runJmod(List.of("hash",
"--module-path",
mpath.toString() + File.pathSeparator + lib.toString(),
"--hash-modules", ".*"));
validateImageJmodsTest(mpath);
}
@Test
public void testImageJmods1() throws IOException {
Path mpath = Paths.get(System.getProperty("java.home"), "jmods");
if (!Files.exists(mpath)) {
return;
}
makeModule("m1", "jdk.compiler", "jdk.attach");
makeModule("m2", "m1");
makeModule("m3", "java.compiler");
makeJar("m2");
makeJar("m1",
"--module-path",
mpath.toString() + File.pathSeparator + lib.toString(),
"--hash-modules", ".*");
validateImageJmodsTest(mpath);
}
@Test
private void testReproducibibleHash() throws Exception {
makeModule("m4");
makeModule("m3", "m4");
makeModule("m2");
makeModule("m1", "m2", "m3");
// create JMOD files and run jmod hash
List.of("m1", "m2", "m3", "m4").forEach(this::makeJmod);
Map<String, ModuleHashes> hashes1 = runJmodHash();
// sleep a bit to be confident that the hashes aren't dependent on timestamps
Thread.sleep(2000);
// (re)create JMOD files and run jmod hash
List.of("m1", "m2", "m3", "m4").forEach(this::makeJmod);
Map<String, ModuleHashes> hashes2 = runJmodHash();
// hashes should be equal
assertEquals(hashes1, hashes2);
}
private void validateImageJmodsTest(Path mpath)
throws IOException
{
// hash is recorded in m1 and not any other packaged modules on module path
checkHashes("m1", Set.of("m2"));
assertNull(hashes("m2"));
// should not override any JDK packaged modules
ModuleFinder finder = ModulePath.of(Runtime.version(), true, mpath);
assertNull(hashes(finder, "jdk.compiler"));
assertNull(hashes(finder, "jdk.attach"));
}
private void checkHashes(String mn, Set<String> hashModules) {
ModuleHashes hashes = hashes(mn);
assertEquals(hashModules, hashes.names());
}
private ModuleHashes hashes(String name) {
ModuleFinder finder = ModulePath.of(Runtime.version(), true, lib);
return hashes(finder, name);
}
private ModuleHashes hashes(ModuleFinder finder, String name) {
ModuleReference mref = finder.find(name).orElseThrow(RuntimeException::new);
try {
try (ModuleReader reader = mref.open();
InputStream in = reader.open("module-info.class").get()) {
ModuleHashes hashes = ModuleInfo.read(in, null).recordedHashes();
System.out.format("hashes in module %s %s%n", name,
(hashes != null) ? "present" : "absent");
if (hashes != null) {
hashes.names().stream().sorted().forEach(n ->
System.out.format(" %s %s%n", n, toHex(hashes.hashFor(n)))
);
}
return hashes;
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
private String toHex(byte[] ba) {
StringBuilder sb = new StringBuilder(ba.length);
for (byte b: ba) {
sb.append(String.format("%02x", b & 0xff));
}
return sb.toString();
}
private void deleteDirectory(Path dir) throws IOException {
Files.walkFileTree(dir, new SimpleFileVisitor<>() {
@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs)
throws IOException
{
Files.delete(file);
return FileVisitResult.CONTINUE;
}
@Override
public FileVisitResult postVisitDirectory(Path dir, IOException exc)
throws IOException
{
Files.delete(dir);
return FileVisitResult.CONTINUE;
}
});
}
private void makeModule(String mn, String... deps) throws IOException {
makeModule(mn, null, deps);
}
private void makeModule(String mn, ModuleDescriptor.Requires.Modifier mod, String... deps)
throws IOException
{
if (mod != null && mod != TRANSITIVE && mod != STATIC) {
throw new IllegalArgumentException(mod.toString());
}
StringBuilder sb = new StringBuilder();
sb.append("module ")
.append(mn)
.append(" {")
.append("\n");
Arrays.stream(deps)
.forEach(req -> {
sb.append(" requires ");
if (mod != null) {
sb.append(mod.toString().toLowerCase())
.append(" ");
}
sb.append(req)
.append(";\n");
});
sb.append("}\n");
builder.writeJavaFiles(mn, sb.toString());
builder.compile(mn, mods);
}
private void jmodHashModules(String moduleName, String hashModulesPattern) {
makeJmod(moduleName, "--module-path", lib.toString(),
"--hash-modules", hashModulesPattern);
}
private void makeJmod(String moduleName, String... options) {
Path mclasses = mods.resolve(moduleName);
Path outfile = lib.resolve(moduleName + ".jmod");
List<String> args = new ArrayList<>();
args.add("create");
Collections.addAll(args, options);
Collections.addAll(args, "--class-path", mclasses.toString(),
outfile.toString());
if (Files.exists(outfile)) {
try {
Files.delete(outfile);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
runJmod(args);
}
/**
* Execute jmod hash on the modules in the lib directory. Returns a map of
* the modules, with the module name as the key, for the modules that have
* a ModuleHashes class file attribute.
*/
private Map<String, ModuleHashes> runJmodHash() {
runJmod(List.of("hash",
"--module-path", lib.toString(),
"--hash-modules", ".*"));
HashesTest ht = this;
return ModulePath.of(Runtime.version(), true, lib)
.findAll()
.stream()
.map(ModuleReference::descriptor)
.map(ModuleDescriptor::name)
.filter(mn -> ht.hashes(mn) != null)
.collect(Collectors.toMap(mn -> mn, ht::hashes));
}
private static void runJmod(List<String> args) {
int rc = JMOD_TOOL.run(System.out, System.out, args.toArray(new String[args.size()]));
System.out.println("jmod " + args.stream().collect(Collectors.joining(" ")));
if (rc != 0) {
throw new AssertionError("jmod failed: rc = " + rc);
}
}
private void makeJar(String moduleName, String... options) {
Path mclasses = mods.resolve(moduleName);
Path outfile = lib.resolve(moduleName + ".jar");
List<String> args = new ArrayList<>();
Stream.concat(Stream.of("--create",
"--file=" + outfile.toString()),
Arrays.stream(options))
.forEach(args::add);
args.add("-C");
args.add(mclasses.toString());
args.add(".");
if (Files.exists(outfile)) {
try {
Files.delete(outfile);
} catch (IOException e) {
throw new UncheckedIOException(e);
}
}
int rc = JAR_TOOL.run(System.out, System.out, args.toArray(new String[args.size()]));
System.out.println("jar " + args.stream().collect(Collectors.joining(" ")));
if (rc != 0) {
throw new AssertionError("jar failed: rc = " + rc);
}
}
}