List of Karaf 3.0.4 default maven repositories with snapshot repositories excluded.
*Unfortunately this must be hard-coded since declarative model which uses Options, * does not allow us to read value, parse it (properties has allways * problems with lists) and construct replacement string which does * not contains snapshots.
*When updating Karaf, check this against org.ops4j.pax.url.mvn.cfg in the Karaf distribution.
*/ private static final String EXTERNAL_DEFAULT_REPOSITORIES = "http://repo1.maven.org/maven2@id=central, " + "http://repository.springsource.com/maven/bundles/release@id=spring.ebr.release, " + "http://repository.springsource.com/maven/bundles/external@id=spring.ebr.external, " + "http://zodiac.springsource.com/maven/bundles/release@id=gemini "; @Inject @NonNull private BundleContext bundleContext; @Inject @NonNull private BundleService bundleService; // NOT BundleStateService, see checkBundleStatesDiag() @Inject @NonNull private FeaturesService featuresService; private String karafVersion; private String karafDistroVersion; @ProbeBuilder public TestProbeBuilder probeConfiguration(TestProbeBuilder probe) { // add this to test Karaf Commands, according to green Karaf book // also see http://iocanel.blogspot.ch/2012/01/advanced-integration-testing-with-pax.html // probe.setHeader(org.osgi.framework.Constants.DYNAMICIMPORT_PACKAGE, "*;status=provisional"); // adding these so that loading of TestBundleDiag and its dependencies works // NB that here in the features4-test this works completely differently than // in the original features-test for Karaf 3; there we installed the bundle in // config() whereas here we embed dependencies into a single JAR to simplify // problems we've had in distribution jobs with custom local Maven repos; // but because of this we have to "help" Pax Exam with what classes need // to be bundled with its probe: ReflectionUtil.addAllClassesInSameAndSubPackageOfClass(probe, TestBundleDiag.class); ReflectionUtil.addAllClassesInSameAndSubPackageOfClass(probe, Awaitility.class); ReflectionUtil.addAllClassesInSameAndSubPackageOfPackage(probe, "com.google.common"); return probe; } /** * Returns the required configuration. * * @return The Pax Exam configuration. * @throws IOException if an error occurs. */ @Configuration public Option[] config() throws IOException { return new Option[] { // TODO: Find a way to inherit memory limits from Maven options. new VMOption("-Xmx2g"), new VMOption("-XX:+HeapDumpOnOutOfMemoryError"), new VMOption("-XX:OnOutOfMemoryError=\"kill -3 %p\""), // inspired by org.apache.commons.lang.SystemUtils when(System.getProperty("os.name").toLowerCase().startsWith("linux")).useOptions( // This prevents low entropy issues on Linux to affect Java random numbers // which can block crypto such as the SSH server in netconf // see https://bugs.opendaylight.org/show_bug.cgi?id=6790 new VMOption("-Djava.security.egd=file:/dev/./urandom") ), when(Boolean.getBoolean(PROFILE_PROP)).useOptions( new VMOption("-XX:+UnlockCommercialFeatures"), new VMOption("-XX:+FlightRecorder"), new VMOption("-XX:FlightRecorderOptions=defaultrecording=true,dumponexit=true,dumponexitpath=" + getNewJFRFile()) ), getKarafDistroOption(), when(Boolean.getBoolean(KEEP_UNPACK_DIRECTORY_PROP)).useOptions(keepRuntimeFolder()), configureConsole().ignoreLocalConsole(), logLevel(LogLevel.INFO), mvnLocalRepoOption(), mavenBundle("org.apache.aries.quiesce", "org.apache.aries.quiesce.api", "1.0.0"), editConfigurationFilePut(ORG_OPS4J_PAX_LOGGING_CFG, LOG4J_LOGGER_ORG_OPENDAYLIGHT_YANGTOOLS_FEATURETEST, LogLevel.INFO.name()), editConfigurationFilePut("etc/config.properties", "karaf.framework", "equinox"), editConfigurationFilePut(ETC_ORG_OPS4J_PAX_LOGGING_CFG, "log4j.rootLogger", "INFO, stdout, osgi:*"), /* * Disables external snapshot repositories. * * Pax URL and Karaf by default always search for new version of snapshots * in all snapshots repository, even if that snapshots does not belong to that * repository and maven is invoked even with -nsu (no snapshot update) * or offline mode. * * This is also true for OpenDaylight snapshot artefacts - pax url tries * to resolve them from third-party repositories, even if they are not present * there - this increases time which takes for features to install. * * For more complex projects this actually means several HTTP GETs for each * snapshot bundle referenced, even if the bundle is already present * in local maven repository. * * In order to speed-up installation and remove unnecessary network traffic, * which fails for obvious reasons, external snapshot repositories are * removed. */ disableExternalSnapshotRepositories(), propagateSystemProperty(ORG_OPENDAYLIGHT_FEATURETEST_URI_PROP), propagateSystemProperty(ORG_OPENDAYLIGHT_FEATURETEST_FEATURENAME_PROP), propagateSystemProperty(ORG_OPENDAYLIGHT_FEATURETEST_FEATUREVERSION_PROP), propagateSystemProperty(BUNDLES_DIAG_SKIP_PROP), propagateSystemProperty(BUNDLES_DIAG_FORCE_PROP), propagateSystemProperty(BUNDLES_DIAG_TIMEOUT_PROP), // Needed for Agrona/aeron.io systemPackages("com.sun.media.sound", "sun.nio.ch"), }; } private String getNewJFRFile() throws IOException { return File.createTempFile("SingleFeatureTest-Karaf-JavaFlightRecorder", ".jfr").getAbsolutePath(); } private String getKarafVersion() throws IOException { if (karafVersion == null) { // We use a properties file to retrieve ${karaf.version}, instead of .versionAsInProject() // This avoids forcing all users to depend on Karaf in their POMs Properties singleFeatureTestProps = new Properties(); try (InputStream singleFeatureTestInputStream = Thread.currentThread().getContextClassLoader() .getResourceAsStream(PROPERTIES_FILENAME)) { if (singleFeatureTestInputStream == null) { throw new IOException("Resource not found; expected to be present on current thread classloader: " + PROPERTIES_FILENAME); } singleFeatureTestProps.load(singleFeatureTestInputStream); } karafVersion = singleFeatureTestProps.getProperty(KARAF_DISTRO_VERSION_PROP); LOG.info("Retrieved karafVersion {} from properties file {}", karafVersion, PROPERTIES_FILENAME); } else { LOG.info("Retrieved karafVersion {} from system property {}", karafVersion, KARAF_DISTRO_VERSION_PROP); } return karafVersion; } private String getKarafDistroVersion() throws IOException { if (karafDistroVersion == null) { karafDistroVersion = System.getProperty(KARAF_DISTRO_VERSION_PROP); if (karafDistroVersion == null) { karafDistroVersion = getKarafVersion(); } else { LOG.info("Retrieved karafDistroVersion {} from system property {}", karafVersion, KARAF_DISTRO_VERSION_PROP); } } return karafDistroVersion; } /** * Disables snapshot repositories, which are enabled by default in karaf distribution. * * @return Edit Configuration option which removes external snapshot repositories. */ private static Option disableExternalSnapshotRepositories() { return editConfigurationFilePut(ETC_ORG_OPS4J_PAX_URL_MVN_CFG, ORG_OPS4J_PAX_URL_MVN_REPOSITORIES, EXTERNAL_DEFAULT_REPOSITORIES); } protected Option mvnLocalRepoOption() { String mvnRepoLocal = System.getProperty(MAVEN_REPO_LOCAL, ""); LOG.info("mvnLocalRepo \"{}\"", mvnRepoLocal); return editConfigurationFilePut(ETC_ORG_OPS4J_PAX_URL_MVN_CFG, ORG_OPS4J_PAX_URL_MVN_LOCAL_REPOSITORY, mvnRepoLocal); } protected Option getKarafDistroOption() throws IOException { String groupId = System.getProperty(KARAF_DISTRO_GROUPID_PROP, KARAF_DISTRO_GROUPID); String artifactId = System.getProperty(KARAF_DISTRO_ARTIFACTID_PROP, KARAF_DISTRO_ARTIFACTID); String type = System.getProperty(KARAF_DISTRO_TYPE_PROP, KARAF_DISTRO_TYPE); LOG.info("Using karaf distro {} {} {} {}", groupId, artifactId, getKarafDistroVersion(), type); return karafDistributionConfiguration() .frameworkUrl( maven() .groupId(groupId) .artifactId(artifactId) .type(type) .version(getKarafDistroVersion())) .name("OpenDaylight") .unpackDirectory(new File("target/pax")) .useDeployFolder(false); } private static URI getRepoUri() throws URISyntaxException { return new URI(getProperty(ORG_OPENDAYLIGHT_FEATURETEST_URI_PROP)); } private static String getFeatureName() { return getProperty(ORG_OPENDAYLIGHT_FEATURETEST_FEATURENAME_PROP); } public String getFeatureVersion() { return getProperty(ORG_OPENDAYLIGHT_FEATURETEST_FEATUREVERSION_PROP); } private static String getProperty(final String propName) { String prop = System.getProperty(propName); Assert.assertTrue("Missing property :" + propName, prop != null); return prop; } private void checkRepository(final URI repoUri) throws Exception { Repository repo = null; for (Repository r : featuresService.listRepositories()) { if (r.getURI().equals(repoUri)) { repo = r; break; } } Assert.assertNotNull("Repository not found: " + repoUri, repo); } /** * Sets the repository up. * * @throws Exception if an error occurs. */ @Before public void installRepo() throws Exception { final URI repoUri = getRepoUri(); LOG.info("Attempting to add repository {}", repoUri); featuresService.addRepository(repoUri); checkRepository(repoUri); LOG.info("Successfully loaded repository {}", repoUri); } // Give it 10 minutes max as we've seen feature install hang on jenkins. @Test(timeout = 600000) @SuppressWarnings("checkstyle:IllegalCatch") public void installFeatureCatchAndLog() throws Exception { // TODO remove this when the underlying problem is solved // https://bugs.opendaylight.org/show_bug.cgi?id=7981: // "SFT never fails, Pax Exam (or our wrappers) swallow all exceptions" try { installFeature(); } catch (Throwable t) { LOG.error("installFeature() failed", t); // as of 2017.03.20, this re-throw seems to have no effect, // the exception gets lost in space, swallowed somewhere! :( throw t; } } public void installFeature() throws Exception { // The BundleContext originally @Inject'd into the field // is, as expected, the PAXEXAM-PROBE. For some strange reason, // under Karaf 4 (this works under Karaf 3 without this trick), // after the installFeature() & getFeature() & isInstalled() // below are through, that BundleContext has become invalid // already (too soon!), and using it leads to "IllegalStateException: // BundleContext is no longer valid". -- Because we don't actually // need the PAXEXAM-PROBE, just ANY BundleContext, we employ a // little trick, and obtain the OSGi Framework's (Felix or Equinox's) // own BundleContext, which will never become invalid, and use that instead. // This works, but is a work around, and the fact that we have to do this // may be an indication of a larger problem... see also related strange open bugs // which make it seem like at least some other bundles also get uninstalled // way too soon, for some reason: // * https://bugs.opendaylight.org/show_bug.cgi?id=7924 // * https://bugs.opendaylight.org/show_bug.cgi?id=7923 (?) // * https://bugs.opendaylight.org/show_bug.cgi?id=7926 bundleContext = bundleContext.getBundle(0).getBundleContext(); LOG.info("Attempting to install feature {} {}", getFeatureName(), getFeatureVersion()); featuresService.installFeature(getFeatureName(), getFeatureVersion(), EnumSet.of(FeaturesService.Option.Verbose)); LOG.info("installFeature() completed"); Feature feature = featuresService.getFeature(getFeatureName(), getFeatureVersion()); LOG.info("getFeature() completed"); Assert.assertNotNull( "Attempt to get feature " + getFeatureName() + " " + getFeatureVersion() + "resulted in null", feature); boolean isInstalled = featuresService.isInstalled(feature); LOG.info("isInstalled() completed"); Assert.assertTrue( "Failed to install Feature: " + getFeatureName() + " " + getFeatureVersion(), isInstalled); LOG.info("Successfully installed feature {} {}", getFeatureName(), getFeatureVersion()); if (!Boolean.getBoolean(BUNDLES_DIAG_SKIP_PROP) && (Boolean.getBoolean(BUNDLES_DIAG_FORCE_PROP) || !BLACKLISTED_BROKEN_FEATURES.contains(getFeatureName()))) { LOG.info("new TestBundleDiag().checkBundleDiagInfos() STARTING"); Integer timeOutInSeconds = Integer.getInteger(BUNDLES_DIAG_TIMEOUT_PROP, 5 * 60); new TestBundleDiag(bundleContext, bundleService).checkBundleDiagInfos(timeOutInSeconds, SECONDS); LOG.info("new TestBundleDiag().checkBundleDiagInfos() ENDED"); } else { LOG.warn("SKIPPING TestBundleDiag because system property {} is true or feature is blacklisted: {}", BUNDLES_DIAG_SKIP_PROP, getFeatureName()); } } // TODO remove this when all issues linked to parent https://bugs.opendaylight.org/show_bug.cgi?id=7582 are resolved private static final List