/**
    * Copyright 2005-2006 the original author or authors.
    *
    * Licensed under the Gnu General Pubic 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.opensource.org/licenses/gpl-license.php
    *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   * See the Gnu General Public License for more details.
   */
  package org.figure8.join.services.cache;
  
  import org.figure8.join.core.setup.BootstrapException;
  import org.figure8.join.businessfacades.artifact.ArtifactManager;
  import org.figure8.join.businessfacades.commons.IntegrationProcessManager;
  import org.figure8.join.businessfacades.security.PermissionManager;
  
  import org.easymock.MockControl;
  
  import junit.framework.Test;
  import junit.framework.TestCase;
  import junit.framework.TestSuite;
  
  import java.util.ArrayList;
  /**
   * JUnit test case for testing interaction from CacheLoader pow.
   * @author <a href="mailto:laurent.broudoux@free.fr">Laurent Broudoux</a>
   * @version $Revision: 1.2 $$
   */
  public class CacheLoaderMockTest extends TestCase{
  
     // Attributes ---------------------------------------------------------------
  
     /** Control for mock cache manager */
     private MockControl cacheControl = null;
     /** CacheManager mock implementation */
     private CacheManager cacheManager = null;
  
     /** Control for mock artifact manager */
     private MockControl artifactControl = null;
     /** ArtifactManager mock implementation */
     private ArtifactManager artifactManager = null;
  
     /** Control for mock process manager */
     private MockControl processControl = null;
     /** IntegrationProcessManager mock implementation */
     private IntegrationProcessManager processManager = null;
  
     /** Control for mock permission manager */
     private MockControl permissionControl = null;
     /** PermissionManager mock implementation */
     private PermissionManager permissionManager = null;
  
  
     // Constructors -------------------------------------------------------------
  
     /** Default constructor. Build a test case using a name. */
     public CacheLoaderMockTest(String testName){
        super(testName);
     }
  
  
     // Override of TestCase -----------------------------------------------------
  
     /**
      * Make this class a TestSuite.
      * @return A TestSuite containing this TestCase.
      */
     public static Test suite(){
        TestSuite suite = new TestSuite(CacheLoaderMockTest.class);
        return suite;
     }
     
     
     // Public -------------------------------------------------------------------
  
     /** Creates mock objects and their associated EasyMock controls */
     public void setUp(){
        // Mock a cache manager.
        cacheControl = MockControl.createControl(CacheManager.class);
        cacheManager = (CacheManager)cacheControl.getMock();
        // Mock an artifact manager.
        artifactControl = MockControl.createControl(ArtifactManager.class);
        artifactManager = (ArtifactManager)artifactControl.getMock();
        // Mock a process manager.
        processControl = MockControl.createControl(IntegrationProcessManager.class);
        processManager = (IntegrationProcessManager)processControl.getMock();
        // Mock a permission manager.
        permissionControl = MockControl.createControl(PermissionManager.class);
        permissionManager = (PermissionManager)permissionControl.getMock();
     }
  
     /** Test the loadCaches() method */
     public void testLoadCaches(){
        CacheLoader loader = new CacheLoader();
       // Set mock objects to loader.
       loader.setCacheManager(cacheManager);
       loader.setArtifactManager(artifactManager);
       loader.setPermissionManager(permissionManager);
       loader.setIntegrationProcessManager(processManager);
 
       // Set expectations on mocks : eternal caches should be accessed.
       cacheControl.expectAndReturn(
             cacheManager.getCache(EternalCacheKeys.STEP_ID_TO_STEP_KEY),
             new EhCache(EternalCacheKeys.STEP_ID_TO_STEP_KEY, null, null),
             1);
       cacheControl.expectAndReturn(
             cacheManager.getCache(EternalCacheKeys.ROLE_NAME_TO_ROLE_KEY),
             new EhCache(EternalCacheKeys.ROLE_NAME_TO_ROLE_KEY, null, null),
             1);
       cacheControl.expectAndReturn(
             cacheManager.getCache(EternalCacheKeys.DELTYPE_KEY_TO_DELTYPE_KEY),
             new EhCache(EternalCacheKeys.DELTYPE_KEY_TO_DELTYPE_KEY, null, null),
             1);
       cacheControl.expectAndReturn(
             cacheManager.getCache(EternalCacheKeys.RELEASE_NAME_TO_RELEASE_KEY),
             new EhCache(EternalCacheKeys.RELEASE_NAME_TO_RELEASE_KEY, null, null),
             1);
       cacheControl.replay();
 
       // Deliverable types should be retrieved.
       artifactControl.expectAndReturn(artifactManager.getDeliverableTypes(), new ArrayList(), 1);
       artifactControl.replay();
       // Steps and Releases shoud be retrieved too.
       processControl.expectAndReturn(processManager.getSteps(), new ArrayList(), 1);
       processControl.expectAndReturn(processManager.getReleases(), new ArrayList(), 1);
       processControl.replay();
       // Roles should be retrieved too.
       permissionControl.expectAndReturn(permissionManager.getRoles(), new ArrayList(), 1);
       permissionControl.replay();
 
       try{
          // Try loading caches.
          loader.loadCaches();
       }
       catch (BootstrapException be){
          // Bootstrap exception is normal during registration of cache accessor.
          assertTrue("BootstrapException during registration", be.getMessage().startsWith("Exception while registring the cache accessor"));
          //fail("Caches cannot be loaded due to BootstrapException: " + be.getMessage());
       }
    }
 }