TestConfigIntegration.java

/*
 * 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.
 */
package org.apache.tamaya.integration.osgi;

import org.apache.log4j.Priority;
import org.apache.tamaya.ConfigurationProvider;
import org.apache.tamaya.functions.ConfigurationFunctions;
import org.apache.tamaya.inject.ConfigurationInjection;
import org.apache.tamaya.spi.ServiceContext;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.OperateOnDeployment;
import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;
import org.jboss.osgi.metadata.OSGiManifestBuilder;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.asset.Asset;
import org.jboss.shrinkwrap.api.importer.ZipImporter;
import org.jboss.shrinkwrap.api.spec.JavaArchive;
import org.jboss.shrinkwrap.resolver.api.maven.Maven;
import org.junit.Before;
import org.junit.Ignore;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.osgi.framework.*;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;
import org.osgi.util.tracker.ServiceTracker;

import java.io.File;
import java.io.InputStream;
import java.net.URL;
import java.util.Dictionary;
import java.util.Hashtable;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;

@RunWith(Arquillian.class)
public class TestConfigIntegration{

    private static final String TAMAYA_VERSION = "0.3-incubating-SNAPSHOT";

    static{
        System.setProperty("[bundle:tamaya]systemTestKey", "foo");
        System.setProperty("org.osgi.framework.bootdelegation", "org.apache.tamaya");
    }


    @ArquillianResource BundleContext context;

    //////////////////////////////////////////////////////// Test setup //////////////////////////////////

    @Deployment(name="default", order=100)
    public static JavaArchive createdeployment() {
        final JavaArchive archive = ShrinkWrap.create(JavaArchive.class, "tamaya-osgi-general.jar");
        archive.setManifest(new Asset() {
            public InputStream openStream() {
                OSGiManifestBuilder builder = OSGiManifestBuilder.newInstance();
                builder.addBundleSymbolicName(archive.getName());
                builder.addBundleManifestVersion(2);
                builder.addImportPackages("org.junit", "org.apache.tamaya", "org.apache.tamaya.spi",
                        "org.apache.tamaya.core", "org.osgi.service.cm");
                builder.addImportPackages(ServiceContext.class, ConfigurationProvider.class, ConfigurationAdmin.class,
                        ServiceTracker.class, ConfigurationFunctions.class, ConfigurationInjection.class);
                builder.addBundleActivator(Activator.class);
                return builder.openStream();
            }
        });
        archive.addClasses(Test.class, TestConfigIntegration.class, Priority.class, Activator.class,
                            TamayaConfigAdminImpl.class, TamayaConfigurationImpl.class, OSGIConfigRootMapper.class,
                HelloService.class, HelloServiceImpl.class);
        URL config = ClassLoader.getSystemClassLoader().getResource("META-INF/javaconfiguration.properties");
        archive.addAsResource(config, "META-INF/javaconfiguration.properties");
        return archive;
    }

    @Deployment(name="felix.main", order=1)
    public static JavaArchive deployMain() {
        return ShrinkWrap.create(ZipImporter.class, "felix.main-5.4.0.jar")
                .importFrom(getBundleFile("org.apache.felix:org.apache.felix.main:5.4.0"))
                .as(JavaArchive.class);
    }

    @Deployment(name="osgi.config", order=1)
    public static JavaArchive deployOSGIConfig() {
        return ShrinkWrap.create(ZipImporter.class, "felix.configadmin-1.8.8.jar")
                .importFrom(getBundleFile("org.apache.felix:org.apache.felix.configadmin:1.8.8"))
                .as(JavaArchive.class);
    }

    @Deployment(name="javax.annotation",order=4)
    public static JavaArchive deployJavaxAnnotation() {
        return ShrinkWrap.create(ZipImporter.class, "javax.annotation.jar")
                .importFrom(getBundleFile("org.apache.geronimo.specs:geronimo-annotation_1.2_spec:1.0-alpha-1"))
                .as(JavaArchive.class);
    }

    @Deployment(name="tamaya-api", order=5)
    public static JavaArchive deployTamayaAPI() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-api.jar")
                .importFrom(getBundleFile("org.apache.tamaya:tamaya-api:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

    @Deployment(name="tamaya-core", order=6)
    public static JavaArchive deployTamayaCore() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-core.jar")
                .importFrom(getBundleFile("org.apache.tamaya:tamaya-core:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

    @Deployment(name="tamaya-functions",order=7)
    public static JavaArchive deployTamayaFunctions() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-functions.jar")
                .importFrom(getBundleFile("org.apache.tamaya.ext:tamaya-functions:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

//    @Deployment(name="java.atInject",order=8)
//    public static JavaArchive deployAtInject() {
//        return ShrinkWrap.create(ZipImporter.class, "java.atinject.jar")
//                .importFrom(getBundleFile("org.apache.geronimo.specs:geronimo-atinject_1.0_spec:1.0"))
//                .as(JavaArchive.class);
//    }

//    @Deployment(name="javax.el",order=9)
//    public static JavaArchive deployEL() {
//        return ShrinkWrap.create(ZipImporter.class, "javax.el.jar")
//                .importFrom(Maven.configureResolver()
//                        .withMavenCentralRepo(false)
//                        .withClassPathResolution(true)
//                        .resolve("org.apache.geronimo.specs:geronimo-el_2.2_spec:1.0.4")
//                        .withoutTransitivity().asSingleFile())
//                .as(JavaArchive.class);
//    }

//    @Deployment(name="javax.interceptor",order=9)
//    public static JavaArchive deployInterceptor() {
//        return ShrinkWrap.create(ZipImporter.class, "javax.interceptor.jar")
//                .importFrom(getBundleFile("org.apache.geronimo.specs:geronimo-interceptor_1.1_spec:1.0"))
//                .as(JavaArchive.class);
//    }
//
//    @Deployment(name="javax.inject",order=10)
//    public static JavaArchive deployCDISpec() {
//        return ShrinkWrap.create(ZipImporter.class, "javax.inject.jar")
//                .importFrom(getBundleFile("org.apache.geronimo.specs:geronimo-jcdi_1.1_spec:1.0"))
//                .as(JavaArchive.class);
//    }

    @Deployment(name="tamaya-injection-api",order=11)
    public static JavaArchive deployTamayaInjectionAPI() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-injection-api.jar")
                .importFrom(getBundleFile("org.apache.tamaya.ext:tamaya-injection-api:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

    @Deployment(name="tamaya-events", order=14)
    public static JavaArchive deployTamayaEvents() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-events.jar")
                .importFrom(getBundleFile("org.apache.tamaya.ext:tamaya-events:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

    @Deployment(name="tamaya-injection", order=6)
    public static JavaArchive deployTamayaInjectionSE() {
        return ShrinkWrap.create(ZipImporter.class, "tamaya-injection.jar")
                .importFrom(getBundleFile("org.apache.tamaya.ext:tamaya-injection:"+TAMAYA_VERSION))
                .as(JavaArchive.class);
    }

    private static File getBundleFile(String artifactId) {
        return Maven.configureResolver()
                .withMavenCentralRepo(true)
                .withClassPathResolution(true)
                .resolve(artifactId).withoutTransitivity().asSingleFile();
    }


    //////////////////////////////////////////////////////// Tests //////////////////////////////////


    @Before
    public void startBundles(){
        for(Bundle bundle : context.getBundles()) {
            try {
                bundle.start();
            } catch (BundleException e) {
                e.printStackTrace();
            }
        }
    }

    @OperateOnDeployment("tamaya-core")
    @Test
    public void testTamayaAvailable() throws Exception {
        assertNotNull(ConfigurationProvider.getConfiguration());
    }

    @Test
    public void testTamayaConfigAdminAvailable() throws Exception {
        ServiceReference<ConfigurationAdmin> ref = context.getServiceReference(ConfigurationAdmin.class);
        assertNotNull("OSGI ConfigAdmin not loaded.", ref);
        ConfigurationAdmin osgiConfig = context.getService(ref);
        assertNotNull("No config available from Tamaya through OSGI ConfigAdmin.", osgiConfig);
        assertEquals("Override of OSGI ConfigAdmin with Tamaya did not work.", osgiConfig.getClass().getName(), TamayaConfigAdminImpl.class.getName());
    }

    @Test
    public void testLoadTamayaConfigFromConfigAdmin() throws Exception {
        ServiceReference<ConfigurationAdmin> ref = context.getServiceReference(ConfigurationAdmin.class);
        assertNotNull("OSGI ConfigAdmin not loaded.", ref);
        ConfigurationAdmin admin = context.getService(ref);
        Configuration osgiConfig = admin.getConfiguration("tamaya");
        assertNotNull("No config available from Tamaya through OSGI ConfigAdmin.", osgiConfig);
        Dictionary<String,Object> config = osgiConfig.getProperties();
        assertNotNull("No config entries loaded from Tamaya.", config);
        assertEquals("Property 'testKey' not loaded from Tamaya.", "foo", config.get("systemTestKey"));
        // TODO: Think on Resource loading in OSGI:
        // this should work with normal resource loading but does not work with OSGI, since this resource is not
        // visible by default, when we have added resource loading as abstraction to the ServiceContext, too.
        // Reason: Resource Loading in OSGI works differently!
//        assertEquals("Property 'testKey' not loaded from Tamaya.", "success!", config.get("my.testProperty"));
    }

    @Test
    public void testInjection() throws Exception {
        Dictionary<String,Object> config = new Hashtable<>();
        ServiceRegistration<HelloService> reg = context.registerService(HelloService.class, new HelloServiceImpl(), config);
        assertNotNull(context.getServiceReference(HelloService.class));
        ServiceReference<HelloService> ref = context.getServiceReference(HelloService.class);
        assertNotNull("HelloService not loaded.", ref);
        HelloService helloServ = context.getService(ref);
        assertNotNull("HelloService not referenceable.");
        assertEquals("A Tamaya default.",helloServ.sayHello());
    }
}