brooklyn-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sjcorbett <...@git.apache.org>
Subject [GitHub] incubator-brooklyn pull request: Brooklyn features
Date Tue, 02 Jun 2015 17:11:46 GMT
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.
---

Mime
View raw message