/*

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

 * @bug 6175517 6278707 6318827 6305746 6392303 6600709 8010285

 * @summary General MXBean test.

 * @author Eamonn McManus

 * @author Jaroslav Bachorik

 * @run clean MXBeanTest MerlinMXBean TigerMXBean

 * @run build MXBeanTest MerlinMXBean TigerMXBean

 * @run main MXBeanTest

 */

import java.lang.reflect.Array;

import java.lang.reflect.Field;

import java.lang.reflect.InvocationHandler;

import java.lang.reflect.Method;

import java.lang.reflect.Proxy;

import java.util.Arrays;

import java.util.Collection;

import java.util.HashMap;

import java.util.Iterator;

import java.util.Map;

import java.util.SortedMap;

import javax.management.JMX;

import javax.management.MBeanAttributeInfo;

import javax.management.MBeanInfo;

import javax.management.MBeanOperationInfo;

import javax.management.MBeanParameterInfo;

import javax.management.MBeanServer;

import javax.management.MBeanServerConnection;

import javax.management.MBeanServerFactory;

import javax.management.MBeanServerInvocationHandler;

import javax.management.NotCompliantMBeanException;

import javax.management.ObjectName;

import javax.management.StandardMBean;

import javax.management.openmbean.ArrayType;

import javax.management.openmbean.CompositeData;

import javax.management.openmbean.CompositeDataInvocationHandler;

import javax.management.openmbean.OpenType;

import javax.management.openmbean.SimpleType;

import javax.management.openmbean.TabularData;

import javax.management.openmbean.TabularType;

import javax.management.remote.JMXConnector;

import javax.management.remote.JMXConnectorFactory;

import javax.management.remote.JMXConnectorServer;

import javax.management.remote.JMXConnectorServerFactory;

import javax.management.remote.JMXServiceURL;

public class MXBeanTest {

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

        testInterface(MerlinMXBean.class, false);

        testInterface(TigerMXBean.class, false);

        testInterface(MerlinMXBean.class, true);

        testInterface(TigerMXBean.class, true);

        testExplicitMXBean();

        testSubclassMXBean();

        testIndirectMXBean();

        testNonCompliantMXBean("Private", new Private());

        testNonCompliantMXBean("NonCompliant", new NonCompliant());

        if (failures == 0)

            System.out.println("Test passed");

        else

            throw new Exception("TEST FAILURES: " + failures);

    }

    private static int failures = 0;

    private static interface PrivateMXBean {

        public int[] getInts();

    }

    public static class Private implements PrivateMXBean {

        public int[] getInts() {

            return new int[]{1,2,3};

        }

    }

    public static interface NonCompliantMXBean {

        public boolean getInt();

        public boolean isInt();

        public void setInt(int a);

        public void setInt(long b);

    }

    public static class NonCompliant implements NonCompliantMXBean {

        public boolean getInt() {

            return false;

        }

        public boolean isInt() {

            return true;

        }

        public void setInt(int a) {

        }

        public void setInt(long b) {

        }

    }

    public static interface ExplicitMXBean {

        public int[] getInts();

    }

    public static class Explicit implements ExplicitMXBean {

        public int[] getInts() {

            return new int[] {1, 2, 3};

        }

    }

    public static class Subclass

        extends StandardMBean

        implements ExplicitMXBean {

        public Subclass() {

            super(ExplicitMXBean.class, true);

        }

        public int[] getInts() {

            return new int[] {1, 2, 3};

        }

    }

    public static interface IndirectInterface extends ExplicitMXBean {}

    public static class Indirect implements IndirectInterface {

        public int[] getInts() {

            return new int[] {1, 2, 3};

        }

    }

    private static void testNonCompliantMXBean(String type, Object bean) throws Exception {

        System.out.println(type + " MXBean test...");

        MBeanServer mbs = MBeanServerFactory.newMBeanServer();

        ObjectName on = new ObjectName("test:type=" + type);

        try {

            mbs.registerMBean(bean, on);

            failure(bean.getClass().getInterfaces()[0].getName() + " is not a compliant "

                + "MXBean interface");

        } catch (NotCompliantMBeanException e) {

            success("Non-compliant MXBean not registered");

        }

    }

    private static void testExplicitMXBean() throws Exception {

        System.out.println("Explicit MXBean test...");

        MBeanServer mbs = MBeanServerFactory.newMBeanServer();

        ObjectName on = new ObjectName("test:type=Explicit");

        Explicit explicit = new Explicit();

        mbs.registerMBean(explicit, on);

        testMXBean(mbs, on);

    }

    private static void testSubclassMXBean() throws Exception {

        System.out.println("Subclass MXBean test...");

        MBeanServer mbs = MBeanServerFactory.newMBeanServer();

        ObjectName on = new ObjectName("test:type=Subclass");

        Subclass subclass = new Subclass();

        mbs.registerMBean(subclass, on);

        testMXBean(mbs, on);

    }

    private static void testIndirectMXBean() throws Exception {

        System.out.println("Indirect MXBean test...");

        MBeanServer mbs = MBeanServerFactory.newMBeanServer();

        ObjectName on = new ObjectName("test:type=Indirect");

        Indirect indirect = new Indirect();

        mbs.registerMBean(indirect, on);

        testMXBean(mbs, on);

    }

    private static void testMXBean(MBeanServer mbs, ObjectName on)

            throws Exception {

        MBeanInfo mbi = mbs.getMBeanInfo(on);

        MBeanAttributeInfo[] attrs = mbi.getAttributes();

        int nattrs = attrs.length;

        if (mbi.getAttributes().length != 1)

            failure("wrong number of attributes: " + attrs);

        else {

            MBeanAttributeInfo mbai = attrs[0];

            if (mbai.getName().equals("Ints")

                && mbai.isReadable() && !mbai.isWritable()

                && mbai.getDescriptor().getFieldValue("openType")

                    .equals(new ArrayType<int[]>(SimpleType.INTEGER, true))

                && attrs[0].getType().equals("[I"))

                success("MBeanAttributeInfo");

            else

                failure("MBeanAttributeInfo: " + mbai);

        }

        int[] ints = (int[]) mbs.getAttribute(on, "Ints");

        if (equal(ints, new int[] {1, 2, 3}, null))

            success("getAttribute");

        else

            failure("getAttribute: " + Arrays.toString(ints));

        ExplicitMXBean proxy =

            JMX.newMXBeanProxy(mbs, on, ExplicitMXBean.class);

        int[] pints = proxy.getInts();

        if (equal(pints, new int[] {1, 2, 3}, null))

            success("getAttribute through proxy");

        else

            failure("getAttribute through proxy: " + Arrays.toString(pints));

    }

    private static class NamedMXBeans extends HashMap<ObjectName, Object> {

        private static final long serialVersionUID = 0;

        NamedMXBeans(MBeanServerConnection mbsc) {

            this.mbsc = mbsc;

        }

        MBeanServerConnection getMBeanServerConnection() {

            return mbsc;

        }

        private final MBeanServerConnection mbsc;

    }

    /* This is the core of the test.  Given the MXBean interface c, we

       make an MXBean object that implements that interface by

       constructing a dynamic proxy.  If the interface defines an

       attribute Foo (with getFoo and setFoo methods), then it must

       also contain a field (constant) Foo of the same type, and a

       field (constant) FooType that is an OpenType.  The field Foo is

       a reference value for this case.  We check that the attribute

       does indeed have the given OpenType.  The dynamically-created

       MXBean will return the reference value from the getFoo()

       method, and we check that that value survives the mapping to

       open values and back when the attribute is accessed through an

       MXBean proxy.  The MXBean will also check in its setFoo method

       that the value being set is equal to the reference value, which

       tests that the mapping and unmapping also works in the other

       direction.  The interface should define an operation opFoo with

       two parameters and a return value all of the same type as the

       attribute.  The MXBean will check that the two parameters are

       equal to the reference value, and will return that value.  The

       test checks that calling the operation through an MXBean proxy

       returns the reference value, again after mapping to and back

       from open values.

       If any field (constant) in the MXBean interface has a name that

       ends with ObjectName, say FooObjectName, then its value must be

       a String containing an ObjectName value.  There must be a field

       (constant) called Foo that is a valid MXBean, and that MXBean

       will be registered in the MBean Server with the given name before

       the test starts.  This enables us to test that inter-MXBean

       references are correctly converted to ObjectNames and back.

     */

    private static <T> void testInterface(Class<T> c, boolean nullTest)

            throws Exception {

        System.out.println("Testing " + c.getName() +

                           (nullTest ? " for null values" : "") + "...");

        MBeanServer mbs = MBeanServerFactory.newMBeanServer();

        JMXServiceURL url = new JMXServiceURL("rmi", null, 0);

        JMXConnectorServer cs =

            JMXConnectorServerFactory.newJMXConnectorServer(url, null, mbs);

        cs.start();

        JMXServiceURL addr = cs.getAddress();

        JMXConnector cc = JMXConnectorFactory.connect(addr);

        MBeanServerConnection mbsc = cc.getMBeanServerConnection();

        NamedMXBeans namedMXBeans = new NamedMXBeans(mbsc);

        InvocationHandler ih =

            nullTest ? new MXBeanNullImplInvocationHandler(c, namedMXBeans) :

                       new MXBeanImplInvocationHandler(c, namedMXBeans);

        T impl = c.cast(Proxy.newProxyInstance(c.getClassLoader(),

                                               new Class[] {c},

                                               ih));

        ObjectName on = new ObjectName("test:type=" + c.getName());

        mbs.registerMBean(impl, on);

        System.out.println("Register any MXBeans...");

        Field[] fields = c.getFields();

        for (Field field : fields) {

            String n = field.getName();

            if (n.endsWith("ObjectName")) {

                String objectNameString = (String) field.get(null);

                String base = n.substring(0, n.length() - 10);

                Field f = c.getField(base);

                Object mxbean = f.get(null);

                ObjectName objectName =

                    ObjectName.getInstance(objectNameString);

                mbs.registerMBean(mxbean, objectName);

                namedMXBeans.put(objectName, mxbean);

            }

        }

        try {

            testInterface(c, mbsc, on, namedMXBeans, nullTest);

        } finally {

            try {

                cc.close();

            } finally {

                cs.stop();

            }

        }

    }

    private static <T> void testInterface(Class<T> c,

                                          MBeanServerConnection mbsc,

                                          ObjectName on,

                                          NamedMXBeans namedMXBeans,

                                          boolean nullTest)

            throws Exception {

        System.out.println("Type check...");

        MBeanInfo mbi = mbsc.getMBeanInfo(on);

        MBeanAttributeInfo[] mbais = mbi.getAttributes();

        for (int i = 0; i < mbais.length; i++) {

            MBeanAttributeInfo mbai = mbais[i];

            String name = mbai.getName();

            Field typeField = c.getField(name + "Type");

            OpenType typeValue = (OpenType) typeField.get(null);

            OpenType openType =

                (OpenType) mbai.getDescriptor().getFieldValue("openType");

            if (typeValue.equals(openType))

                success("attribute " + name);

            else {

                final String msg =

                    "Wrong type attribute " + name + ": " +

                    openType + " should be " + typeValue;

                failure(msg);

            }

        }

        MBeanOperationInfo[] mbois = mbi.getOperations();

        for (int i = 0; i < mbois.length; i++) {

            MBeanOperationInfo mboi = mbois[i];

            String oname = mboi.getName();

            if (!oname.startsWith("op"))

                throw new Error();

            OpenType retType =

                (OpenType) mboi.getDescriptor().getFieldValue("openType");

            MBeanParameterInfo[] params = mboi.getSignature();

            MBeanParameterInfo p1i = params[0];

            MBeanParameterInfo p2i = params[1];

            OpenType p1Type =

                (OpenType) p1i.getDescriptor().getFieldValue("openType");

            OpenType p2Type =

                (OpenType) p2i.getDescriptor().getFieldValue("openType");

            if (!retType.equals(p1Type) || !p1Type.equals(p2Type)) {

                final String msg =

                    "Parameter and return open types should all be same " +

                    "but are not: " + retType + " " + oname + "(" + p1Type +

                    ", " + p2Type + ")";

                failure(msg);

                continue;

            }

            String name = oname.substring(2);

            Field typeField = c.getField(name + "Type");

            OpenType typeValue = (OpenType) typeField.get(null);

            if (typeValue.equals(retType))

                success("operation " + oname);

            else {

                final String msg =

                    "Wrong type operation " + oname + ": " +

                    retType + " should be " + typeValue;

                failure(msg);

            }

        }

        System.out.println("Mapping check...");

        Object proxy =

            JMX.newMXBeanProxy(mbsc, on, c);

        Method[] methods = c.getMethods();

        for (int i = 0; i < methods.length; i++) {

            final Method method = methods[i];

            if (method.getDeclaringClass() != c)

                continue; // skip hashCode() etc inherited from Object

            final String mname = method.getName();

            final int what = getType(method);

            final String name = getName(method);

            final Field refField = c.getField(name);

            if (nullTest && refField.getType().isPrimitive())

                continue;

            final Field openTypeField = c.getField(name + "Type");

            final OpenType openType = (OpenType) openTypeField.get(null);

            final Object refValue = nullTest ? null : refField.get(null);

            Object setValue = refValue;

            try {

                Field onField = c.getField(name + "ObjectName");

                String refName = (String) onField.get(null);

                ObjectName refObjName = ObjectName.getInstance(refName);

                Class<?> mxbeanInterface = refField.getType();

                setValue = nullTest ? null :

                    JMX.newMXBeanProxy(mbsc, refObjName, mxbeanInterface);

            } catch (Exception e) {

                // no xObjectName field, setValue == refValue

            }

            boolean ok = true;

            try {

                switch (what) {

                case GET:

                    final Object gotOpen = mbsc.getAttribute(on, name);

                    if (nullTest) {

                        if (gotOpen != null) {

                            failure(mname + " got non-null value " +

                                    gotOpen);

                            ok = false;

                        }

                    } else if (!openType.isValue(gotOpen)) {

                        if (gotOpen instanceof TabularData) {

                            // detail the mismatch

                            TabularData gotTabular = (TabularData) gotOpen;

                            compareTabularType((TabularType) openType,

                                               gotTabular.getTabularType());

                        }

                        failure(mname + " got open data " + gotOpen +

                                " not valid for open type " + openType);

                        ok = false;

                    }

                    final Object got = method.invoke(proxy, (Object[]) null);

                    if (!equal(refValue, got, namedMXBeans)) {

                        failure(mname + " got " + string(got) +

                                ", should be " + string(refValue));

                        ok = false;

                    }

                    break;

                case SET:

                    method.invoke(proxy, new Object[] {setValue});

                    break;

                case OP:

                    final Object opped =

                        method.invoke(proxy, new Object[] {setValue, setValue});

                    if (!equal(refValue, opped, namedMXBeans)) {

                        failure(

                                mname + " got " + string(opped) +

                                ", should be " + string(refValue)

                                );

                        ok = false;

                    }

                    break;

                default:

                    throw new Error();

                }

                if (ok)

                    success(mname);

            } catch (Exception e) {

                failure(mname, e);

            }

        }

    }

    private static void success(String what) {

        System.out.println("OK: " + what);

    }

    private static void failure(String what) {

        System.out.println("FAILED: " + what);

        failures++;

    }

    private static void failure(String what, Exception e) {

        System.out.println("FAILED WITH EXCEPTION: " + what);

        e.printStackTrace(System.out);

        failures++;

    }

    private static class MXBeanImplInvocationHandler

            implements InvocationHandler {

        MXBeanImplInvocationHandler(Class intf, NamedMXBeans namedMXBeans) {

            this.intf = intf;

            this.namedMXBeans = namedMXBeans;

        }

        public Object invoke(Object proxy, Method method, Object[] args)

                throws Throwable {

            final String mname = method.getName();

            final int what = getType(method);

            final String name = getName(method);

            final Field refField = intf.getField(name);

            final Object refValue = getRefValue(refField);

            switch (what) {

            case GET:

                assert args == null;

                return refValue;

            case SET:

                assert args.length == 1;

                Object setValue = args[0];

                if (!equal(refValue, setValue, namedMXBeans)) {

                    final String msg =

                        mname + "(" + string(setValue) +

                        ") does not match ref: " + string(refValue);

                    throw new IllegalArgumentException(msg);

                }

                return null;