AbstractTest.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.ops4j.pax.cdi.extension;

import java.io.File;
import java.io.IOException;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.Dictionary;
import java.util.HashMap;
import java.util.Hashtable;
import java.util.List;
import java.util.Map;
import java.util.ServiceLoader;
import java.util.UUID;

import org.ops4j.pax.cdi.extension.impl.OsgiExtension2;
import org.ops4j.pax.cdi.extension.impl.component2.BundleContextHolder;
import org.jboss.weld.environment.se.Weld;
import org.jboss.weld.environment.se.WeldContainer;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.rules.TemporaryFolder;
import org.ops4j.pax.cdi.spi.ContainerInitialized;
import org.osgi.framework.*;
import org.osgi.framework.launch.Framework;
import org.osgi.framework.launch.FrameworkFactory;
import org.osgi.service.cm.Configuration;
import org.osgi.service.cm.ConfigurationAdmin;

public abstract class AbstractTest {

    @Rule
    public TemporaryFolder cache;

    Framework framework;
    List<WeldContainer> welds = new ArrayList<>();

    public AbstractTest() {
        File root = new File("target/osgi");
        root.mkdirs();
        cache = new TemporaryFolder(root);
    }

    @Before
    public void setUp() throws BundleException {
        // Boot an empty osgi framework for testing
        Map<String, String> config = new HashMap<>();
        config.put(Constants.FRAMEWORK_STORAGE, cache.getRoot().toString());
        framework = ServiceLoader.load(FrameworkFactory.class).iterator().next().newFramework(config);
        framework.start();
        BundleContextHolder.setBundleContext(framework.getBundleContext());
    }

    @After
    public void tearDown() throws BundleException {
        for (WeldContainer weld : welds) {
            weld.close();
        }
        framework.stop();
        welds.clear();
    }

    protected BundleContext getBundleContext() {
        return framework.getBundleContext();
    }

    protected void startConfigAdmin() {
        BundleContextHolder.setBundleContext(getBundleContext());
        new org.apache.felix.cm.impl.ConfigurationManager().start(getBundleContext());
    }

    protected <T> T getService(Class<T> clazz) {
        ServiceReference<T> ref = getBundleContext().getServiceReference(clazz);
        if (ref != null) {
            return getBundleContext().getService(ref);
        } else {
            return null;
        }
    }

    protected <T> T getPrototype(Class<T> clazz) {
        ServiceReference<T> ref = getBundleContext().getServiceReference(clazz);
        if (ref != null) {
            ServiceObjects<T> so = getBundleContext().getServiceObjects(ref);
            return so.getService();
        } else {
            return null;
        }
    }

    protected <T> T getService(Class<T> clazz, String filter) throws InvalidSyntaxException {
        ServiceReference<?>[] refs = getBundleContext().getServiceReferences(clazz.getName(), filter);
        if (refs != null && refs.length > 0) {
            List<ServiceReference<?>> list = new ArrayList<>();
            list.addAll(Arrays.asList(refs));
            Collections.sort(list);
            return getBundleContext().getService((ServiceReference<T>) list.get(0));
        } else {
            return null;
        }
    }

    protected <T> ServiceRegistration<T> register(Class<T> clazz, T t) {
        return getBundleContext().registerService(clazz, t, null);
    }

    protected <T> ServiceRegistration<T> register(Class<T> clazz, T t, int ranking) {
        return getBundleContext().registerService(clazz, t,
                dictionary(Constants.SERVICE_RANKING, ranking));
    }

    protected <T> ServiceRegistration<T> register(Class<T> clazz, T t, Dictionary<String, Object> props) {
        return getBundleContext().registerService(clazz, t, props);
    }

    protected WeldContainer createCdi(Class... classes) {
        return createCdi(UUID.randomUUID().toString(), classes);
    }

    protected WeldContainer createCdi(String id, Class... classes) {
        BundleContextHolder.setBundleContext(getBundleContext());
        WeldContainer weld = new Weld()
                .containerId(id)
                .disableDiscovery()
                .beanClasses(classes)
                .extensions(new OsgiExtension2())
                .initialize();
        weld.getBeanManager().fireEvent(new ContainerInitialized());
        welds.add(weld);
        return weld;
    }

    protected Configuration getConfiguration(Class<? extends Annotation> cfg) throws IOException {
        return getService(ConfigurationAdmin.class).getConfiguration(cfg.getName());
    }

    protected Dictionary<String, Object> dictionary(String key, Object val) {
        Dictionary<String, Object> dictionary = new Hashtable<>();
        dictionary.put(key, val);
        return dictionary;
    }

}