Github user ahgittin commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/866#discussion_r146488928
--- Diff:
core/src/main/java/org/apache/brooklyn/core/catalog/internal/BundleUpgradeParser.java
---
@@ -0,0 +1,239 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.brooklyn.core.catalog.internal;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.Dictionary;
+import java.util.LinkedHashSet;
+import java.util.List;
+import java.util.Set;
+
+import org.apache.brooklyn.api.catalog.CatalogItem;
+import org.apache.brooklyn.util.osgi.VersionedName;
+import org.apache.brooklyn.util.text.BrooklynVersionSyntax;
+import org.apache.brooklyn.util.text.QuotedStringTokenizer;
+import org.apache.brooklyn.util.text.Strings;
+import org.osgi.framework.Bundle;
+import org.osgi.framework.VersionRange;
+
+import com.google.common.annotations.Beta;
+import com.google.common.annotations.VisibleForTesting;
+import com.google.common.base.Objects;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.ImmutableSet;
+
+public class BundleUpgradeParser {
+
+ @Beta
+ public static final String MANIFEST_HEADER_FORCE_REMOVE_LEGACY_ITEMS =
"brooklyn-catalog-force-remove-legacy-items";
+
+ @Beta
+ public static final String MANIFEST_HEADER_FORCE_REMOVE_BUNDLES =
"brooklyn-catalog-force-remove-bundles";
+
+ @Beta
+ public static final String MANIFEST_HEADER_UPGRADE_BUNDLES =
"brooklyn-catalog-upgrade-for-bundles";
+
+ /**
+ * The result from parsing bundle(s) to find their upgrade info.
+ */
+ public static class CatalogUpgrades {
+ static final CatalogUpgrades EMPTY = new
CatalogUpgrades(builder());
+
+ static class Builder {
+ private Set<VersionRangedName> removedLegacyItems = new
LinkedHashSet<>();
+ private Set<VersionRangedName> removedBundles = new
LinkedHashSet<>();
+
+ public Builder
removedLegacyItems(Collection<VersionRangedName> vals) {
+ removedLegacyItems.addAll(vals);
+ return this;
+ }
+ public Builder removedBundles(Collection<VersionRangedName>
vals) {
+ removedBundles.addAll(vals);
+ return this;
+ }
+ public Builder addAll(CatalogUpgrades other) {
+ removedLegacyItems.addAll(other.removedLegacyItems);
+ removedBundles.addAll(other.removedBundles);
+ return this;
+ }
+ public CatalogUpgrades build() {
+ return new CatalogUpgrades(this);
+ }
+ }
+
+ public static Builder builder() {
+ return new Builder();
+ }
+
+ private Set<VersionRangedName> removedLegacyItems;
+ private Set<VersionRangedName> removedBundles;
+
+ public CatalogUpgrades(Builder builder) {
+ this.removedLegacyItems =
ImmutableSet.copyOf(builder.removedLegacyItems);
+ this.removedBundles =
ImmutableSet.copyOf(builder.removedBundles);
+ }
+
+ public boolean isEmpty() {
+ return removedLegacyItems.isEmpty() &&
removedBundles.isEmpty();
+ }
+
+ public Set<VersionRangedName> getRemovedLegacyItems() {
+ return removedLegacyItems;
+ }
+
+ public Set<VersionRangedName> getRemovedBundles() {
+ return removedBundles;
+ }
+
+ public boolean isLegacyItemRemoved(CatalogItem<?, ?>
legacyCatalogItem) {
+ VersionedName name = new
VersionedName(legacyCatalogItem.getSymbolicName(),
legacyCatalogItem.getVersion());
+ return contains(removedLegacyItems, name);
+ }
+
+ public boolean isBundleRemoved(VersionedName bundle) {
+ return contains(removedBundles, bundle);
+ }
+
+ public boolean contains(Iterable<VersionRangedName> names,
VersionedName name) {
+ for (VersionRangedName contender : names) {
+ if
(contender.getSymbolicName().equals(name.getSymbolicName()) &&
contender.getOsgiVersionRange().includes(name.getOsgiVersion())) {
+ return true;
+ }
+ }
+ return false;
+ }
+ }
+
+ /**
+ * Records a name (string) and version range (string),
+ * with conveniences for pretty-printing and converting to OSGi format.
+ *
+ * Implementation-wise, this is similar to {@link VersionedName}, but
is intended
+ * as internal-only so is cut down to only what is needed.
+ */
+ public static class VersionRangedName {
+ private final String name;
+ private final String v;
+ private transient volatile VersionRange cachedOsgiVersionRange;
+
+ public static VersionRangedName fromString(String val, boolean
singleVersionIsOsgiRange) {
+ if (Strings.isBlank(val)) {
+ throw new IllegalArgumentException("Must not be blank");
+ }
+ String[] parts = val.split(":");
+ if (parts.length > 2) {
+ throw new IllegalArgumentException("Identifier '"+val+"'
has too many parts; max one ':' symbol");
+ }
+ if (parts.length == 1 || Strings.isBlank(parts[1])) {
+ throw new IllegalArgumentException("Identifier '"+val+"'
must be of 'name:versionRange' syntax");
+ } else if (singleVersionIsOsgiRange ||
(parts[1].startsWith("(") || parts[1].startsWith("["))) {
+ return new VersionRangedName(parts[0], parts[1]);
+ } else {
+ return new VersionRangedName(parts[0],
"["+parts[1]+","+parts[1]+"]");
+ }
+ }
+
+ public VersionRangedName(String name, VersionRange v) {
+ this.name = checkNotNull(name, "name").toString();
+ this.v = checkNotNull(v, "versionRange").toString();
+ }
+
+ private VersionRangedName(String name, String v) {
+ this.name = checkNotNull(name, "name");
+ this.v = checkNotNull(v, "versionRange");
+ }
+
+ @Override
+ public String toString() {
+ return name + ":" + v;
+ }
+
+ public String toOsgiString() {
+ return name + ":" + getOsgiVersionRange();
+ }
+
+ public String getSymbolicName() {
+ return name;
+ }
+
+ public VersionRange getOsgiVersionRange() {
+ if (cachedOsgiVersionRange == null) {
+ cachedOsgiVersionRange =
VersionRange.valueOf(BrooklynVersionSyntax.toValidOsgiVersionRange(v));
+ }
+ return cachedOsgiVersionRange;
+ }
+
+ public String getVersionString() {
+ return v;
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hashCode(name, v);
+ }
+
+ @Override
+ public boolean equals(Object other) {
+ if (!(other instanceof VersionRangedName)) {
+ return false;
+ }
+ VersionRangedName o = (VersionRangedName) other;
+ return Objects.equal(name, o.name) && Objects.equal(v, o.v);
+ }
+ }
+
+ public static CatalogUpgrades
parseBundleManifestForCatalogUpgrades(Bundle bundle) {
+ Dictionary<String, String> headers = bundle.getHeaders();
+ String removedLegacyItemsHeader =
headers.get(MANIFEST_HEADER_FORCE_REMOVE_LEGACY_ITEMS);
+ String removedBundlesHeader =
headers.get(MANIFEST_HEADER_FORCE_REMOVE_BUNDLES);
+ List<VersionRangedName> removedLegacyItems = ImmutableList.of();
+ List<VersionRangedName> removedBundles = ImmutableList.of();
+ if (removedLegacyItemsHeader == null && removedBundlesHeader ==
null) {
+ return CatalogUpgrades.EMPTY;
+ }
+ if (removedLegacyItemsHeader != null) {
+ removedLegacyItems =
parseVersionRangedNameList(removedLegacyItemsHeader, false);
+ }
+ if (removedBundlesHeader != null) {
+ removedBundles =
parseVersionRangedNameList(removedBundlesHeader, false);
+ }
+ return CatalogUpgrades.builder()
+ .removedLegacyItems(removedLegacyItems)
+ .removedBundles(removedBundles)
+ .build();
+ }
+
+ @VisibleForTesting
+ static List<VersionRangedName> parseVersionRangedNameList(String
input, boolean singleVersionIsOsgiRange) {
+ List<String> vals = QuotedStringTokenizer.builder()
--- End diff --
judging by the tests i'm surprised this works for mismatched brackets, or
at least require a boolean flag to allow mismatched brackets -- but your test
indicates otherwise
---
