FluentPropertyBeanIntrospectorTest.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.commons.beanutils2;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.beans.IntrospectionException;
import java.beans.PropertyDescriptor;
import java.net.URI;
import java.util.HashMap;
import java.util.Map;

import org.junit.jupiter.api.Test;

/**
 * Test class for {@code FluentPropertyBeanIntrospector}.
 */
class FluentPropertyBeanIntrospectorTest {
    public static final class CapsBean {
        private URI mURI;

        public URI getURI() {
            return mURI;
        }

        public void setURI(final URI theURI) {
            mURI = theURI;
        }
    }

    public static final class MixedSetterBean {
        public static void setMixed(final Integer v) {
            // static setter should be ignored
        }

        private String value;

        public String getMixed() {
            return value;
        }

        public MixedSetterBean setMixed(final String v) {
            this.value = v;
            return this;
        }
    }

    public static final class StaticSetterBean {
        private static String staticValue;

        public static void setStaticOnly(final String value) {
            staticValue = value;
        }

        public static StaticSetterBean setStaticProperty(final String value) {
            staticValue = value;
            return new StaticSetterBean();
        }

        public String getStaticProperty() {
            return staticValue;
        }
    }

    /**
     * Puts all property descriptors into a map so that they can be accessed by property name.
     *
     * @param descs The array with descriptors
     * @return A map with property names as keys
     */
    private static Map<String, PropertyDescriptor> createDescriptorMap(final PropertyDescriptor[] descs) {
        final Map<String, PropertyDescriptor> map = new HashMap<>();
        for (final PropertyDescriptor pd : descs) {
            map.put(pd.getName(), pd);
        }
        return map;
    }

    /**
     * Convenience method for obtaining a specific property descriptor and checking whether it exists.
     *
     * @param props The map with property descriptors
     * @param name  The name of the desired descriptor
     * @return The descriptor from the map
     */
    private static PropertyDescriptor fetchDescriptor(final Map<String, PropertyDescriptor> props, final String name) {
        assertTrue(props.containsKey(name), "Property not found: " + name);
        return props.get(name);
    }

    /**
     * Tries to create an instance without a prefix for write methods.
     */
    @Test
    void testInitNoPrefix() {
        assertThrows(NullPointerException.class, () -> new FluentPropertyBeanIntrospector(null));
    }

    /**
     * Tests whether correct property descriptors are detected.
     */
    @Test
    void testIntrospection() throws IntrospectionException {
        final PropertyUtilsBean pu = new PropertyUtilsBean();
        final FluentPropertyBeanIntrospector introspector = new FluentPropertyBeanIntrospector();
        pu.addBeanIntrospector(introspector);
        final Map<String, PropertyDescriptor> props = createDescriptorMap(pu.getPropertyDescriptors(FluentIntrospectionTestBean.class));
        PropertyDescriptor pd = fetchDescriptor(props, "name");
        assertNotNull(pd.getReadMethod(), "No read method for name");
        assertNotNull(pd.getWriteMethod(), "No write method for name");
        fetchDescriptor(props, "stringProperty");
        pd = fetchDescriptor(props, "fluentProperty");
        assertNull(pd.getReadMethod(), "Read method for fluentProperty");
        assertNotNull(pd.getWriteMethod(), "No write method for fluentProperty");
        pd = fetchDescriptor(props, "fluentGetProperty");
        assertNotNull(pd.getReadMethod(), "No read method for fluentGetProperty");
        assertNotNull(pd.getWriteMethod(), "No write method for fluentGetProperty");
    }

    @Test
    void testIntrospectionCaps() throws Exception {
        final PropertyUtilsBean pu = new PropertyUtilsBean();

        final FluentPropertyBeanIntrospector introspector = new FluentPropertyBeanIntrospector();

        pu.addBeanIntrospector(introspector);

        final Map<String, PropertyDescriptor> props = createDescriptorMap(pu.getPropertyDescriptors(CapsBean.class));

        final PropertyDescriptor aDescriptor = fetchDescriptor(props, "URI");

        assertNotNull(aDescriptor, "missing property");

        assertNotNull(aDescriptor.getReadMethod(), "No read method for uri");
        assertNotNull(aDescriptor.getWriteMethod(), "No write method for uri");

        assertNull(props.get("uRI"), "Should not find mis-capitalized property");
    }

    /**
     * Tests that an instance setter is used when a static setter with the same name exists.
     */
    @Test
    void testIntrospectionMixedStaticInstanceSetter() throws Exception {
        final PropertyUtilsBean pu = new PropertyUtilsBean();
        pu.addBeanIntrospector(new FluentPropertyBeanIntrospector());
        final Map<String, PropertyDescriptor> props = createDescriptorMap(pu.getPropertyDescriptors(MixedSetterBean.class));
        final PropertyDescriptor pd = fetchDescriptor(props, "mixed");
        assertNotNull(pd.getReadMethod(), "No read method for mixed");
        assertNotNull(pd.getWriteMethod(), "Instance setter should be found");
        assertFalse(java.lang.reflect.Modifier.isStatic(pd.getWriteMethod().getModifiers()), "Write method should not be static");
        assertTrue(pu.isWriteable(new MixedSetterBean(), "mixed"), "mixed should be writeable");
    }

    /**
     * Tests that static methods are not treated as write methods.
     */
    @Test
    void testIntrospectionStaticMethods() throws Exception {
        final PropertyUtilsBean pu = new PropertyUtilsBean();
        pu.addBeanIntrospector(new FluentPropertyBeanIntrospector());
        final Map<String, PropertyDescriptor> props = createDescriptorMap(pu.getPropertyDescriptors(StaticSetterBean.class));
        assertNull(props.get("staticOnly"), "Property created from static method");
        final PropertyDescriptor pd = fetchDescriptor(props, "staticProperty");
        assertNotNull(pd.getReadMethod(), "No read method for staticProperty");
        assertNull(pd.getWriteMethod(), "Static method used as write method");
        assertFalse(pu.isWriteable(new StaticSetterBean(), "staticProperty"), "staticProperty is writeable");
    }
}