package org.apache.commons.beanutils2;

/*
 * 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
 *
 *     http://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.
 */

import static org.apache.commons.beanutils2.BeanUtils.on;
import static org.apache.commons.beanutils2.testbeans.TestBeanUtils.*;
import static org.junit.Assert.assertEquals;

import java.util.Map;

import org.apache.commons.beanutils2.testbeans.TestBean;
import org.junit.*;

public class CopyPropertiesTestCase
{

    private TestBean source;

    private ExtendedTestBean target;

    @Before
    public void setUp()
    {
        source = new TestBean();
        target = new ExtendedTestBean();
    }

    @After
    public void tearDown()
    {
        source = null;
        target = null;
    }

    @Test( expected = NullPointerException.class )
    public void copyPropertiesToNull()
        throws Exception
    {
        on( source ).copyPropertiesTo( null );
    }

    @Test
    public void copyPropertiesToTargetWithChangedScalarProperties()
        throws Exception
    {
        changeScalarProperties( target );
        on( source ).copyPropertiesTo( target );
        // we can not simply call assertEquals because of the nested properties in TestBean
        assertReadWritePropertiesEquals( source, target );
        assertExtendedPropertiesUnchanged();
    }

    private void assertExtendedPropertiesUnchanged()
    {
        ExtendedTestBean expected = new ExtendedTestBean();
        assertEquals( expected.extendedBooleanProperty, target.extendedBooleanProperty );
        assertEquals( expected.extendedReadOnlyProperty, target.extendedReadOnlyProperty );
        assertEquals( expected.extendedStringProperty, target.extendedStringProperty );
    }

    @Test
    public void copyPropertiesToTargetWithChangedArrayProperties()
        throws Exception
    {
        changeArrayProperties( target );
        on( source ).copyPropertiesTo( target );
        assertReadWritePropertiesEquals( source, target );
        assertExtendedPropertiesUnchanged();
    }

    /**
     * Makes sure that copy properties has the same effect as populate, if source and target are of the same type
     */
    @Test
    public void copyPropertiesToSameAsPopulate()
        throws Exception
    {
        changeScalarProperties( source );
        changeArrayProperties( source );
        Map<String, Object> sourceProperties = on( source ).describe();

        TestBean targetForCopyProperties = new TestBean();
        TestBean targetForPopulate = new TestBean();

        on( source ).copyPropertiesTo( targetForCopyProperties );
        on( targetForPopulate ).populate( sourceProperties );

        assertReadWritePropertiesEquals( source, targetForCopyProperties );
        assertReadWritePropertiesEquals( source, targetForPopulate );
        assertReadWritePropertiesEquals( targetForCopyProperties, targetForPopulate );
    }

    /**
     * Makes sure, that coping properties does not change the source
     */
    @Test
    public void copyPropertiesToTargetNotChangingSource()
        throws Exception
    {
        Map<String, Object> propertiesBefore = on( source ).describe();
        on( source ).copyPropertiesTo( target );
        Map<String, Object> propertiesAfter = on( source ).describe();

        assertEquals( propertiesBefore, propertiesAfter );
    }

    /**
     * Makes sure, that properties are copied shallow. In other words, that complex properties like nested beans will
     * only be referenced from target and not copied.
     */
    @Test
    public void copyPropertiesToTargetIsShallow() throws Exception {
        on( source ).copyPropertiesTo( target );

        assertShallow(source, target);
    }

    @SuppressWarnings( "unused" ) // unused methods invoked via introspection
    private static class ExtendedTestBean
        extends TestBean
    {

        private static final long serialVersionUID = 4854743778089894313L;

        private boolean extendedBooleanProperty = true;

        private final String extendedReadOnlyProperty = "extended read only property";

        private String extendedStringProperty = "extended string property";

        public boolean getExtendedBooleanProperty()
        {
            return extendedBooleanProperty;
        }

        public void setExtendedBooleanProperty( boolean booleanProperty )
        {
            extendedBooleanProperty = booleanProperty;
        }

        public String getExtendedReadOnlyProperty()
        {
            return extendedReadOnlyProperty;
        }

        public String getExtendedStringProperty()
        {
            return extendedStringProperty;
        }

        public void setExtendedStringProperty( String stringProperty )
        {
            extendedStringProperty = stringProperty;
        }

    }

}