package org.apache.commons.jcs3.auxiliary.lateral.socket.tcp;
   
   import java.util.ArrayList;
   import java.util.List;
   
   import org.apache.commons.jcs3.auxiliary.lateral.LateralCache;
   import org.apache.commons.jcs3.auxiliary.lateral.LateralCacheNoWait;
   import org.apache.commons.jcs3.auxiliary.lateral.LateralCacheNoWaitFacade;
   import org.apache.commons.jcs3.auxiliary.lateral.socket.tcp.behavior.ITCPLateralCacheAttributes;
  import org.apache.commons.jcs3.engine.ZombieCacheServiceNonLocal;
  import org.apache.commons.jcs3.engine.behavior.IElementSerializer;
  import org.apache.commons.jcs3.engine.control.CompositeCacheManager;
  import org.apache.commons.jcs3.engine.logging.MockCacheEventLogger;
  import org.apache.commons.jcs3.utils.discovery.DiscoveredService;
  import org.apache.commons.jcs3.utils.serialization.StandardSerializer;
  
  /*
   * 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.
   */
  
  import junit.framework.TestCase;
  
  /** Test for the listener that observers UDP discovery events. */
  public class LateralTCPDiscoveryListenerUnitTest
      extends TestCase
  {
      /** the listener */
      private LateralTCPDiscoveryListener listener;
  
      /** the cache factory */
      private LateralTCPCacheFactory factory;
  
      /** The cache manager. */
      private CompositeCacheManager cacheMgr;
  
      /** The event logger. */
      protected MockCacheEventLogger cacheEventLogger;
  
      /** The serializer. */
      protected IElementSerializer elementSerializer;
  
      /** Create the listener for testing */
      @Override
      protected void setUp() throws Exception
      {
          factory = new LateralTCPCacheFactory();
          factory.initialize();
  
          cacheMgr = CompositeCacheManager.getInstance();
          cacheEventLogger = new MockCacheEventLogger();
          elementSerializer = new StandardSerializer();
  
          listener = new LateralTCPDiscoveryListener( factory.getName(), cacheMgr,
                  cacheEventLogger, elementSerializer );
      }
  
      private LateralCacheNoWaitFacade<String, String> setupFacade(final String cacheName)
      {
          List<LateralCacheNoWait<String, String>> noWaits = new ArrayList<>();
          final ITCPLateralCacheAttributes cattr = new TCPLateralCacheAttributes();
          cattr.setCacheName( cacheName );
  
          return new LateralCacheNoWaitFacade<>( null, noWaits, cattr );
      }
  
      private LateralCacheNoWait<String, String> setupNoWait(final String cacheName)
      {
          final ITCPLateralCacheAttributes cattr = new TCPLateralCacheAttributes();
          cattr.setCacheName( cacheName );
  
          final LateralCache<String, String> cache = new LateralCache<>(cattr, new ZombieCacheServiceNonLocal<>(), null);
          return new LateralCacheNoWait<>( cache );
      }
  
      /**
       * Add a no wait facade.
       */
      public void testAddNoWaitFacade_NotInList()
      {
          // SETUP
          final String cacheName = "testAddNoWaitFacade_NotInList";
          final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
  
          // DO WORK
         listener.addNoWaitFacade( cacheName, facade );
 
         // VERIFY
         assertTrue( "Should have the facade.", listener.containsNoWaitFacade( cacheName ) );
     }
 
     /**
      * Add a no wait to a known facade.
      */
     public void testAddNoWait_FacadeInList()
     {
         // SETUP
         final String cacheName = "testAddNoWaitFacade_FacadeInList";
         final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
         listener.addNoWaitFacade( cacheName, facade );
 
         final LateralCacheNoWait<String, String> noWait = setupNoWait(cacheName);
 
         // DO WORK
         final boolean result = listener.addNoWait( noWait );
 
         // VERIFY
         assertTrue( "Should have added the no wait.", result );
     }
 
     /**
      * Add a no wait from an unknown facade.
      */
     public void testAddNoWait_FacadeNotInList()
     {
         // SETUP
         final String cacheName = "testAddNoWaitFacade_FacadeInList";
         final LateralCacheNoWait<String, String> noWait = setupNoWait(cacheName);
 
         // DO WORK
         final boolean result = listener.addNoWait( noWait );
 
         // VERIFY
         assertFalse( "Should not have added the no wait.", result );
     }
 
     /**
      * Remove a no wait from an unknown facade.
      */
     public void testRemoveNoWait_FacadeNotInList()
     {
         // SETUP
         final String cacheName = "testRemoveNoWaitFacade_FacadeNotInList";
         final LateralCacheNoWait<String, String> noWait = setupNoWait(cacheName);
 
         // DO WORK
         final boolean result = listener.removeNoWait( noWait );
 
         // VERIFY
         assertFalse( "Should not have removed the no wait.", result );
     }
 
     /**
      * Remove a no wait from a known facade.
      */
     public void testRemoveNoWait_FacadeInList_NoWaitNot()
     {
         // SETUP
         final String cacheName = "testAddNoWaitFacade_FacadeInList";
         final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
         listener.addNoWaitFacade( cacheName, facade );
 
         final LateralCacheNoWait<String, String> noWait = setupNoWait(cacheName);
 
         // DO WORK
         final boolean result = listener.removeNoWait( noWait );
 
         // VERIFY
         assertFalse( "Should not have removed the no wait.", result );
     }
 
     /**
      * Remove a no wait from a known facade.
      */
     public void testRemoveNoWait_FacadeInList_NoWaitIs()
     {
         // SETUP
         final String cacheName = "testRemoveNoWaitFacade_FacadeInListNoWaitIs";
         final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
         listener.addNoWaitFacade( cacheName, facade );
 
         final LateralCacheNoWait<String, String> noWait = setupNoWait(cacheName);
         listener.addNoWait( noWait );
 
         // DO WORK
         final boolean result = listener.removeNoWait( noWait );
 
         // VERIFY
         assertTrue( "Should have removed the no wait.", result );
     }
 
     /**
      * Test cache creation with empty noWaits.
      */
     public void testEmptyNoWaits()
     {
         // SETUP
         final String cacheName = "testEmptyNoWaits";
 
         final ITCPLateralCacheAttributes lca = new TCPLateralCacheAttributes();
         lca.setTcpServers(""); // default
         lca.setTcpListenerPort(1120);
         lca.setCacheName(cacheName);
         lca.setUdpDiscoveryEnabled(false);
         final LateralCacheNoWaitFacade<String, String> noWait = factory.createCache(lca, cacheMgr, cacheEventLogger, elementSerializer);
 
         // VERIFY
         assertFalse( "No waits should be empty.", noWait.containsNoWait(""));
     }
 
     /**
      * Add a no wait to a known facade.
      */
     public void testAddDiscoveredService_FacadeInList_NoWaitNot()
     {
         // SETUP
         final String cacheName = "testAddDiscoveredService_FacadeInList_NoWaitNot";
         final ArrayList<String> cacheNames = new ArrayList<>();
         cacheNames.add( cacheName );
 
         final DiscoveredService service = new DiscoveredService();
         service.setCacheNames( cacheNames );
         service.setServiceAddress( "localhost" );
         service.setServicePort( 9999 );
 
         final ITCPLateralCacheAttributes lca = new TCPLateralCacheAttributes();
         // used as identifying key by factory
         lca.setTcpServer( service.getServiceAddress() + ":" + service.getServicePort() );
         lca.setCacheName(cacheName);
         final LateralCacheNoWait<String, String> noWait = factory.createCacheNoWait(lca, cacheEventLogger, elementSerializer);
         // this is the normal process, the discovery service expects it there
         cacheMgr.addAuxiliaryCache(factory.getName(), cacheName, noWait);
         cacheMgr.registryFacPut(factory);
 
         final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
         listener.addNoWaitFacade( cacheName, facade );
 
         // DO WORK
         listener.addDiscoveredService( service );
 
         // VERIFY
         assertTrue( "Should have no wait.", listener.containsNoWait( cacheName, noWait ) );
     }
 
     /**
      * Remove a no wait from a known facade.
      */
     public void testRemoveDiscoveredService_FacadeInList_NoWaitIs()
     {
         // SETUP
         final String cacheName = "testRemoveDiscoveredService_FacadeInList_NoWaitIs";
 
         final ArrayList<String> cacheNames = new ArrayList<>();
         cacheNames.add( cacheName );
 
         final DiscoveredService service = new DiscoveredService();
         service.setCacheNames( cacheNames );
         service.setServiceAddress( "localhost" );
         service.setServicePort( 9999 );
 
         final ITCPLateralCacheAttributes lca = new TCPLateralCacheAttributes();
         // used as identifying key by factory
         lca.setTcpServer( service.getServiceAddress() + ":" + service.getServicePort() );
         lca.setCacheName(cacheName);
         final LateralCacheNoWait<String, String> noWait = factory.createCacheNoWait(lca, cacheEventLogger, elementSerializer);
         // this is the normal process, the discovery service expects it there
         cacheMgr.addAuxiliaryCache(factory.getName(), cacheName, noWait);
         cacheMgr.registryFacPut(factory);
 
         final LateralCacheNoWaitFacade<String, String> facade = setupFacade(cacheName);
         listener.addNoWaitFacade( cacheName, facade );
         listener.addDiscoveredService( service );
 
         // DO WORK
         listener.removeDiscoveredService( service );
 
         // VERIFY
         assertFalse( "Should not have no wait.", listener.containsNoWait( cacheName, noWait ) );
     }
 }