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                 .artifactId("karaf")
  90                 .version("1.1.0-SNAPSHOT")
  91                 .type("zip");
  92         return karafUrl;
  93     }
  94
  95     @Configuration
  96     public Option[] config() {
  97         LOG.info("Calling config, configTimes: {}", configTimes);
  98         configTimes++;
  99         extras = setExtras();
 100         Option[] options = new Option[] {
 101                 //KarafDistributionOption.debugConfiguration("5005", true),
 102                 karafDistributionConfiguration()
 103                         .frameworkUrl(getKarafDistro())
 104                         .unpackDirectory(new File("target/exam"))
 105                         .useDeployFolder(false),
 106                 keepRuntimeFolder(),
 107                 //features(getFeatureRepo() , getFeatureName())
 108         };
 109         options = ObjectArrays.concat(options, getFeaturesOptions(extras), Option.class);
 110         options = ObjectArrays.concat(options, getLoggingOptions(extras), Option.class);
 111         options = ObjectArrays.concat(options, getPropertiesOptions(extras), Option.class);
 112         return options;
 113     }
 114
 115     public void setup() throws Exception {
 116         LOG.info("Module: {} Instance: {} attempting to configure.",
 117                 getModuleName(),getInstanceName());
 118         Calendar start = Calendar.getInstance();
 119         ConfigRegistry configRegistryClient = new ConfigRegistryJMXClient(ManagementFactory
 120                 .getPlatformMBeanServer());
 121         for (int timer = 0;timer < MODULE_TIMEOUT;timer++) {
 122             try {
 123                 configRegistryClient.lookupConfigBean(getModuleName(), getInstanceName());
 124                 Thread.sleep(1);
 125             } catch (InstanceNotFoundException e) {
 126                 if (timer >= MODULE_TIMEOUT) {
 127                     throw e;
 128                 }
 129             } catch (InterruptedException e) {
 130                 LOG.error("Exception: ",e);
 131             }
 132         }
 133         Calendar stop = Calendar.getInstance();
 134         LOG.info("Module: {} Instance: {} configured after {} ms",
 135                 getModuleName(),getInstanceName(),
 136                 stop.getTimeInMillis() - start.getTimeInMillis());
 137     }
 138
 139     @Rule
 140     public TestRule watcher = new TestWatcher() {
 141         @Override
 142         protected void starting(Description description) {
 143             LOG.info("TestWatcher: Starting test:\n{}", description.getDisplayName());
 144         }
 145
 146         @Override
 147         protected void finished(Description description) {
 148             LOG.info("TestWatcher: Finished test:\n{}", description.getDisplayName());
 149         }
 150
 151         @Override
 152         protected void succeeded(Description description) {
 153             LOG.info("TestWatcher: Test succeeded:\n{}", description.getDisplayName());
 154         }
 155
 156         @Override
 157         protected void failed(Throwable ex, Description description) {
 158             LOG.info("TestWatcher: Test failed:\n{} ", description.getDisplayName(), ex);
 159         }
 160
 161         @Override
 162         protected void skipped(AssumptionViolatedException ex, Description description) {
 163             LOG.info("TestWatcher: Test skipped:\n{} ", description.getDisplayName(), ex);
 164         }
 165     };
 166 }