You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by sjcorbett <gi...@git.apache.org> on 2015/06/02 19:10:18 UTC
[GitHub] incubator-brooklyn pull request: Brooklyn features
GitHub user sjcorbett opened a pull request:
https://github.com/apache/incubator-brooklyn/pull/675
Brooklyn features
Adds `BrooklynVersion.getFeatures()` and exposes in response to `GET /v1/server/version`. The downstream-parent pom is updated to automatically trigger projects' inclusion.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/sjcorbett/incubator-brooklyn versions
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-brooklyn/pull/675.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #675
----
commit 7a3a1f8cd225b2aaf995d9f501185de28d5a39dd
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-05-05T16:12:56Z
Adds BrooklynClassLoadingContext.getResources(String)
As ClassLoader.getResources but returning an Iterable<URL> rather than
an Enumeration<URL>.
commit b515f38d3e3e4643108c40d4ca46473dfcc49ab5
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-05-05T16:14:59Z
Indent BrooklynVersion properly
commit 8ff666e4a597058c85dbbb08d871c38e6de3fb6d
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-05-26T21:09:25Z
ResourceUtils.getResources
commit b087c1c8b215360d958247e2ec0375925186b04a
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-05-26T21:10:31Z
BrooklynVersion.getFeatures
Reports a summary of feature information extracted from all manifests
on the classpath and in catalogue bundles.
commit 4f441ef6f377101736346563a436af98178134bc
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-06-02T10:40:20Z
Include Brooklyn-Feature-Name in downstream project manifests
Triggers inclusion in feature list.
commit 570436d94dfe64244633f2655003871ea897b012
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-06-02T10:49:41Z
Update archetype notes
commit f18707395b85601a3023e003b5af1757508a52bc
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-06-02T12:16:28Z
Simplify ServerResource logic
commit 283b6e3ea335c14a19a1eb9dfbe2b9fadeb9e80e
Author: Sam Corbett <sa...@cloudsoftcorp.com>
Date: 2015-06-02T17:05:54Z
Expose features in /v1/server/version response
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r32013050
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
+
+ // Set over list in case a bundle is reported more than once (e.g. from classpath and from OSGi).
+ // Not sure of validity of this approach over just reporting duplicates.
+ ImmutableSet.Builder<BrooklynFeature> features = ImmutableSet.builder();
+ for (URL manifest : manifests) {
+ ManifestHelper mh = null;
+ try {
+ mh = Osgis.ManifestHelper.forManifest(manifest);
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.debug("Error reading OSGi manifest from " + manifest + " when determining version properties: " + e, e);
+ }
+ if (mh == null) continue;
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ Optional<BrooklynFeature> fs = BrooklynFeature.newFeature(attrs);
+ if (fs.isPresent()) {
+ features.add(fs.get());
+ }
+ }
+ return features.build();
+ }
+
+ public static class BrooklynFeature {
+ private final String name;
+ private final String symbolicName;
+ private final String version;
+ private final String lastModified;
+ private final Map<String, String> additionalData;
+
+ BrooklynFeature(String name, String symbolicName, String version, String lastModified, Map<String, String> additionalData) {
+ this.symbolicName = checkNotNull(symbolicName, "symbolicName");
+ this.name = name;
+ this.version = version;
+ this.lastModified = lastModified;
+ this.additionalData = ImmutableMap.copyOf(additionalData);
+ }
+
+ /** @return Present if any attribute name begins with {@link #BROOKLYN_FEATURE_PREFIX}, absent otherwise. */
+ private static Optional<BrooklynFeature> newFeature(Attributes attributes) {
+ Map<String, String> additionalData = Maps.newHashMap();
+ for (Object key : attributes.keySet()) {
+ if (key instanceof Attributes.Name && key.toString().startsWith(BROOKLYN_FEATURE_PREFIX)) {
+ Attributes.Name name = Attributes.Name.class.cast(key);
+ String value = attributes.getValue(name);
+ if (!Strings.isBlank(value)) {
+ additionalData.put(name.toString(), value);
+ }
+ }
+ }
+ if (additionalData.isEmpty()) {
+ return Optional.absent();
+ }
+
+ // Name is special cased as it a useful way to indicate a feature without
--- End diff --
Without what? Is the comment complete?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r31620543
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
--- End diff --
I needed something similar the other day and used the following snipped:
```
Maybe<OsgiManager> osgiManager = managementContext.getOsgiManager();
if (osgiManager.isPresent()) {
Framework framework = osgiManager.get().getFramework();
Bundle[] bundles = framework.getBundleContext().getBundles();
for (Bundle bundle : bundles) {
if (bundle == framework) continue;
if (Osgis.isExtensionBundle(bundle)) continue;
try {
//TODO better .start the bundle on install
bundle.loadClass("Some.None.Existent.Class.To.Force.BundleWiring.Initialization");
} catch (ClassNotFoundException e1) {}
BundleWiring bundleWiring = bundle.adapt(BundleWiring.class);
if (bundleWiring == null) continue; //bundle not resolved
ClassLoader bundleClassLoader = bundleWiring.getClassLoader();
//do something with the CL, i.e.
bundleClassLoader.getResources(MANIFEST_PATH)
}
}
```
It's hackish and not necessarily better than your approach, best way is probably using OSGi services - but not feasible at this point.
One thing to watch out with scanning the catalog items is that the same bundle can be used in multiple catalog items, i.e. one jar providing multiple entities. Then you will get duplicates in the output.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/incubator-brooklyn/pull/675
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r32014231
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
+
+ // Set over list in case a bundle is reported more than once (e.g. from classpath and from OSGi).
+ // Not sure of validity of this approach over just reporting duplicates.
+ ImmutableSet.Builder<BrooklynFeature> features = ImmutableSet.builder();
+ for (URL manifest : manifests) {
+ ManifestHelper mh = null;
+ try {
+ mh = Osgis.ManifestHelper.forManifest(manifest);
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.debug("Error reading OSGi manifest from " + manifest + " when determining version properties: " + e, e);
+ }
+ if (mh == null) continue;
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ Optional<BrooklynFeature> fs = BrooklynFeature.newFeature(attrs);
+ if (fs.isPresent()) {
+ features.add(fs.get());
+ }
+ }
+ return features.build();
+ }
+
+ public static class BrooklynFeature {
+ private final String name;
+ private final String symbolicName;
+ private final String version;
+ private final String lastModified;
+ private final Map<String, String> additionalData;
+
+ BrooklynFeature(String name, String symbolicName, String version, String lastModified, Map<String, String> additionalData) {
+ this.symbolicName = checkNotNull(symbolicName, "symbolicName");
+ this.name = name;
+ this.version = version;
+ this.lastModified = lastModified;
+ this.additionalData = ImmutableMap.copyOf(additionalData);
+ }
+
+ /** @return Present if any attribute name begins with {@link #BROOKLYN_FEATURE_PREFIX}, absent otherwise. */
+ private static Optional<BrooklynFeature> newFeature(Attributes attributes) {
+ Map<String, String> additionalData = Maps.newHashMap();
+ for (Object key : attributes.keySet()) {
+ if (key instanceof Attributes.Name && key.toString().startsWith(BROOKLYN_FEATURE_PREFIX)) {
+ Attributes.Name name = Attributes.Name.class.cast(key);
+ String value = attributes.getValue(name);
+ if (!Strings.isBlank(value)) {
+ additionalData.put(name.toString(), value);
+ }
+ }
+ }
+ if (additionalData.isEmpty()) {
+ return Optional.absent();
+ }
+
+ // Name is special cased as it a useful way to indicate a feature without
+ String nameKey = BROOKLYN_FEATURE_PREFIX + "Name";
+ String name = Optional.fromNullable(additionalData.remove(nameKey))
+ .or(Optional.fromNullable(Constants.BUNDLE_NAME))
+ .or(attributes.getValue(Constants.BUNDLE_SYMBOLICNAME));
+
+ return Optional.of(new BrooklynFeature(
+ name,
+ attributes.getValue(Constants.BUNDLE_SYMBOLICNAME),
+ attributes.getValue(Constants.BUNDLE_VERSION),
+ attributes.getValue("Bnd-LastModified"),
+ additionalData));
+ }
+
+ public String getLastModified() {
+ return lastModified;
+ }
+
+ public String getName() {
+ return name;
+ }
+
+ public String getSymbolicName() {
+ return symbolicName;
+ }
+
+ public String getVersion() {
+ return version;
+ }
+
+ /** @return an unmodifiable map */
+ public Map<String, String> getAdditionalData() {
+ return additionalData;
+ }
+
+ @Override
+ public String toString() {
+ return getClass().getSimpleName() + "{" + symbolicName + (version != null ? ":" + version : "") + "}";
+ }
+
+ @Override
+ public int hashCode() {
+ return Objects.hashCode(symbolicName, version);
+ }
+
+ @Override
+ public boolean equals(Object other) {
--- End diff --
Brooklyn supports loading different bundles with the same symbolicName+version, namespaced in different catalog items. Might not be worth the trouble supporting them here, but definitely it's something to have in mind.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r32130836
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
--- End diff --
Perhaps we should incorporate `getCatalogItemId` into the output instead. If I did this and updated the `equals` method in `BrooklynFeature` to include it we'd give a much clearer indication of what features were installed by which catalogue items.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by sjcorbett <gi...@git.apache.org>.
Github user sjcorbett commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r31546204
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
--- End diff --
@neykov Is there a more suitable place or way to search catalogue bundles for manifests?
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r31620874
--- Diff: core/src/main/java/brooklyn/management/classloading/BrooklynClassLoadingContextSequential.java ---
@@ -101,6 +102,18 @@ public URL getResource(String resourceInThatDir) {
}
@Override
+ public Iterable<URL> getResources(String name) {
+ List<Iterable<URL>> resources = Lists.newArrayList();
+ for (BrooklynClassLoadingContext target : primaries) {
+ resources.add(target.getResources(name));
+ }
+ for (BrooklynClassLoadingContext target : secondaries) {
+ resources.add(target.getResources(name));
+ }
+ return Iterables.concat(resources);
--- End diff --
It's often the case that the application class loader will be contained multiple times in the BCLCs, even in a single one, leading resources.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by ahgittin <gi...@git.apache.org>.
Github user ahgittin commented on the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#issuecomment-111969215
I will merge. @sjcorbett @neykov @aledsage let's remember the notes in this PR if we choose to do OSGi scanning earlier.
Also note the feature request where we log the version metadata once for each bundle on first read. This will make the log files more useful if we have to debug.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#discussion_r32012132
--- Diff: core/src/main/java/brooklyn/BrooklynVersion.java ---
@@ -46,201 +58,333 @@
*/
public class BrooklynVersion {
- private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
-
- private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
- private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
- private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
-
- private static final String MVN_VERSION_PROPERTY_NAME = "version";
- private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
- private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
-
-
- private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
- private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
-
- public static final BrooklynVersion INSTANCE = new BrooklynVersion();
-
- private final Properties versionProperties = new Properties();
-
- public BrooklynVersion() {
- // we read the maven pom metadata and osgi metadata and make sure it's sensible
- // everything is put into a single map for now (good enough, but should be cleaned up)
- readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
- readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
- // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
- // see comments on that about folding it into this class instead
-
- checkVersions();
- }
-
- public void checkVersions() {
- String mvnVersion = getVersionFromMavenProperties();
- if (mvnVersion!=null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
- throw new IllegalStateException("Version error: maven "+mvnVersion+" / code "+VERSION_FROM_STATIC);
- }
-
- String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- // TODO does the OSGi version include other slightly differ gubbins/style ?
- if (osgiVersion!=null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
- throw new IllegalStateException("Version error: osgi "+osgiVersion+" / code "+VERSION_FROM_STATIC);
- }
- }
-
- /** Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
- * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
- * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
- */
- @Deprecated
- public String getVersionFromClasspath() {
- String v = getVersionFromMavenProperties();
- if (Strings.isNonBlank(v)) return v;
- v = getVersionFromOsgiManifest();
- if (Strings.isNonBlank(v)) return v;
- return "0.0.0-SNAPSHOT";
- }
-
- @Nullable
- public String getVersionFromMavenProperties() {
- return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- public String getVersionFromOsgiManifest() {
- return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
- }
-
- @Nullable
- /** SHA1 of the last commit to brooklyn at the time this build was made.
- * For SNAPSHOT builds of course there may have been further non-committed changes. */
- public String getSha1FromOsgiManifest() {
- return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
- }
-
- public String getVersion() {
- return VERSION_FROM_STATIC;
- }
-
- public boolean isSnapshot() {
- return (getVersion().indexOf("-SNAPSHOT")>=0);
- }
-
- private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
- InputStream versionStream = null;
- try {
- versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
- if (versionStream==null) {
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- } else {
- log.warn("No maven resource file "+MVN_VERSION_RESOURCE_FILE+" available");
- }
- return;
- }
- versionProperties.load(checkNotNull(versionStream));
- } catch (IOException e) {
- log.warn("Error reading maven resource file "+MVN_VERSION_RESOURCE_FILE+": "+e, e);
- } finally {
- Streams.closeQuietly(versionStream);
- }
- }
-
- /** reads properties from brooklyn-core's manifest */
- private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- InputStream us = null;
- try {
- us = u.openStream();
- ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
- if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
- Attributes attrs = mh.getManifest().getMainAttributes();
- for (Object key: attrs.keySet()) {
- // key is an Attribute.Name; toString converts to string
- versionProperties.put(key.toString(), attrs.getValue(key.toString()));
- }
- return;
- }
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading OSGi manifest from "+u+" when determining version properties: "+e, e);
- } finally {
- Streams.closeQuietly(us);
- }
- }
- if (isDevelopmentEnvironment()) {
- // allowed for dev env
- log.trace("No OSGi manifest available to determine version properties");
- } else {
- log.warn("No OSGi manifest available to determine version properties");
- }
- }
-
- /**
- * Returns whether this is a Brooklyn dev environment,
- * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
- * <p>
- * In a packaged or library build of Brooklyn (normal usage) this should return false,
- * and all OSGi components should be available.
- * <p>
- * There is no longer any way to force this,
- * such as the old BrooklynDevelopmentMode class;
- * but that could easily be added if required (eg as a system property).
- */
- public static boolean isDevelopmentEnvironment() {
- Boolean isDevEnv = IS_DEV_ENV.get();
- if (isDevEnv!=null) return isDevEnv;
- synchronized (IS_DEV_ENV) {
- isDevEnv = computeIsDevelopmentEnvironment();
- IS_DEV_ENV.set(isDevEnv);
- return isDevEnv;
- }
- }
-
- private static boolean computeIsDevelopmentEnvironment() {
- Enumeration<URL> paths;
- try {
- paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
- } catch (IOException e) {
- // shouldn't happen
- throw Exceptions.propagate(e);
- }
- while (paths.hasMoreElements()) {
- URL u = paths.nextElement();
- // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
- if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
- try {
- log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: "+u);
- return true;
- } catch (Exception e) {
- Exceptions.propagateIfFatal(e);
- log.warn("Error reading manifest to determine whether this is a development environment: "+e, e);
- }
- }
- }
- return false;
- }
-
- public void logSummary() {
- log.debug("Brooklyn version "+getVersion()+" (git SHA1 "+getSha1FromOsgiManifest()+")");
- }
-
- /** @deprecated since 0.7.0, redundant with {@link #get()} */ @Deprecated
- public static String getVersionFromStatic() {
- return VERSION_FROM_STATIC;
- }
-
- public static String get() {
- return INSTANCE.getVersion();
- }
-
+ private static final Logger log = LoggerFactory.getLogger(BrooklynVersion.class);
+
+ private static final String MVN_VERSION_RESOURCE_FILE = "META-INF/maven/org.apache.brooklyn/brooklyn-core/pom.properties";
+ private static final String MANIFEST_PATH = "META-INF/MANIFEST.MF";
+ private static final String BROOKLYN_CORE_SYMBOLIC_NAME = "org.apache.brooklyn.core";
+
+ private static final String MVN_VERSION_PROPERTY_NAME = "version";
+ private static final String OSGI_VERSION_PROPERTY_NAME = Attributes.Name.IMPLEMENTATION_VERSION.toString();
+ private static final String OSGI_SHA1_PROPERTY_NAME = "Implementation-SHA-1";
+ private static final String OSGI_BRANCH_PROPERTY_NAME = "Implementation-Branch";
+
+ private final static String VERSION_FROM_STATIC = "0.7.0-SNAPSHOT"; // BROOKLYN_VERSION
+ private static final AtomicReference<Boolean> IS_DEV_ENV = new AtomicReference<Boolean>();
+
+ private static final String BROOKLYN_FEATURE_PREFIX = "Brooklyn-Feature-";
+
+ public static final BrooklynVersion INSTANCE = new BrooklynVersion();
+
+ private final Properties versionProperties = new Properties();
+
+ private BrooklynVersion() {
+ // we read the maven pom metadata and osgi metadata and make sure it's sensible
+ // everything is put into a single map for now (good enough, but should be cleaned up)
+ readPropertiesFromMavenResource(BrooklynVersion.class.getClassLoader());
+ readPropertiesFromOsgiResource(BrooklynVersion.class.getClassLoader(), BROOKLYN_CORE_SYMBOLIC_NAME);
+ // TODO there is also build-metadata.properties used in ServerResource /v1/server/version endpoint
+ // see comments on that about folding it into this class instead
+
+ checkVersions();
+ }
+
+ public void checkVersions() {
+ String mvnVersion = getVersionFromMavenProperties();
+ if (mvnVersion != null && !VERSION_FROM_STATIC.equals(mvnVersion)) {
+ throw new IllegalStateException("Version error: maven " + mvnVersion + " / code " + VERSION_FROM_STATIC);
+ }
+
+ String osgiVersion = versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ // TODO does the OSGi version include other slightly differ gubbins/style ?
+ if (osgiVersion != null && !VERSION_FROM_STATIC.equals(osgiVersion)) {
+ throw new IllegalStateException("Version error: osgi " + osgiVersion + " / code " + VERSION_FROM_STATIC);
+ }
+ }
+
+ /**
+ * Returns version as inferred from classpath/osgi, if possible, or 0.0.0-SNAPSHOT.
+ * See also {@link #getVersionFromMavenProperties()} and {@link #getVersionFromOsgiManifest()}.
+ *
+ * @deprecated since 0.7.0, in favour of the more specific methods (and does anyone need that default value?)
+ */
+ @Deprecated
+ public String getVersionFromClasspath() {
+ String v = getVersionFromMavenProperties();
+ if (Strings.isNonBlank(v)) return v;
+ v = getVersionFromOsgiManifest();
+ if (Strings.isNonBlank(v)) return v;
+ return "0.0.0-SNAPSHOT";
+ }
+
+ @Nullable
+ public String getVersionFromMavenProperties() {
+ return versionProperties.getProperty(MVN_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ public String getVersionFromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_VERSION_PROPERTY_NAME);
+ }
+
+ @Nullable
+ /** SHA1 of the last commit to brooklyn at the time this build was made.
+ * For SNAPSHOT builds of course there may have been further non-committed changes. */
+ public String getSha1FromOsgiManifest() {
+ return versionProperties.getProperty(OSGI_SHA1_PROPERTY_NAME);
+ }
+
+ public String getVersion() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public boolean isSnapshot() {
+ return (getVersion().indexOf("-SNAPSHOT") >= 0);
+ }
+
+ private void readPropertiesFromMavenResource(ClassLoader resourceLoader) {
+ InputStream versionStream = null;
+ try {
+ versionStream = resourceLoader.getResourceAsStream(MVN_VERSION_RESOURCE_FILE);
+ if (versionStream == null) {
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ } else {
+ log.warn("No maven resource file " + MVN_VERSION_RESOURCE_FILE + " available");
+ }
+ return;
+ }
+ versionProperties.load(checkNotNull(versionStream));
+ } catch (IOException e) {
+ log.warn("Error reading maven resource file " + MVN_VERSION_RESOURCE_FILE + ": " + e, e);
+ } finally {
+ Streams.closeQuietly(versionStream);
+ }
+ }
+
+ /**
+ * reads properties from brooklyn-core's manifest
+ */
+ private void readPropertiesFromOsgiResource(ClassLoader resourceLoader, String symbolicName) {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources(MANIFEST_PATH);
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ InputStream us = null;
+ try {
+ us = u.openStream();
+ ManifestHelper mh = Osgis.ManifestHelper.forManifest(us);
+ if (BROOKLYN_CORE_SYMBOLIC_NAME.equals(mh.getSymbolicName())) {
+ Attributes attrs = mh.getManifest().getMainAttributes();
+ for (Object key : attrs.keySet()) {
+ // key is an Attribute.Name; toString converts to string
+ versionProperties.put(key.toString(), attrs.getValue(key.toString()));
+ }
+ return;
+ }
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading OSGi manifest from " + u + " when determining version properties: " + e, e);
+ } finally {
+ Streams.closeQuietly(us);
+ }
+ }
+ if (isDevelopmentEnvironment()) {
+ // allowed for dev env
+ log.trace("No OSGi manifest available to determine version properties");
+ } else {
+ log.warn("No OSGi manifest available to determine version properties");
+ }
+ }
+
+ /**
+ * Returns whether this is a Brooklyn dev environment,
+ * specifically core/target/classes/ is on the classpath for the org.apache.brooklyn.core project.
+ * <p/>
+ * In a packaged or library build of Brooklyn (normal usage) this should return false,
+ * and all OSGi components should be available.
+ * <p/>
+ * There is no longer any way to force this,
+ * such as the old BrooklynDevelopmentMode class;
+ * but that could easily be added if required (eg as a system property).
+ */
+ public static boolean isDevelopmentEnvironment() {
+ Boolean isDevEnv = IS_DEV_ENV.get();
+ if (isDevEnv != null) return isDevEnv;
+ synchronized (IS_DEV_ENV) {
+ isDevEnv = computeIsDevelopmentEnvironment();
+ IS_DEV_ENV.set(isDevEnv);
+ return isDevEnv;
+ }
+ }
+
+ private static boolean computeIsDevelopmentEnvironment() {
+ Enumeration<URL> paths;
+ try {
+ paths = BrooklynVersion.class.getClassLoader().getResources("brooklyn/BrooklynVersion.class");
+ } catch (IOException e) {
+ // shouldn't happen
+ throw Exceptions.propagate(e);
+ }
+ while (paths.hasMoreElements()) {
+ URL u = paths.nextElement();
+ // running fram a classes directory (including coverage-classes for cobertura) triggers dev env
+ if (u.getPath().endsWith("classes/brooklyn/BrooklynVersion.class")) {
+ try {
+ log.debug("Brooklyn dev/src environment detected: BrooklynVersion class is at: " + u);
+ return true;
+ } catch (Exception e) {
+ Exceptions.propagateIfFatal(e);
+ log.warn("Error reading manifest to determine whether this is a development environment: " + e, e);
+ }
+ }
+ }
+ return false;
+ }
+
+ public void logSummary() {
+ log.debug("Brooklyn version " + getVersion() + " (git SHA1 " + getSha1FromOsgiManifest() + ")");
+ }
+
+ /**
+ * @deprecated since 0.7.0, redundant with {@link #get()}
+ */
+ @Deprecated
+ public static String getVersionFromStatic() {
+ return VERSION_FROM_STATIC;
+ }
+
+ public static String get() {
+ return INSTANCE.getVersion();
+ }
+
+ /**
+ * @param mgmt The context to search for features.
+ * @return An iterable containing all features found in the management context's classpath and catalogue.
+ */
+ public static Iterable<BrooklynFeature> getFeatures(ManagementContext mgmt) {
+ Iterable<URL> manifests = ResourceUtils.create(mgmt).getResources(MANIFEST_PATH);
+
+ for (CatalogItem<?, ?> catalogItem : mgmt.getCatalog().getCatalogItems()) {
+ OsgiBrooklynClassLoadingContext osgiContext = new OsgiBrooklynClassLoadingContext(
+ mgmt, catalogItem.getCatalogItemId(), catalogItem.getLibraries());
+ manifests = Iterables.concat(manifests, osgiContext.getResources(MANIFEST_PATH));
+ }
--- End diff --
Looks like OSGi bundles already provide the manifest content through `[getHeaders()](https://osgi.org/javadoc/r4v43/core/org/osgi/framework/Bundle.html#getHeaders%28%29)`. So a nice way to fetch them would be to iterate the bundles, similarly to the above code. This would belong in `Osgis` class, on the other hand the goto place for catalog related code which doesn't belong elsewhere is `CatalogUtils`.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] incubator-brooklyn pull request: Brooklyn features
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on the pull request:
https://github.com/apache/incubator-brooklyn/pull/675#issuecomment-110435120
Works great for me. Good to merge.
Going straight to scanning OSGi bundles without going through the catalog items will simplify the changes. It will also enable listing duplicate symbolicName+version bundles. The downside is that we don't unregister bundles when removing catalog items, so even unused bundles will be listed - no perfect solution it seems.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---