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
24import java.io.File;
25import java.io.FileReader;
26import java.io.IOException;
27import java.io.UncheckedIOException;
28import java.nio.ByteOrder;
29import java.nio.file.Files;
30import java.nio.file.Path;
31import java.nio.file.Paths;
32import java.util.ArrayList;
33import java.util.Collections;
34import java.util.HashMap;
35import java.util.HashSet;
36import java.util.List;
37import java.util.Map;
38import java.util.Properties;
39import java.util.Set;
40import java.util.function.Function;
41import jdk.tools.jlink.internal.Jlink;
42import jdk.tools.jlink.builder.DefaultImageBuilder;
43import jdk.tools.jlink.plugin.ResourcePool;
44import jdk.tools.jlink.plugin.ResourcePoolBuilder;
45import jdk.tools.jlink.plugin.Plugin;
46import jdk.tools.jlink.internal.ExecutableImage;
47import jdk.tools.jlink.internal.Jlink.JlinkConfiguration;
48import jdk.tools.jlink.internal.Jlink.PluginsConfiguration;
49import jdk.tools.jlink.internal.PostProcessor;
50import jdk.tools.jlink.internal.plugins.DefaultCompressPlugin;
51import jdk.tools.jlink.internal.plugins.StripDebugPlugin;
52
53import tests.Helper;
54import tests.JImageGenerator;
55
56/*
57 * @test
58 * @summary Test integration API
59 * @author Jean-Francois Denise
60 * @library ../lib
61 * @modules java.base/jdk.internal.jimage
62 *          jdk.jdeps/com.sun.tools.classfile
63 *          jdk.jlink/jdk.tools.jlink.builder
64 *          jdk.jlink/jdk.tools.jlink.internal
65 *          jdk.jlink/jdk.tools.jlink.internal.plugins
66 *          jdk.jlink/jdk.tools.jlink.plugin
67 *          jdk.jlink/jdk.tools.jmod
68 *          jdk.jlink/jdk.tools.jimage
69 *          jdk.compiler
70 * @build tests.*
71 * @run main IntegrationTest
72 */
73public class IntegrationTest {
74
75    private static final List<Integer> ordered = new ArrayList<>();
76
77    public static class MyPostProcessor implements PostProcessor, Plugin {
78
79        public static final String NAME = "mypostprocessor";
80
81        @Override
82        public List<String> process(ExecutableImage image) {
83            try {
84                Files.createFile(image.getHome().resolve("toto.txt"));
85                return null;
86            } catch (IOException ex) {
87                throw new UncheckedIOException(ex);
88            }
89        }
90
91        @Override
92        public String getName() {
93            return NAME;
94        }
95
96        @Override
97        public Category getType() {
98            return Category.PROCESSOR;
99        }
100
101        @Override
102        public void configure(Map<String, String> config) {
103            throw new UnsupportedOperationException("Shouldn't be called");
104        }
105
106        @Override
107        public ResourcePool transform(ResourcePool in, ResourcePoolBuilder out) {
108            in.transformAndCopy(Function.identity(), out);
109            return out.build();
110        }
111    }
112
113    public static void main(String[] args) throws Exception {
114
115        Helper helper = Helper.newHelper();
116        if (helper == null) {
117            System.err.println("Test not run");
118            return;
119        }
120        apitest();
121        test();
122    }
123
124    private static void apitest() throws Exception {
125        boolean failed = false;
126        Jlink jl = new Jlink();
127
128        try {
129            jl.build(null);
130            failed = true;
131        } catch (Exception ex) {
132            // XXX OK
133        }
134        if (failed) {
135            throw new Exception("Should have failed");
136        }
137        System.out.println(jl);
138
139        Plugin p = Jlink.newPlugin("toto", Collections.emptyMap(), null);
140        if (p != null) {
141            throw new Exception("Plugin should be null");
142        }
143
144        Plugin p2 = Jlink.newPlugin("compress", Map.of("compress", "1"), null);
145        if (p2 == null) {
146            throw new Exception("Plugin should not be null");
147        }
148    }
149
150    private static void test() throws Exception {
151        Jlink jlink = new Jlink();
152        Path output = Paths.get("integrationout");
153        List<Path> modulePaths = new ArrayList<>();
154        File jmods
155                = JImageGenerator.getJModsDir(new File(System.getProperty("test.jdk")));
156        modulePaths.add(jmods.toPath());
157        Set<String> mods = new HashSet<>();
158        mods.add("java.management");
159        Set<String> limits = new HashSet<>();
160        limits.add("java.management");
161        JlinkConfiguration config = new Jlink.JlinkConfiguration(output,
162                modulePaths, mods, limits, ByteOrder.nativeOrder());
163
164        List<Plugin> lst = new ArrayList<>();
165
166        //Strip debug
167        {
168            Map<String, String> config1 = new HashMap<>();
169            config1.put(StripDebugPlugin.NAME, "");
170            Plugin strip = Jlink.newPlugin("strip-debug", config1, null);
171            lst.add(strip);
172        }
173        // compress
174        {
175            Map<String, String> config1 = new HashMap<>();
176            config1.put(DefaultCompressPlugin.NAME, "2");
177            Plugin compress
178                    = Jlink.newPlugin("compress", config1, null);
179            lst.add(compress);
180        }
181        // Post processor
182        {
183            lst.add(new MyPostProcessor());
184        }
185        // Image builder
186        DefaultImageBuilder builder = new DefaultImageBuilder(output, Collections.emptyMap());
187        PluginsConfiguration plugins
188                = new Jlink.PluginsConfiguration(lst, builder, null);
189
190        jlink.build(config, plugins);
191
192        if (!Files.exists(output)) {
193            throw new AssertionError("Directory not created");
194        }
195        File jimage = new File(output.toString(), "lib" + File.separator + "modules");
196        if (!jimage.exists()) {
197            throw new AssertionError("jimage not generated");
198        }
199        File release = new File(output.toString(), "release");
200        if (!release.exists()) {
201            throw new AssertionError("release not generated");
202        }
203
204        Properties props = new Properties();
205        try (FileReader reader = new FileReader(release)) {
206            props.load(reader);
207        }
208
209        checkReleaseProperty(props, "JAVA_VERSION");
210
211        if (!Files.exists(output.resolve("toto.txt"))) {
212            throw new AssertionError("Post processing not called");
213        }
214
215    }
216
217    static void checkReleaseProperty(Properties props, String name) {
218        if (! props.containsKey(name)) {
219            throw new AssertionError("release file does not contain property : " + name);
220        }
221
222        // property value is of min. length 3 and double quoted at the ends.
223        String value = props.getProperty(name);
224        if (value.length() < 3 ||
225            value.charAt(0) != '"' ||
226            value.charAt(value.length() - 1) != '"') {
227            throw new AssertionError("release property " + name + " is not quoted property");
228        }
229    }
230}
231