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 8144355 8144062 8176709 8194070 8193802
27  * @summary Test aliasing additions to ZipFileSystem for multi-release jar files
28  * @library /lib/testlibrary/java/util/jar
29  * @modules jdk.compiler
30  *          jdk.jartool
31  *          jdk.zipfs
32  * @build Compiler JarBuilder CreateMultiReleaseTestJars
33  * @run testng MultiReleaseJarTest
34  */
35 
36 import java.io.IOException;
37 import java.lang.invoke.MethodHandle;
38 import java.lang.invoke.MethodHandles;
39 import java.lang.invoke.MethodType;
40 import java.lang.Runtime.Version;
41 import java.net.URI;
42 import java.nio.file.*;
43 import java.util.HashMap;
44 import java.util.Map;
45 import java.util.concurrent.atomic.AtomicInteger;
46 
47 import org.testng.Assert;
48 import org.testng.annotations.*;
49 
50 public class MultiReleaseJarTest {
51     final private int MAJOR_VERSION = Runtime.version().major();
52 
53     final private String userdir = System.getProperty("user.dir",".");
54     final private CreateMultiReleaseTestJars creator =  new CreateMultiReleaseTestJars();
55     final private Map<String,String> stringEnv = new HashMap<>();
56     final private Map<String,Integer> integerEnv = new HashMap<>();
57     final private Map<String,Version> versionEnv = new HashMap<>();
58     final private String className = "version.Version";
59     final private MethodType mt = MethodType.methodType(int.class);
60 
61     private String entryName;
62     private URI uvuri;
63     private URI mruri;
64     private URI smruri;
65 
66     @BeforeClass
initialize()67     public void initialize() throws Exception {
68         creator.compileEntries();
69         creator.buildUnversionedJar();
70         creator.buildMultiReleaseJar();
71         creator.buildShortMultiReleaseJar();
72         String ssp = Paths.get(userdir, "unversioned.jar").toUri().toString();
73         uvuri = new URI("jar", ssp , null);
74         ssp = Paths.get(userdir, "multi-release.jar").toUri().toString();
75         mruri = new URI("jar", ssp, null);
76         ssp = Paths.get(userdir, "short-multi-release.jar").toUri().toString();
77         smruri = new URI("jar", ssp, null);
78         entryName = className.replace('.', '/') + ".class";
79     }
80 
close()81     public void close() throws IOException {
82         Files.delete(Paths.get(userdir, "unversioned.jar"));
83         Files.delete(Paths.get(userdir, "multi-release.jar"));
84         Files.delete(Paths.get(userdir, "short-multi-release.jar"));
85     }
86 
87     @DataProvider(name="strings")
createStrings()88     public Object[][] createStrings() {
89         return new Object[][]{
90                 {"runtime", MAJOR_VERSION},
91                 {"-20", 8},
92                 {"0", 8},
93                 {"8", 8},
94                 {"9", 9},
95                 {Integer.toString(MAJOR_VERSION), MAJOR_VERSION},
96                 {Integer.toString(MAJOR_VERSION+1), MAJOR_VERSION},
97                 {"50", MAJOR_VERSION}
98         };
99     }
100 
101     @DataProvider(name="integers")
createIntegers()102     public Object[][] createIntegers() {
103         return new Object[][] {
104                 {new Integer(-5), 8},
105                 {new Integer(0), 8},
106                 {new Integer(8), 8},
107                 {new Integer(9), 9},
108                 {new Integer(MAJOR_VERSION), MAJOR_VERSION},
109                 {new Integer(MAJOR_VERSION + 1), MAJOR_VERSION},
110                 {new Integer(100), MAJOR_VERSION}
111         };
112     }
113 
114     @DataProvider(name="versions")
createVersions()115     public Object[][] createVersions() {
116         return new Object[][] {
117                 {Version.parse("8"),    8},
118                 {Version.parse("9"),    9},
119                 {Version.parse("11"),  MAJOR_VERSION},
120                 {Version.parse("100"), MAJOR_VERSION}
121         };
122     }
123 
124     // Not the best test but all I can do since ZipFileSystem and JarFileSystem
125     // are not public, so I can't use (fs instanceof ...)
126     @Test
testNewFileSystem()127     public void testNewFileSystem() throws Exception {
128         Map<String,String> env = new HashMap<>();
129         // no configuration, treat multi-release jar as unversioned
130         try (FileSystem fs = FileSystems.newFileSystem(mruri, env)) {
131             Assert.assertTrue(readAndCompare(fs, 8));
132         }
133         env.put("multi-release", "runtime");
134         // a configuration and jar file is multi-release
135         try (FileSystem fs = FileSystems.newFileSystem(mruri, env)) {
136             Assert.assertTrue(readAndCompare(fs, MAJOR_VERSION));
137         }
138         // a configuration but jar file is unversioned
139         try (FileSystem fs = FileSystems.newFileSystem(uvuri, env)) {
140             Assert.assertTrue(readAndCompare(fs, 8));
141         }
142     }
143 
readAndCompare(FileSystem fs, int expected)144     private boolean readAndCompare(FileSystem fs, int expected) throws IOException {
145         Path path = fs.getPath("version/Version.java");
146         String src = new String(Files.readAllBytes(path));
147         return src.contains("return " + expected);
148     }
149 
150     @Test(dataProvider="strings")
testStrings(String value, int expected)151     public void testStrings(String value, int expected) throws Throwable {
152         stringEnv.put("multi-release", value);
153         runTest(stringEnv, expected);
154     }
155 
156     @Test(dataProvider="integers")
testIntegers(Integer value, int expected)157     public void testIntegers(Integer value, int expected) throws Throwable {
158         integerEnv.put("multi-release", value);
159         runTest(integerEnv, expected);
160     }
161 
162     @Test(dataProvider="versions")
testVersions(Version value, int expected)163     public void testVersions(Version value, int expected) throws Throwable {
164         versionEnv.put("multi-release", value);
165         runTest(versionEnv, expected);
166     }
167 
168     @Test
testShortJar()169     public void testShortJar() throws Throwable {
170         integerEnv.put("multi-release", Integer.valueOf(MAJOR_VERSION));
171         runTest(smruri, integerEnv, MAJOR_VERSION);
172         integerEnv.put("multi-release", Integer.valueOf(9));
173         runTest(smruri, integerEnv, 8);
174     }
175 
runTest(Map<String,?> env, int expected)176     private void runTest(Map<String,?> env, int expected) throws Throwable {
177         runTest(mruri, env, expected);
178     }
179 
runTest(URI uri, Map<String,?> env, int expected)180     private void runTest(URI uri, Map<String,?> env, int expected) throws Throwable {
181         try (FileSystem fs = FileSystems.newFileSystem(uri, env)) {
182             Path version = fs.getPath(entryName);
183             byte [] bytes = Files.readAllBytes(version);
184             Class<?> vcls = (new ByteArrayClassLoader(fs)).defineClass(className, bytes);
185             MethodHandle mh = MethodHandles.lookup().findVirtual(vcls, "getVersion", mt);
186             Assert.assertEquals((int)mh.invoke(vcls.newInstance()), expected);
187         }
188     }
189 
190     @Test
testIsMultiReleaseJar()191     public void testIsMultiReleaseJar() throws Exception {
192         // Re-examine commented out tests as part of JDK-8176843
193         testCustomMultiReleaseValue("true", true);
194         testCustomMultiReleaseValue("true\r\nOther: value", true);
195         testCustomMultiReleaseValue("true\nOther: value", true);
196         //testCustomMultiReleaseValue("true\rOther: value", true);
197 
198         testCustomMultiReleaseValue("false", false);
199         testCustomMultiReleaseValue(" true", false);
200         testCustomMultiReleaseValue("true ", false);
201         //testCustomMultiReleaseValue("true\n ", false);
202         //testCustomMultiReleaseValue("true\r ", false);
203         //testCustomMultiReleaseValue("true\n true", false);
204         //testCustomMultiReleaseValue("true\r\n true", false);
205     }
206 
207     @Test
testMultiReleaseJarWithNonVersionDir()208     public void testMultiReleaseJarWithNonVersionDir() throws Exception {
209         String jfname = "multi-release-non-ver.jar";
210         Path jfpath = Paths.get(jfname);
211         URI uri = new URI("jar", jfpath.toUri().toString() , null);
212         JarBuilder jb = new JarBuilder(jfname);
213         jb.addAttribute("Multi-Release", "true");
214         jb.build();
215         Map<String,String> env = Map.of("multi-release", "runtime");
216         try (FileSystem fs = FileSystems.newFileSystem(uri, env)) {
217             Assert.assertTrue(true);
218         }
219         Files.delete(jfpath);
220     }
221 
222     private static final AtomicInteger JAR_COUNT = new AtomicInteger(0);
223 
testCustomMultiReleaseValue(String value, boolean expected)224     private void testCustomMultiReleaseValue(String value, boolean expected)
225             throws Exception {
226         String fileName = "custom-mr" + JAR_COUNT.incrementAndGet() + ".jar";
227         creator.buildCustomMultiReleaseJar(fileName, value, Map.of(),
228                 /*addEntries*/true);
229 
230         Map<String,String> env = Map.of("multi-release", "runtime");
231         Path filePath = Paths.get(userdir, fileName);
232         String ssp = filePath.toUri().toString();
233         URI customJar = new URI("jar", ssp , null);
234         try (FileSystem fs = FileSystems.newFileSystem(customJar, env)) {
235             if (expected) {
236                 Assert.assertTrue(readAndCompare(fs, MAJOR_VERSION));
237             } else {
238                 Assert.assertTrue(readAndCompare(fs, 8));
239             }
240         }
241         Files.delete(filePath);
242     }
243 
244     private static class ByteArrayClassLoader extends ClassLoader {
245         final private FileSystem fs;
246 
ByteArrayClassLoader(FileSystem fs)247         ByteArrayClassLoader(FileSystem fs) {
248             super(null);
249             this.fs = fs;
250         }
251 
252         @Override
loadClass(String name)253         public Class<?> loadClass(String name) throws ClassNotFoundException {
254             try {
255                 return super.loadClass(name);
256             } catch (ClassNotFoundException x) {}
257             Path cls = fs.getPath(name.replace('.', '/') + ".class");
258             try {
259                 byte[] bytes = Files.readAllBytes(cls);
260                 return defineClass(name, bytes);
261             } catch (IOException x) {
262                 throw new ClassNotFoundException(x.getMessage());
263             }
264         }
265 
defineClass(String name, byte[] bytes)266         public Class<?> defineClass(String name, byte[] bytes) throws ClassNotFoundException {
267             if (bytes == null) throw new ClassNotFoundException("No bytes for " + name);
268             return defineClass(name, bytes, 0, bytes.length);
269         }
270     }
271 }
272