1 /*
2 * Copyright (c) 2015, 2018, 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 * @bug 8132734 8144062 8165723 8199172
27 * @summary Test the extended API and the aliasing additions in JarFile that
28 * support multi-release jar files
29 * @library /lib/testlibrary/java/util/jar /test/lib
30 * @build jdk.test.lib.RandomFactory
31 * Compiler JarBuilder CreateMultiReleaseTestJars
32 * @run testng MultiReleaseJarAPI
33 */
34
35 import java.io.File;
36 import java.io.IOException;
37 import java.io.InputStream;
38 import java.nio.charset.StandardCharsets;
39 import java.nio.file.Files;
40 import java.util.Arrays;
41 import java.util.Map;
42 import java.util.Random;
43 import java.util.concurrent.atomic.AtomicInteger;
44 import java.util.jar.JarFile;
45 import java.util.zip.ZipEntry;
46 import java.util.zip.ZipFile;
47
48 import jdk.test.lib.RandomFactory;
49
50 import org.testng.Assert;
51 import org.testng.annotations.AfterClass;
52 import org.testng.annotations.BeforeClass;
53 import org.testng.annotations.DataProvider;
54 import org.testng.annotations.Test;
55
56 public class MultiReleaseJarAPI {
57
58 private static final Random RANDOM = RandomFactory.getRandom();
59
60 String userdir = System.getProperty("user.dir",".");
61 CreateMultiReleaseTestJars creator = new CreateMultiReleaseTestJars();
62 File unversioned = new File(userdir, "unversioned.jar");
63 File multirelease = new File(userdir, "multi-release.jar");
64 File signedmultirelease = new File(userdir, "signed-multi-release.jar");
65
66
67 @BeforeClass
68 public void initialize() throws Exception {
69 creator.compileEntries();
70 creator.buildUnversionedJar();
71 creator.buildMultiReleaseJar();
72 creator.buildSignedMultiReleaseJar();
73 }
74
75 @AfterClass
76 public void close() throws IOException {
77 Files.delete(unversioned.toPath());
78 Files.delete(multirelease.toPath());
79 Files.delete(signedmultirelease.toPath());
80 }
81
82 @Test
83 public void isMultiReleaseJar() throws Exception {
84 try (JarFile jf = new JarFile(unversioned)) {
85 Assert.assertFalse(jf.isMultiRelease());
86 }
87
88 try (JarFile jf = new JarFile(unversioned, true, ZipFile.OPEN_READ, Runtime.version())) {
89 Assert.assertFalse(jf.isMultiRelease());
90 }
91
92 try (JarFile jf = new JarFile(multirelease)) {
93 Assert.assertTrue(jf.isMultiRelease());
94 }
95
96 try (JarFile jf = new JarFile(multirelease, true, ZipFile.OPEN_READ, Runtime.version())) {
97 Assert.assertTrue(jf.isMultiRelease());
98 }
99
100 testCustomMultiReleaseValue("true", true);
101 testCustomMultiReleaseValue("true\r\nOther: value", true);
102 testCustomMultiReleaseValue("true\nOther: value", true);
103 testCustomMultiReleaseValue("true\rOther: value", true);
104
105 testCustomMultiReleaseValue("false", false);
106 testCustomMultiReleaseValue(" true", false);
107 testCustomMultiReleaseValue("true ", false);
108 // testCustomMultiReleaseValue("true\n ", false);
109 // testCustomMultiReleaseValue("true\r ", false);
110 testCustomMultiReleaseValue("true\n true", false);
111 testCustomMultiReleaseValue("true\r true", false);
112 testCustomMultiReleaseValue("true\r\n true", false);
113
114 // generate "random" Strings to use as extra attributes, and
115 // verify that Multi-Release: true is always properly matched
116 for (int i = 0; i < 100; i++) {
117 byte[] keyBytes = new byte[RANDOM.nextInt(70) + 1];
118 Arrays.fill(keyBytes, (byte)('a' + RANDOM.nextInt(24)));
119 byte[] valueBytes = new byte[RANDOM.nextInt(70) + 1];
120 Arrays.fill(valueBytes, (byte)('a' + RANDOM.nextInt(24)));
121
122 String key = new String(keyBytes, StandardCharsets.UTF_8);
123 String value = new String(valueBytes, StandardCharsets.UTF_8);
124 // test that Multi-Release: true anywhere in the manifest always
125 // return true
126 testCustomMultiReleaseValue("true", Map.of(key, value), true);
127
128 // test that we don't get any false positives
129 testCustomMultiReleaseValue("false", Map.of(key, value), false);
130 }
131 }
132
133 private void testCustomMultiReleaseValue(String value, boolean expected)
134 throws Exception {
135 testCustomMultiReleaseValue(value, Map.of(), expected);
136 }
137
138 private static final AtomicInteger JAR_COUNT = new AtomicInteger(0);
139
140 private void testCustomMultiReleaseValue(String value,
141 Map<String, String> extraAttributes, boolean expected)
142 throws Exception {
143 String fileName = "custom-mr" + JAR_COUNT.incrementAndGet() + ".jar";
144 creator.buildCustomMultiReleaseJar(fileName, value, extraAttributes);
145 File custom = new File(userdir, fileName);
146 try (JarFile jf = new JarFile(custom, true, ZipFile.OPEN_READ, Runtime.version())) {
147 Assert.assertEquals(jf.isMultiRelease(), expected);
148 }
149 Files.delete(custom.toPath());
150 }
151
152 @DataProvider(name = "versions")
153 public Object[][] createVersionData() throws Exception {
154 return new Object[][]{
155 {JarFile.baseVersion(), 8},
156 {JarFile.runtimeVersion(), Runtime.version().major()},
157 {Runtime.version(), Runtime.version().major()},
158 {Runtime.Version.parse("7.1"), JarFile.baseVersion().major()},
159 {Runtime.Version.parse("9"), 9},
160 {Runtime.Version.parse("9.1.5-ea+200"), 9}
161 };
162 }
163
164 @Test(dataProvider="versions")
165 public void testVersioning(Runtime.Version value, int xpected) throws Exception {
166 Runtime.Version expected = Runtime.Version.parse(String.valueOf(xpected));
167 Runtime.Version base = JarFile.baseVersion();
168
169 // multi-release jar, opened as unversioned
170 try (JarFile jar = new JarFile(multirelease)) {
171 Assert.assertEquals(jar.getVersion(), base);
172 }
173
174 System.err.println("test versioning for Release " + value);
175 try (JarFile jf = new JarFile(multirelease, true, ZipFile.OPEN_READ, value)) {
176 Assert.assertEquals(jf.getVersion(), expected);
177 }
178
179 // regular, unversioned, jar
180 try (JarFile jf = new JarFile(unversioned, true, ZipFile.OPEN_READ, value)) {
181 Assert.assertEquals(jf.getVersion(), base);
182 }
183 }
184
185 @Test(dataProvider="versions")
186 public void testAliasing(Runtime.Version version, int xpected) throws Exception {
187 int n = Math.max(version.major(), JarFile.baseVersion().major());
188 Runtime.Version value = Runtime.Version.parse(String.valueOf(n));
189 System.err.println("test aliasing for Release " + version);
190 String prefix;
191 if (JarFile.baseVersion().equals(value)) {
192 prefix = "";
193 } else {
194 prefix = "META-INF/versions/" + value.major() + "/";
195 }
196 // test both multi-release jars
197 readAndCompare(multirelease, value, "README", prefix + "README");
198 readAndCompare(multirelease, value, "version/Version.class", prefix + "version/Version.class");
199 // and signed multi-release jars
200 readAndCompare(signedmultirelease, value, "README", prefix + "README");
201 readAndCompare(signedmultirelease, value, "version/Version.class", prefix + "version/Version.class");
202 }
203
204 private void readAndCompare(File jar, Runtime.Version version, String name, String realName) throws Exception {
205 byte[] baseBytes;
206 byte[] versionedBytes;
207 try (JarFile jf = new JarFile(jar, true, ZipFile.OPEN_READ, JarFile.baseVersion())) {
208 ZipEntry ze = jf.getEntry(realName);
209 try (InputStream is = jf.getInputStream(ze)) {
210 baseBytes = is.readAllBytes();
211 }
212 }
213 assert baseBytes.length > 0;
214
215 try (JarFile jf = new JarFile(jar, true, ZipFile.OPEN_READ, version)) {
216 ZipEntry ze = jf.getEntry(name);
217 try (InputStream is = jf.getInputStream(ze)) {
218 versionedBytes = is.readAllBytes();
219 }
220 }
221 assert versionedBytes.length > 0;
222
223 Assert.assertTrue(Arrays.equals(baseBytes, versionedBytes));
224 }
225
226 @Test
227 public void testNames() throws Exception {
228 String rname = "version/Version.class";
229 String vname = "META-INF/versions/9/version/Version.class";
230 ZipEntry ze1;
231 ZipEntry ze2;
232 try (JarFile jf = new JarFile(multirelease)) {
233 ze1 = jf.getEntry(vname);
234 }
235 Assert.assertEquals(ze1.getName(), vname);
236 try (JarFile jf = new JarFile(multirelease, true, ZipFile.OPEN_READ, Runtime.Version.parse("9"))) {
237 ze2 = jf.getEntry(rname);
238 }
239 Assert.assertEquals(ze2.getName(), rname);
240 Assert.assertNotEquals(ze1.getName(), ze2.getName());
241 }
242 }