vara 0.17.1

data/lib/vara/metadata/compiled_packages.rb

@@ -0,0 +1,87 @@
+module Vara
+  module Metadata
+    # "Struct" representing the information about the compiled_packages field in metadata.yml
+    # @example entry from metadata.yml
+    #  compiled_package:
+    #    name: cf
+    #    file: cf-170-bosh-vsphere-esxi-ubuntu-2366.tgz
+    #    version: "170"
+    #    md5: 048f9e546bb2bb490f44cd9ea074b22a
+    #    url: https://s3-us-west-1.amazonaws.com/releng-artifacts/cf-170-build-99/cf-170-bosh-vsphere-esxi-ubuntu-2366.tgz
+    class CompiledPackages
+      # The name field of the YAML. Typically the name of the contained release.
+      # @return [String]
+      attr_reader :name
+
+      # The version field of the YAML.  Typically the version of the contained release.
+      # @return [String]
+      attr_reader :version
+
+      # The filename of the compiled package
+      # @return [String]
+      attr_reader :basename
+
+      # Checksum of the compiled_packages tarball
+      # @return [String]
+      attr_reader :md5
+
+      # SHA1 Checksum is not supported for compiled_packages
+      # @return nil
+      attr_reader :sha1
+
+      # Infers the metadata given a compiled packages file on disk
+      # @param path_to_compiled_packages [String] The path to the compiled packages file on disk
+      # @return [Vara::CompiledPackagesMetadata]
+      def self.from_file(path_to_compiled_packages)
+        md5      = Digest::MD5.file(path_to_compiled_packages).hexdigest
+        basename = File.basename(path_to_compiled_packages)
+
+        name, rest = basename.split('-', 2)
+        version    = rest.gsub(/-bosh.*$/, '')
+
+        new(name, version, basename, md5)
+      end
+
+      # @param name [String]
+      # @param version [String]
+      # @param file [String]
+      # @param md5 [String]
+      # @param url [String]
+      def initialize(name, version, file, md5, url = nil)
+        @name     = name
+        @version  = version
+        @basename = file
+        @md5      = md5
+        @url      = url
+      end
+
+      # The blobstore URL for the compiled_package.
+      # @raise [RuntimeError] if the URL is not set.
+      # @return [String]
+      def url
+        @url || fail("URL unknown for compiled_packages #{name}")
+      end
+
+      # @return [nil] the interface for downloader requires this method
+      def aws
+        nil
+      end
+
+      # If the URL is set, a markdown-style URL with the basename attribute.
+      # Otherwise, just the basename.
+      # @return [String]
+      def to_s
+        @url ? "[#{basename}](#{@url})" : basename
+      end
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vara/metadata/release.rb

@@ -0,0 +1,86 @@
+require 'ostruct'
+
+module Vara
+  module Metadata
+    # "Struct" representing the information about a single release in metadata.yml's releases array
+    # @example entry from metadata.yml
+    #   releases:
+    #     - file: cf-170.tgz
+    #       name: cf
+    #       version: '170'
+    #       md5: 8a0700de688b4fdd270b41c4a4de9d0e
+    #       url: https://releng-artifacts.s3.amazonaws.com/cf-170.tgz
+    class Release
+      # @return [String] Name of the release
+      attr_reader :name
+
+      # @return [String] Version of the release
+      attr_reader :version
+
+      # @return [String] The name of the release file
+      attr_reader :basename
+
+      # @return [String] The md5 of the release file's content
+      attr_reader :md5
+
+      # @return [String] The sha1 of the release file's content
+      attr_reader :sha1
+
+      # @return [OpenStruct] The AWS Configuration
+      attr_reader :aws
+
+      # Infers the metadata given a release file on disk
+      # @param release_tarball_path [String] The path to the release file on disk
+      # @return [Vara::ReleaseMetadata]
+      def self.from_file(release_tarball_path)
+        md5      = Digest::MD5.file(release_tarball_path).hexdigest
+        sha1     = Digest::SHA1.file(release_tarball_path).hexdigest
+        basename = File.basename(release_tarball_path)
+
+        release_parts = basename.gsub(/\.tgz$/, '')
+        name, version = release_parts.split('-', 2)
+
+        new(name: name, version: version, file: basename, md5: md5, sha1: sha1)
+      end
+
+      # @param name [String]
+      # @param version [String]
+      # @param file [String]
+      # @param md5 [String]
+      # @param url [String]
+      def initialize(name:, version:, file:, md5:, sha1:, url: nil, aws: nil)
+        @name     = name
+        @version  = version
+        @basename = file
+        @md5      = md5
+        @sha1     = sha1
+        @url      = url
+        @aws = OpenStruct.new(aws) if aws
+      end
+
+      def url
+        if @url
+          @url
+        elsif @aws
+          "#{aws.bucket_name}/#{aws.filename}"
+        end
+      end
+
+      # If the URL is set, a markdown-style URL with the basename attribute.
+      # Otherwise, just the basename.
+      # @return [String]
+      def to_s
+        @url ? "[#{basename}](#{@url})" : basename
+      end
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vara/metadata/stemcell.rb

@@ -0,0 +1,84 @@
+module Vara
+  module Metadata
+    # "Struct" representing the information about the stemcell field in metadata.yml
+    # @note Unlike Vara::ReleaseMetadata and Vara::CompiledPackagesMetadata, this class does not have a settable URL
+    #   because there is an inferred URL from the global BOSH stemcell blobstore.
+    # @example entry from metadata.yml
+    #   stemcell:
+    #     name: bosh-vsphere-esxi-ubuntu
+    #     version: '2366'
+    #     file: bosh-stemcell-2366-vsphere-esxi-ubuntu.tgz
+    #     md5: 0fbdcd100f716d127f821b1b4335135a
+    class Stemcell
+      # @return [String] the name of the stemcell.
+      attr_reader :name
+
+      # @return [String] the version of the stemcell.
+      attr_reader :version
+
+      # @return [String] the filename of the stemcell
+      attr_reader :basename
+
+      # @return [String] md5 checksum of the stemcell
+      attr_reader :md5
+
+      # @return [String] sha1 checksum of the stemcell
+      attr_reader :sha1
+
+      # Infers the metadata given a stemcell file on disk
+      # @param path_to_stemcell [String] The path to the stemcell file on disk
+      # @return [Vara::StemcellMetadata]
+      def self.from_file(path_to_stemcell)
+        md5      = Digest::MD5.file(path_to_stemcell).hexdigest
+        sha1     = Digest::SHA1.file(path_to_stemcell).hexdigest
+        basename = File.basename(path_to_stemcell)
+
+        stemcell_parts = basename.gsub(/^bosh-stemcell-/, '').gsub(/\.tgz$/, '')
+
+        raw_version, iaas, hypervisor, os = stemcell_parts.split('-')
+        version                           = raw_version.tr('_', '.')
+
+        name = ['bosh', iaas, hypervisor, os].join('-')
+
+        new(name: name, version: version, file: basename, md5: md5, sha1: sha1)
+      end
+
+      # @param name [String]
+      # @param version [String]
+      # @param file [String]
+      # @param md5 [String]
+      def initialize(name:, version:, file:, md5:, sha1:)
+        @name     = name
+        @version  = version
+        @basename = file
+        @md5      = md5
+        @sha1     = sha1
+      end
+
+      # @return [String] the inferred blobstore URL of the stemcell, assuming it is a BOSH public stemcell
+      def url
+        iaas = basename.gsub(/.*\d-(\w+)-.*/, '\1')
+        "http://bosh-jenkins-artifacts.cf-app.com/bosh-stemcell/#{iaas}/#{basename}"
+      end
+
+      # @return [nil] the interface for downloader requires this method
+      def aws
+        nil
+      end
+
+      # @return [String] a markdown-style URL with the basename attribute.
+      def to_s
+        "[#{basename}](#{url})"
+      end
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vara/prerelease_versioner.rb

@@ -0,0 +1,79 @@
+require 'vara/git_inspector'
+
+module Vara
+  class PrereleaseVersioner
+    PRERELEASE_VERSION_PLACEHOLDER = '$PRERELEASE_VERSION$'.freeze
+    PRODUCT_VERSION_KEY = 'product_version'.freeze
+    TO_VERSION_KEY = 'to_version'.freeze
+    MIGRATIONS_KEY = 'migrations'.freeze
+    MIGRATIONS_RULES_KEY = 'rules'.freeze
+    MIGRATIONS_RULES_TO_KEY = 'to'.freeze
+
+    # @param product_directory_path [String]
+    # @param cycle [String] cycle (e.g. alpha, beta, etc.) to use in expanded prerelease version value
+    def initialize(product_directory_path, cycle)
+      @product_directory_path = product_directory_path
+      @cycle = cycle
+    end
+
+    # @param new_prerelease_version [String] explicit value to override the prerelease version. Use with caution.
+    # @return [void]
+    def override_prerelease_version!(new_prerelease_version)
+      @prerelease_version = new_prerelease_version
+    end
+
+    # @param metadata_hash [Hash] Hash contents of full product metadata
+    # @return [Hash] product metadata with product version value updated if necessary
+    def update_metadata(metadata_hash)
+      return metadata_hash unless metadata_hash.fetch(PRODUCT_VERSION_KEY).include?(PRERELEASE_VERSION_PLACEHOLDER)
+      metadata_hash[PRODUCT_VERSION_KEY].gsub!(PRERELEASE_VERSION_PLACEHOLDER, prerelease_version)
+      metadata_hash
+    end
+
+    # @param migrations_hash [Hash] Hash contents of full content migrations
+    # @return [Hash] content migrations with product version value updated if necessary
+    def update_content_migrations(migrations_hash)
+      migrations_hash[TO_VERSION_KEY].gsub!(PRERELEASE_VERSION_PLACEHOLDER, prerelease_version) if migrations_hash.key?(TO_VERSION_KEY)
+      migrations_hash.fetch(MIGRATIONS_KEY, []).each do |migration|
+        migration.fetch(MIGRATIONS_RULES_KEY, []).each do |rule|
+          next unless updates_product_version?(rule)
+          rule[MIGRATIONS_RULES_TO_KEY].gsub!(PRERELEASE_VERSION_PLACEHOLDER, prerelease_version)
+        end
+      end
+      migrations_hash
+    end
+
+    private
+
+    attr_reader :product_directory_path, :cycle
+
+    def updates_product_version?(rule_hash)
+      rule_hash['type'] == 'update' && rule_hash['selector'] == 'product_version'
+    end
+
+    def prerelease_version
+      @prerelease_version ||= ".#{cycle}.#{commit_number}.#{short_sha}"
+    end
+
+    def commit_number
+      git_inspector.commit_count
+    end
+
+    def short_sha
+      git_inspector.short_sha
+    end
+
+    def git_inspector
+      @git_inspector ||= GitInspector.new(product_directory_path)
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vara/product.rb

@@ -0,0 +1,98 @@
+require 'vara/product_metadata'
+require 'vara/product_resource_downloader'
+require 'vara/product_artifact_zipper'
+require 'vara/product_contents'
+require 'vara/md5_creator'
+require 'vara/materials'
+
+module Vara
+  class Product
+    METADATA_DIR       = 'metadata'.freeze
+    METADATA_PARTS_DIR = 'metadata_parts'.freeze
+
+    attr_reader :base_dir
+
+    def initialize(base_dir)
+      @base_dir = base_dir
+    end
+
+    def metadata_file
+      @metadata_file ||= find_metadata_file || fail('No metadata file found.')
+    end
+
+    def build
+      if metadata.explicit_stemcell? && metadata.stemcell_criteria?
+        fail 'binaries.yml includes both stemcell and stemcell criteria keys'
+      end
+
+      ProductArtifactZipper.new(path, ProductContents.from_metadata_path(metadata_file)).zip!
+
+      MD5Creator.md5(path)
+
+      Materials.build(metadata_file, path).save_to(bom_path)
+
+      path
+    end
+
+    def path
+      File.join(base_dir, "#{filename_components.join('-')}.pivotal")
+    end
+
+    def bom_path
+      "#{path}.yml"
+    end
+
+    def md5_path
+      "#{path}.md5"
+    end
+
+    def stemcell_version
+      metadata.stemcell_metadata.version
+    end
+
+    def metadata_ref
+      `cd #{base_dir} && git log -1 --format=format:%h`
+    end
+
+    def releases
+      metadata.releases_metadata.map do |release_metadata|
+        {
+          'name'    => release_metadata['name'],
+          'version' => release_metadata['version']
+        }
+      end
+    end
+
+    private
+
+    def metadata
+      ProductMetadata.from_file(metadata_file)
+    end
+
+    def filename_components
+      [metadata.name, metadata.product_version]
+    end
+
+    def find_metadata_file
+      files = Dir.glob(File.join(base_dir, METADATA_DIR, '*.yml')).sort
+
+      case files.size
+      when 0 then
+        nil
+      when 1 then
+        files.first
+      else
+        fail("Found: #{files.map { |f| File.basename(f) }}. Vara supports one .yml file under metadata/")
+      end
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/vara/product_artifact_validator.rb

@@ -0,0 +1,32 @@
+module Vara
+  class ProductArtifactValidator
+    def self.validate_file_checksum(file_metadata, file_name)
+      fail "No checksum for file #{file_name}!" unless file_metadata.md5 || file_metadata.sha1
+
+      validate_md5(file_metadata, file_name) if file_metadata.md5
+
+      validate_sha1(file_metadata, file_name) if file_metadata.sha1
+    end
+
+    def self.validate_sha1(file_metadata, file_name)
+      sha1_got = Digest::SHA1.file(file_name).hexdigest
+      sha1_expected = file_metadata.sha1
+      fail "sha1 mismatch for file #{file_name}, expected #{sha1_expected}, got #{sha1_got}" if sha1_got != sha1_expected
+    end
+
+    def self.validate_md5(file_metadata, file_name)
+      md5_got = Digest::MD5.file(file_name).hexdigest
+      md5_expected = file_metadata.md5
+      fail "md5 mismatch for file #{file_name}, expected #{md5_expected}, got #{md5_got}" if md5_got != md5_expected
+    end
+  end
+end
+
+# Copyright (c) 2014-2015 Pivotal Software, Inc.
+# All rights reserved.
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+# INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
+# PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+# TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+# USE OR OTHER DEALINGS IN THE SOFTWARE.