src/test/org/apache/fulcrum/yaafi/framework/factory/ServiceContainerFactoryTest.java

package org.apache.fulcrum.yaafi.framework.factory;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.fail;

/*
 * 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 java.io.File;
import java.io.IOException;

import org.apache.avalon.framework.configuration.Configuration;
import org.apache.avalon.framework.configuration.ConfigurationUtil;
import org.apache.avalon.framework.configuration.DefaultConfigurationBuilder;
import org.apache.avalon.framework.context.DefaultContext;
import org.apache.avalon.framework.service.ServiceException;
import org.apache.fulcrum.yaafi.TestComponent;
import org.apache.fulcrum.yaafi.framework.container.ServiceContainer;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;

/**
 * Test suite for the ServiceContainerFactory.
 *
 * @author <a href="mailto:siegfried.goeschl@it20one.at">Siegfried Goeschl</a>
 */

public class ServiceContainerFactoryTest
{
    private ServiceContainer container = null;

    @AfterEach
    protected void tearDown() throws Exception
    {
        ServiceContainerFactory.dispose( this.container );
    }

    /**
     * @throws Exception generic exception
     */
    private void checkTestComponent() throws Exception
    {
        TestComponent testComponent = this.getTestComponent();

        testComponent.test();

        assertEquals( testComponent.getBar(), "BAR" );
        assertEquals( testComponent.getFoo(), "FOO" );

        assertNotNull( testComponent.getUrnAvalonClassLoader() );
        assertNotNull( testComponent.getUrnAvaloneHome() );
        assertNotNull( testComponent.getUrnAvaloneTemp() );
        assertNotNull( testComponent.getUrnAvalonName() );
        assertNotNull( testComponent.getUrnAvalonPartition() );

        try
        {
            testComponent.createException( "enforce exception", this );
        } catch (Exception e)
        {
            // nothing to do
        }
    }

    /**
     * @return get our simple test component
     * @throws ServiceException if service not found
     */
    private TestComponent getTestComponent() throws ServiceException
    {
        return (TestComponent) container.lookup( TestComponent.ROLE );
    }

    /**
     * Creates a YAAFI container using a container configuration file which already contains
     * most of the required settings
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testCreationWithContainerConfiguration() throws Exception
    {
        ServiceContainerConfiguration config = new ServiceContainerConfiguration();
        config.loadContainerConfiguration( "./src/test/TestYaafiContainerConfig.xml" );
        this.container = ServiceContainerFactory.create( config );
        this.checkTestComponent();
        System.out.println( this.container.toString() );
        return;
    }

    /**
     * Creates a YAAFI container using a non-existent container configuration file. Therefore
     * the creation should fail.
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testCreationWithMissingContainerConfiguration() throws Exception
    {
        ServiceContainerConfiguration config = new ServiceContainerConfiguration();

        try
        {
            config.loadContainerConfiguration( "./src/test/MissingTestContainerConfig.xml" );
            this.container = ServiceContainerFactory.create( config );
            fail( "The creation of the YAAFI container must fail" );
        } catch (IOException e)
        {
            // nothing to do
        } catch (Exception e)
        {
            fail( "We are expecting an IOException" );
        }
    }

    /**
     * Creates a YAAFI container providing all required settings manually
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testCreationWithManualSettings() throws Exception
    {
        ServiceContainerConfiguration config = new ServiceContainerConfiguration();
        config.setComponentRolesLocation( "./src/test/TestRoleConfig.xml" );
        config.setComponentConfigurationLocation( "./src/test/TestComponentConfig.xml" );
        config.setParametersLocation( "./src/test/TestParameters.properties" );
        this.container = ServiceContainerFactory.create( config );
        this.checkTestComponent();
    }

    /**
     * Creates a YAAFI container providing a Phoenix context
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testCreationWithPhoenixContext() throws Exception
    {
        ServiceContainerConfiguration config = new ServiceContainerConfiguration();
        DefaultContext context = new DefaultContext();

        // use an existing container configuration

        config.loadContainerConfiguration( "./src/test/TestPhoenixContainerConfig.xml" );

        // fill the context with Phoenix settings

        context.put( "app.name", "ServiceContainerFactoryTest" );
        context.put( "block.name", "fulcrum-yaafi" );
        context.put( "app.home", new File( new File( "" ).getAbsolutePath() ) );

        // create an instance

        this.container = ServiceContainerFactory.create( config, context );

        // execute the test component

        this.checkTestComponent();
    }

    /**
     * Creates a YAAFI container providing a Fortress context
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testCreationWithFortressContext() throws Exception
    {
        ServiceContainerConfiguration config = new ServiceContainerConfiguration();
        DefaultContext context = new DefaultContext();

        // use an existing container configuration

        config.loadContainerConfiguration( "./src/test/TestFortressContainerConfig.xml" );

        // fill the context with Fortress settings

        context.put( "component.id", "ServiceContainerFactoryTest" );
        context.put( "component.logger", "fulcrum-yaafi" );
        context.put( "context-root", new File( new File( "" ).getAbsolutePath() ) );
        context.put( "impl.workDir", new File( new File( "" ).getAbsolutePath() ) );

        // create an instance

        this.container = ServiceContainerFactory.create( config, context );

        // execute the test component

        this.checkTestComponent();
    }

    /**
     * Reconfigures the YAAFI container with the "TestReconfigurationConfig.xml"
     * 
     * @throws Exception generic exception
     */
    @Test
    public void testReconfiguration() throws Exception
    {
        // create a YAAFI instance

        ServiceContainerConfiguration config = new ServiceContainerConfiguration();
        config.loadContainerConfiguration( "./src/test/TestYaafiContainerConfig.xml" );
        this.container = ServiceContainerFactory.create( config );
        this.checkTestComponent();

        // load a different configuration and reconfigure YAAFI

        DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder();
        Configuration configuration = builder.buildFromFile( "./src/test/TestReconfigurationConfig.xml" );
        System.out.println( ConfigurationUtil.toString( configuration ) );

        this.container.reconfigure( configuration );
        TestComponent testComponent = this.getTestComponent();
        testComponent.test();

        // the TestReconfigurationConfig.xml overwrites the
        // TestComponentImpl.foo and the SystemProperty.FOO

        assertEquals( System.getProperty( "FOO" ), "YAAFI" );
        assertEquals( testComponent.getFoo(), "YAAFI" );

    }
}