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.internal.AssumptionViolatedException;
  26 import org.junit.rules.TestRule;
  27 import org.junit.rules.TestWatcher;
  28 import org.junit.runner.Description;
  29 import org.opendaylight.controller.config.api.ConfigRegistry;
  30 import org.opendaylight.controller.config.util.ConfigRegistryJMXClient;
  31 import org.ops4j.pax.exam.Configuration;
  32 import org.ops4j.pax.exam.Option;
  33 import org.ops4j.pax.exam.karaf.options.LogLevelOption.LogLevel;
  34 import org.ops4j.pax.exam.options.MavenArtifactUrlReference;
  35 import org.ops4j.pax.exam.options.MavenUrlReference;
  36 import org.slf4j.Logger;
  37 import org.slf4j.LoggerFactory;
  38
  39 public abstract class AbstractConfigTestBase {
  40     private static final Logger LOG = LoggerFactory.getLogger(AbstractConfigTestBase.class);
  41
  42     /*
  43      * Wait up to 10s for our configured module to come up
  44      */
  45     private static final int MODULE_TIMEOUT = 10000;
  46     private static int configTimes = 0;
  47     private static boolean extras = false;
  48
  49     public abstract String getModuleName();
  50
  51     public abstract String getInstanceName();
  52
  53     public abstract boolean setExtras();
  54
  55     public abstract MavenUrlReference getFeatureRepo();
  56
  57     public abstract String getFeatureName();
  58
  59     public Option[] getLoggingOptions(boolean extras) {
  60         Option[] options = new Option[] {
  61                 editConfigurationFilePut(SouthboundITConstants.ORG_OPS4J_PAX_LOGGING_CFG,
  62                         logConfiguration(AbstractConfigTestBase.class),
  63                         LogLevel.INFO.name())
  64         };
  65         return options;
  66     }
  67
  68     public String logConfiguration(Class<?> klazz) {
  69         return "log4j.logger." + klazz.getPackage().getName();
  70     }
  71
  72     public Option[] getFeaturesOptions(boolean extras) {
  73         return new Option[]{};
  74     }
  75
  76     public Option[] getPropertiesOptions(boolean extras) {
  77         return new Option[]{};
  78     }
  79
  80     public MavenArtifactUrlReference getKarafDistro() {
  81         /*MavenArtifactUrlReference karafUrl = maven()
  82                 .groupId("org.opendaylight.controller")
  83                 .artifactId("opendaylight-karaf-empty")
  84                 .version("1.5.0-SNAPSHOT")
  85                 .type("zip");*/
  86         MavenArtifactUrlReference karafUrl = maven()
  87                 .groupId("org.opendaylight.ovsdb")
  88                 .artifactId("southbound-karaf")
  89                 .version("1.1.0-SNAPSHOT")
  90                 .type("zip");
  91         return karafUrl;
  92     }
  93
  94     @Configuration
  95     public Option[] config() {
  96         LOG.info("Calling config, configTimes: {}", configTimes);
  97         configTimes++;
  98         extras = setExtras();
  99         Option[] options = new Option[] {
 100                 // KarafDistributionOption.debugConfiguration("5005", true),
 101                 karafDistributionConfiguration()
 102                         .frameworkUrl(getKarafDistro())
 103                         .unpackDirectory(new File("target/exam"))
 104                         .useDeployFolder(false),
 105                 keepRuntimeFolder(),
 106                 //features(getFeatureRepo() , getFeatureName())
 107         };
 108         options = ObjectArrays.concat(options, getFeaturesOptions(extras), Option.class);
 109         options = ObjectArrays.concat(options, getLoggingOptions(extras), Option.class);
 110         options = ObjectArrays.concat(options, getPropertiesOptions(extras), Option.class);
 111         return options;
 112     }
 113
 114     public void setup() throws Exception {
 115         LOG.info("Module: {} Instance: {} attempting to configure.",
 116                 getModuleName(),getInstanceName());
 117         Calendar start = Calendar.getInstance();
 118         ConfigRegistry configRegistryClient = new ConfigRegistryJMXClient(ManagementFactory
 119                 .getPlatformMBeanServer());
 120         for (int timer = 0;timer < MODULE_TIMEOUT;timer++) {
 121             try {
 122                 configRegistryClient.lookupConfigBean(getModuleName(), getInstanceName());
 123                 Thread.sleep(1);
 124             } catch (InstanceNotFoundException e) {
 125                 if (timer >= MODULE_TIMEOUT) {
 126                     throw e;
 127                 }
 128             } catch (InterruptedException e) {
 129                 LOG.error("Exception: ",e);
 130             }
 131         }
 132         Calendar stop = Calendar.getInstance();
 133         LOG.info("Module: {} Instance: {} configured after {} ms",
 134                 getModuleName(),getInstanceName(),
 135                 stop.getTimeInMillis() - start.getTimeInMillis());
 136     }
 137
 138     @Rule
 139     public TestRule watcher = new TestWatcher() {
 140         @Override
 141         protected void starting(Description description) {
 142             LOG.info("TestWatcher: Starting test:\n{}", description.getDisplayName());
 143         }
 144
 145         @Override
 146         protected void finished(Description description) {
 147             LOG.info("TestWatcher: Finished test:\n{}", description.getDisplayName());
 148         }
 149
 150         @Override
 151         protected void succeeded(Description description) {
 152             LOG.info("TestWatcher: Test succeeded:\n{}", description.getDisplayName());
 153         }
 154
 155         @Override
 156         protected void failed(Throwable ex, Description description) {
 157             LOG.info("TestWatcher: Test failed:\n{} ", description.getDisplayName(), ex);
 158         }
 159
 160         @Override
 161         protected void skipped(AssumptionViolatedException ex, Description description) {
 162             LOG.info("TestWatcher: Test skipped:\n{} ", description.getDisplayName(), ex);
 163         }
 164     };
 165 }