chef-dk 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ddf96556ab7bfa73a009627a4bee13f83bada0
-  data.tar.gz: c3f5519baae22cf7d471a49ed968ebebbc826ad1
+  metadata.gz: dc8cebdbcdaa5a3c3f4e2b3bf18fc1c3caca8843
+  data.tar.gz: 9f57e9e37cf5b66823e9a6e3f6470afb369177fe
 SHA512:
-  metadata.gz: f4a7492bafe9715b38a62f86b9ce94ed15bd002663f87624989d36e8f9006f05c662b58fd7169fd3c7ce7ea199d53c86fa128451f5c7a95dad653db468f61c0c
-  data.tar.gz: 86a69277b0e3c9ce1c132c9abc6ed58a2d4d48fd7083247bb65427361afd52bc86bff1ec529fbe5e4244650cf789909c8725b85cc10b039ff0c0054dc6e4acec
+  metadata.gz: 0f3578a7438281d5360cc4278e16e424e84c1dcec4f7087a8d9ce9dbbecd8a0e74c3b67d5fde04128bf58ee7815a21f3a48e12d444241928f2f2dd75cc1dc082
+  data.tar.gz: e2e691462cb8febe46e0fec9d07f5f6f21e1bfc73bb89c7bb7556e475253f25ad75f521521cdd523f61c62ceaa3ab7323aead451a568c5339e9bd64c0ca61e21

data/CONTRIBUTING.md

@@ -174,7 +174,7 @@ We frequently make `alpha` and `beta` releases with version numbers that look li
 We do a `Minor` release approximately every 3 months and `Patch` releases on a when-needed
   basis for regressions, significant bugs, and security issues.
 
-Announcements of releases are available on [Chef Blog](http://www.getchef.com/blog) when they are
+Announcements of releases are available on [Chef Blog](https://www.chef.io/blog/) when they are
   available.
 
 ## Chef Community
@@ -187,6 +187,6 @@ Chef is made possible by a strong community of developers and system administrat
 
 Also here are some additional pointers to some awesome Chef content:
 
-* [Chef Docs](http://docs.opscode.com/)
-* [Learn Chef](https://learnchef.opscode.com/)
-* [Chef Inc](http://www.getchef.com/)
+* [Chef Docs](https://docs.chef.io/)
+* [Learn Chef](https://learn.chef.io/)
+* [Chef Inc](https://www.chef.io/)

data/README.md

@@ -219,10 +219,10 @@ dpkg -P chefdk
 - - -
 
 [Berkshelf]: http://berkshelf.com "Berkshelf"
-[Chef]: https://www.getchef.com "Chef"
-[ChefDK]: https://www.getchef.com/downloads/chef-dk "Chef Development Kit"
-[Chef Documentation]: http://docs.opscode.com "Chef Documentation"
+[Chef]: https://www.chef.io "Chef"
+[ChefDK]: https://www.chef.io/downloads/chef-dk "Chef Development Kit"
+[Chef Documentation]: http://docs.chef.io "Chef Documentation"
 [ChefSpec]: http://chefspec.org "ChefSpec"
 [Foodcritic]: http://foodcritic.io "Foodcritic"
-[Learn Chef]: http://learn.getchef.com "Learn Chef"
+[Learn Chef]: http://learn.chef.io "Learn Chef"
 [Test Kitchen]: http://kitchen.ci "Test Kitchen"

data/lib/chef-dk/builtin_commands.rb

@@ -29,7 +29,11 @@ ChefDK.commands do |c|
 
   c.builtin "install", :Install, desc: "Install cookbooks from a Policyfile and generate a locked cookbook set"
 
+  c.builtin "update", :Update, desc: "Updates a Policyfile.lock.json with latest run_list and cookbooks"
+
   c.builtin "push", :Push, desc: "Push a local policy lock to a policy group on the server"
 
+  c.builtin "export", :Export, desc: "Export a policy lock as a Chef Zero code repo"
+
   c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
 end

data/lib/chef-dk/chef_runner.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 #
 
+require 'chef-dk/exceptions'
 require 'chef'
 
 module ChefDK
@@ -25,7 +26,7 @@ module ChefDK
     attr_reader :run_list
 
     def initialize(cookbook_path, run_list)
-      @cookbook_path = cookbook_path
+      @cookbook_path = File.expand_path(cookbook_path)
       @run_list = run_list
       @formatter = nil
       @ohai = nil
@@ -34,6 +35,11 @@ module ChefDK
     def converge
       configure
       Chef::Runner.new(run_context).converge
+    rescue Chef::Exceptions::CookbookNotFound => e
+      message = "Could not find cookbook(s) to satisfy run list #{run_list.inspect} in #{cookbook_path}"
+      raise CookbookNotFound.new(message, e)
+    rescue => e
+      raise ChefConvergeError.new("Chef failed to converge: #{e}", e)
     end
 
     def run_context

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

@@ -30,6 +30,15 @@ module ChefDK
         exec(*params)
         raise "Exec failed without an exception, your ruby is buggy"  # should never get here
       end
+
+      def needs_version?(params)
+        # Force version to get passed down to command
+        false
+      end
+
+      def needs_help?(params)
+        ['-h', '--help'].include? params[0]
+      end
     end
   end
 end

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

@@ -0,0 +1,132 @@
+#
+# 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/command/base'
+require 'chef-dk/ui'
+require 'chef-dk/policyfile_services/export_repo'
+require 'chef-dk/configurable'
+
+module ChefDK
+  module Command
+
+    class Export < Base
+
+      include Configurable
+
+      banner(<<-E)
+Usage: chef export [ POLICY_FILE ] DESTINATION_DIRECTORY [options]
+
+`chef export` creates a Chef Zero compatible Chef repository containing the
+cookbooks described in a Policyfile.lock.json. Once the exported repo is copied
+to the target machine, you can apply the policy to the machine with
+`chef-client -z`. You will need at least the following config:
+
+    use_policyfile true
+    deployment_group '$POLICY_NAME-local'
+    versioned_cookbooks true
+
+The Policyfile feature is incomplete and beta quality. See our detailed README
+for more information.
+
+https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+Options:
+
+E
+
+      option :force,
+        short:       "-f",
+        long:        "--force",
+        description: "If the DESTINATION_DIRECTORY is not empty, remove its content.",
+        default:     false,
+        boolean:     true
+
+      option :debug,
+        short:       "-D",
+        long:        "--debug",
+        description: "Enable stacktraces and other debug output",
+        default:     false
+
+      attr_reader :policyfile_relative_path
+      attr_reader :export_dir
+
+      attr_accessor :ui
+
+      def initialize(*args)
+        super
+        @push = nil
+        @ui = nil
+        @policyfile_relative_path = nil
+        @export_dir = nil
+        @chef_config = nil
+        @ui = UI.new
+      end
+
+      def run(params = [])
+        return 1 unless apply_params!(params)
+        export_service.run
+        ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_dir}")
+        0
+      rescue ExportDirNotEmpty => e
+        ui.err("ERROR: " + e.message)
+        ui.err("Use --force to force export")
+        1
+      rescue PolicyfileServiceError => e
+        handle_error(e)
+        1
+      end
+
+      def debug?
+        !!config[:debug]
+      end
+
+      def export_service
+        @export_service ||= PolicyfileServices::ExportRepo.new(policyfile: policyfile_relative_path,
+                                                       export_dir: export_dir,
+                                                       root_dir: Dir.pwd,
+                                                       force: config[:force])
+      end
+
+      def handle_error(error)
+        ui.err("Error: #{error.message}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
+          ui.err("")
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
+        end
+      end
+
+      def apply_params!(params)
+        remaining_args = parse_options(params)
+        case remaining_args.size
+        when 1
+          @export_dir = remaining_args[0]
+        when 2
+          @policyfile_relative_path, @export_dir = remaining_args
+        else
+          ui.err(banner)
+          return false
+        end
+        true
+      end
+
+    end
+  end
+end
+
+

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

@@ -55,7 +55,7 @@ module ChefDK
         :short => "-g GENERATOR_COOKBOOK_PATH",
         :long  => "--generator-cookbook GENERATOR_COOKBOOK_PATH",
         :description => "Use GENERATOR_COOKBOOK_PATH for the code_generator cookbook",
-        :default => File.expand_path("../../skeletons", __FILE__),
+        :default => nil,
         :proc => Proc.new { |s| File.expand_path(s) },
         :on => :tail
 

data/lib/chef-dk/command/generator_commands/app.rb

@@ -49,6 +49,9 @@ module ChefDK
             msg(banner)
             1
           end
+        rescue ChefDK::ChefRunnerError => e
+          err("ERROR: #{e}")
+          1
         end
 
         def setup_context
@@ -57,12 +60,17 @@ module ChefDK
           Generator.add_attr_to_context(:app_name, app_name)
           Generator.add_attr_to_context(:cookbook_root, cookbook_root)
           Generator.add_attr_to_context(:cookbook_name, cookbook_name)
+          Generator.add_attr_to_context(:recipe_name, recipe_name)
         end
 
         def recipe
           "app"
         end
 
+        def recipe_name
+          "default"
+        end
+
         def app_name
           File.basename(app_full_path)
         end

data/lib/chef-dk/command/generator_commands/base.rb

@@ -15,6 +15,7 @@
 # limitations under the License.
 #
 
+require 'chef-dk/configurable'
 require 'chef-dk/command/generator_commands'
 
 module ChefDK
@@ -31,6 +32,8 @@ module ChefDK
       # chef-dk/skeletons/code_generator.
       class Base < Command::Base
 
+        include Configurable
+
         attr_reader :params
 
         options.merge!(SharedGeneratorOptions.options)
@@ -38,19 +41,26 @@ module ChefDK
         def initialize(params)
           super()
           @params = params
+
+          @generator_cookbook_path = nil
+          @generator_cookbook_name = nil
         end
 
         # An instance of ChefRunner. Calling ChefRunner#converge will trigger
         # convergence and generate the desired code.
         def chef_runner
-          @chef_runner ||= ChefRunner.new(generator_cookbook_path, ["code_generator::#{recipe}"])
+          @chef_runner ||= ChefRunner.new(generator_cookbook_path, ["recipe[#{generator_cookbook_name}::#{recipe}]"])
         end
 
         # Path to the directory where the code_generator cookbook is located.
-        # For now, this is hard coded to the 'skeletons' directory in this
-        # repo.
         def generator_cookbook_path
-          config[:generator_cookbook]
+          detect_generator_cookbook_name_and_path! unless @generator_cookbook_path
+          @generator_cookbook_path
+        end
+
+        def generator_cookbook_name
+          detect_generator_cookbook_name_and_path! unless @generator_cookbook_name
+          @generator_cookbook_name
         end
 
         # Sets git related generator_context values.
@@ -73,6 +83,38 @@ module ChefDK
           paths = path.split(File::PATH_SEPARATOR)
           paths.any? {|bin_path| File.exist?(File.join(bin_path, "git#{RbConfig::CONFIG['EXEEXT']}"))}
         end
+
+        private
+
+        # Inspects the `config[:generator_cookbook]` option to determine the
+        # generator_cookbook_name and generator_cookbook_path. There are two
+        # supported ways this can work:
+        #
+        # * `config[:generator_cookbook]` is the full path to the generator
+        # cookbook. In this case, the last path component is the cookbook name,
+        # and the parent directory is the cookbook path
+        # * `config[:generator_cookbook]` is the path to a directory that
+        # contains a cookbook named "code_generator" (DEPRECATED). This is how
+        # the `--generator-cookbook` feature was originally written, so we
+        # support this for backwards compatibility. This way has poor UX and
+        # we'd like to get rid of it, so a warning is printed in this case.
+        def detect_generator_cookbook_name_and_path!
+          given_path = generator_cookbook_option
+          code_generator_subdir = File.join(given_path, "code_generator")
+          if File.directory?(code_generator_subdir)
+            @generator_cookbook_name = "code_generator"
+            @generator_cookbook_path = given_path
+            err("WARN: Please configure the generator cookbook by giving the full path to the desired cookbook (like '#{code_generator_subdir}')")
+          else
+            @generator_cookbook_name = File.basename(given_path)
+            @generator_cookbook_path = File.dirname(given_path)
+          end
+        end
+
+        def generator_cookbook_option
+          config[:generator_cookbook] || chefdk_config.generator_cookbook
+        end
+
       end
     end
   end

data/lib/chef-dk/command/generator_commands/cookbook.rb

@@ -52,6 +52,9 @@ module ChefDK
             msg(banner)
             1
           end
+        rescue ChefDK::ChefRunnerError => e
+          err("ERROR: #{e}")
+          1
         end
 
         def setup_context
@@ -59,12 +62,17 @@ module ChefDK
           Generator.add_attr_to_context(:skip_git_init, cookbook_path_in_git_repo?)
           Generator.add_attr_to_context(:cookbook_root, cookbook_root)
           Generator.add_attr_to_context(:cookbook_name, cookbook_name)
+          Generator.add_attr_to_context(:recipe_name, recipe_name)
         end
 
         def recipe
           "cookbook"
         end
 
+        def recipe_name
+          "default"
+        end
+
         def cookbook_name
           File.basename(cookbook_full_path)
         end

data/lib/chef-dk/command/generator_commands/cookbook_code_file.rb

@@ -58,6 +58,7 @@ module ChefDK
           Generator.add_attr_to_context(:cookbook_root, cookbook_root)
           Generator.add_attr_to_context(:cookbook_name, cookbook_name)
           Generator.add_attr_to_context(:new_file_basename, new_file_basename)
+          Generator.add_attr_to_context(:recipe_name, new_file_basename)
         end
 
         def cookbook_root

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

@@ -18,12 +18,15 @@
 require 'chef-dk/command/base'
 require 'chef-dk/ui'
 require 'chef-dk/policyfile_services/push'
+require 'chef-dk/configurable'
 
 module ChefDK
   module Command
 
     class Push < Base
 
+      include Configurable
+
       banner(<<-E)
 Usage: chef push POLICY_GROUP [ POLICY_FILE ] [options]
 
@@ -80,12 +83,6 @@ E
         !!config[:debug]
       end
 
-      def chef_config
-        return @chef_config if @chef_config
-        Chef::WorkstationConfigLoader.new(config[:config_file]).load
-        @chef_config = Chef::Config
-      end
-
       def push
         @push ||= PolicyfileServices::Push.new(policyfile: policyfile_relative_path,
                                                ui: ui,

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 ].map(&:freeze).freeze
+      SUPPORTED_SHELLS = %w[ bash zsh sh powershell posh].map(&:freeze).freeze
 
       banner(<<-HELP)
 Usage: chef shell-init
@@ -32,11 +32,17 @@ ruby.
 
   To enable for just the current shell session:
 
-    eval "$(chef shell-init SHELL_NAME)"
+    In sh, bash, and zsh:
+      eval "$(chef shell-init SHELL_NAME)"
+    In Powershell:
+      chef shell-init powershell | Invoke-Expression
 
   To permanently enable:
 
-    echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
+    In sh, bash, and zsh:
+      echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
+    In Powershell
+      "chef shell-init powershell | Invoke-Expression" >> $PROFILE
 
 OPTIONS:
 
@@ -67,12 +73,29 @@ HELP
 
         env = omnibus_env.dup
         path = env.delete("PATH")
-        msg("export PATH=#{path}")
+        export(shell_name, "PATH", path)
         env.each do |var_name, value|
-          msg("export #{var_name}=#{value}")
+          export(shell_name, var_name, value)
         end
         0
       end
+
+      def export(shell, var, val)
+        case shell
+        when 'sh', 'bash', 'zsh'
+          posix_shell_export(var, val)
+        when 'powershell', 'posh'
+          powershell_export(var, val)
+        end
+      end
+
+      def posix_shell_export(var, val)
+        msg("export #{var}=\"#{val}\"")
+      end
+
+      def powershell_export(var, val)
+        msg("$env:#{var}=\"#{val}\"")
+      end
     end
   end
 end