chef-dk 0.5.0.rc.1 → 0.5.0

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

@@ -104,7 +104,7 @@ E
       def apply_params!(params)
         remaining_args = parse_options(params)
         if remaining_args.size < 1 or remaining_args.size > 2
-          ui.err(banner)
+          ui.err(opt_parser)
           return false
         else
           @policy_group = remaining_args[0]

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

@@ -22,7 +22,7 @@ module ChefDK
   module Command
     class ShellInit < ChefDK::Command::Base
 
-      SUPPORTED_SHELLS = %w[ bash zsh sh powershell posh].map(&:freeze).freeze
+      SUPPORTED_SHELLS = %w[ bash fish zsh sh powershell posh].map(&:freeze).freeze
 
       banner(<<-HELP)
 Usage: chef shell-init
@@ -34,6 +34,8 @@ ruby.
 
     In sh, bash, and zsh:
       eval "$(chef shell-init SHELL_NAME)"
+    In fish:
+      eval (chef shell-init fish)
     In Powershell:
       chef shell-init powershell | Invoke-Expression
 
@@ -41,6 +43,8 @@ ruby.
 
     In sh, bash, and zsh:
       echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
+    In fish:
+      echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
     In Powershell
       "chef shell-init powershell | Invoke-Expression" >> $PROFILE
 
@@ -84,17 +88,31 @@ HELP
         case shell
         when 'sh', 'bash', 'zsh'
           posix_shell_export(var, val)
+        when 'fish'
+          fish_shell_export(var, val)
         when 'powershell', 'posh'
           powershell_export(var, val)
         end
       end
 
       def posix_shell_export(var, val)
-        msg("export #{var}=\"#{val}\"")
+        msg(%Q(export #{var}="#{val}"))
+      end
+
+      def fish_shell_export(var, val)
+        # Fish's syntax for setting PATH is special. Path elements are
+        # divided by spaces (instead of colons). We also send STDERR to
+        # /dev/null to avoid Fish's helpful warnings about nonexistent
+        # PATH elements.
+        if var == 'PATH'
+          msg(%Q(set -gx #{var} "#{val.split(':').join('" "')}" 2>/dev/null;))
+        else
+          msg(%Q(set -gx #{var} "#{val}";))
+        end
       end
 
       def powershell_export(var, val)
-        msg("$env:#{var}=\"#{val}\"")
+        msg(%Q($env:#{var}="#{val}"))
       end
     end
   end

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

@@ -18,6 +18,7 @@
 require 'chef-dk/command/base'
 require 'chef-dk/ui'
 require 'chef-dk/policyfile_services/install'
+require 'chef-dk/policyfile_services/update_attributes'
 
 module ChefDK
   module Command
@@ -46,10 +47,18 @@ Options:
 BANNER
 
       option :debug,
-        short:       "-D",
-        long:        "--debug",
-        description: "Enable stacktraces and other debug output",
-        default:     false
+        short:        "-D",
+        long:         "--debug",
+        description:  "Enable stacktraces and other debug output",
+        default:      false,
+        boolean:      true
+
+      option :update_attributes,
+        short:        "-a",
+        long:         "--attributes",
+        description:  "Update attributes",
+        default:      false,
+        boolean:      true
 
       attr_reader :policyfile_relative_path
 
@@ -61,11 +70,16 @@ BANNER
 
         @policyfile_relative_path = nil
         @installer = nil
+        @attributes_updater = nil
       end
 
       def run(params = [])
         apply_params!(params)
-        installer.run
+        if update_attributes?
+          attributes_updater.run
+        else
+          installer.run
+        end
         0
       rescue PolicyfileServiceError => e
         handle_error(e)
@@ -76,10 +90,19 @@ BANNER
         @installer ||= PolicyfileServices::Install.new(policyfile: policyfile_relative_path, ui: ui, root_dir: Dir.pwd, overwrite: true)
       end
 
+      def attributes_updater
+        @attributes_updater ||=
+          PolicyfileServices::UpdateAttributes.new(policyfile: policyfile_relative_path, ui: ui, root_dir: Dir.pwd)
+      end
+
       def debug?
         !!config[:debug]
       end
 
+      def update_attributes?
+        !!config[:update_attributes]
+      end
+
       def handle_error(error)
         ui.err("Error: #{error.message}")
         if error.respond_to?(:reason)

data/lib/chef-dk/configurable.rb

@@ -21,7 +21,7 @@ require 'chef/workstation_config_loader'
 # Define a config context for ChefDK
 class Chef::Config
 
-  default(:policy_document_native_api, false)
+  default(:policy_document_native_api, true)
 
   config_context(:chefdk) do
 

data/lib/chef-dk/exceptions.rb

@@ -38,6 +38,9 @@ module ChefDK
   class CachedCookbookModified < StandardError
   end
 
+  class InvalidPolicyfileAttribute < StandardError
+  end
+
   class MissingComponentError < RuntimeError
     def initialize(component_name, path_checked)
       super("Component #{component_name} is missing. \nReason: Could not find #{path_checked}.")

data/lib/chef-dk/pager.rb

@@ -0,0 +1,106 @@
+#
+# 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/ui'
+
+module ChefDK
+  class Pager
+
+    attr_reader :pager_pid
+
+    def initialize(enable_pager: true)
+      @enable_pager = enable_pager
+      @pipe = nil
+      @pager_pid
+    end
+
+    def pager_enabled?
+      !!(@enable_pager && have_tty? && env["PAGER"])
+    end
+
+    def ui
+      @ui ||=
+        if pager_enabled?
+          UI.new(out: parent_stdout)
+        else
+          UI.new
+        end
+    end
+
+    def with_pager
+      start
+      begin
+        yield self
+      ensure
+        wait
+      end
+    end
+
+    def start
+      return false unless pager_enabled?
+
+      # Ignore CTRL-C because it can cause the parent to die before the
+      # pager which causes wonky behavior in the terminal
+      Kernel.trap(:INT, "IGNORE")
+
+      @pager_pid = Process.spawn(pager_env, env["PAGER"], in: child_stdin)
+
+      child_stdin.close
+    end
+
+    def wait
+      return false unless pager_enabled?
+
+      # Sends EOF to the PAGER
+      parent_stdout.close
+      # wait or else we'd kill the pager when we exit
+      Process.waitpid(pager_pid)
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def env
+      ENV
+    end
+
+    # @api private
+    # This is just public so we can stub it for testing
+    def have_tty?
+      $stdout.tty?
+    end
+
+    private
+
+    def child_stdin
+      pipe[0]
+    end
+
+    def parent_stdout
+      pipe[1]
+    end
+
+    def pipe
+      @pipe ||= IO.pipe
+    end
+
+    def pager_env
+      {"LESS" => "-FRX", "LV" => "-c"}
+    end
+
+  end
+end
+

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

@@ -0,0 +1,114 @@
+#
+# Copyright:: Copyright (c) 2014 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'
+require 'chef/cookbook_loader'
+require 'chef/cookbook/file_system_file_vendor'
+require 'chef-dk/ui'
+
+module ChefDK
+  module Policyfile
+    class ChefRepoCookbookSource
+
+      # path to a chef-repo or the cookbook path under it
+      attr_reader :path
+      # UI object for output
+      attr_accessor :ui
+
+      # Constructor
+      #
+      # @param path [String] path to a chef-repo or the cookbook path under it
+      def initialize(path)
+        self.path = path
+        @ui = UI.new
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.path == path
+      end
+
+      # Calls the slurp_metadata! helper once to calculate the @universe_graph
+      # and @cookbook_version_paths metadata.  Returns the @universe_graph.
+      #
+      # @return [Hash] universe_graph
+      def universe_graph
+        slurp_metadata! if @universe_graph.nil?
+        @universe_graph
+      end
+
+      # Returns the metadata (path and version) for an individual cookbook
+      #
+      # @return [Hash] metadata for a single cookbook version
+      def source_options_for(cookbook_name, cookbook_version)
+        { path: cookbook_version_paths[cookbook_name][cookbook_version], version: cookbook_version }
+      end
+
+      private
+
+      # Setter for setting the path.  It may either be a full chef-repo with
+      # a cookbooks directory in it, or only a path to the cookbooks directory,
+      # and it autodetects which it is passed.
+      #
+      # @param path [String] path to a chef-repo or the cookbook path under it
+      def path=(path)
+        cookbooks_path = "#{path}/cookbooks"
+        if Dir.exist?(cookbooks_path)
+          @path = cookbooks_path
+        else
+          @path = path
+        end
+      end
+
+      # Calls the slurp_metadata! helper once to calculate the @universe_graph
+      # and @cookbook_version_paths metadata.  Returns the @cookbook_version_paths.
+      #
+      # @return [Hash] cookbook_version_paths
+      def cookbook_version_paths
+        slurp_metadata! if @cookbook_version_paths.nil?
+        @cookbook_version_paths
+      end
+
+      # Helper to compute the @universe_graph and @cookbook_version_paths once
+      # from the Chef::CookbookLoader on-disk cookbook repo.
+      def slurp_metadata!
+        @universe_graph = {}
+        @cookbook_version_paths = {}
+        cookbook_repo.load_cookbooks
+        cookbook_repo.each do |cookbook_name, cookbook_version|
+          metadata = cookbook_version.metadata
+          if metadata.name.nil?
+            ui.err("WARN: #{cookbook_name} cookbook missing metadata or no name field, skipping")
+            next
+          end
+          @universe_graph[metadata.name] ||= {}
+          @universe_graph[metadata.name][metadata.version] = metadata.dependencies.to_a
+          @cookbook_version_paths[metadata.name] ||= {}
+          @cookbook_version_paths[metadata.name][metadata.version] = cookbook_version.root_dir
+        end
+      end
+
+      # @return [Chef::CookbookLoader] cookbook loader using on disk FileVendor
+      def cookbook_repo
+        @cookbook_repo ||= begin
+          Chef::Cookbook::FileVendor.fetch_from_disk(path)
+          Chef::CookbookLoader.new(path)
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+#
+# 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 'ffi_yajl'
+require 'mixlib/shellout'
+require 'chef-dk/service_exceptions'
+
+module ChefDK
+  module Policyfile
+    module ComparisonBase
+
+      class Local
+
+        attr_reader :policyfile_lock_relpath
+
+        def initialize(policyfile_lock_relpath)
+          @policyfile_lock_relpath = policyfile_lock_relpath
+        end
+
+        def name
+          "local:#{policyfile_lock_relpath}"
+        end
+
+        def lock
+          raise LockfileNotFound, "Expected lockfile at #{policyfile_lock_relpath} does not exist" unless File.exist?(policyfile_lock_relpath)
+          raise LockfileNotFound, "Expected lockfile at #{policyfile_lock_relpath} cannot be read" unless File.readable?(policyfile_lock_relpath)
+          FFI_Yajl::Parser.parse(IO.read(policyfile_lock_relpath))
+        rescue FFI_Yajl::ParseError => e
+          raise MalformedLockfile, "Invalid JSON in lockfile at #{policyfile_lock_relpath}:\n  #{e.message}"
+        end
+
+      end
+
+      class Git
+
+        attr_reader :ref
+        attr_reader :policyfile_lock_relpath
+
+        def initialize(ref, policyfile_lock_relpath)
+          @ref = ref
+          @policyfile_lock_relpath = policyfile_lock_relpath
+        end
+
+        def name
+          "git:#{ref}"
+        end
+
+        def lock
+          git_cmd.run_command
+          git_cmd.error!
+          FFI_Yajl::Parser.parse(git_cmd.stdout)
+        rescue Mixlib::ShellOut::ShellCommandFailed
+          raise GitError, "Git command `#{git_cmd_string}` failed with message: #{git_cmd.stderr.chomp}"
+        rescue FFI_Yajl::ParseError => e
+          raise MalformedLockfile, "Invalid JSON in lockfile at git ref '#{ref}' at path '#{policyfile_lock_relpath}':\n  #{e.message}"
+        end
+
+        def git_cmd
+          @git_cmd ||= Mixlib::ShellOut.new(git_cmd_string)
+        end
+
+        def git_cmd_string
+          # Git is a little picky about how we specify the paths, but it looks
+          # like we don't need to worry about the relative path to the root of
+          # the repo if we give git a leading dot:
+          #
+          #    git show 6644e6cb2ade90b8aff2ebb44728958fbc939ebf:zero.rb
+          #    fatal: Path 'etc/zero.rb' exists, but not 'zero.rb'.
+          #    Did you mean '6644e6cb2ade90b8aff2ebb44728958fbc939ebf:etc/zero.rb' aka '6644e6cb2ade90b8aff2ebb44728958fbc939ebf:./zero.rb'?
+          #    git show 6644e6cb2ade90b8aff2ebb44728958fbc939ebf:./zero.rb
+          #    (works)
+          "git show #{ref}:./#{policyfile_lock_relpath}"
+        end
+
+      end
+
+      class PolicyGroup
+
+        attr_reader :group
+        attr_reader :policy_name
+        attr_reader :http_client
+
+        def initialize(group, policy_name, http_client)
+          @group = group
+          @policy_name = policy_name
+          @http_client = http_client
+        end
+
+        def name
+          "policy_group:#{group}"
+        end
+
+        def lock
+          http_client.get("policy_groups/#{group}/policies/#{policy_name}")
+        rescue Net::ProtocolError => e
+          if e.respond_to?(:response) && e.response.code.to_s == "404"
+            raise PolicyfileDownloadError.new("No policyfile lock named '#{policy_name}' found in policy_group '#{group}' at #{http_client.url}", e)
+          else
+            raise PolicyfileDownloadError.new("HTTP error attempting to fetch policyfile lock from #{http_client.url}", e)
+          end
+        rescue => e
+          raise PolicyfileDownloadError.new("Failed to fetch policyfile lock from #{http_client.url}", e)
+        end
+
+      end
+
+    end
+  end
+end
+