X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;ds=sidebyside;f=opendaylight%2Fconfig%2Fconfig-persister-feature-adapter%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fconfigpusherfeature%2Finternal%2FFeatureConfigPusher.java;h=6f304452a9bd04b55b9357a3657bdaa0b065c7bd;hb=35cfadae941fb2a8722b40b829569d8754fa309e;hp=406739d1c752c05a49e21b66d35667a0881678af;hpb=f5fcfe86c7baeea72b81886e01215840fbf1b91b;p=controller.git diff --git a/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/FeatureConfigPusher.java b/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/FeatureConfigPusher.java index 406739d1c7..6f304452a9 100644 --- a/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/FeatureConfigPusher.java +++ b/opendaylight/config/config-persister-feature-adapter/src/main/java/org/opendaylight/controller/configpusherfeature/internal/FeatureConfigPusher.java @@ -9,16 +9,18 @@ package org.opendaylight.controller.configpusherfeature.internal; import com.google.common.base.Optional; import com.google.common.collect.LinkedHashMultimap; + import java.util.ArrayList; import java.util.Arrays; -import java.util.ConcurrentModificationException; +import java.util.Collections; import java.util.LinkedHashSet; import java.util.List; import java.util.Set; +import java.util.concurrent.TimeUnit; + import org.apache.karaf.features.Feature; import org.apache.karaf.features.FeaturesService; import org.opendaylight.controller.config.persist.api.ConfigPusher; -import org.opendaylight.controller.config.persist.api.ConfigSnapshotHolder; import org.opendaylight.controller.config.persist.storage.file.xml.XmlFileStorageAdapter; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -27,14 +29,12 @@ import org.slf4j.LoggerFactory; * Simple class to push configs to the config subsystem from Feature's configfiles */ public class FeatureConfigPusher { - private static final Logger LOG = LoggerFactory.getLogger(FeatureConfigPusher.class); + private static final int MAX_RETRIES = 100; + private static final int RETRY_PAUSE_MILLIS = 1; - private static final int MAX_RETRIES = 10; - private static final int RETRY_PAUSE_MILLIS = 100; - - private final FeaturesService featuresService; - private final ConfigPusher pusher; + private FeaturesService featuresService = null; + private ConfigPusher pusher = null; /* * A LinkedHashSet (to preserve order and insure uniqueness) of the pushedConfigs @@ -42,21 +42,20 @@ public class FeatureConfigPusher { * chains. Also, preserves the *original* Feature chain for which we pushed the config. * (which is handy for logging). */ - Set pushedConfigs = new LinkedHashSet<>(); + private final Set pushedConfigs = new LinkedHashSet<>(); /* * LinkedHashMultimap to track which configs we pushed for each Feature installation * For future use */ - LinkedHashMultimap feature2configs = LinkedHashMultimap.create(); + private final LinkedHashMultimap feature2configs = LinkedHashMultimap + .create(); - /* - * @param p - ConfigPusher to push ConfigSnapshotHolders - */ - public FeatureConfigPusher(final ConfigPusher pusher, final FeaturesService featuresService) { - this.pusher = pusher; + public FeatureConfigPusher(final ConfigPusher configPusher, final FeaturesService featuresService) { + pusher = configPusher; this.featuresService = featuresService; } + /* * Push config files from Features to config subsystem * @param features - list of Features to extract config files from recursively and push @@ -66,11 +65,10 @@ public class FeatureConfigPusher { * If a Feature is not in the returned LinkedHashMultimap then we couldn't push its configs * (Ususally because it was not yet installed) */ - public LinkedHashMultimap pushConfigs(final List features) throws Exception { + public LinkedHashMultimap pushConfigs( + final List features) throws Exception { LinkedHashMultimap pushedFeatures = LinkedHashMultimap.create(); for (Feature feature : features) { - - Set configSnapShots = pushConfig(feature); if (!configSnapShots.isEmpty()) { pushedFeatures.putAll(feature, configSnapShots); @@ -80,75 +78,78 @@ public class FeatureConfigPusher { } private Set pushConfig(final Feature feature) throws Exception { - Set configs = new LinkedHashSet<>(); - if(isInstalled(feature)) { - // FIXME Workaround for BUG-2836, features service returns null for feature: standard-condition-webconsole_0_0_0, 3.0.1 - if(featuresService.getFeature(feature.getName(), feature.getVersion()) == null) { - LOG.debug("Feature: {}, {} is missing from features service. Skipping", feature.getName(), feature.getVersion()); - } else { - ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature, featuresService); - configs = wrappedFeature.getFeatureConfigSnapshotHolders(); - if (!configs.isEmpty()) { - configs = pushConfig(configs, feature); - feature2configs.putAll(feature, configs); - } - } + // Ignore feature conditions — these encode conditions on other features and shouldn't be processed here + if (feature.getName().contains("-condition-")) { + LOG.debug("Ignoring conditional feature {}", feature); + return Collections.emptySet(); + } + // pax-exam's Karaf container generates a wrapper feature holding the test dependencies. Ignore it. + if ("test-dependencies".equals(feature.getName())) { + LOG.debug("Ignoring pax-exam wrapper feature {}", feature); + return Collections.emptySet(); } - return configs; - } - private boolean isInstalled(final Feature feature) { - Exception lastException = null; - for (int retries = 0; retries < MAX_RETRIES; retries++) { - try { - List installedFeatures = Arrays.asList(featuresService.listInstalledFeatures()); - if (installedFeatures.contains(feature)) { - return true; - } else { - LOG.warn("Karaf featuresService.listInstalledFeatures() has not yet finished installing feature (retry {}) {} {}", retries, feature.getName(), feature.getVersion()); - } - // TODO This catch of ConcurrentModificationException may be able to simply be removed after - // we're fully on Karaf 4 only, as a comment in BUG-6787 indicates that (in Karaf 4) : - // "the 'installed' Map of FeaturesServiceImpl .. appears to be correctly synchronized/thread-safe". - // (Or, if it's still NOK, then it could be fixed properly upstream in Karaf once we're on recent.) - } catch (ConcurrentModificationException e) { - // BUG-6787 experience shows that a LOG.warn (or info) here is very confusing to end-users; - // as we have a retry loop anyway, there is no point informing (and confusing) users of this - // intermediate state of, so ... NOOP, do not log here. - lastException = e; - } - try { - Thread.sleep(RETRY_PAUSE_MILLIS); - } catch (InterruptedException e1) { - throw new IllegalStateException(e1); - } + if (!isInstalled(feature)) { + return Collections.emptySet(); } - LOG.error("Giving up (after {} retries) on Karaf featuresService.listInstalledFeatures() " - + "which has not yet finished installing feature {} {} (stack trace is last exception caught)", - MAX_RETRIES, feature.getName(), feature.getVersion(), lastException); - return false; + // FIXME Workaround for BUG-2836, features service returns null for feature: + // standard-condition-webconsole_0_0_0, 3.0.1 + if (featuresService.getFeature(feature.getName(), feature.getVersion()) == null) { + LOG.debug("Feature: {}, {} is missing from features service. Skipping", feature.getName(), feature + .getVersion()); + return Collections.emptySet(); + } + + ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature, featuresService); + Set configs = wrappedFeature.getFeatureConfigSnapshotHolders(); + if (!configs.isEmpty()) { + configs = pushConfig(configs, feature); + feature2configs.putAll(feature, configs); + } + return configs; } - private Set pushConfig(final Set configs, final Feature feature) - throws InterruptedException { + private Set pushConfig(final Set configs, + final Feature feature) throws InterruptedException { Set configsToPush = new LinkedHashSet<>(configs); configsToPush.removeAll(pushedConfigs); if (!configsToPush.isEmpty()) { // Ignore features that are present in persisted current config final Optional currentCfgPusher = XmlFileStorageAdapter.getInstance(); - if (currentCfgPusher.isPresent() && - currentCfgPusher.get().getPersistedFeatures().contains(feature.getId())) { + if (currentCfgPusher.isPresent() && currentCfgPusher.get().getPersistedFeatures() + .contains(feature.getId())) { LOG.warn("Ignoring default configuration {} for feature {}, the configuration is present in {}", configsToPush, feature.getId(), currentCfgPusher.get()); } else { - pusher.pushConfigs(new ArrayList(configsToPush)); + pusher.pushConfigs(new ArrayList<>(configsToPush)); } - pushedConfigs.addAll(configsToPush); } Set configsPushed = new LinkedHashSet<>(pushedConfigs); configsPushed.retainAll(configs); return configsPushed; } + + @SuppressWarnings("IllegalCatch") + private boolean isInstalled(final Feature feature) throws InterruptedException { + for (int retries = 0; retries < MAX_RETRIES; retries++) { + try { + List installedFeatures = Arrays.asList(featuresService.listInstalledFeatures()); + if (installedFeatures.contains(feature)) { + return true; + } + + LOG.info("Karaf Feature Service has not yet finished installing feature {}/{} (retry {})", feature + .getName(), feature.getVersion(), retries); + } catch (final Exception e) { + LOG.warn("Karaf featuresService.listInstalledFeatures() has thrown an exception, retry {}", retries, e); + } + + TimeUnit.MILLISECONDS.sleep(RETRY_PAUSE_MILLIS); + } + LOG.error("Giving up (after {} retries) on Karaf featuresService.listInstalledFeatures() which has not yet " + + "finished installing feature {} {}", MAX_RETRIES, feature.getName(), feature.getVersion()); + return false; + } }