opendaylight/config/config-manager/src/test/java/org/opendaylight/controller/config/manager/impl/AbstractConfigTest.java

   1 /*
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.controller.config.manager.impl;
   9
  10 import org.junit.After;
  11 import org.mockito.Matchers;
  12 import org.opendaylight.controller.config.api.jmx.CommitStatus;
  13 import org.opendaylight.controller.config.manager.impl.factoriesresolver.ModuleFactoriesResolver;
  14 import org.opendaylight.controller.config.manager.impl.jmx.BaseJMXRegistrator;
  15 import org.opendaylight.controller.config.manager.impl.jmx.ConfigRegistryJMXRegistrator;
  16 import org.opendaylight.controller.config.manager.impl.jmx.InternalJMXRegistrator;
  17 import org.opendaylight.controller.config.spi.Module;
  18 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
  19 import org.opendaylight.controller.config.util.ConfigTransactionJMXClient;
  20 import org.osgi.framework.BundleContext;
  21 import org.osgi.framework.ServiceRegistration;
  22
  23 import javax.management.InstanceAlreadyExistsException;
  24 import javax.management.MBeanServer;
  25 import javax.management.ObjectName;
  26 import java.io.Closeable;
  27 import java.lang.management.ManagementFactory;
  28 import java.util.Dictionary;
  29 import java.util.Set;
  30
  31 import static org.junit.Assert.assertEquals;
  32 import static org.mockito.Matchers.any;
  33 import static org.mockito.Mockito.doNothing;
  34 import static org.mockito.Mockito.doReturn;
  35 import static org.mockito.Mockito.mock;
  36
  37 /**
  38  * Each test that relies on
  39  * {@link org.opendaylight.controller.config.manager.impl.ConfigRegistryImpl}
  40  * needs to subclass this test.
  41  * {@link org.opendaylight.controller.config.manager.impl.ConfigRegistryImpl} is
  42  * registered to platform MBean Server using
  43  * {@link #initConfigTransactionManagerImpl(org.opendaylight.controller.config.manager.impl.factoriesresolver.ModuleFactoriesResolver)}
  44  * typically during setting up the each test.
  45  */
  46 public abstract class AbstractConfigTest extends
  47         AbstractLockedPlatformMBeanServerTest {
  48     protected ConfigRegistryJMXRegistrator configRegistryJMXRegistrator;
  49     protected ConfigRegistryImpl configRegistry;
  50     protected ConfigRegistryJMXClient configRegistryClient;
  51     protected BaseJMXRegistrator baseJmxRegistrator;
  52     protected InternalJMXRegistrator internalJmxRegistrator;
  53     protected BundleContext mockedContext = mock(BundleContext.class);
  54     protected ServiceRegistration<?> mockedServiceRegistration;
  55
  56     // this method should be called in @Before
  57     protected void initConfigTransactionManagerImpl(
  58             ModuleFactoriesResolver resolver) {
  59         final MBeanServer platformMBeanServer = ManagementFactory
  60                 .getPlatformMBeanServer();
  61
  62         configRegistryJMXRegistrator = new ConfigRegistryJMXRegistrator(
  63                 platformMBeanServer);
  64         this.mockedServiceRegistration = mock(ServiceRegistration.class);
  65         doNothing().when(mockedServiceRegistration).unregister();
  66         doReturn(mockedServiceRegistration).when(mockedContext).registerService(
  67                 Matchers.any(String[].class), any(Closeable.class),
  68                 any(Dictionary.class));
  69
  70         internalJmxRegistrator = new InternalJMXRegistrator(platformMBeanServer);
  71         baseJmxRegistrator = new BaseJMXRegistrator(internalJmxRegistrator);
  72
  73         configRegistry = new ConfigRegistryImpl(resolver, mockedContext,
  74                 platformMBeanServer, baseJmxRegistrator);
  75         try {
  76             configRegistryJMXRegistrator.registerToJMX(configRegistry);
  77         } catch (InstanceAlreadyExistsException e) {
  78             throw new RuntimeException(e);
  79         }
  80         configRegistryClient = new ConfigRegistryJMXClient(platformMBeanServer);
  81     }
  82
  83     @After
  84     public final void cleanUpConfigTransactionManagerImpl() {
  85         configRegistryJMXRegistrator.close();
  86         configRegistry.close();
  87     }
  88
  89     /**
  90      * Can be called in @After of tests if some other cleanup is needed that
  91      * would be discarded by closing config beans in this method
  92      */
  93     protected void destroyAllConfigBeans() throws Exception {
  94         ConfigTransactionJMXClient transaction = configRegistryClient
  95                 .createTransaction();
  96         Set<ObjectName> all = transaction.lookupConfigBeans();
  97         // workaround for getting same Module more times
  98         while (all.size() > 0) {
  99             transaction.destroyModule(all.iterator().next());
 100             all = transaction.lookupConfigBeans();
 101         }
 102         transaction.commit();
 103     }
 104
 105     protected void assertSame(ObjectName oN1, ObjectName oN2) {
 106         assertEquals(oN1.getKeyProperty("instanceName"),
 107                 oN2.getKeyProperty("instanceName"));
 108         assertEquals(oN1.getKeyProperty("interfaceName"),
 109                 oN2.getKeyProperty("interfaceName"));
 110     }
 111
 112     protected void assertStatus(CommitStatus status, int expectedNewInstances,
 113             int expectedRecreatedInstances, int expectedReusedInstances) {
 114         assertEquals(expectedNewInstances, status.getNewInstances().size());
 115         assertEquals(expectedRecreatedInstances, status.getRecreatedInstances()
 116                 .size());
 117         assertEquals(expectedReusedInstances, status.getReusedInstances()
 118                 .size());
 119     }
 120
 121     protected ObjectName createTestConfigBean(
 122             ConfigTransactionJMXClient transaction, String implementationName,
 123             String name) throws InstanceAlreadyExistsException {
 124         ObjectName nameCreated = transaction.createModule(implementationName,
 125                 name);
 126         return nameCreated;
 127     }
 128
 129     protected void assertBeanCount(int i, String configMXBeanName) {
 130         assertEquals(i, configRegistry.lookupConfigBeans(configMXBeanName)
 131                 .size());
 132     }
 133
 134     protected void assertBeanExists(int count, String moduleName,
 135             String instanceName) {
 136         assertEquals(1,
 137                 configRegistry.lookupConfigBeans(moduleName, instanceName)
 138                         .size());
 139     }
 140
 141     /**
 142      *
 143      * @param configBeanClass
 144      *            Empty constructor class of config bean to be instantiated
 145      *            whenever create
 146      * @param implementationName
 147      * @return
 148      */
 149     protected ClassBasedModuleFactory createClassBasedCBF(
 150             Class<? extends Module> configBeanClass, String implementationName) {
 151         return new ClassBasedModuleFactory(implementationName, configBeanClass);
 152     }
 153 }