/*

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

 * @library /lib/testlibrary

 * @modules java.base/jdk.internal.misc

 * @build BasicLayerTest ModuleUtils

 * @compile layertest/Test.java

 * @run testng BasicLayerTest

 * @summary Basic tests for java.lang.ModuleLayer

 */

import java.lang.module.Configuration;

import java.lang.module.ModuleDescriptor;

import java.lang.module.ModuleDescriptor.Requires;

import java.lang.module.ModuleFinder;

import java.util.HashMap;

import java.util.Map;

import java.util.Optional;

import java.util.Set;

import java.util.stream.Collectors;

import jdk.internal.misc.SharedSecrets;

import org.testng.annotations.DataProvider;

import org.testng.annotations.Test;

import static org.testng.Assert.*;

@Test

public class BasicLayerTest {

    /**

     * Creates a "non-strict" builder for building a module. This allows the

     * test the create ModuleDescriptor objects that do not require java.base.

     */

    private static ModuleDescriptor.Builder newBuilder(String mn) {

        return SharedSecrets.getJavaLangModuleAccess()

                .newModuleBuilder(mn, false, Set.of());

    }

    /**

     * Exercise ModuleLayer.empty()

     */

    public void testEmpty() {

        ModuleLayer emptyLayer = ModuleLayer.empty();

        assertTrue(emptyLayer.parents().isEmpty());

        assertTrue(emptyLayer.configuration() == Configuration.empty());

        assertTrue(emptyLayer.modules().isEmpty());

        assertFalse(emptyLayer.findModule("java.base").isPresent());

        try {

            emptyLayer.findLoader("java.base");

            assertTrue(false);

        } catch (IllegalArgumentException expected) { }

    }

    /**

     * Exercise ModuleLayer.boot()

     */

    public void testBoot() {

        ModuleLayer bootLayer = ModuleLayer.boot();

        // configuration

        Configuration cf = bootLayer.configuration();

        assertTrue(cf.findModule("java.base").get()

                .reference()

                .descriptor()

                .exports()

                .stream().anyMatch(e -> (e.source().equals("java.lang")

                                         && !e.isQualified())));

        // modules

        Set<Module> modules = bootLayer.modules();

        assertTrue(modules.contains(Object.class.getModule()));

        int count = (int) modules.stream().map(Module::getName).count();

        assertEquals(count, modules.size()); // module names are unique

        // findModule

        Module base = Object.class.getModule();

        assertTrue(bootLayer.findModule("java.base").get() == base);

        assertTrue(base.getLayer() == bootLayer);

        // findLoader

        assertTrue(bootLayer.findLoader("java.base") == null);

        // parents

        assertTrue(bootLayer.parents().size() == 1);

        assertTrue(bootLayer.parents().get(0) == ModuleLayer.empty());

    }

    /**

     * Exercise defineModules, created with empty layer as parent

     */

    public void testLayerOnEmpty() {

        ModuleDescriptor descriptor1 = newBuilder("m1")

                .requires("m2")

                .exports("p1")

                .build();

        ModuleDescriptor descriptor2 = newBuilder("m2")

                .requires("m3")

                .build();

        ModuleDescriptor descriptor3 = newBuilder("m3")

                .build();

        ModuleFinder finder

            = ModuleUtils.finderOf(descriptor1, descriptor2, descriptor3);

        Configuration cf = resolve(finder, "m1");

        // map each module to its own class loader for this test

        ClassLoader loader1 = new ClassLoader() { };

        ClassLoader loader2 = new ClassLoader() { };

        ClassLoader loader3 = new ClassLoader() { };

        Map<String, ClassLoader> map = new HashMap<>();

        map.put("m1", loader1);

        map.put("m2", loader2);

        map.put("m3", loader3);

        ModuleLayer layer = ModuleLayer.empty().defineModules(cf, map::get);

        // configuration

        assertTrue(layer.configuration() == cf);

        assertTrue(layer.configuration().modules().size() == 3);

        // modules

        Set<Module> modules = layer.modules();

        assertTrue(modules.size() == 3);

        Set<String> names = modules.stream()

            .map(Module::getName)

            .collect(Collectors.toSet());

        assertTrue(names.contains("m1"));

        assertTrue(names.contains("m2"));

        assertTrue(names.contains("m3"));

        // findModule

        Module m1 = layer.findModule("m1").get();

        Module m2 = layer.findModule("m2").get();

        Module m3 = layer.findModule("m3").get();

        assertEquals(m1.getName(), "m1");

        assertEquals(m2.getName(), "m2");

        assertEquals(m3.getName(), "m3");

        assertTrue(m1.getDescriptor() == descriptor1);

        assertTrue(m2.getDescriptor() == descriptor2);

        assertTrue(m3.getDescriptor() == descriptor3);

        assertTrue(m1.getLayer() == layer);

        assertTrue(m2.getLayer() == layer);

        assertTrue(m3.getLayer() == layer);

        assertTrue(modules.contains(m1));

        assertTrue(modules.contains(m2));

        assertTrue(modules.contains(m3));

        assertFalse(layer.findModule("godot").isPresent());

        // findLoader

        assertTrue(layer.findLoader("m1") == loader1);

        assertTrue(layer.findLoader("m2") == loader2);

        assertTrue(layer.findLoader("m3") == loader3);

        try {

            ClassLoader loader = layer.findLoader("godot");

            assertTrue(false);

        } catch (IllegalArgumentException ignore) { }

        // parents

        assertTrue(layer.parents().size() == 1);

        assertTrue(layer.parents().get(0) == ModuleLayer.empty());

    }

    /**

     * Exercise defineModules, created with boot layer as parent

     */

    public void testLayerOnBoot() {

        ModuleDescriptor descriptor1 = newBuilder("m1")

                .requires("m2")

                .requires("java.base")

                .exports("p1")

                .build();

        ModuleDescriptor descriptor2 = newBuilder("m2")

                .requires("java.base")

                .build();

        ModuleFinder finder

            = ModuleUtils.finderOf(descriptor1, descriptor2);

        Configuration parent = ModuleLayer.boot().configuration();

        Configuration cf = resolve(parent, finder, "m1");

        ClassLoader loader = new ClassLoader() { };

        ModuleLayer layer = ModuleLayer.boot().defineModules(cf, mn -> loader);

        // configuration

        assertTrue(layer.configuration() == cf);

        assertTrue(layer.configuration().modules().size() == 2);

        // modules

        Set<Module> modules = layer.modules();

        assertTrue(modules.size() == 2);

        Set<String> names = modules.stream()

            .map(Module::getName)

            .collect(Collectors.toSet());

        assertTrue(names.contains("m1"));

        assertTrue(names.contains("m2"));

        // findModule

        Module m1 = layer.findModule("m1").get();

        Module m2 = layer.findModule("m2").get();

        assertEquals(m1.getName(), "m1");

        assertEquals(m2.getName(), "m2");

        assertTrue(m1.getDescriptor() == descriptor1);

        assertTrue(m2.getDescriptor() == descriptor2);

        assertTrue(m1.getLayer() == layer);

        assertTrue(m2.getLayer() == layer);

        assertTrue(modules.contains(m1));

        assertTrue(modules.contains(m2));

        assertTrue(layer.findModule("java.base").get() == Object.class.getModule());

        assertFalse(layer.findModule("godot").isPresent());

        // findLoader

        assertTrue(layer.findLoader("m1") == loader);

        assertTrue(layer.findLoader("m2") == loader);

        assertTrue(layer.findLoader("java.base") == null);

        // parents

        assertTrue(layer.parents().size() == 1);

        assertTrue(layer.parents().get(0) == ModuleLayer.boot());

    }

    /**

     * Exercise defineModules with a configuration of two modules that

     * have the same module-private package.

     */

    public void testPackageContainedInSelfAndOther() {

        ModuleDescriptor descriptor1 =  newBuilder("m1")

                .requires("m2")

                .packages(Set.of("p"))

                .build();

        ModuleDescriptor descriptor2 = newBuilder("m2")

                .packages(Set.of("p"))

                .build();

        ModuleFinder finder

            = ModuleUtils.finderOf(descriptor1, descriptor2);

        Configuration cf = resolve(finder, "m1");

        assertTrue(cf.modules().size() == 2);

        // one loader per module, should be okay

        ModuleLayer.empty().defineModules(cf, mn -> new ClassLoader() { });

        // same class loader

        try {

            ClassLoader loader = new ClassLoader() { };

            ModuleLayer.empty().defineModules(cf, mn -> loader);

            assertTrue(false);

        } catch (LayerInstantiationException expected) { }

    }

    /**

     * Exercise defineModules with a configuration that is a partitioned

     * graph. The same package is exported in both partitions.

     */

    public void testSameExportInPartitionedGraph() {

        // m1 reads m2, m2 exports p to m1

        ModuleDescriptor descriptor1 =  newBuilder("m1")

                .requires("m2")

                .build();

        ModuleDescriptor descriptor2 =  newBuilder("m2")

                .exports("p", Set.of("m1"))

                .build();

        // m3 reads m4, m4 exports p to m3

        ModuleDescriptor descriptor3 = newBuilder("m3")

                .requires("m4")

                .build();

        ModuleDescriptor descriptor4 = newBuilder("m4")

                .exports("p", Set.of("m3"))

                .build();

        ModuleFinder finder

            = ModuleUtils.finderOf(descriptor1,

                                   descriptor2,

                                   descriptor3,

                                   descriptor4);

        Configuration cf = resolve(finder, "m1", "m3");

        assertTrue(cf.modules().size() == 4);

        // one loader per module

        ModuleLayer.empty().defineModules(cf, mn -> new ClassLoader() { });

        // m1 & m2 in one loader, m3 & m4 in another loader

        ClassLoader loader1 = new ClassLoader() { };

        ClassLoader loader2 = new ClassLoader() { };

        Map<String, ClassLoader> map = new HashMap<>();

        map.put("m1", loader1);

        map.put("m2", loader1);

        map.put("m3", loader2);

        map.put("m4", loader2);

        ModuleLayer.empty().defineModules(cf, map::get);

        // same loader

        try {

            ClassLoader loader = new ClassLoader() { };

            ModuleLayer.empty().defineModules(cf, mn -> loader);

            assertTrue(false);

        } catch (LayerInstantiationException expected) { }

    }

    /**

     * Exercise defineModules with a configuration with a module that

     * contains a package that is the same name as a non-exported package in

     * a parent layer.

     */

    public void testContainsSamePackageAsBootLayer() {

        // check assumption that java.base contains sun.launcher

        ModuleDescriptor base = Object.class.getModule().getDescriptor();

        assertTrue(base.packages().contains("sun.launcher"));

        ModuleDescriptor descriptor = newBuilder("m1")

               .requires("java.base")

               .packages(Set.of("sun.launcher"))

               .build();

        ModuleFinder finder = ModuleUtils.finderOf(descriptor);

        Configuration parent = ModuleLayer.boot().configuration();

        Configuration cf = parent.resolve(finder, ModuleFinder.of(), Set.of("m1"));

        assertTrue(cf.modules().size() == 1);

        ClassLoader loader = new ClassLoader() { };

        ModuleLayer layer = ModuleLayer.boot().defineModules(cf, mn -> loader);

        assertTrue(layer.modules().size() == 1);

   }

    /**

     * Test layers with implied readability.

     *

     * The test consists of three configurations:

     * - Configuration/layer1: m1, m2 requires transitive m1

     * - Configuration/layer2: m3 requires m1

     */

    public void testImpliedReadabilityWithLayers1() {

        // cf1: m1 and m2, m2 requires transitive m1

        ModuleDescriptor descriptor1 = newBuilder("m1")

                .build();

        ModuleDescriptor descriptor2 = newBuilder("m2")

                .requires(Set.of(Requires.Modifier.TRANSITIVE), "m1")

                .build();

        ModuleFinder finder1 = ModuleUtils.finderOf(descriptor1, descriptor2);

        Configuration cf1 = resolve(finder1, "m2");

        ClassLoader cl1 = new ClassLoader() { };

        ModuleLayer layer1 = ModuleLayer.empty().defineModules(cf1, mn -> cl1);

        // cf2: m3, m3 requires m2

        ModuleDescriptor descriptor3 = newBuilder("m3")

                .requires("m2")

                .build();

        ModuleFinder finder2 = ModuleUtils.finderOf(descriptor3);

        Configuration cf2 = resolve(cf1, finder2, "m3");

        ClassLoader cl2 = new ClassLoader() { };

        ModuleLayer layer2 = layer1.defineModules(cf2, mn -> cl2);

        assertTrue(layer1.parents().size() == 1);

        assertTrue(layer1.parents().get(0) == ModuleLayer.empty());

        assertTrue(layer2.parents().size() == 1);

        assertTrue(layer2.parents().get(0) == layer1);

        Module m1 = layer2.findModule("m1").get();

        Module m2 = layer2.findModule("m2").get();

        Module m3 = layer2.findModule("m3").get();

        assertTrue(m1.getLayer() == layer1);

        assertTrue(m2.getLayer() == layer1);

        assertTrue(m3.getLayer() == layer2);

        assertTrue(m1.getClassLoader() == cl1);

        assertTrue(m2.getClassLoader() == cl1);

        assertTrue(m3.getClassLoader() == cl2);

        assertTrue(m1.canRead(m1));

        assertFalse(m1.canRead(m2));

        assertFalse(m1.canRead(m3));

        assertTrue(m2.canRead(m1));

        assertTrue(m2.canRead(m2));

        assertFalse(m2.canRead(m3));

        assertTrue(m3.canRead(m1));

        assertTrue(m3.canRead(m2));

        assertTrue(m3.canRead(m3));

    }

    /**

     * Test layers with implied readability.

     *

     * The test consists of three configurations:

     * - Configuration/layer1: m1

     * - Configuration/layer2: m2 requires transitive m3, m3 requires m2

     */

    public void testImpliedReadabilityWithLayers2() {

        // cf1: m1

        ModuleDescriptor descriptor1 = newBuilder("m1").build();

        ModuleFinder finder1 = ModuleUtils.finderOf(descriptor1);

        Configuration cf1 = resolve(finder1, "m1");

        ClassLoader cl1 = new ClassLoader() { };

        ModuleLayer layer1 = ModuleLayer.empty().defineModules(cf1, mn -> cl1);

        // cf2: m2, m3: m2 requires transitive m1, m3 requires m2

        ModuleDescriptor descriptor2 = newBuilder("m2")

                .requires(Set.of(Requires.Modifier.TRANSITIVE), "m1")

                .build();

        ModuleDescriptor descriptor3 = newBuilder("m3")

                .requires("m2")

                .build();

        ModuleFinder finder2 = ModuleUtils.finderOf(descriptor2, descriptor3);

        Configuration cf2 = resolve(cf1, finder2, "m3");

        ClassLoader cl2 = new ClassLoader() { };

        ModuleLayer layer2 = layer1.defineModules(cf2, mn -> cl2);

        assertTrue(layer1.parents().size() == 1);

        assertTrue(layer1.parents().get(0) == ModuleLayer.empty());

        assertTrue(layer2.parents().size() == 1);

        assertTrue(layer2.parents().get(0) == layer1);

        Module m1 = layer2.findModule("m1").get();

        Module m2 = layer2.findModule("m2").get();

        Module m3 = layer2.findModule("m3").get();

        assertTrue(m1.getLayer() == layer1);

        assertTrue(m2.getLayer() == layer2);

        assertTrue(m3.getLayer() == layer2);

        assertTrue(m1.canRead(m1));

        assertFalse(m1.canRead(m2));

        assertFalse(m1.canRead(m3));

        assertTrue(m2.canRead(m1));

        assertTrue(m2.canRead(m2));

        assertFalse(m2.canRead(m3));

        assertTrue(m3.canRead(m1));

        assertTrue(m3.canRead(m2));

        assertTrue(m3.canRead(m3));

    }

    /**

     * Test layers with implied readability.

     *

     * The test consists of three configurations:

     * - Configuration/layer1: m1

     * - Configuration/layer2: m2 requires transitive m1

     * - Configuration/layer3: m3 requires m1

     */

    public void testImpliedReadabilityWithLayers3() {

        // cf1: m1

        ModuleDescriptor descriptor1 = newBuilder("m1").build();

        ModuleFinder finder1 = ModuleUtils.finderOf(descriptor1);

        Configuration cf1 = resolve(finder1, "m1");

        ClassLoader cl1 = new ClassLoader() { };

        ModuleLayer layer1 = ModuleLayer.empty().defineModules(cf1, mn -> cl1);