/**
 * Copyright 2010 JBoss Inc
 *
 * 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.drools.osgi.test;

import org.drools.osgi.test.utils.EclipseWorkspaceArtifactLocator;
import org.osgi.framework.BundleContext;
import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import org.springframework.osgi.test.AbstractConfigurableBundleCreatorTests;
import org.springframework.osgi.test.platform.OsgiPlatform;
import org.springframework.osgi.test.provisioning.ArtifactLocator;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;

/**
 * Abstract Base Class for JUnit Tests in a OSGI Environment
 * 
 * @author Frederic Conrotte
 * @author Jan Blanckenhorn
 */

public abstract class AbstractDroolsSpringDMTest extends AbstractConfigurableBundleCreatorTests {
    private static final String TEST_FRAMEWORK_BUNDLES_CONF_FILE = "/boot-bundles.properties";
    private ArtifactLocator     m_MavenArtifactLocator, m_EclipseArtifactLocator;
    
    @Override
    protected boolean createManifestOnlyFromTestClass() {
        return false;
    }
    
    protected void onSetUp() throws Exception
    {

    }
    
    @Override
    protected void preProcessBundleContext(BundleContext platformBundleContext) throws Exception {
        try { 
            super.preProcessBundleContext( platformBundleContext );
        } catch( Exception e ) {
            throw e;
        }
    }
    
    @Override
    protected void postProcessBundleContext(BundleContext context) throws Exception {
        try { 
            super.postProcessBundleContext( context );
        } catch( Exception e ) {
            throw e;
        }
    }

    @Override
    /*
     * define OSGI/Equinox Properties which are set while starting up OSGI
     */
    protected OsgiPlatform createPlatform() {
        System.setProperty( "osgi.console",
                            "9000" );
        System.setProperty( "osgi.framework.extensions",
                            "osgi.framework.extensions" );
        return super.createPlatform();
    }

    @Override
    protected Resource getTestingFrameworkBundlesConfiguration() {
        return new InputStreamResource( AbstractDroolsSpringDMTest.class.getResourceAsStream( TEST_FRAMEWORK_BUNDLES_CONF_FILE ) );
    }

    /**
     * Use Eclipse artifact locator as default, falls back on Maven artifact
     * locator in artifact is not found.
     */
    protected Resource locateBundle(String bundleId) {
        Assert.hasText( bundleId,
                        "bundleId should not be empty" );        
        
        Resource result = null;

        // parse the String
        String[] artifactId = StringUtils.commaDelimitedListToStringArray( bundleId );
        
        Assert.isTrue( artifactId.length >= 3,
                       "the CSV string " + bundleId + " contains too few values" );
        // TODO: add a smarter mechanism which can handle 1 or 2 values CSVs
        for ( int i = 0; i < artifactId.length; i++ ) {
            artifactId[i] = StringUtils.trimWhitespace( artifactId[i] );
        }

        if ( m_EclipseArtifactLocator == null ) m_EclipseArtifactLocator = new EclipseWorkspaceArtifactLocator();

        result = (artifactId.length == 3 ? m_EclipseArtifactLocator.locateArtifact( artifactId[0],
                                                                                    artifactId[1],
                                                                                    artifactId[2] ) : m_EclipseArtifactLocator.locateArtifact( artifactId[0],
                                                                                                                                               artifactId[1],
                                                                                                                                               artifactId[2],
                                                                                                                                               artifactId[3] ));

        if ( result == null ) {
            if ( m_MavenArtifactLocator == null ) m_MavenArtifactLocator = getLocator();

            result = (artifactId.length == 3 ? m_MavenArtifactLocator.locateArtifact( artifactId[0],
                                                                                      artifactId[1],
                                                                                      artifactId[2] ) : m_MavenArtifactLocator.locateArtifact( artifactId[0],
                                                                                                                                               artifactId[1],
                                                                                                                                               artifactId[2],
                                                                                                                                               artifactId[3] ));
        }

        if ( result == null ) throw new IllegalStateException( bundleId + " not found" );

        return result;
    }

}