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=2737954884814464dfc1f71615217b073c9d236b;hp=1c094ad2dcea5b4def01253d4e6507a1b60a61f1;hb=5e50116b65e5e6c6f2f69c7a8df91c64e6bc7e10;hpb=a3ff4b68093e6d675a92159e0efa2525af32d644 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 1c094ad2dc..2737954884 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,47 +7,52 @@ */ 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.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; -import com.google.common.collect.LinkedHashMultimap; - /* * Simple class to push configs to the config subsystem from Feature's configfiles */ public class FeatureConfigPusher { - private static final Logger logger = LoggerFactory.getLogger(FeatureConfigPusher.class); + 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; + /* * 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(); + 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(ConfigPusher p, FeaturesService f) { - pusher = p; - featuresService = f; + 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 @@ -57,44 +62,99 @@ 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(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(Feature feature) throws Exception, InterruptedException { - LinkedHashSet 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); - } + private Set pushConfig(final Feature feature) throws Exception { + // 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(Feature feature) { - List installedFeatures = Arrays.asList(featuresService.listInstalledFeatures()); - return installedFeatures.contains(feature); + if (!isInstalled(feature)) { + return Collections.emptySet(); + } + // 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 LinkedHashSet pushConfig(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; } + + @SuppressWarnings("IllegalCatch") + private boolean isInstalled(final Feature feature) throws InterruptedException { + for (int retries = 0; retries < MAX_RETRIES; retries++) { + try { + // We process the installed features manually to handle the special "0.0.0" version + // which is the representation for null + for (Feature installedFeature : featuresService.listInstalledFeatures()) { + if (feature.equals(installedFeature)) { + return true; + } + if ("0.0.0".equals(feature.getVersion()) && feature.getName().equals(installedFeature.getName()) + && !installedFeature.hasVersion()) { + return true; + } + } + + LOG.debug("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; + } }