PaxWicketIntegrationTest.java

/**
 * Copyright OPS4J
 *
 * 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.ops4j.pax.wicket.it;

import static org.junit.Assert.assertNotNull;
import static org.ops4j.pax.exam.CoreOptions.frameworkProperty;
import static org.ops4j.pax.exam.CoreOptions.junitBundles;
import static org.ops4j.pax.exam.CoreOptions.mavenBundle;
import static org.ops4j.pax.exam.CoreOptions.options;
import static org.ops4j.pax.exam.CoreOptions.provision;
import static org.ops4j.pax.exam.CoreOptions.systemProperty;

import org.ops4j.pax.exam.Option;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.framework.ServiceReference;

public abstract class PaxWicketIntegrationTest {

    protected static final String WEBUI_PORT = "9081";
    protected static final String LOG_LEVEL = "WARN";
    protected static final String SYMBOLIC_NAME_PAX_WICKET_SERVICE = "org.ops4j.pax.wicket.service";

    public final Option[] configureProvisions() {
        return options(
            provision(mavenBundle().groupId("org.apache.felix").artifactId("org.apache.felix.eventadmin")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.felix").artifactId("org.apache.felix.configadmin")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.felix").artifactId("org.apache.felix.scr")
                        .versionAsInProject().startLevel(1).start(true)),
            provision(mavenBundle().groupId("org.apache.geronimo.specs").artifactId("geronimo-activation_1.1_spec")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.geronimo.specs").artifactId("geronimo-servlet_2.5_spec")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.geronimo.specs").artifactId("geronimo-jta_1.1_spec")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.servicemix.bundles")
                .artifactId("org.apache.servicemix.bundles.javax.mail").versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.servicemix.bundles")
                .artifactId("org.apache.servicemix.bundles.asm")
                .versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-util").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-io").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-http").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-continuation").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-server").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-security").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-servlet").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-xml").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-jndi").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-plus").versionAsInProject()),
            provision(mavenBundle().groupId("org.eclipse.jetty").artifactId("jetty-webapp").versionAsInProject()),
            provision(mavenBundle().groupId("org.ops4j.pax.web").artifactId("pax-web-api").versionAsInProject()),
            provision(mavenBundle().groupId("org.ops4j.pax.web").artifactId("pax-web-spi").versionAsInProject()),
            provision(mavenBundle().groupId("org.ops4j.pax.web").artifactId("pax-web-runtime").versionAsInProject()),
            provision(mavenBundle().groupId("org.ops4j.pax.web").artifactId("pax-web-jetty").versionAsInProject()),
            provision(mavenBundle().groupId("org.apache.servicemix.bundles")
                .artifactId("org.apache.servicemix.bundles.cglib")
                .versionAsInProject()),
            junitBundles(),
            frameworkProperty("osgi.console").value("6666"),
            systemProperty("org.ops4j.pax.logging.DefaultServiceLog.level").value("INFO"),
            systemProperty("org.osgi.service.http.port").value(WEBUI_PORT));
    }

    /**
     * Return bundle given the symbolic name. Returns {@code null} if not found.
     *
     * @param bundleContext Bundle context. This argument must not be {@code null}.
     * @param symbolicName Bundle symbolic name. This argument must not be {@code null}.
     *
     * @return The bundle given the symbolic name.
     *
     * @since 0.5.5
     */
    protected final Bundle getBundleBySymbolicName(BundleContext bundleContext, String symbolicName) {
        Bundle[] bundles = bundleContext.getBundles();
        for (Bundle bundle : bundles) {
            String bundleSymbolicName = bundle.getSymbolicName();
            if (bundleSymbolicName.equals(symbolicName)) {
                return bundle;
            }
        }
        return null;
    }

    /**
     * Returns the pax wicket service bundle.
     *
     * @param bundleContext Bundle context. This argument must not be {@code null}.
     *
     * @return The pax wicket service bundle.
     *
     * @since 0.5.5
     */
    protected final Bundle getPaxWicketServiceBundle(BundleContext bundleContext) {
        Bundle paxWicketBundle = getBundleBySymbolicName(bundleContext, SYMBOLIC_NAME_PAX_WICKET_SERVICE);
        assertNotNull(paxWicketBundle);
        return paxWicketBundle;
    }
    
    /**
     * @param services
     * @return returns a String representation of the given service references printing there {@link Constants#OBJECTCLASS} property
     */
    protected String buildServiceGraph(ServiceReference[] services) {
        if (services == null) {
            return "(no services)";
        }
        StringBuilder sb = new StringBuilder("PAX Wicket Bundle services: ");
        for (ServiceReference serviceReference : services) {
            sb.append(" ");
            Object property = serviceReference.getProperty(Constants.OBJECTCLASS);
            if (property instanceof String[]) {
                String[] strings = (String[]) property;
                sb.append("[");
                for (int i = 0; i < strings.length; i++) {
                    if (i > 0) {
                        sb.append(", ");
                    }
                    sb.append(strings[i]);    
                }
                sb.append("]");
            }
        }
        return sb.toString();
    }
    
    /**
     * @param services
     * @param serviceClass
     * @return <code>true</code> if the {@link ServiceReference}s contain a
     *         service with the given Objectclass
     */
    protected boolean containsService(ServiceReference[] services, Class<?> serviceClass) {
        if (services != null) {
            for (ServiceReference serviceReference : services) {
                Object property = serviceReference.getProperty(Constants.OBJECTCLASS);
                if (property instanceof String[]) {
                    String[] strings = (String[]) property;
                    for (String string : strings) {
                        if (string.equals(serviceClass.getName())) {
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    }
}