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
|
/*
* Copyright (c) 2024, 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 8323628
* @summary Update license on "pass-through" files
* @library /tools/lib ../../lib
* @modules jdk.javadoc/jdk.javadoc.internal.tool
* @build toolbox.ToolBox javadoc.tester.*
* @run main TestPassThruFiles
*/
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.List;
import java.util.TreeSet;
import java.util.stream.Collectors;
import javadoc.tester.JavadocTester;
import toolbox.ToolBox;
public class TestPassThruFiles extends JavadocTester {
public static void main(String... args) throws Exception {
var tester = new TestPassThruFiles();
tester.runTests();
}
final ToolBox tb = new ToolBox();
@Test
public void testPassThroughFiles(Path base) throws Exception {
Path src = base.resolve("src");
tb.writeJavaFiles(src, "public class C { }");
javadoc("-d", base.resolve("api").toString(),
"-Xdoclint:none",
src.resolve("C.java").toString());
checkExit(Exit.OK);
var files = List.of(
"resource-files/copy.svg",
"resource-files/link.svg",
"resource-files/stylesheet.css",
"script-files/script.js",
"script-files/search.js",
"script-files/search-page.js"
);
for (var f : files) {
checkOrder(f,
"Copyright",
"Oracle and/or its affiliates. All rights reserved.",
"DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.",
"Licensed under the Universal Permissive License v 1.0 as shown at " +
"https://oss.oracle.com/licenses/upl/");
}
var foundFiles = new TreeSet<String>();
for (var d : List.of("resource-files", "script-files")) {
try (var s = Files.list(outputDir.resolve(d))) {
s.filter(this::requiresCheck)
.map(p -> outputDir.relativize(p).toString())
.map(f -> f.replace(FS, "/"))
.collect(Collectors.toCollection(() -> foundFiles));
}
}
checking("verifying the set of checked files");
if (foundFiles.equals(new TreeSet<>(files))) {
passed("expected files found");
} else {
failed("mismatch in expected files");
var s1 = new TreeSet<>(files);
s1.removeAll(foundFiles);
if (!s1.isEmpty()) {
out.println("expected, but not found: " + s1);
}
var s2 = new TreeSet<>(foundFiles);
s2.removeAll(files);
if (!s2.isEmpty()) {
out.println("found, but not expected: " + s2);
}
}
}
/**
* {@return {@code true} if a file should be checked}
* For future robustness, instead of specifying the set of files
* that should be checked, we specify the set of files that should
* not be checked.
*
* @param p the path for the file
*/
private boolean requiresCheck(Path p) {
var fn = p.getFileName().toString();
return !fn.startsWith("jquery")
&& !fn.endsWith(".png");
}
}
|
