BundleDependencyTest.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.felix.dm.lambda.itest;

import static org.apache.felix.dm.lambda.DependencyManagerActivator.component;

import org.apache.felix.dm.Component;
import org.apache.felix.dm.DependencyManager;
import org.junit.Assert;
import org.osgi.framework.Bundle;

/**
 * @author <a href="mailto:dev@felix.apache.org">Felix Project Team</a>
 */
public class BundleDependencyTest extends TestBase {
    private final static String BSN = "org.apache.felix.metatype";
    
    public void testBundleDependencies() {
        DependencyManager m = getDM();
        // create a service provider and consumer
        MyConsumer c = new MyConsumer();        
        Component consumer = component(m, comp -> comp.impl(c).withBundle(bundle -> bundle.add("add").remove("remove")));
        
        // check if at least one bundle was found
        c.check();
        // remove the consumer again
        m.remove(consumer);
        // check if all bundles were removed correctly
        c.doubleCheck();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        String filter = "(Bundle-SymbolicName=" + BSN + ")";
        Component consumerWithFilter = component(m, comp -> comp.impl(new FilteredConsumer(e))
            .withBundle(bundle-> bundle.filter(filter).add("add").remove("remove")));
        e.step(2);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.step(4);
    }

    public void testBundleDependenciesRef() {
        DependencyManager m = getDM();
        // create a service provider and consumer
        MyConsumer c = new MyConsumer();        
        Component consumer = component(m, comp -> comp.impl(c).withBundle(bundle -> bundle.add(MyConsumer::add).remove(MyConsumer::remove)));
        
        // check if at least one bundle was found
        c.check();
        // remove the consumer again
        m.remove(consumer);
        // check if all bundles were removed correctly
        c.doubleCheck();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        String filter = "(Bundle-SymbolicName=" + BSN + ")";
        Component consumerWithFilter = component(m, comp -> comp.impl(new FilteredConsumer(e))
            .withBundle(bundle-> bundle.filter(filter).add(FilteredConsumer::add).remove(FilteredConsumer::remove)));
        e.step(2);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.step(4);
    }
    
    public void testRequiredBundleDependency() {
        DependencyManager m = getDM();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        Component consumerWithFilter = component(m, c -> c.impl(new FilteredConsumerRequired(e))
            .withBundle(b -> b.filter("(Bundle-SymbolicName=" + BSN + ")").add("add").remove("remove")));
        e.waitForStep(1, 5000);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.waitForStep(2, 5000);
    }
    
    public void testRequiredBundleDependencyRef() {
        DependencyManager m = getDM();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        FilteredConsumerRequired impl = new FilteredConsumerRequired(e);
        Component consumerWithFilter = component(m, c -> c.impl(impl)
            .withBundle(b -> b.filter("(Bundle-SymbolicName=" + BSN + ")").add(impl::add).remove(impl::remove)));
        e.waitForStep(1, 5000);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.waitForStep(2, 5000);
    }
        
    public void testRequiredBundleDependencyWithComponentArgInCallbackMethod() {
        DependencyManager m = getDM();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        // add a consumer with a filter
        FilteredConsumerRequiredWithComponentArg impl = new FilteredConsumerRequiredWithComponentArg(e);
        Component consumerWithFilter = component(m, c -> c.impl(impl)
            .withBundle(b -> b.filter("(Bundle-SymbolicName=" + BSN + ")").add("add").remove("remove")));
        e.waitForStep(1, 5000);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.waitForStep(2, 5000);
    }
    
    public void testRequiredBundleDependencyWithComponentArgInCallbackMethodRef() {
        DependencyManager m = getDM();
        
        // helper class that ensures certain steps get executed in sequence
        Ensure e = new Ensure();
        FilteredConsumerRequiredWithComponentArg impl = new FilteredConsumerRequiredWithComponentArg(e);
        Component consumerWithFilter = component(m).impl(impl)
        		.withBundle(b -> b.filter("(Bundle-SymbolicName=" + BSN + ")").add(impl::addRef).remove(impl::removeRef)).build();
        // add a consumer with a filter
        m.add(consumerWithFilter);
        e.waitForStep(1, 5000);
        // remove the consumer again
        m.remove(consumerWithFilter);
        e.waitForStep(2, 5000);
    }
    
    static class MyConsumer {
        private volatile int m_count = 0;

        public void add(Bundle b) {
            System.out.println("Consumer.add(" + b.getSymbolicName() + ")");
            Assert.assertNotNull("bundle instance must not be null", b);
            m_count++;
        }
        
        public void check() {
            Assert.assertTrue("we should have found at least one bundle", m_count > 0);
        }
        
        public void remove(Bundle b) {
            System.out.println("Consumer.remove(" + b.getSymbolicName() + ")");
            m_count--;
        }
        
        public void doubleCheck() {
            Assert.assertEquals("all bundles we found should have been removed again", 0, m_count);
        }
    }
    
    static class FilteredConsumer {
        private final Ensure m_ensure;

        public FilteredConsumer(Ensure e) {
            m_ensure = e;
        }
        
        public void add(Bundle b) {
            m_ensure.step(1);
        }
        
        public void remove(Bundle b) {
            m_ensure.step(3);
        }
    }
    
    static class FilteredConsumerRequired {
        private final Ensure m_ensure;

        public FilteredConsumerRequired(Ensure e) {
            m_ensure = e;
        }
        
        public void add(Bundle b) {
            System.out.println("Bundle is " + b);
//            Assert.assertNotNull(b);
            if (b.getSymbolicName().equals(BSN)) {
                m_ensure.step(1);
            }
        }
        
        public void remove(Bundle b) {
            Assert.assertNotNull(b);
            if (b.getSymbolicName().equals(BSN)) {
                m_ensure.step(2);
            }
        }
    }

    static class FilteredConsumerRequiredWithComponentArg {
        private final Ensure m_ensure;

        public FilteredConsumerRequiredWithComponentArg(Ensure e) {
            m_ensure = e;
        }
                
        public void add(Component component, Bundle b) { // method ref callback
            Assert.assertNotNull(component);
            if (b.getSymbolicName().equals(BSN)) {
                m_ensure.step(1);
            }
        }
        
        public void addRef(Bundle b, Component component) { // method ref callback
            add(component, b);
        }
        
        public void removeRef(Bundle b, Component component) { // method ref callback
            remove(component, b);
        }

        public void remove(Component component, Bundle b) { // method ref callback
            Assert.assertNotNull(component);
            Assert.assertNotNull(b);
            if (b.getSymbolicName().equals(BSN)) {
                m_ensure.step(2);
            }
        }
    }
}