content: /*  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.aries.blueprint.itests;
  
  import static org.apache.aries.blueprint.itests.Helper.mvnBundle;
  import static org.junit.Assert.assertEquals;
  import static org.junit.Assert.assertNotNull;
  import static org.ops4j.pax.exam.CoreOptions.bootDelegationPackages;
  
  import java.util.ArrayList;
  import java.util.Arrays;
  import java.util.Collections;
  import java.util.List;
  
  import org.apache.aries.blueprint.testquiescebundle.TestBean;
  import org.apache.aries.quiesce.manager.QuiesceCallback;
  import org.apache.aries.quiesce.participant.QuiesceParticipant;
  import org.junit.Test;
  import org.junit.runner.RunWith;
  import org.ops4j.pax.exam.Configuration;
  import org.ops4j.pax.exam.CoreOptions;
  import org.ops4j.pax.exam.Option;
  import org.ops4j.pax.exam.junit.PaxExam;
  import org.ops4j.pax.exam.options.BootDelegationOption;
  import org.ops4j.pax.exam.spi.reactors.ExamReactorStrategy;
  import org.ops4j.pax.exam.spi.reactors.PerMethod;
  import org.osgi.framework.Bundle;
  import org.osgi.framework.InvalidSyntaxException;
  import org.osgi.framework.ServiceReference;
  import org.osgi.framework.Version;
  
  @RunWith(PaxExam.class)
  @ExamReactorStrategy(PerMethod.class)
  public class QuiesceBlueprintTest extends AbstractBlueprintIntegrationTest {
  
    private static class TestQuiesceCallback implements QuiesceCallback
    {
      private int calls = 0;
  
    	public synchronized void bundleQuiesced(Bundle... bundlesQuiesced) {
    		System.out.println("bundleQuiesced "+ Arrays.toString(bundlesQuiesced));
    	  calls++;
    	}
    	
    	public synchronized int getCalls() {
    		return calls;
    	}
    }
    
    @SuppressWarnings({ "rawtypes", "unchecked" })
  private QuiesceParticipant getParticipant(String bundleName) throws InvalidSyntaxException {
      ServiceReference[] refs = bundleContext.getServiceReferences(QuiesceParticipant.class.getName(), null);
      
      if(refs != null) {
        for(ServiceReference ref : refs) {
          if(ref.getBundle().getSymbolicName().equals(bundleName))
            return (QuiesceParticipant) bundleContext.getService(ref);
          else System.out.println(ref.getBundle().getSymbolicName());
        }
      }
      
      
      return null;
    }
  
    @Configuration
    public Option[] configuration() {
      return new Option[] {
              baseOptions(),
              bootDelegationPackages("javax.transaction", "javax.transaction.*"),
              CoreOptions.vmOption("-Dorg.osgi.framework.system.packages=javax.accessibility,javax.activation,javax.activity,javax.annotation,javax.annotation.processing,javax.crypto,javax.crypto.interfaces,javax.crypto.spec,javax.imageio,javax.imageio.event,javax.imageio.metadata,javax.imageio.plugins.bmp,javax.imageio.plugins.jpeg,javax.imageio.spi,javax.imageio.stream,javax.jws,javax.jws.soap,javax.lang.model,javax.lang.model.element,javax.lang.model.type,javax.lang.model.util,javax.management,javax.management.loading,javax.management.modelmbean,javax.management.monitor,javax.management.openmbean,javax.management.relation,javax.management.remote,javax.management.remote.rmi,javax.management.timer,javax.naming,javax.naming.directory,javax.naming.event,javax.naming.ldap,javax.naming.spi,javax.net,javax.net.ssl,javax.print,javax.print.attribute,javax.print.attribute.standard,javax.print.event,javax.rmi,javax.rmi.CORBA,javax.rmi.ssl,javax.script,javax.security.auth,javax.security.auth.callback,javax.security.auth.kerberos,javax.security.auth.login,javax.security.auth.spi,javax.security.auth.x500,javax.security.cert,javax.security.sasl,javax.sound.midi,javax.sound.midi.spi,javax.sound.sampled,javax.sound.sampled.spi,javax.sql,javax.sql.rowset,javax.sql.rowset.serial,javax.sql.rowset.spi,javax.swing,javax.swing.border,javax.swing.colorchooser,javax.swing.event,javax.swing.filechooser,javax.swing.plaf,javax.swing.plaf.basic,javax.swing.plaf.metal,javax.swing.plaf.multi,javax.swing.plaf.synth,javax.swing.table,javax.swing.text,javax.swing.text.html,javax.swing.text.html.parser,javax.swing.text.rtf,javax.swing.tree,javax.swing.undo,javax.tools,javax.xml,javax.xml.bind,javax.xml.bind.annotation,javax.xml.bind.annotation.adapters,javax.xml.bind.attachment,javax.xml.bind.helpers,javax.xml.bind.util,javax.xml.crypto,javax.xml.crypto.dom,javax.xml.crypto.dsig,javax.xml.crypto.dsig.dom,javax.xml.crypto.dsig.keyinfo,javax.xml.crypto.dsig.spec,javax.xml.datatype,javax.xml.namespace,javax.xml.parsers,javax.xml.soap,javax.xml.stream,javax.xml.stream.events,javax.xml.stream.util,javax.xml.transform,javax.xml.transform.dom,javax.xml.transform.sax,javax.xml.transform.stax,javax.xml.transform.stream,javax.xml.validation,javax.xml.ws,javax.xml.ws.handler,javax.xml.ws.handler.soap,javax.xml.ws.http,javax.xml.ws.soap,javax.xml.ws.spi,javax.xml.xpath,org.ietf.jgss,org.omg.CORBA,org.omg.CORBA.DynAnyPackage,org.omg.CORBA.ORBPackage,org.omg.CORBA.TypeCodePackage,org.omg.CORBA.portable,org.omg.CORBA_2_3,org.omg.CORBA_2_3.portable,org.omg.CosNaming,org.omg.CosNaming.NamingContextExtPackage,org.omg.CosNaming.NamingContextPackage,org.omg.Dynamic,org.omg.DynamicAny,org.omg.DynamicAny.DynAnyFactoryPackage,org.omg.DynamicAny.DynAnyPackage,org.omg.IOP,org.omg.IOP.CodecFactoryPackage,org.omg.IOP.CodecPackage,org.omg.Messaging,org.omg.PortableInterceptor,org.omg.PortableInterceptor.ORBInitInfoPackage,org.omg.PortableServer,org.omg.PortableServer.CurrentPackage,org.omg.PortableServer.POAManagerPackage,org.omg.PortableServer.POAPackage,org.omg.PortableServer.ServantLocatorPackage,org.omg.PortableServer.portable,org.omg.SendingContext,org.omg.stub.java.rmi,org.w3c.dom,org.w3c.dom.bootstrap,org.w3c.dom.css,org.w3c.dom.events,org.w3c.dom.html,org.w3c.dom.ls,org.w3c.dom.ranges,org.w3c.dom.stylesheets,org.w3c.dom.traversal,org.w3c.dom.views,org.xml.sax,org.xml.sax.ext,org.xml.sax.helpers,javax.transaction;partial=true;mandatory:=partial,javax.transaction.xa;partial=true;mandatory:=partial"),
              Helper.blueprintBundles(),
  
              mvnBundle("org.apache.aries.quiesce", "org.apache.aries.quiesce.api"),
              mvnBundle("org.apache.aries.blueprint", "org.apache.aries.blueprint.testbundlea", false),
              mvnBundle("org.apache.aries.blueprint", "org.apache.aries.blueprint.testbundleb", false),
              mvnBundle("org.apache.aries.blueprint", "org.apache.aries.blueprint.testquiescebundle")
      };
    }
    
    
    protected Bundle getBundle(String symbolicName) {
      return getBundle(symbolicName, null);
    }
  
    protected Bundle getBundle(String bundleSymbolicName, String version) {
      Bundle result = null;
      for (Bundle b : bundleContext.getBundles()) {
        if (b.getSymbolicName().equals(bundleSymbolicName)) {
          if (version == null
              || b.getVersion().equals(Version.parseVersion(version))) {
            result = b;
            break;
          }
        }
      }
      return result;
    }
  
    public static BootDelegationOption bootDelegation() {
      return new BootDelegationOption("org.apache.aries.unittest.fixture");
    }
    
    @Test
    public void testBasicQuieseEmptyCounter() throws Exception 
    {
  	  //This test checks that a single bundle when called will not quiesce while 
  	  //there is an active request (method sleeps), but will quiesce after the 
  	  //request is completed. 
  	  
  	System.out.println("In testBasicQuieseEmptyCounter");
  	Object obj = context().getService(TestBean.class);
  	
  	if (obj != null)
  	{
  	  QuiesceParticipant participant = getParticipant("org.apache.aries.blueprint.core");
  	  
  	  if (participant != null)
  	  {
  	    System.out.println(obj.getClass().getName());
  
  	    TestQuiesceCallback callback = new TestQuiesceCallback();
  	    
  	    Bundle bundle = getBundle("org.apache.aries.blueprint.testquiescebundle");
  	    
  	    System.out.println("Got the bundle");
  	    
  	    List<Bundle> bundles = new ArrayList<Bundle>();
  	    bundles.add(bundle);
  	    
  	    Thread t = new Thread(new TestBeanClient((TestBean)obj, 2000));
  	    t.start();
  
  	    System.out.println("Thread Started");
  	    
  	    participant.quiesce(callback, bundles);
  	    
  	    System.out.println("Called Quiesce");
  	    
  	    Thread.sleep(1000);
  
          assertEquals("Quiesce callback should not have occurred yet; calls should be 0, but it is " + callback.getCalls(), 0, callback.getCalls());
  	    
  	    t.join();
  	    
  	    System.out.println("After join");
  
          assertEquals("Quiesce callback should have occurred once; calls should be 1, but it is " + callback.getCalls(), 1, callback.getCalls());
  	    
   	  }
    	  else
  	  {
  		throw new Exception("No Quiesce Participant found for the blueprint service");
  	  }
    
  	  System.out.println("done");
  	}
  	else
  	{
  		throw new Exception("No Service returned for " + TestBean.class);
  	}
    }
    
    @Test
    public void testNoServicesQuiesce() throws Exception {
     
     //This test covers the case where one of the bundles being asked to quiesce has no 
     //services. It should be quiesced immediately.
  	  
     System.out.println("In testNoServicesQuiesce");
  	Object obj = context().getService(TestBean.class);
  	
  	if (obj != null)
  	{    
  		QuiesceParticipant participant = getParticipant("org.apache.aries.blueprint.core");
  		
  		if (participant != null)
  		{
  			TestQuiesceCallback callbackA = new TestQuiesceCallback();
  			TestQuiesceCallback callbackB = new TestQuiesceCallback();
  		    
  			//bundlea provides the ns handlers, bean processors, interceptors etc for this test.
  	        Bundle bundlea = getBundle("org.apache.aries.blueprint.testbundlea");
  	        assertNotNull(bundlea);
  	        bundlea.start();
  	        
  	        //bundleb has no services and makes use of the extensions provided by bundlea
  	        Bundle bundleb = getBundle("org.apache.aries.blueprint.testbundleb");
  	        assertNotNull(bundleb);
  	        bundleb.start();
  	        
  	        Helper.getBlueprintContainerForBundle(context(), "org.apache.aries.blueprint.testbundleb");
  	        
  			participant.quiesce(callbackB, Collections.singletonList(getBundle(
  				"org.apache.aries.blueprint.testbundleb")));
  			
  		    System.out.println("Called Quiesce");
  		    
  		    Thread.sleep(200);
  
              assertEquals("Quiesce callback B should have occurred; calls should be 1, but it is " + callbackB.getCalls(), 1, callbackB.getCalls());
              assertEquals("Quiesce callback A should not have occurred yet; calls should be 0, but it is " + callbackA.getCalls(), 0, callbackA.getCalls());
  		    
  		    bundleb.stop();
  		    
  		    participant.quiesce(callbackA, Collections.singletonList(getBundle(
  			"org.apache.aries.blueprint.testbundlea")));
  				    
  		    Thread.sleep(1000);
  		    
  		    System.out.println("After second sleep");
  
              assertEquals("Quiesce callback A should have occurred once; calls should be 1, but it is " + callbackA.getCalls(), 1, callbackA.getCalls());
              assertEquals("Quiesce callback B should have occurred once; calls should be 1, but it is " + callbackB.getCalls(), 1, callbackB.getCalls());
  		    
  		}else{
  			throw new Exception("No Quiesce Participant found for the blueprint service");
  		}
  	}else{
  		throw new Exception("No Service returned for " + TestBean.class);
  	}
    }
  
    @Test
    public void testMultiBundleQuiesce() throws Exception {
     
     //This test covers the case where two bundles are quiesced at the same time. 
     //Bundle A should quiesce immediately, quiesce bundle should quiesce after the 
     //request has completed.
  	  
     System.out.println("In testMultiBundleQuiesce");
  	Object obj = context().getService(TestBean.class);
  	
  	if (obj != null)
  	{    
  		QuiesceParticipant participant = getParticipant("org.apache.aries.blueprint.core");
  		
  		if (participant != null)
  		{
  			TestQuiesceCallback callback = new TestQuiesceCallback();
  		    
  			//bundlea provides the ns handlers, bean processors, interceptors etc for this test.
  	        Bundle bundlea = getBundle("org.apache.aries.blueprint.testbundlea");
  	        assertNotNull(bundlea);
  	        bundlea.start();
  	        
  	        //quiesce bundle will sleep for a second so will quiesce after that
  		    Bundle bundleq = getBundle("org.apache.aries.blueprint.testquiescebundle");
  		    
  		    System.out.println("Got the bundle");
  		    
  		    List<Bundle> bundles = new ArrayList<Bundle>();
  		    bundles.add(bundlea);
  		    bundles.add(bundleq);
  		    
  		    Thread t = new Thread(new TestBeanClient((TestBean)obj, 1500));
  		    t.start();
  		    Thread.sleep(200);
  	        
  			  participant.quiesce(callback, bundles);
  			
  		    System.out.println("Called Quiesce");
  		    
  		    Thread.sleep(500);
  
              assertEquals("Quiesce callback should have occurred once for bundle a but not for bundle q; calls should be 1, but it is " + callback.getCalls(), 1, callback.getCalls());
  		    
  		    Thread.sleep(1500);
  		    
  		    System.out.println("After second sleep");
  
              assertEquals("Quiesce callback should have occurred twice, once for bundle a and q respectively; calls should be 2, but it is " + callback.getCalls(), 2, callback.getCalls());
  		    
  		}else{
  			throw new Exception("No Quiesce Participant found for the blueprint service");
  		}
  	}else{
  		throw new Exception("No Service returned for " + TestBean.class);
  	}
    }
    
    @Test
    public void testMultiRequestQuiesce() throws Exception {
     
     //This test covers the case where we have two active requests when 
     //the bundle is being quiesced.
  	  
     System.out.println("In testMultiRequestQuiesce");
  	Object obj = context().getService(TestBean.class);
  	
  	if (obj != null)
  	{    
  		QuiesceParticipant participant = getParticipant("org.apache.aries.blueprint.core");
  		
  		if (participant != null)
  		{
  			TestQuiesceCallback callback = new TestQuiesceCallback();
  			TestBeanClient client =  new TestBeanClient((TestBean)obj, 1500);
  		    
  
  	        //quiesce bundle will sleep for a second so will quiesce after that
  		    Bundle bundle = getBundle("org.apache.aries.blueprint.testquiescebundle");
  		    
  		    System.out.println("Got the bundle");
  		    
  		    List<Bundle> bundles = new ArrayList<Bundle>();
  		    bundles.add(bundle);
  		    
  		    Thread t = new Thread(client);
  		    t.start();
  	        
  			participant.quiesce(callback, bundles);
  			
  		    System.out.println("Called Quiesce, putting in a new request");
  		    
  		    Thread t2 = new Thread(client);
  		    t2.start();
  		    
  		    Thread.sleep(5000);
  
              assertEquals("Quiesce callback should have occurred once; calls should be 1, but it is " + callback.getCalls(), 1, callback.getCalls());
  		    
     
  		}else{
  			throw new Exception("No Quiesce Participant found for the blueprint service");
  		}
  	}else{
  		throw new Exception("No Service returned for " + TestBean.class);
  	}
    }
    
    
    private class TestBeanClient implements Runnable
    {
      private final TestBean myService;
      private final int time;
      
      public TestBeanClient(TestBean myService, int time)
      {
        this.myService = myService;
        this.time = time;
      }
  	  
  	public void run() 
  	{
  	  try
  	  {
  		System.out.println("In Test Bean Client - Sleeping zzzzzzz");
  		myService.sleep(time);
  		System.out.println("Woken up");
  	  }
  	  catch (InterruptedException ie)
  	  {
  		  ie.printStackTrace();
  	  }
  	}
  	  
    }
  }
  