/*

 * Copyright (c) 2015, 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

 * @summary Test last sorter property

 * @author Jean-Francois Denise

 * @modules jdk.jlink/jdk.tools.jlink.internal

 *          jdk.jlink/jdk.tools.jlink

 * @run main/othervm LastSorterTest

 */

import java.util.ArrayList;

import java.util.Collections;

import java.util.HashMap;

import java.util.List;

import java.util.Map;

import jdk.tools.jlink.internal.ImagePluginConfiguration;

import jdk.tools.jlink.internal.PluginRepository;

import jdk.tools.jlink.internal.ImagePluginStack;

import jdk.tools.jlink.internal.ModulePoolImpl;

import jdk.tools.jlink.Jlink;

import jdk.tools.jlink.Jlink.PluginsConfiguration;

import jdk.tools.jlink.plugin.Plugin;

import jdk.tools.jlink.plugin.ModuleEntry;

import jdk.tools.jlink.plugin.ModulePool;

import jdk.tools.jlink.plugin.TransformerPlugin;

public class LastSorterTest {

    public LastSorterTest() {

        for (int i = 1; i <= 6; i++) {

            PluginRepository.registerPlugin(new SorterPlugin("sorterplugin" + i));

        }

    }

    public static void main(String[] args) throws Exception {

        new LastSorterTest().test();

    }

    public void test() throws Exception {

        checkUnknownPlugin();

        checkOrderAfterLastSorter();

        checkPositiveCase();

        checkTwoLastSorters();

    }

    private void checkTwoLastSorters() throws Exception {

        List<Plugin> plugins = new ArrayList<>();

        plugins.add(createPlugin("sorterplugin5", "/a"));

        plugins.add(createPlugin("sorterplugin6", "/a"));

        PluginsConfiguration config = new Jlink.PluginsConfiguration(plugins,

                null, "sorterplugin5");

        ImagePluginStack stack = ImagePluginConfiguration.parseConfiguration(config);

        // check order

        ModulePoolImpl res = fillOutResourceModulePool();

        try {

            stack.visitResources(res);

            throw new AssertionError("Exception expected: Order of resources is already frozen." +

                    "Plugin sorterplugin6 is badly located");

        } catch (Exception e) {

            // expected

        }

    }

    private ModulePoolImpl fillOutResourceModulePool() throws Exception {

        ModulePoolImpl res = new ModulePoolImpl();

        res.add(ModuleEntry.create("/eee/bbb/res1.class", new byte[90]));

        res.add(ModuleEntry.create("/aaaa/bbb/res2.class", new byte[90]));

        res.add(ModuleEntry.create("/bbb/aa/res1.class", new byte[90]));

        res.add(ModuleEntry.create("/aaaa/bbb/res3.class", new byte[90]));

        res.add(ModuleEntry.create("/bbb/aa/res2.class", new byte[90]));

        res.add(ModuleEntry.create("/fff/bbb/res1.class", new byte[90]));

        res.add(ModuleEntry.create("/aaaa/bbb/res1.class", new byte[90]));

        res.add(ModuleEntry.create("/bbb/aa/res3.class", new byte[90]));

        res.add(ModuleEntry.create("/ccc/bbb/res1.class", new byte[90]));

        res.add(ModuleEntry.create("/ddd/bbb/res1.class", new byte[90]));

        return res;

    }

    private static Plugin createPlugin(String name, String arg) {

        Map<String, String> conf = new HashMap<>();

        conf.put(name, arg);

        return Jlink.newPlugin(name, conf, null);

    }

    private void checkPositiveCase() throws Exception {

        List<Plugin> plugins = new ArrayList<>();

        plugins.add(createPlugin("sorterplugin1", "/c"));

        plugins.add(createPlugin("sorterplugin2", "/b"));

        plugins.add(createPlugin("sorterplugin3", "/a"));

        PluginsConfiguration config = new Jlink.PluginsConfiguration(plugins,

                null, "sorterplugin3");

        ImagePluginStack stack = ImagePluginConfiguration.parseConfiguration(config);

        // check order

        ModulePoolImpl res = fillOutResourceModulePool();

        stack.visitResources(res);

    }

    private void checkUnknownPlugin() {

        List<Plugin> plugins = new ArrayList<>();

        plugins.add(createPlugin("sorterplugin1", "/1"));

        plugins.add(createPlugin("sorterplugin2", "/1"));

        plugins.add(createPlugin("sorterplugin3", "/1"));

        plugins.add(createPlugin("sorterplugin4", "/1"));

        PluginsConfiguration config = new Jlink.PluginsConfiguration(plugins,

                null, "sorterplugin5");

        try {

            ImagePluginConfiguration.parseConfiguration(config);

            throw new AssertionError("Unknown plugin should have failed.");

        } catch (Exception ex) {

            // XXX OK expected

        }

    }

    private void checkOrderAfterLastSorter() throws Exception {

        List<Plugin> plugins = new ArrayList<>();

        plugins.add(createPlugin("sorterplugin1", "/c"));

        plugins.add(createPlugin("sorterplugin2", "/b"));

        plugins.add(createPlugin("sorterplugin3", "/a"));

        plugins.add(createPlugin("sorterplugin4", "/d"));

        PluginsConfiguration config = new Jlink.PluginsConfiguration(plugins,

                null, "sorterplugin3");

        ImagePluginStack stack = ImagePluginConfiguration.parseConfiguration(config);

        // check order

        ModulePoolImpl res = fillOutResourceModulePool();

        try {

            stack.visitResources(res);

            throw new AssertionError("Order was changed after the last sorter, but no exception occurred");

        } catch (Exception ex) {

            // XXX OK expected

        }

    }

    public static class SorterPlugin implements TransformerPlugin {

        private final String name;

        private String starts;

        private SorterPlugin(String name) {

            this.name = name;

        }

        @Override

        public void visit(ModulePool resources, ModulePool output) {

            List<ModuleEntry> paths = new ArrayList<>();

            resources.entries().forEach(res -> {

                if (res.getPath().startsWith(starts)) {

                    paths.add(0, res);

                } else {

                    paths.add(res);

                }

            });

            for (ModuleEntry r : paths) {

                output.add(r);

            }

        }

        @Override

        public String getName() {

            return name;

        }

        @Override

        public void configure(Map<String, String> config) {

            String arguments = config.get(name);

            this.starts = arguments;

        }

    }

}