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