southbound/southbound-it/src/test/java/org/opendaylight/ovsdb/southbound/it/AbstractConfigTestBase.java

   1 /*
   2  * Copyright (c) 2015 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.ovsdb.southbound.it;
   9
  10 import static org.ops4j.pax.exam.CoreOptions.maven;
  11 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.editConfigurationFilePut;
  12 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.features;
  13 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.karafDistributionConfiguration;
  14 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.keepRuntimeFolder;
  15
  16 import com.google.common.collect.ObjectArrays;
  17
  18 import java.io.File;
  19 import java.lang.management.ManagementFactory;
  20 import java.util.Calendar;
  21
  22 import javax.management.InstanceNotFoundException;
  23
  24 import org.junit.Rule;
  25 import org.junit.rules.TestRule;
  26 import org.junit.rules.TestWatcher;
  27 import org.junit.runner.Description;
  28 import org.opendaylight.controller.config.api.ConfigRegistry;
  29 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
  30 import org.ops4j.pax.exam.Configuration;
  31 import org.ops4j.pax.exam.Option;
  32 import org.ops4j.pax.exam.karaf.options.LogLevelOption.LogLevel;
  33 import org.ops4j.pax.exam.options.MavenArtifactUrlReference;
  34 import org.ops4j.pax.exam.options.MavenUrlReference;
  35 import org.slf4j.Logger;
  36 import org.slf4j.LoggerFactory;
  37
  38 public abstract class AbstractConfigTestBase {
  39
  40     private static final Logger LOG = LoggerFactory.getLogger(AbstractConfigTestBase.class);
  41     public static final String ORG_OPS4J_PAX_LOGGING_CFG = "etc/org.ops4j.pax.logging.cfg";
  42     public static final String CUSTOM_PROPERTIES = "etc/custom.properties";
  43     private static final String SERVER_IPADDRESS = "ovsdbserver.ipaddress";
  44     private static final String SERVER_PORT = "ovsdbserver.port";
  45     private static final String CONNECTION_TYPE = "ovsdbserver.connection";
  46     private static final String CONNECTION_TYPE_ACTIVE = "active";
  47     private static final String CONNECTION_TYPE_PASSIVE = "passive";
  48     private static final String DEFAULT_SERVER_IPADDRESS = "127.0.0.1";
  49     private static final String DEFAULT_SERVER_PORT = "6640";
  50
  51     /*
  52      * Wait up to 10s for our configured module to come up
  53      */
  54     private static final int MODULE_TIMEOUT = 10000;
  55
  56     public abstract String getModuleName();
  57
  58     public abstract String getInstanceName();
  59
  60     public abstract MavenUrlReference getFeatureRepo();
  61
  62     public abstract String getFeatureName();
  63
  64     public Option[] getLoggingOptions() {
  65         Option[] options = new Option[] {
  66                 editConfigurationFilePut(ORG_OPS4J_PAX_LOGGING_CFG,
  67                         logConfiguration(AbstractConfigTestBase.class),
  68                         LogLevel.INFO.name()),
  69                 editConfigurationFilePut(ORG_OPS4J_PAX_LOGGING_CFG,
  70                         "log4j.logger.org.opendaylight.ovsdb.southbound-impl",
  71                         LogLevel.DEBUG.name())
  72         };
  73         return options;
  74     }
  75
  76     public String logConfiguration(Class<?> klazz) {
  77         return "log4j.logger." + klazz.getPackage().getName();
  78     }
  79
  80     public Option[] getPropertiesOptions() {
  81         return null;
  82     }
  83
  84     public MavenArtifactUrlReference getKarafDistro() {
  85         MavenArtifactUrlReference karafUrl = maven()
  86                 .groupId("org.opendaylight.controller")
  87                 .artifactId("opendaylight-karaf-empty")
  88                 .version("1.5.0-SNAPSHOT")
  89                 .type("zip");
  90         return karafUrl;
  91     }
  92
  93     @Configuration
  94     public Option[] config() {
  95         Option[] options = new Option[] {
  96                 // KarafDistributionOption.debugConfiguration("5005", true),
  97                 karafDistributionConfiguration()
  98                         .frameworkUrl(getKarafDistro())
  99                         .unpackDirectory(new File("target/exam"))
 100                         .useDeployFolder(false),
 101                 keepRuntimeFolder(),
 102                 features(getFeatureRepo() , getFeatureName()),
 103         };
 104         options = ObjectArrays.concat(options, getLoggingOptions(), Option.class);
 105         options = ObjectArrays.concat(options, getPropertiesOptions(), Option.class);
 106         return options;
 107     }
 108
 109     public void setup() throws Exception {
 110         LOG.info("Module: {} Instance: {} attempting to configure.",
 111                 getModuleName(),getInstanceName());
 112         Calendar start = Calendar.getInstance();
 113         ConfigRegistry configRegistryClient = new ConfigRegistryJMXClient(ManagementFactory
 114                 .getPlatformMBeanServer());
 115         for (int timer = 0;timer < MODULE_TIMEOUT;timer++) {
 116             try {
 117                 configRegistryClient.lookupConfigBean(getModuleName(), getInstanceName());
 118                 Thread.sleep(1);
 119             } catch (InstanceNotFoundException e) {
 120                 if (timer < MODULE_TIMEOUT) {
 121                     continue;
 122                 } else {
 123                     throw e;
 124                 }
 125             } catch (InterruptedException e) {
 126                 LOG.error("Exception: ",e);
 127             }
 128         }
 129         Calendar stop = Calendar.getInstance();
 130         LOG.info("Module: {} Instance: {} configured after {} ms",
 131                 getModuleName(),getInstanceName(),
 132                 stop.getTimeInMillis() - start.getTimeInMillis());
 133     }
 134
 135     @Rule
 136     public TestRule watcher = new TestWatcher() {
 137         @Override
 138         protected void starting(Description description) {
 139             LOG.info("TestWatcher: Starting test: {}",
 140                     description.getDisplayName());
 141         }
 142
 143         @Override
 144         protected void finished(Description description) {
 145             LOG.info("TestWatcher: Finished test: {}", description.getDisplayName());
 146         }
 147     };
 148 }