X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fconfig%2Fconfig-persister-feature-adapter%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fconfigpusherfeature%2Finternal%2FFeatureConfigPusher.java;h=406739d1c752c05a49e21b66d35667a0881678af;hp=7b90580a660cac0a03a4b90c0c0f8d40a1d2eb68;hb=f5fcfe86c7baeea72b81886e01215840fbf1b91b;hpb=ad587084842de7086a54e57a3152bf3232a30702 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 7b90580a66..406739d1c7 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 @@ -7,15 +7,19 @@ */ 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.LinkedHashSet; import java.util.List; +import java.util.Set; 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; @@ -23,18 +27,23 @@ 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 FeaturesService featuresService = null; - private ConfigPusher pusher = null; + + private static final int MAX_RETRIES = 10; + private static final int RETRY_PAUSE_MILLIS = 100; + + private final FeaturesService featuresService; + private final ConfigPusher pusher; + /* * A LinkedHashSet (to preserve order and insure uniqueness) of the pushedConfigs * This is used to prevent pushing duplicate configs if a Feature is in multiple dependency * chains. Also, preserves the *original* Feature chain for which we pushed the config. * (which is handy for logging). */ - LinkedHashSet pushedConfigs = new LinkedHashSet(); + Set pushedConfigs = new LinkedHashSet<>(); + /* * LinkedHashMultimap to track which configs we pushed for each Feature installation * For future use @@ -44,9 +53,9 @@ public class FeatureConfigPusher { /* * @param p - ConfigPusher to push ConfigSnapshotHolders */ - public FeatureConfigPusher(final ConfigPusher p, final FeaturesService f) { - pusher = p; - featuresService = f; + public FeatureConfigPusher(final ConfigPusher pusher, final FeaturesService featuresService) { + this.pusher = pusher; + this.featuresService = featuresService; } /* * Push config files from Features to config subsystem @@ -57,46 +66,56 @@ 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, InterruptedException { - LinkedHashMultimap pushedFeatures = LinkedHashMultimap.create(); - for(Feature feature: features) { - LinkedHashSet configSnapShots = pushConfig(feature); - if(!configSnapShots.isEmpty()) { - pushedFeatures.putAll(feature,configSnapShots); + 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); } } return pushedFeatures; } - private LinkedHashSet pushConfig(final Feature feature) throws Exception, InterruptedException { - LinkedHashSet configs = new LinkedHashSet(); + private Set pushConfig(final Feature feature) throws Exception { + Set configs = new LinkedHashSet<>(); if(isInstalled(feature)) { - ChildAwareFeatureWrapper wrappedFeature = new ChildAwareFeatureWrapper(feature,featuresService); - configs = wrappedFeature.getFeatureConfigSnapshotHolders(); - if(!configs.isEmpty()) { - configs = pushConfig(configs); - feature2configs.putAll(feature, configs); + // 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); + } } } return configs; } private boolean isInstalled(final Feature feature) { - for(int retries=0;retries installedFeatures = Arrays.asList(featuresService.listInstalledFeatures()); - if(installedFeatures.contains(feature)) { + if (installedFeatures.contains(feature)) { return true; } else { - LOG.warn("Karaf featuresService.listInstalledFeatures() has not yet finished installing feature (retry {}) {} {}",retries,feature.getName(),feature.getVersion()); - } - } catch (Exception e) { - if(retries < MAX_RETRIES) { - LOG.warn("Karaf featuresService.listInstalledFeatures() has thrown an exception, retry {}", retries, e); - } else { - LOG.error("Giving up on Karaf featuresService.listInstalledFeatures() which has thrown an exception, retry {}", retries, e); - throw e; + 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); @@ -104,18 +123,31 @@ public class FeatureConfigPusher { throw new IllegalStateException(e1); } } - LOG.error("Giving up (after {} retries) on Karaf featuresService.listInstalledFeatures() which has not yet finished installing feature {} {}",MAX_RETRIES,feature.getName(),feature.getVersion()); + 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; } - private LinkedHashSet pushConfig(final LinkedHashSet configs) throws InterruptedException { - LinkedHashSet configsToPush = new LinkedHashSet(configs); + private Set pushConfig(final Set configs, final Feature feature) + throws InterruptedException { + Set configsToPush = new LinkedHashSet<>(configs); configsToPush.removeAll(pushedConfigs); - if(!configsToPush.isEmpty()) { - pusher.pushConfigs(new ArrayList(configsToPush)); + 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())) { + LOG.warn("Ignoring default configuration {} for feature {}, the configuration is present in {}", + configsToPush, feature.getId(), currentCfgPusher.get()); + } else { + pusher.pushConfigs(new ArrayList(configsToPush)); + } + pushedConfigs.addAll(configsToPush); } - LinkedHashSet configsPushed = new LinkedHashSet(pushedConfigs); + Set configsPushed = new LinkedHashSet<>(pushedConfigs); configsPushed.retainAll(configs); return configsPushed; }