src/test/java/org/apache/commons/beanutils2/MappedPropertyTest.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.assertEquals;
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 java.beans.IntrospectionException;

import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;

/**
 * <p>
 * Test Case for the {@code MappedPropertyDescriptor}.
 * </p>
 */
class MappedPropertyTest {

    /**
     * Sets up instance variables required by this test case.
     */
    @BeforeEach
    public void setUp() throws Exception {
    }

    /**
     * Tear down instance variables required by this test case.
     */
    @AfterEach
    public void tearDown() {
    }

    /**
     * Test property with any two args
     */
    @Test
    void testAnyArgsProperty() throws Exception {
        final String property = "anyMapped";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNull(desc.getMappedReadMethod(), "Getter is found");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test boolean "is" method name
     */
    @Test
    void testBooleanMapped() throws Exception {
        final String property = "mappedBoolean";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test Interface Inherited mapped property
     */
    @Test
    void testChildInterfaceMapped() throws Exception {
        final String property = "mapproperty";
        final Class<?> clazz = MappedPropertyChildInterface.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test Mapped Property - Different Types
     *
     * Expect to find the getDifferentTypes() method, but not the setDifferentTypes() method because setDifferentTypes() sets and Integer, while
     * getDifferentTypes() returns a Long.
     */
    @Test
    void testDifferentTypes() throws Exception {
        final String property = "differentTypes";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNull(desc.getMappedWriteMethod(), "Setter is found");
    }

    /**
     * Test valid method name
     */
    @Test
    void testFound() throws Exception {
        final String property = "mapproperty";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test Interface with mapped property
     */
    @Test
    void testInterfaceMapped() throws Exception {
        final String property = "mapproperty";
        final Class<?> clazz = MappedPropertyTestInterface.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test property not found in interface
     */
    @Test
    void testInterfaceNotFound() {
        final String property = "XXXXXX";
        final Class<?> clazz = MappedPropertyTestInterface.class;
        assertThrows(IntrospectionException.class, () -> new MappedPropertyDescriptor(property, clazz));
    }

    /**
     * Test Mapped Property - Invalid Getter
     */
    @Test
    void testInvalidGetter() throws Exception {
        final String property = "invalidGetter";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNull(desc.getMappedReadMethod(), "Getter is found");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test Mapped Property - Invalid Setter
     */
    @Test
    void testInvalidSetter() throws Exception {
        final String property = "invalidSetter";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNull(desc.getMappedWriteMethod(), "Setter is found");
    }

    /**
     * Test Map getter
     */
    @Test
    void testMapGetter() throws Exception {
        final MappedPropertyTestBean bean = new MappedPropertyTestBean();
        final String testValue = "test value";
        final String testKey = "testKey";
        BeanUtils.setProperty(bean, "myMap(" + testKey + ")", "test value");
        assertEquals(testValue, bean.getMyMap().get(testKey), "Map getter");
    }

    /**
     * Test Mapped Property - Getter only
     */
    @Test
    void testMappedGetterOnly() throws Exception {
        final String property = "mappedGetterOnly";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNull(desc.getMappedWriteMethod(), "Setter is found");
    }

    /**
     * Test Mapped Property - Setter Only
     */
    @Test
    void testMappedSetterOnly() throws Exception {
        final String property = "mappedSetterOnly";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNull(desc.getMappedReadMethod(), "Getter is found");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test invalid method name
     */
    @Test
    void testNotFound() {
        final String property = "xxxxxxx";
        final Class<?> clazz = MappedPropertyTestBean.class;
        assertThrows(IntrospectionException.class, () -> new MappedPropertyDescriptor(property, clazz));
    }

    /**
     * Test property with two primitive args
     */
    @Test
    void testPrimitiveArgsProperty() throws Exception {
        final String property = "mappedPrimitive";
        final Class<?> clazz = MappedPropertyTestBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNull(desc.getMappedReadMethod(), "Getter is found");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }

    /**
     * Test 'protected' mapped property
     */
    @Test
    void testProtected() {
        final String property = "protectedProperty";
        final Class<?> clazz = MappedPropertyTestBean.class;
        assertThrows(IntrospectionException.class, () -> new MappedPropertyDescriptor(property, clazz));
    }

    /**
     * Test 'protected' method in parent
     */
    @Test
    void testProtectedParentMethod() {
        final String property = "protectedMapped";
        final Class<?> clazz = MappedPropertyChildBean.class;
        assertThrows(IntrospectionException.class, () -> new MappedPropertyDescriptor(property, clazz));
    }

    /**
     * Test 'public' method in parent
     */
    @Test
    void testPublicParentMethod() throws Exception {
        final String property = "mapproperty";
        final Class<?> clazz = MappedPropertyChildBean.class;
        final MappedPropertyDescriptor desc = new MappedPropertyDescriptor(property, clazz);
        assertNotNull(desc.getMappedReadMethod(), "Getter is missing");
        assertNotNull(desc.getMappedWriteMethod(), "Setter is missing");
    }
}