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