vara 0.17.1

data/lib/vara/content_migrations_processor.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+require 'vara/log'
+
+module Vara
+  class ContentMigrationsProcessor
+    include Vara::Loggable
+
+    # @param product_dir [String] path to product directory root
+    # @param versioner [Vara::PrereleaseVersioner,Vara::StaticVersioner]
+    def initialize(product_dir, versioner)
+      @product_dir = product_dir
+      @versioner = versioner
+    end
+
+    # Composes content_migrations_parts/base.yml and content_migrations_parts/migrations/*.yml
+    # into content_migrations/migrations.yml, expanding placeholders as necessary.
+    # @return [String] path to the generated content migration file
+    def process
+      content_migrations = load_content_migrations
+      processed = versioner.update_content_migrations(content_migrations)
+      save_content_migrations(processed)
+    end
+
+    private
+
+    attr_reader :product_dir, :versioner
+
+    def load_content_migrations
+      parts_dir = File.join(product_dir, 'content_migrations_parts')
+      base_path = File.join(parts_dir, 'base.yml')
+      content_migrations = YAML.load_file(base_path) || {}
+      log.info("Composing content migrations: loaded #{base_path}")
+      Dir.glob(File.join(parts_dir, 'migrations', '*.yml')).each do |migration_path|
+        migration = YAML.load_file(migration_path)
+        log.info("Composing content migrations: loaded #{migration_path}")
+        content_migrations['migrations'] ||= []
+        content_migrations['migrations'] << migration
+      end
+
+      content_migrations
+    end
+
+    def save_content_migrations(processed_hash)
+      out_path = File.join(product_dir, 'content_migrations', 'migrations.yml')
+
+      File.open(out_path, 'w') do |out|
+        YAML.dump(processed_hash, out)
+      end
+
+      out_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/downloader.rb

@@ -0,0 +1,61 @@
+require 'uri'
+require 'net/http'
+require 'aws-sdk'
+
+module Vara
+  class Downloader
+    # @param source [String] The URL from which to download
+    # @param target [String] The path on disk for where to save the downloaded file
+    def self.download(metadata, target)
+      fail 'URL or AWS Config required to download!' unless metadata.url || metadata.aws
+      if metadata.aws
+        download_from_aws(metadata.aws, target)
+      elsif metadata.url
+        download_from_url(metadata.url, target)
+      end
+    end
+
+    def self.download_from_aws(aws_config, target)
+      s3 = Aws::S3::Client.new(
+        access_key_id: aws_config.access_key_id,
+        secret_access_key: aws_config.secret_access_key,
+        force_path_style: true,
+        region: aws_config.region
+      )
+
+      s3.get_object(
+        response_target: target,
+        bucket: aws_config.bucket_name,
+        key: aws_config.filename
+      )
+    end
+
+    def self.download_from_url(url, target)
+      uri = URI(url)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.scheme == 'https'
+      http.start { |h| stream_target(h, target, uri) }
+    end
+
+    def self.stream_target(http, target, uri)
+      request = Net::HTTP::Get.new uri.request_uri
+
+      http.request request do |response|
+        return download_from_url(response['location'], target) if response.is_a?(Net::HTTPRedirection)
+
+        open target, 'w' do |io|
+          response.read_body { |chunk| io.write chunk }
+        end
+      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/git_inspector.rb

@@ -0,0 +1,66 @@
+module Vara
+  class GitInspector
+    # @param repo_path [String] Path to the root of the repository to inspect
+    # @return [String] The SHA of the current git revision
+    def self.current_revision(repo_path)
+      new(repo_path).current_revision
+    end
+
+    # @param repo_path [String] Path to the root of the repository to inspect
+    # @return [Boolean]
+    def self.git_repo?(repo_path)
+      system("cd #{repo_path} && git rev-parse --is-inside-work-tree")
+    end
+
+    # @param repo_path [String] Path to the root of the repository to inspect
+    def initialize(repo_path)
+      fail "The directory #{repo_path} must be a git repo" unless self.class.git_repo?(repo_path)
+      @repo_path = repo_path
+    end
+
+    # @return [String] The SHA of the current git revision
+    def current_revision
+      revision = `cd #{repo_path} && git rev-list --max-count=1 HEAD`.chomp
+      [revision, dirty_suffix].join('')
+    end
+
+    # @return [Integer] The number of commits on this git branch
+    def commit_count
+      count = `cd #{repo_path} && git rev-list HEAD | wc -l`
+      Integer(count)
+    end
+
+    # @return [String] The abbreviated SHA of the current git revision
+    def short_sha
+      sha = `cd #{repo_path} && git rev-parse --short HEAD`.chomp
+      [sha, dirty_suffix].join('')
+    end
+
+    private
+
+    attr_reader :repo_path
+
+    def dirty?
+      # inspired by http://stackoverflow.com/a/5737794
+      `cd #{repo_path} && test -n "$(git status --porcelain)"`
+      $?.success?
+    end
+
+    def dirty_suffix
+      if dirty?
+        '.dirty'
+      else
+        ''
+      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/linter.rb

@@ -0,0 +1,40 @@
+require 'yaml'
+
+module Vara
+  class Linter
+    def self.build(metadata_path)
+      new(YAML.load_file(metadata_path))
+    end
+
+    def initialize(metadata)
+      @metadata = metadata
+      @errors = []
+    end
+
+    def lint!
+      validate_metadata_version
+      fail LintError, errors.join("\n") unless errors.empty?
+    end
+
+    private
+
+    def validate_metadata_version
+      metadata_version = metadata.fetch('metadata_version')
+      errors << 'metadata_version must be a string' unless metadata_version.is_a?(String)
+    end
+
+    attr_reader :metadata, :errors
+  end
+
+  class LintError < RuntimeError
+  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/log.rb

@@ -0,0 +1,71 @@
+require 'logger'
+
+module Vara
+  class << self
+    def log
+      Log.instance
+    end
+
+    def logger_for(progname)
+      LoggerWithProgName.new(progname)
+    end
+  end
+
+  module Loggable
+    def log
+      @_releng_instance_log ||= LoggerWithProgName.new(self.class.name)
+    end
+
+    def self.included(other_module)
+      def other_module.log
+        @_releng_class_log ||= LoggerWithProgName.new(name)
+      end
+    end
+  end
+
+  class Log
+    class << self
+      def instance
+        @instance || fail('Logging attempted without being configured first!')
+      end
+
+      def test_mode!
+        log_path = '/tmp/vara_test.log'
+        File.open(log_path, 'w') {} # empty out the file in a cross-platform-safe way
+        @instance              = ::Logger.new(log_path, File::WRONLY | File::APPEND)
+        instance.sev_threshold = ::Logger::DEBUG
+      end
+
+      def stdout_mode!
+        STDOUT.sync            = true
+        @instance              = ::Logger.new(STDOUT)
+        instance.sev_threshold = ::Logger.const_get(ENV.fetch('LOG_LEVEL', 'INFO'))
+      end
+    end
+  end
+
+  class LoggerWithProgName
+    def initialize(progname)
+      @progname = progname
+    end
+
+    %w(debug info warn error fatal).map(&:to_sym).each do |level|
+      define_method(level) do |message|
+        Log.instance.public_send(level, progname) { message }
+      end
+    end
+
+    private
+
+    attr_reader :progname
+  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/materials.rb

@@ -0,0 +1,139 @@
+require 'yaml'
+require 'digest/md5'
+require 'vara/product_metadata'
+require 'vara/git_inspector'
+require 'vara/log'
+require 'vara/version'
+
+module Vara
+  class Materials
+    include Vara::Loggable
+
+    # @param materials_path [String] Path to a materials YAML file
+    # @return [Vara::Materials] A Materials object based on the content of the file at materials_path
+    def self.from_file(materials_path)
+      new(YAML.load_file(materials_path))
+    end
+
+    # @param product_metadata_path [String] Path to a product's metadata file.
+    #   Expected to be in metadata/ folder of a product repo.
+    # @param product_path [String] Path to a built .pivotal file on disk
+    # @return [Vara::Materials]
+    def self.build(product_metadata_path, product_path)
+      product_metadata_dir = File.dirname(File.expand_path(product_metadata_path))
+      repo_dir = File.expand_path(File.join(product_metadata_dir, '..'))
+      repo_name = File.basename(repo_dir)
+
+      product_metadata = ProductMetadata.from_file(product_metadata_path)
+
+      repo_revision = if GitInspector.git_repo?(repo_dir)
+                        GitInspector.new(repo_dir).current_revision
+                      else
+                        log.warn('Creating Materials from a non-git repository')
+                        'not_a_git_repository'
+                      end
+
+      materials_hash = {
+        'filename' => File.basename(product_path),
+        'md5' => Digest::MD5.file(product_path).hexdigest,
+        'contents' => {
+          'releases' => product_metadata.releases_metadata.map(&:basename),
+          'compiled_packages' => []
+        },
+        'build_info' => {
+          'product_repository' => repo_name,
+          'product_revision' => repo_revision,
+          'vara_version' => Vara::VERSION
+        }
+      }
+
+      if product_metadata.explicit_stemcell?
+        materials_hash['contents']['stemcells'] = [product_metadata.stemcell_metadata.basename]
+
+        if product_metadata.has_compiled_packages?
+          materials_hash['contents']['compiled_packages'] << product_metadata.compiled_packages_metadata.basename
+        end
+      else
+        materials_hash['contents']['stemcell_criteria'] = product_metadata.stemcell_criteria
+      end
+
+      new(materials_hash)
+    end
+
+    # @param materials_hash [Hash]
+    def initialize(materials_hash)
+      @hash = materials_hash
+    end
+
+    def save_to(file_path)
+      File.open(file_path, 'w') { |file| YAML.dump(hash, file) }
+    end
+
+    # @return [String] The filename of the .pivotal file
+    def filename
+      hash.fetch('filename')
+    end
+
+    # @return [String] The listed md5 of the .pivotal file
+    def md5
+      hash.fetch('md5')
+    end
+
+    # @return [<String>] The listed releases contained in the .pivotal file
+    def releases
+      contents.fetch('releases')
+    end
+
+    # @return [<String>] The listed stemcells contained in the .pivotal file
+    def stemcells
+      contents['stemcells']
+    end
+
+    def stemcell_criteria
+      contents['stemcell_criteria']
+    end
+
+    # @return [<String>] The listed compiled packages contained in the .pivotal file
+    def compiled_packages
+      contents.fetch('compiled_packages')
+    end
+
+    # @return [String] The name of the product repository
+    def product_repository
+      build_info.fetch('product_repository')
+    end
+
+    # @return [String] The git revision of the product repository used to build the .pivotal
+    def product_revision
+      build_info.fetch('product_revision')
+    end
+
+    # @return [String] the version of vara used to build the described .pivotal (will be >= 0.7.1 or 'unknown')
+    def vara_version
+      build_info.fetch('vara_version', 'unknown')
+    end
+
+    private
+
+    attr_reader :hash
+
+    # @return [Hash]
+    def contents
+      hash.fetch('contents')
+    end
+
+    # @return [Hash]
+    def build_info
+      hash.fetch('build_info')
+    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/md5_creator.rb

@@ -0,0 +1,31 @@
+require 'vara/log'
+
+module Vara
+  class MD5Creator
+    include Loggable
+
+    def self.md5(path)
+      expanded_path = File.expand_path(path)
+      md5_file = "#{expanded_path}.md5"
+
+      md5_string = Digest::MD5.file(expanded_path).hexdigest
+
+      log.warn("File #{md5_file} already exists, overwriting!") if File.exist?(md5_file)
+      File.open(md5_file, 'w') do |file|
+        file.write(md5_string)
+        log.info("Created md5 file: #{md5_file} with contents #{md5_string}")
+      end
+
+      md5_file
+    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.