chef-dk 0.7.0 → 0.8.0

data/lib/chef-dk/command/update.rb

@@ -37,8 +37,7 @@ NOTE: `chef update` does not yet support granular updates (e.g., just updating
 the `run_list` or a specific cookbook version). Support will be added in a
 future version.
 
-The Policyfile feature is incomplete and beta quality. See our detailed README
-for more information.
+See our detailed README for more information:
 
 https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
 
@@ -74,7 +73,7 @@ BANNER
       end
 
       def run(params = [])
-        apply_params!(params)
+        return 1 unless apply_params!(params)
         if update_attributes?
           attributes_updater.run
         else
@@ -116,10 +115,11 @@ BANNER
       def apply_params!(params)
         remaining_args = parse_options(params)
         if remaining_args.size > 1
-          ui.err(banner)
-          return 1
+          ui.err(opt_parser)
+          false
         else
           @policyfile_relative_path = remaining_args.first
+          true
         end
       end
 

data/lib/chef-dk/command/verify.rb

@@ -127,11 +127,17 @@ module ChefDK
 
         c.smoke_test do
           # ------------
-          # we want to avoid hard-coding driver names, but calling Gem::Specification produces a warning; this
-          # seems to be the best way to silence it.
+          # we want to avoid hard-coding driver names, but calling Gem::Specification produces a warning;
+          # changing $VERBOSE seems to be the best way to silence it.
           verbose = $VERBOSE
           $VERBOSE = nil
 
+          # construct a hash of { driver_name => [version1, version2, ...]}
+          driver_versions = {}
+          Gem::Specification.all.map { |gs| [gs.name, gs.version] }.
+                                  select { |n| n[0] =~ /^chef-provisioning-/ }.
+                                  each { |gem, version| (driver_versions[gem] ||= []) << version }
+
           drivers = Gem::Specification.all.map { |gs| gs.name }.
                                            select { |n| n =~ /^chef-provisioning-/ }.
                                            uniq
@@ -141,6 +147,48 @@ module ChefDK
           # ------------
           failures = []
 
+          # ------------
+          # fail the verify if we have more than one version of chef-provisioning or any of its drivers.
+          def format_gem_failure(name, versions)
+            <<-EOS
+#{name} has multiple versions installed:
+#{versions.sort.map { |gv| "    #{gv.to_s}" }.join("\n")}
+            EOS
+          end
+
+          failures << format_gem_failure("chef-provisioning", versions) if versions.size > 1
+
+          driver_versions.keys.sort.each do |driver_name|
+            v = driver_versions[driver_name]
+            failures << format_gem_failure(driver_name, v) if v.size > 1
+          end
+
+          if failures.size > 0
+            failures << <<-EOS
+
+Some applications may need or prefer different versions of the chef-provisioning gem or its drivers, so
+this multiple-version check can fail if a user has installed new versions of those libraries.
+EOS
+          end
+
+          # ------------
+          # load the core gem and all of the drivers (ignoring versions).
+          require "chef/provisioning"
+          drivers.map { |d| "#{d.gsub('-', '/')}_driver" }.each do |driver_gem|
+            begin
+              begin
+                require driver_gem
+              rescue LoadError
+                # anomalously, chef-provisioning-fog does not have a fog_driver.rb. (9/2015)
+                require "#{driver_gem}/driver.rb"
+              end
+            rescue LoadError => ex
+              puts ex
+            end
+          end
+
+          # ------------
+          # look for version dependency conflicts.
           tmpdir do |cwd|
             versions.each do |provisioning_version|
               gemfile = "chef-provisioning-#{provisioning_version}-chefdk-test.gemfile"
@@ -154,15 +202,11 @@ module ChefDK
               result = sh("bundle install --local --quiet", cwd: cwd, env: {"BUNDLE_GEMFILE" => gemfile })
 
               if result.exitstatus != 0
-                failures << result
+                failures << result.stdout
               end
-
             end  # end provisioning versions.
 
-            if failures.size > 0
-              failures.each { |fail| puts fail.stdout }
-              puts "\nDriver list (no version restrictions):\n  #{drivers.join("\n  ")}"
-            end
+            failures.each { |fail| puts fail }
 
             # dubious on Windows.
             # this is weird, but we seem to require a Mixlib::ShellOut as the return value. suggestions
@@ -238,13 +282,13 @@ end
 
         c.smoke_test do
 
-          if File.directory?("/usr/bin")
-            sh!("/usr/bin/berks -v")
+          if File.directory?(usr_bin_prefix)
+            sh!("#{usr_bin_path("berks")} -v")
 
-            sh!("/usr/bin/chef -v")
+            sh!("#{usr_bin_path("chef")} -v")
 
-            sh!("/usr/bin/chef-client -v")
-            sh!("/usr/bin/chef-solo -v")
+            sh!("#{usr_bin_path("chef-client")} -v")
+            sh!("#{usr_bin_path("chef-solo")} -v")
 
             # In `knife`, `knife -v` follows a different code path that skips
             # command/plugin loading; `knife -h` loads commands and plugins, but
@@ -253,17 +297,17 @@ end
             # exits 0, which runs most of the code.
             #
             # See also: https://github.com/opscode/chef-dk/issues/227
-            sh!("/usr/bin/knife exec -E true")
+            sh!("#{usr_bin_path("knife")} exec -E true")
 
             tmpdir do |dir|
               # Kitchen tries to create a .kitchen dir even when just running
               # `kitchen -v`:
-              sh!("/usr/bin/kitchen -v", cwd: dir)
+              sh!("#{usr_bin_path("kitchen")} -v", cwd: dir)
             end
 
-            sh!("/usr/bin/ohai -v")
+            sh!("#{usr_bin_path("ohai")} -v")
 
-            sh!("/usr/bin/foodcritic -V")
+            sh!("#{usr_bin_path("foodcritic")} -V")
           end
 
           # Test blocks are expected to return a Mixlib::ShellOut compatible

data/lib/chef-dk/completions/bash.sh.erb

@@ -0,0 +1,5 @@
+_chef_comp() {
+    local COMMANDS="<%= commands.keys.join(' ')-%>"
+    COMPREPLY=($(compgen -W "$COMMANDS" -- ${COMP_WORDS[COMP_CWORD]} ))
+}
+complete -F _chef_comp chef

data/lib/chef-dk/completions/chef.fish.erb

@@ -0,0 +1,10 @@
+# Fish Shell command-line completions for ChefDK
+
+function __fish_chef_no_command --description 'Test if chef has yet to be given the main command'
+  set -l cmd (commandline -opc)
+  test (count $cmd) -eq 1
+end
+
+<% commands.each do |command, desc| -%>
+complete -c chef -f -n '__fish_chef_no_command' -a <%= command %> -d "<%= desc %>"
+<% end -%>

data/lib/chef-dk/completions/zsh.zsh.erb

@@ -0,0 +1,21 @@
+function _chef() {
+
+  local -a _1st_arguments
+  _1st_arguments=(
+  <% commands.each do |command, desc| -%>
+    '<%=command%>:<%=desc%>'
+  <% end -%>
+  )
+
+  _arguments \
+    '(-v --version)'{-v,--version}'[version information]' \
+    '*:: :->subcmds' && return 0
+
+  if (( CURRENT == 1 )); then
+    _describe -t commands "chef subcommand" _1st_arguments
+    return
+  fi
+}
+
+compdef _chef chef
+

data/lib/chef-dk/exceptions.rb

@@ -68,6 +68,18 @@ module ChefDK
   class InvalidPolicyfileFilename < StandardError
   end
 
+  class InvalidUndoRecord < StandardError
+  end
+
+  class CantUndo < StandardError
+  end
+
+  class UndoRecordNotFound < StandardError
+  end
+
+  class MultipleErrors < StandardError
+  end
+
   class BUG < RuntimeError
   end
 

data/lib/chef-dk/helpers.rb

@@ -86,6 +86,18 @@ module ChefDK
                        end
     end
 
+    # Returns the directory that contains our main symlinks.
+    # On Mac we place all of our symlinks under /usr/local/bin on other
+    # platforms they are under /usr/bin
+    def usr_bin_prefix
+      @usr_bin_prefix ||= os_x? ? "/usr/local/bin" : "/usr/bin"
+    end
+
+    # Returns the full path to the given command under usr_bin_prefix
+    def usr_bin_path(command)
+      File.join(usr_bin_prefix, command)
+    end
+
     private
 
     def omnibus_expand_path(*paths)
@@ -138,5 +150,10 @@ module ChefDK
         self.instance_variable_set(ivar, nil)
       end
     end
+
+    # Returns true if we are on Mac OS X. Otherwise false
+    def os_x?
+      !!(RUBY_PLATFORM =~ /darwin/)
+    end
   end
 end

data/lib/chef-dk/policyfile/community_cookbook_source.rb

@@ -20,9 +20,6 @@ require 'chef-dk/cookbook_omnifetch'
 require 'chef-dk/exceptions'
 require 'chef/http/simple'
 
-# TODO: fix hardcoding
-Chef::Config.ssl_verify_mode = :verify_peer
-
 module ChefDK
   module Policyfile
 

data/lib/chef-dk/policyfile/lister.rb

@@ -67,6 +67,8 @@ module ChefDK
 
     class PolicyGroupRevIDMap
 
+      include Enumerable
+
       attr_reader :policy_name
       attr_reader :revision_ids_by_group
 
@@ -215,7 +217,7 @@ module ChefDK
 
       def set_policies_by_group_from_api(policy_group_data)
         @policies_by_group = policy_group_data.inject({}) do |map, (policy_group, policy_info)|
-          map[policy_group] = policy_info["policies"].inject({}) do |rev_map, (policy_name, rev_info)|
+          map[policy_group] = (policy_info["policies"] || []).inject({}) do |rev_map, (policy_name, rev_info)|
             rev_map[policy_name] = rev_info["revision_id"]; rev_map
           end
 

data/lib/chef-dk/policyfile/undo_record.rb

@@ -0,0 +1,142 @@
+#
+# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'chef-dk/exceptions'
+
+module ChefDK
+  module Policyfile
+
+    class UndoRecord
+
+      PolicyGroupRestoreData = Struct.new(:policy_name, :policy_group, :data) do
+
+        def load(data)
+          self.policy_name = data["policy_name"]
+          self.policy_group = data["policy_group"]
+          self.data = data["data"]
+          self
+        end
+
+        def for_serialization
+          {
+            "policy_name" => policy_name,
+            "policy_group" => policy_group,
+            "data" => data
+          }
+        end
+
+      end
+
+      attr_reader :policy_groups
+
+      attr_reader :policy_revisions
+
+      attr_accessor :description
+
+      def initialize
+        reset!
+      end
+
+      def ==(other)
+        other.kind_of?(UndoRecord) &&
+          other.policy_groups == policy_groups &&
+          other.policy_revisions == policy_revisions
+      end
+
+      def add_policy_group(name)
+        @policy_groups << name
+      end
+
+      def add_policy_revision(policy_name, policy_group, data)
+        @policy_revisions << PolicyGroupRestoreData.new(policy_name, policy_group, data)
+      end
+
+      def load(data)
+        reset!
+
+        unless data.kind_of?(Hash)
+          raise InvalidUndoRecord, "Undo data is incorrectly formatted. Must be a Hash, got '#{data}'."
+        end
+        missing_fields = %w[ format_version description backup_data ].select { |key| !data.key?(key) }
+        unless missing_fields.empty?
+          raise InvalidUndoRecord, "Undo data is missing mandatory field(s) #{missing_fields.join(', ')}. Undo data: '#{data}'"
+        end
+
+        @description = data["description"]
+
+        policy_data = data["backup_data"]
+        unless policy_data.kind_of?(Hash)
+          raise InvalidUndoRecord, "'backup_data' in the undo record is incorrectly formatted. Must be a Hash, got '#{policy_data}'"
+        end
+        missing_policy_data_fields = %w[ policy_groups policy_revisions ].select { |key| !policy_data.key?(key) }
+        unless missing_policy_data_fields.empty?
+          raise InvalidUndoRecord,
+            "'backup_data' in the undo record is missing mandatory field(s) #{missing_policy_data_fields.join(', ')}. Backup data: #{policy_data}"
+        end
+
+        policy_groups = policy_data["policy_groups"]
+
+        unless policy_groups.kind_of?(Array)
+          raise InvalidUndoRecord,
+            "'policy_groups' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_groups}'"
+        end
+
+        @policy_groups = policy_groups
+
+        policy_revisions = policy_data["policy_revisions"]
+        unless policy_revisions.kind_of?(Array)
+          raise InvalidUndoRecord,
+            "'policy_revisions' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_revisions}'"
+        end
+
+        policy_revisions.each do |revision|
+          unless revision.kind_of?(Hash)
+            raise InvalidUndoRecord,
+              "Invalid item in 'policy_revisions' in the undo record. Must be a Hash, got '#{revision}'"
+          end
+
+          @policy_revisions << PolicyGroupRestoreData.new.load(revision)
+        end
+
+        self
+      end
+
+      def for_serialization
+        {
+          "format_version" => 1,
+          "description" => description,
+          "backup_data" => {
+            "policy_groups" => policy_groups,
+            "policy_revisions" => policy_revisions.map(&:for_serialization)
+          }
+        }
+      end
+
+      private
+
+      def reset!
+        @description = ""
+        @policy_groups = []
+        @policy_revisions = []
+      end
+
+    end
+  end
+end
+
+
+

data/lib/chef-dk/policyfile/undo_stack.rb

@@ -0,0 +1,130 @@
+#
+# Copyright:: Copyright (c) 2015 Chef Software Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'fileutils'
+
+require 'ffi_yajl'
+
+require 'chef-dk/helpers'
+require 'chef-dk/policyfile/undo_record'
+
+module ChefDK
+  module Policyfile
+
+    class UndoStack
+
+      MAX_SIZE = 10
+
+      include Helpers
+
+      def undo_dir
+        File.join(Helpers.chefdk_home, "undo")
+      end
+
+      def size
+        undo_record_files.size
+      end
+
+      def empty?
+        size == 0
+      end
+
+      def has_id?(id)
+        File.exist?(undo_file_for(id))
+      end
+
+      def each_with_id
+        undo_record_files.each do |filename|
+          yield File.basename(filename), load_undo_record(filename)
+        end
+      end
+
+      def undo_records
+        undo_record_files.map { |f| load_undo_record(f) }
+      end
+
+      def push(undo_record)
+        ensure_undo_dir_exists
+
+        record_id = Time.new.utc.strftime("%Y%m%d%H%M%S")
+        path = File.join(undo_dir, record_id)
+
+        with_file(path) do |f|
+          f.print(FFI_Yajl::Encoder.encode(undo_record.for_serialization, pretty: true))
+        end
+
+        records_to_delete = undo_record_files.size - MAX_SIZE
+        if records_to_delete > 0
+          undo_record_files.take(records_to_delete).each do |file|
+            File.unlink(file)
+          end
+        end
+
+        self
+      end
+
+      def pop
+        file_to_pop = undo_record_files.last
+        if file_to_pop.nil?
+          raise CantUndo, "No undo records exist in #{undo_dir}"
+        end
+
+        record = load_undo_record(file_to_pop)
+        # if this hits an exception, we skip unlink
+        yield record if block_given?
+        File.unlink(file_to_pop)
+        record
+      end
+
+      def delete(id)
+        undo_file = undo_file_for(id)
+        unless File.exist?(undo_file)
+          raise UndoRecordNotFound, "No undo record for id '#{id}' exists at #{undo_file}"
+        end
+
+        record = load_undo_record(undo_file)
+        yield record if block_given?
+        File.unlink(undo_file)
+        record
+      end
+
+      private
+
+      def undo_file_for(id)
+        File.join(undo_dir, id)
+      end
+
+      def load_undo_record(file)
+        data = FFI_Yajl::Parser.parse(IO.read(file))
+        UndoRecord.new.load(data)
+      end
+
+      def undo_record_files
+        Dir[File.join(undo_dir, '*')].sort
+      end
+
+      def ensure_undo_dir_exists
+        return false if File.directory?(undo_dir)
+
+
+        FileUtils.mkdir_p(undo_dir)
+      end
+    end
+
+  end
+end
+