berktacular 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b550dd28f7c682c8659d022921d89a65785053a
-  data.tar.gz: c1c53aeeb4858818ccddb394229c2f38d8d3caa8
+  metadata.gz: dd96380cb5328cdcb55bb90c68f82bbf7c880d88
+  data.tar.gz: 3acd725fb400db94b90e9d5c715b93e3e827ff23
 SHA512:
-  metadata.gz: 638e0ef1f4a61e6754482c2b371dc1167a4671d27e4c297867ef2f1674fa82381e49f3cf37e2c3bdca30b8ad02fc9bd85a166c98d88276808f23d803272eeceb
-  data.tar.gz: 548d71a31fd89eb2781657a40fe85f075e0b3a0faf4956cdad663f3212ce77e538a111a4fcdd5d80f1b785fba75f17c5d5f3052f74822de32c800b5b1f69daaa
+  metadata.gz: 237987cab59af28eb1bbceb9be83025cce24202bce5f6a077ea430a631099926c975a9e7039a3b18a9c87c03f0ee301d4b01c806900dd8dafb57f032990c61a9
+  data.tar.gz: ce2bd2304cad516b5c0cea0718fd29f26d6fc419039017c2dd5dd653f7694a0e76d74b715462e8272269a125e7ce00b6b0e25f857a8a8aef7155e0e89e96ec4e

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.2.2

data/bin/berktacular

@@ -18,6 +18,7 @@ upload      = false
 berks_conf  = nil
 knife_conf  = nil
 workdir     = nil
+parent_env_dir = nil
 verbose     = false
 source_list = []
 versions_only = false
@@ -69,6 +70,9 @@ options =  OptionParser.new do |opts|
     workdir = w
     preserve = true
   end
+  opts.on("--parent-env-directory DIR", String, "Directory to search for parent environments. Defaults to the directory of the env file") do |t|
+    parent_env_dir = t
+  end
   opts.on("-m PATH", "--multi-cookbook-dir PATH", String,
       "Treat the given directory as a multi-cookbook directory, and allow referring to cookbooks " \
       "under this directory when the 'rel' configuration parameter is specified and the version " \
@@ -161,7 +165,8 @@ b = Berktacular::Berksfile.new(
   github_token: github_token,
   verbose: verbose,
   source_list: source_list,
-  multi_cookbook_dir: multi_cookbook_dir
+  multi_cookbook_dir: multi_cookbook_dir,
+  parent_env_dir: parent_env_dir
 )
 b.check_updates if check
 puts "#{b}" if printit

data/lib/berktacular/berksfile.rb

@@ -46,7 +46,8 @@ module Berktacular
         source_list:   opts.has_key?(:source_list)  ? opts[:source_list]  : [],
         multi_cookbook_dir:  opts.has_key?(:multi_cookbook_dir) ? opts[:multi_cookbook_dir] : nil,
         versions_only:  opts.has_key?(:versions_only) ? opts[:versions_only] : false,
-        max_depth:      opts.has_key?(:max_depth) ? opts[:max_depth] : 10
+        max_depth:      opts.has_key?(:max_depth) ? opts[:max_depth] : 10,
+        parent_env_dir: opts.has_key?(:parent_env_dir) ? opts[:parent_env_dir] : nil
       }
       @counter  = 0
       @env_hash =  expand_env_file(env_path)
@@ -254,10 +255,11 @@ module Berktacular
         raise "Environment file '#{env_file}' does not exist!"
       end
       if env.has_key?("parent")
+        parent_env_dir = @opts[:parent_env_dir].nil? ? File.dirname(env_file) : @opts[:parent_env_dir]
         parent = env["parent"]
         if !File.exists?(parent)
           parent = File.join(
-            File.dirname(env_file),
+            parent_env_dir,
             parent
           )
         end

data/lib/berktacular/berksfile.rb.jeff

@@ -0,0 +1,274 @@
+require 'ostruct'
+require 'json'
+require 'solve'
+
+# Taken from http://stackoverflow.com/a/25990044
+class ::Hash
+  def deep_merge(second)
+    merger = proc { |key, v1, v2|
+      Hash === v1 && Hash === v2 ?
+        v1.merge(v2, &merger) :
+        [:undefined, nil, :nil].include?(v2) ? v1 : v2
+    }
+    self.merge(second, &merger)
+  end
+end
+
+module Berktacular
+
+  # This class represents a Berksfile
+
+  class Berksfile
+
+    # @!attribute [r] name
+    #   @return [String] the name of the environment.
+    # @!attribute [r] description
+    #   @return [String] a description of the enviroment.
+    # @!attribute [r] installed
+    #   @return [Hash] a hash of installed cookbook directories.
+    # @!attribute [r] missing_deps
+    #   @return [Hash] a hash of cookbooks missing dependencies after calling verify.
+    attr_reader :name, :description, :installed, :missing_deps
+
+    # Creates a new Berksfile from a chef environment file.
+    #
+    # @param environment [Hash] a parsed JSON chef environment config.
+    # @option opts [String] :github_token (nil) the github token to use.
+    # @option opts [True,False] :upgrade (False) whether or not to check for upgraded cookbooks.
+    # @option opts [True,False] :verbose (False) be more verbose.
+    # @option opts [Array<String>] :source_list additional Berkshelf API sources to include in the
+    #   generated Berksfile.
+    def initialize( env_path, opts = {})
+      @opts = {
+        upgrade:       opts.has_key?(:upgrade)      ? opts[:upgrade]      : false,
+        github_token:  opts.has_key?(:github_token) ? opts[:github_token] : nil,
+        verbose:       opts.has_key?(:verbose)      ? opts[:verbose]      : false,
+        source_list:   opts.has_key?(:source_list)  ? opts[:source_list]  : [],
+        multi_cookbook_dir:  opts.has_key?(:multi_cookbook_dir) ? opts[:multi_cookbook_dir] : nil,
+        versions_only:  opts.has_key?(:versions_only) ? opts[:versions_only] : false,
+        max_depth:      opts.has_key?(:max_depth) ? opts[:max_depth] : 10
+      }
+      @counter  = 0
+      @env_hash =  expand_env_file(env_path)
+
+      @name               = @env_hash['name']               || nil
+      @description        = @env_hash['description']        || nil
+      @cookbook_versions  = @env_hash['cookbook_versions']  || {}
+      @cookbook_locations = @env_hash['cookbook_locations'] || {}
+      @installed = {}
+      # only connect once, pass the client to each cookbook.  and only if needed
+      connect_to_git if @opts[:upgrade]
+      @opts[:source_list] = (@opts[:source_list] + ["https://supermarket.chef.io"]).uniq
+    end
+
+    # @return [Hash] representation of the env_file.
+    def env_file
+      if @opts[:upgrade]
+        cookbooks.each do |book|
+          @env_hash['cookbook_versions'][book.name] = book.version_specifier
+        end
+      end
+      @env_hash
+    end
+
+    # @return [String] representation of the env_file in pretty json.
+    def env_file_json
+      if @opts[:upgrade]
+        cookbooks.each do |book|
+          @env_hash['cookbook_versions'][book.name] = book.version_specifier
+        end
+      end
+      JSON.pretty_generate(@env_hash)
+    end
+
+    # @param workdir [String] the directory in which to install.  If nil, Berktacular.best_temp_dir is used.
+    # @return [String] the directory path where the cookbooks were installed.
+    def install(workdir = nil)
+      if workdir
+        FileUtils.mkdir_p(workdir)
+      else
+        workdir = Berktacular.best_temp_dir
+      end
+      unless @installed[workdir]
+        # remove the Berksfile.lock if it exists (it shouldn't).
+        berksfile = File.join(workdir, "Berksfile")
+        lck       = berksfile + ".lock"
+        cookbooks = File.join(workdir, "cookbooks")
+        FileUtils.rm(lck) if File.exists? lck
+        File.write(berksfile, self)
+        Berktacular.run_command("berks vendor -d --berksfile #{berksfile} #{cookbooks}")
+        @installed[workdir] = {berksfile: berksfile, lck: lck, cookbooks: cookbooks}
+      end
+      workdir
+    end
+
+    # @params workdir [String] the directory in which to install.  If nil, Berktacular.best_temp_dir is used.
+    # @return [True,False] the status of the verify.
+    def verify(workdir = nil)
+      require 'ridley'
+      @missing_deps = {}
+      workdir       = install(workdir)
+      versions      = {}
+      dependencies  = {}
+      Dir["#{@installed[workdir][:cookbooks]}/*"].each do |cookbook_dir|
+        next unless File.directory?(cookbook_dir)
+        metadata_candidates = ['rb', 'json'].map {|ext| File.join(cookbook_dir, "metadata.#{ext}") }
+        metadata_path = metadata_candidates.find {|f| File.exists?(f) }
+        raise "Metadata file not found: #{metadata_candidates}" if metadata_path.nil?
+        metadata =
+          metadata_path =~ /\.json$/ ? metadata_from_json(IO.read(metadata_path)) :
+            Ridley::Chef::Cookbook::Metadata.from_file(metadata_path)
+        cookbook_name = metadata.name
+        name_from_path = File.basename(cookbook_dir)
+        unless cookbook_name == name_from_path
+          if cookbook_name.empty?
+            puts "Cookbook #{name_from_path} has no name specified in metadata.rb"
+            cookbook_name = name_from_path
+          else
+            warn "Cookbook name from metadata.rb does not match the directory name!",
+                 "metadata.rb: '#{cookbook_name}'",
+                 "cookbook directory name: '#{name_from_path}'"
+          end
+        end
+        versions[cookbook_name] = metadata.version
+        dependencies[cookbook_name] = metadata.dependencies
+      end
+      errors = false
+      dependencies.each do |name, deps|
+        deps.each do |dep_name, constraint|
+          actual_version = versions[dep_name]
+          if !actual_version
+            @missing_deps[name] = "#{name}-#{versions[name]} depends on #{dep_name} which was not installed!"
+            warn @missing_deps[name]
+            errors = true
+          elsif constraint != []  # some cookbooks have '[]' as a dependency in their json metadata
+            constraint_obj = begin
+              Semverse::Constraint.new(constraint)
+            rescue Semverse::InvalidConstraintFormat => ex
+              warn "Could not parse version constraint '#{constraint}' " +
+                   "for dependency '#{dep_name}' of cookbook '#{name}'"
+              raise ex
+            end
+
+            unless constraint_obj.satisfies?(actual_version)
+              @missing_deps[name] = "#{name}-#{versions[name]} depends on #{dep_name} #{constraint} but #{dep_name} is #{actual_version}!"
+              warn @missing_deps[name]
+              errors = true
+            end
+          end
+        end
+      end
+      !errors
+    end
+
+    # @param berks_conf [String] path to the berkshelf config file to use.
+    # @param knife_conf [String] path to the knife config file to use.
+    # @param workdir [String] Path to use as the working directory.
+    #   @default Berktacular.best_temp_dir
+    # @return [True] or raise on error.
+    def upload(berks_conf, knife_conf, workdir=nil)
+      raise "No berks config, required for upload" unless berks_conf && File.exists?(berks_conf)
+      raise "No knife config, required for upload" unless knife_conf && File.exists?(knife_conf)
+      workdir       = install(workdir)
+      new_env_file  = File.join(workdir, @name + ".json")
+      File.write(new_env_file, env_file_json)
+      Berktacular.run_command("berks upload --berksfile #{@installed[workdir][:berksfile]} -c #{berks_conf}")
+      Berktacular.run_command("knife environment from file #{new_env_file} -c #{knife_conf}")
+    end
+
+    # param workdir [String,nil] the workdir to remove.  If nil, remove all installed working directories.
+    def clean(workdir = nil)
+      if workdir
+        Fileutils.rm_r(workdir)
+        @installed.delete(workdir)
+      else
+        # clean them all
+        @installed.keys.each { |d| FileUtils.rm_r(d) }
+        @installed = {}
+      end
+    end
+
+    # @param [IO] where to write the data.
+    def print_berksfile( io = STDOUT )
+      io.puts to_s
+    end
+
+    # @return [String] the berksfile as a String object
+    def to_s
+      str = ''
+      str << "# Name: '#{@name}'\n" if @name
+      str << "# Description: #{@description}\n\n" if @description
+      str << "# This file is auto-generated, changes will be overwritten\n"
+      str << "# Modify the .json environment file and regenerate this Berksfile to make changes.\n\n"
+
+      @opts[:source_list].each do |source_url|
+        str << "source '#{source_url}'\n"
+      end
+      str << "\n"
+      cookbooks.each { |l| str << l.to_s << "\n" }
+      str
+    end
+
+    # @return [Array] a list of Cookbook objects for this environment.
+    def cookbooks
+      @cookbooks ||= @cookbook_versions.sort.map do |book, version|
+        Cookbook.new(book, version, @cookbook_locations[book], @opts)
+      end
+    end
+
+    # print out the cookbooks that have newer version available on github.
+    def check_updates
+      connect_to_git
+      cookbooks.each do |b|
+        candidates = b.check_updates
+        next unless candidates.any?
+        puts "Cookbook: #{b.name} (auto upgrade: #{b.auto_upgrade ? 'enabled' : 'disabled'})",
+             "\tCurrent: #{b.version_number}",
+             "\tUpdates: #{candidates.join(", ")}"
+      end
+    end
+
+    private
+
+    # connect to github using the token in @opts[:github_token].
+    # @return [Octokit::Client] a connected github client.
+    def connect_to_git
+      raise "No token given, can't connect to git" unless @opts[:github_token]
+      puts "Connecting to git with supplied github_token" if @opts[:verbose]
+      require 'octokit'
+      @opts[:git_client] ||= Octokit::Client.new(
+        access_token: @opts[:github_token],
+        auto_paginate: true
+      )
+    end
+
+    # recursively expand env_file @opts[:max_depth] times.
+    # @return [Hash] of merged env_file
+    def expand_env_file(env_file)
+      raise "Exceeded max depth!" if @counter > @opts[:max_depth]
+      @counter += 1
+      env = {}
+      if File.exists?(env_file)
+        env = JSON.parse( File.read(env_file) )
+      else
+        raise "Environment file '#{env_file}' does not exist!"
+      end
+      if env.has_key?("parent")
+        parent = env["parent"]
+        if !File.exists?(parent)
+          parent = File.join(
+            File.dirname(env_file),
+            parent
+          )
+        end
+        env = expand_env_file( parent ).deep_merge( env )
+      end
+      env
+    end
+
+    def metadata_from_json(json_str)
+      OpenStruct.new(JSON.parse(json_str))
+    end
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: berktacular
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Jeff Harvey-Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-09 00:00:00.000000000 Z
+date: 2016-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solve
@@ -143,6 +143,7 @@ files:
 - bin/berktacular
 - lib/berktacular.rb
 - lib/berktacular/berksfile.rb
+- lib/berktacular/berksfile.rb.jeff
 - lib/berktacular/cookbook.rb
 - lib/berktacular/version.rb
 homepage: https://rubygems.org/gems/berktacular
@@ -165,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Parse chef env files, generates a Berksfile and verifies it.
 test_files: []
-has_rdoc: