# AbstractQi4jScenarioTest.java

    /*
     * Copyright (c) 2008, Rickard Öberg. All Rights Reserved.
     *
     * Licensed 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.
     *
     */

    package org.qi4j.test;

    import org.junit.AfterClass;
    import org.junit.BeforeClass;
    import org.qi4j.api.Qi4j;
    import org.qi4j.api.structure.Application;
    import org.qi4j.api.structure.ApplicationDescriptor;
    import org.qi4j.api.structure.Module;
    import org.qi4j.api.unitofwork.UnitOfWork;
    import org.qi4j.bootstrap.ApplicationAssembler;
    import org.qi4j.bootstrap.ApplicationAssembly;
    import org.qi4j.bootstrap.ApplicationAssemblyFactory;
    import org.qi4j.bootstrap.Assembler;
    import org.qi4j.bootstrap.AssemblyException;
    import org.qi4j.bootstrap.Energy4Java;
    import org.qi4j.spi.Qi4jSPI;

    /**
     * Base class for Zest scenario tests. This will create one Zest application per class instead of per test.
     */
    public abstract class AbstractQi4jScenarioTest
        implements Assembler
    {
        static protected Qi4j api;
        static protected Qi4jSPI spi;

        static protected Energy4Java qi4j;
        static protected ApplicationDescriptor applicationModel;
        static protected Application application;

        static protected Module module;

        static protected Assembler assembler; // Initialize this in static block of subclass

        @BeforeClass
        public static void setUp()
            throws Exception
        {
            qi4j = new Energy4Java();
            applicationModel = newApplication();
            if( applicationModel == null )
            {
                // An AssemblyException has occurred that the Test wants to check for.
                return;
            }
            application = applicationModel.newInstance( qi4j.spi() );
            initApplication( application );
            api = spi = qi4j.spi();
            application.activate();

            // Assume only one module
            module = application.findModule( "Layer 1", "Module 1" );
        }

        static protected ApplicationDescriptor newApplication()
            throws AssemblyException
        {
            final Assembler asm = assembler;

            ApplicationAssembler assembler = new ApplicationAssembler()
            {
                @Override
                public ApplicationAssembly assemble( ApplicationAssemblyFactory applicationFactory )
                    throws AssemblyException
                {
                    return applicationFactory.newApplicationAssembly( asm );
                }
            };
            try
            {
                return qi4j.newApplicationModel( assembler );
            }
            catch( AssemblyException e )
            {
                assemblyException( e );
                return null;
            }
        }

        /**
         * This method is called when there was an AssemblyException in the creation of the Zest application model.
         * <p>
         * Override this method to catch valid failures to place into satisfiedBy suites.
         * </p>
         *
         * @param exception the exception thrown.
         *
         * @throws org.qi4j.bootstrap.AssemblyException The default implementation of this method will simply re-throw the exception.
         */
        static protected void assemblyException( AssemblyException exception )
            throws AssemblyException
        {
            throw exception;
        }

        static protected void initApplication( Application app )
            throws Exception
        {
        }

        @AfterClass
        public void tearDown()
            throws Exception
        {
            if( module != null && module.isUnitOfWorkActive() )
            {
                while( module.isUnitOfWorkActive() )
                {
                    UnitOfWork uow = module.currentUnitOfWork();
                    if( uow.isOpen() )
                    {
                        uow.discard();
                    }
                    else
                    {
                        throw new InternalError( "I have seen a case where a UoW is on the stack, but not opened. First is" + uow
                            .usecase()
                            .name() );
                    }
                }
                new Exception( "UnitOfWork not properly cleaned up" ).printStackTrace();
            }

            if( application != null )
            {
                application.passivate();
            }
        }
    }