opendaylight/md-sal/mdsal-it-base/src/main/java/org/opendaylight/controller/mdsal/it/base/AbstractMdsalTestBase.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
   9 package org.opendaylight.controller.mdsal.it.base;
  10
  11 import static org.ops4j.pax.exam.CoreOptions.composite;
  12 import static org.ops4j.pax.exam.CoreOptions.maven;
  13 import static org.ops4j.pax.exam.CoreOptions.when;
  14 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.configureConsole;
  15 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.editConfigurationFilePut;
  16 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.features;
  17 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.karafDistributionConfiguration;
  18 import static org.ops4j.pax.exam.karaf.options.KarafDistributionOption.keepRuntimeFolder;
  19
  20 import java.io.File;
  21 import javax.inject.Inject;
  22 import org.junit.Before;
  23 import org.ops4j.pax.exam.Configuration;
  24 import org.ops4j.pax.exam.MavenUtils;
  25 import org.ops4j.pax.exam.Option;
  26 import org.ops4j.pax.exam.OptionUtils;
  27 import org.ops4j.pax.exam.karaf.container.internal.JavaVersionUtil;
  28 import org.ops4j.pax.exam.karaf.options.KarafDistributionOption;
  29 import org.ops4j.pax.exam.karaf.options.LogLevelOption.LogLevel;
  30 import org.ops4j.pax.exam.options.MavenUrlReference;
  31 import org.ops4j.pax.exam.options.extra.VMOption;
  32 import org.ops4j.pax.exam.util.Filter;
  33 import org.osgi.framework.BundleContext;
  34 import org.slf4j.Logger;
  35 import org.slf4j.LoggerFactory;
  36
  37 public abstract class AbstractMdsalTestBase {
  38
  39     private static final Logger LOG = LoggerFactory.getLogger(AbstractMdsalTestBase.class);
  40     private static final String MAVEN_REPO_LOCAL = "maven.repo.local";
  41     private static final String ETC_ORG_OPS4J_PAX_URL_MVN_CFG = "etc/org.ops4j.pax.url.mvn.cfg";
  42     private static final String ETC_ORG_OPS4J_PAX_LOGGING_CFG = "etc/org.ops4j.pax.logging.cfg";
  43
  44     private static final String PAX_EXAM_UNPACK_DIRECTORY = "target/exam";
  45     private static final String KARAF_DEBUG_PORT = "5005";
  46     private static final String KARAF_DEBUG_PROP = "karaf.debug";
  47     private static final String KEEP_UNPACK_DIRECTORY_PROP = "karaf.keep.unpack";
  48
  49     /*
  50      * Default values for karaf distro type, groupId, and artifactId
  51      */
  52     private static final String KARAF_DISTRO_TYPE = "zip";
  53     private static final String KARAF_DISTRO_ARTIFACTID = "opendaylight-karaf-empty";
  54     private static final String KARAF_DISTRO_GROUPID = "org.opendaylight.odlparent";
  55
  56     /*
  57      * Property names to override defaults for karaf distro artifactId, groupId,
  58      * version, and type
  59      */
  60     private static final String KARAF_DISTRO_TYPE_PROP = "karaf.distro.type";
  61     private static final String KARAF_DISTRO_ARTIFACTID_PROP = "karaf.distro.artifactId";
  62     private static final String KARAF_DISTRO_GROUPID_PROP = "karaf.distro.groupId";
  63
  64     public static final String ORG_OPS4J_PAX_LOGGING_CFG = "etc/org.ops4j.pax.logging.cfg";
  65
  66     @Inject @Filter(timeout = 60000)
  67     private BundleContext context;
  68
  69     public abstract MavenUrlReference getFeatureRepo();
  70
  71     public abstract String getFeatureName();
  72
  73     @Before
  74     public void setup() throws Exception {
  75     }
  76
  77     public Option getLoggingOption() {
  78         Option option = editConfigurationFilePut(ORG_OPS4J_PAX_LOGGING_CFG,
  79                 "log4j2.logger.mdsal-it-base.name",
  80                 AbstractMdsalTestBase.class.getPackage().getName());
  81         option = composite(option, editConfigurationFilePut(ORG_OPS4J_PAX_LOGGING_CFG,
  82                 "log4j2.logger.mdsal-it-base.level",
  83                 LogLevel.INFO.name()));
  84         return option;
  85     }
  86
  87     /**
  88      * Override this method to provide more options to config.
  89      *
  90      * @return An array of additional config options
  91      */
  92     protected Option[] getAdditionalOptions() {
  93         return new Option[0];
  94     }
  95
  96     /**
  97      * Returns a Log4J logging configuration property name for the given class's package name of the form
  98      * "log4j.logger.package_name".
  99      *
 100      * @deprecated The karaf logging provider is now Log4J2 so logging configurations must conform to the Log4J2 style.
 101      *     This method is kept for compilation backwards compatibility but will be removed in a future release.
 102      */
 103     @Deprecated
 104     public String logConfiguration(final Class<?> klazz) {
 105         return "log4j.logger." + klazz.getPackage().getName();
 106     }
 107
 108     public String getKarafDistro() {
 109         String groupId = System.getProperty(KARAF_DISTRO_GROUPID_PROP, KARAF_DISTRO_GROUPID);
 110         String artifactId = System.getProperty(KARAF_DISTRO_ARTIFACTID_PROP, KARAF_DISTRO_ARTIFACTID);
 111         String type = System.getProperty(KARAF_DISTRO_TYPE_PROP, KARAF_DISTRO_TYPE);
 112
 113         return maven().groupId(groupId).artifactId(artifactId).versionAsInProject().type(type).getURL();
 114     }
 115
 116     protected Option mvnLocalRepoOption() {
 117         String mvnRepoLocal = System.getProperty(MAVEN_REPO_LOCAL, "");
 118         LOG.info("mvnLocalRepo \"{}\"", mvnRepoLocal);
 119         return editConfigurationFilePut(ETC_ORG_OPS4J_PAX_URL_MVN_CFG,
 120             "org.ops4j.pax.url.mvn.localRepository", mvnRepoLocal);
 121     }
 122
 123     @Configuration
 124     public Option[] config() {
 125         Option[] options = new Option[] {
 126                 when(Boolean.getBoolean(KARAF_DEBUG_PROP))
 127                         .useOptions(KarafDistributionOption.debugConfiguration(KARAF_DEBUG_PORT, true)),
 128                 karafDistributionConfiguration().frameworkUrl(getKarafDistro())
 129                         .unpackDirectory(new File(PAX_EXAM_UNPACK_DIRECTORY)).useDeployFolder(false),
 130                 when(Boolean.getBoolean(KEEP_UNPACK_DIRECTORY_PROP)).useOptions(keepRuntimeFolder()),
 131                 features(getFeatureRepo(), getFeatureName()),
 132                 mvnLocalRepoOption(),
 133
 134                 // Make sure karaf's default repository is consulted before anything else
 135                 editConfigurationFilePut(ETC_ORG_OPS4J_PAX_URL_MVN_CFG, "org.ops4j.pax.url.mvn.defaultRepositories",
 136                         "file:${karaf.home}/${karaf.default.repository}@id=system.repository"),
 137
 138                 configureConsole().ignoreLocalConsole().ignoreRemoteShell(),
 139                 editConfigurationFilePut(ETC_ORG_OPS4J_PAX_LOGGING_CFG, "log4j2.rootLogger.level", "INFO") };
 140
 141         if (JavaVersionUtil.getMajorVersion() >= 9) {
 142             final String karafVersion = MavenUtils.getArtifactVersion("org.apache.karaf.features",
 143                 "org.apache.karaf.features.core");
 144             options = OptionUtils.combine(options, new VMOption[] {
 145                 new VMOption("--add-reads=java.xml=java.logging"),
 146                 new VMOption("--add-exports=java.base/org.apache.karaf.specs.locator=java.xml,ALL-UNNAMED"),
 147                 new VMOption("--patch-module"),
 148                 new VMOption("java.base=lib/endorsed/org.apache.karaf.specs.locator-" + karafVersion + ".jar"),
 149                 new VMOption("--patch-module"),
 150                 new VMOption("java.xml=lib/endorsed/org.apache.karaf.specs.java.xml-" + karafVersion + ".jar"),
 151                 new VMOption("--add-opens"),
 152                 new VMOption("java.base/java.security=ALL-UNNAMED"),
 153                 new VMOption("--add-opens"),
 154                 new VMOption("java.base/java.net=ALL-UNNAMED"),
 155                 new VMOption("--add-opens"),
 156                 new VMOption("java.base/java.lang=ALL-UNNAMED"),
 157                 new VMOption("--add-opens"),
 158                 new VMOption("java.base/java.util=ALL-UNNAMED"),
 159                 new VMOption("--add-opens"),
 160                 new VMOption("java.naming/javax.naming.spi=ALL-UNNAMED"),
 161                 new VMOption("--add-opens"),
 162                 new VMOption("java.rmi/sun.rmi.transport.tcp=ALL-UNNAMED"),
 163                 new VMOption("--add-exports=java.base/sun.net.www.protocol.http=ALL-UNNAMED"),
 164                 new VMOption("--add-exports=java.base/sun.net.www.protocol.https=ALL-UNNAMED"),
 165                 new VMOption("--add-exports=java.base/sun.net.www.protocol.jar=ALL-UNNAMED"),
 166                 new VMOption("--add-exports=jdk.naming.rmi/com.sun.jndi.url.rmi=ALL-UNNAMED"),
 167                 new VMOption("-classpath"),
 168                 new VMOption("lib/jdk9plus/*" + File.pathSeparator + "lib/boot/*")
 169             });
 170         }
 171
 172         return OptionUtils.combine(options, getAdditionalOptions());
 173     }
 174 }