chef-dk 0.3.0 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f843be984f4748b386cfc76d5b13fc53a015ffeb
-  data.tar.gz: ff6284980c5d4db06395d5264fae6de79dd858f3
+  metadata.gz: 15ddf96556ab7bfa73a009627a4bee13f83bada0
+  data.tar.gz: c3f5519baae22cf7d471a49ed968ebebbc826ad1
 SHA512:
-  metadata.gz: 2c7ebbe3baf7bae4ca25072f6f62da8ee3c6cf14aa38d4bf7af8632338bed6f3b9949c06ee0e7283b958b1a61e38178a9bec9bbf9f04b3e0ad672e1c18bf99bf
-  data.tar.gz: 0d0c18793a5a724ba719d4237a3f8e58ae1a6ed9bb07020277df9c9ce96caac5ba5632728004d6e91caa2a080fc0b150ef32906a305c2326d697889d202a6fd7
+  metadata.gz: f4a7492bafe9715b38a62f86b9ce94ed15bd002663f87624989d36e8f9006f05c662b58fd7169fd3c7ce7ea199d53c86fa128451f5c7a95dad653db468f61c0c
+  data.tar.gz: 86a69277b0e3c9ce1c132c9abc6ed58a2d4d48fd7083247bb65427361afd52bc86bff1ec529fbe5e4244650cf789909c8725b85cc10b039ff0c0054dc6e4acec

data/README.md

@@ -70,6 +70,11 @@ cookbook. Supports the `-s SOURCE` option similar to template.
 * `chef generate lwrp` Creates a new LWRP resource and provider in an
 existing cookbook.
 
+The `chef generate` command also accepts additional `--generator-arg key=value`
+pairs that can be used to supply ad-hoc data to a generator cookbook.
+For example, you might specify `--generator-arg database=mysql` and then only
+write a template for `recipes/mysql.rb` if `context.database == 'mysql'`.
+
 #### `chef gem`
 `chef gem` is a wrapper command that manages installation and updating
 of rubygems for the Ruby installation embedded in the ChefDK package.

data/lib/chef-dk/cli.rb

@@ -141,7 +141,7 @@ BANNER
 
     # Find PATH or Path correctly if we are on Windows
     def path_key
-      ENV.keys.grep(/\Apath\Z/i).first
+      env.keys.grep(/\Apath\Z/i).first
     end
 
     # upcase drive letters for comparison since ruby has a String#capitalize function
@@ -161,6 +161,8 @@ BANNER
     # when they have the embedded_bin_dir before the omnibus_bin_dir -- both of which will
     # defeat appbundler and interact very badly with our intent.
     def sanity_check!
+      # When installed outside of omnibus, trust the user to configure their PATH
+      return true unless omnibus_install?
       paths = env[path_key].split(File::PATH_SEPARATOR)
       paths.map! { |p| drive_upcase(Chef::Util::PathHelper.cleanpath(p)) }
       embed_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_embedded_bin_dir)))
@@ -168,12 +170,12 @@ BANNER
       if embed_index
         if bin_index
           if embed_index < bin_index
-            msg("WARN: #{omnibus_embedded_bin_dir} is before #{omnibus_bin_dir} in your #{path_key}, please reverse that order.")
-            msg("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+            err("WARN: #{omnibus_embedded_bin_dir} is before #{omnibus_bin_dir} in your #{path_key}, please reverse that order.")
+            err("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
           end
         else
-          msg("WARN: only #{omnibus_embedded_bin_dir} is present in your path, you must add #{omnibus_bin_dir} before that directory.")
-          msg("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
+          err("WARN: only #{omnibus_embedded_bin_dir} is present in your path, you must add #{omnibus_bin_dir} before that directory.")
+          err("WARN: consider using the correct `chef shell-init <shell>` command to setup your environment correctly.")
         end
       end
     end

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

@@ -27,6 +27,7 @@ require 'chef-dk/command/generator_commands/lwrp'
 require 'chef-dk/command/generator_commands/recipe'
 require 'chef-dk/command/generator_commands/template'
 require 'chef-dk/command/generator_commands/repo'
+require 'chef-dk/command/generator_commands/policyfile'
 
 module ChefDK
   module Command
@@ -50,6 +51,7 @@ module ChefDK
       generator(:file, :CookbookFile, "Generate a cookbook file")
       generator(:lwrp, :LWRP, "Generate a lightweight resource/provider")
       generator(:repo, :Repo, "Generate a Chef policy repository")
+      generator(:policyfile, :Policyfile, "Generate a Policyfile for use with the install/push commands (experimental)")
 
       def self.banner_headline
         <<-E

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

@@ -58,6 +58,14 @@ module ChefDK
         :default => File.expand_path("../../skeletons", __FILE__),
         :proc => Proc.new { |s| File.expand_path(s) },
         :on => :tail
+
+      generator_args = [] # accumulator variable
+      option :generator_arg,
+        :short => "-a KEY=VALUE",
+        :long  => "--generator-arg KEY=VALUE",
+        :description => "Use to set arbitrary attribute KEY to VALUE in the code_generator cookbook",
+        :default => [],
+        :proc => Proc.new { |s| generator_args <<  s.split("=").map(&:strip) }
     end
 
     # ## GeneratorCommands

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

@@ -60,6 +60,10 @@ module ChefDK
           config.each do |k,v|
             Generator.add_attr_to_context(k, v)
           end
+          # inject the arbitrary args supplied on cmdline, default = []
+          config[:generator_arg].each do |k,v|
+            Generator.add_attr_to_context(k, v)
+          end
         end
 
         # Checks the `PATH` for the presence of a `git` (or `git.exe`, on
@@ -73,4 +77,3 @@ module ChefDK
     end
   end
 end
-

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

@@ -0,0 +1,83 @@
+#
+# 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/generator_commands/base'
+
+module ChefDK
+  module Command
+    module GeneratorCommands
+
+      class Policyfile < Base
+
+        banner "Usage: chef generate policyfile [NAME] [options]"
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        attr_reader :new_file_basename
+        attr_reader :policyfile_dir
+
+        def initialize(*args)
+          super
+          @params_valid = true
+        end
+
+        def recipe
+          'policyfile'
+        end
+
+        def setup_context
+          super
+          Generator.add_attr_to_context(:policyfile_dir, policyfile_dir)
+          Generator.add_attr_to_context(:new_file_basename, new_file_basename)
+        end
+
+        def run
+          read_and_validate_params
+          if params_valid?
+            setup_context
+            chef_runner.converge
+            0
+          else
+            msg(banner)
+            1
+          end
+        end
+
+        def read_and_validate_params
+          arguments = parse_options(params)
+          new_file_path =
+            case arguments.size
+            when 0
+              "Policyfile"
+            when 1
+              arguments[0]
+            else
+              @params_valid = false
+              return false
+            end
+          @new_file_basename = File.basename(new_file_path, ".rb")
+          @policyfile_dir = File.expand_path(File.dirname(new_file_path))
+        end
+
+        def params_valid?
+          @params_valid
+        end
+
+      end
+    end
+  end
+end

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

@@ -80,12 +80,11 @@ E
 
       def handle_error(error)
         ui.err("Error: #{error.message}")
-        if error.respond_to?(:cause) && error.cause
-          cause = error.cause
-          ui.err("Reason: #{cause.class.name}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
           ui.err("")
-          ui.err(cause.message)
-          ui.err(cause.backtrace.join("\n")) if debug?
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
         end
       end
 

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

@@ -96,12 +96,11 @@ E
 
       def handle_error(error)
         ui.err("Error: #{error.message}")
-        if error.respond_to?(:cause) && error.cause
-          cause = error.cause
-          ui.err("Reason: #{cause.class.name}")
+        if error.respond_to?(:reason)
+          ui.err("Reason: #{error.reason}")
           ui.err("")
-          ui.err(cause.message)
-          ui.err(cause.backtrace.join("\n")) if debug?
+          ui.err(error.extended_error_info) if debug?
+          ui.err(error.cause.backtrace.join("\n")) if debug?
         end
       end
 

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

@@ -23,6 +23,7 @@ module ChefDK
   module Command
     class Verify < ChefDK::Command::Base
 
+      include ChefDK::Helpers
 
       banner "Usage: chef verify [component, ...] [options]"
 
@@ -120,7 +121,7 @@ module ChefDK
         c.smoke_test do
           tmpdir do |cwd|
             FileUtils.mkdir(File.join(cwd, "spec"))
-            File.open(File.join(cwd, "spec", "spec_helper.rb"), "w+") do |f|
+            with_file(File.join(cwd, "spec", "spec_helper.rb")) do |f|
               f.write <<-EOF
 require 'chefspec'
 require 'chefspec/berkshelf'
@@ -132,7 +133,7 @@ end
               EOF
             end
             FileUtils.touch(File.join(cwd, "Berksfile"))
-            File.open(File.join(cwd, "spec", "foo_spec.rb"), "w+") do |f|
+            with_file(File.join(cwd, "spec", "foo_spec.rb")) do |f|
               f.write <<-EOF
 require 'spec_helper'
               EOF

data/lib/chef-dk/component_test.rb

@@ -131,7 +131,13 @@ module ChefDK
 
     def gem_base_dir
       return nil if @gem_name_for_base_dir.nil?
-      Gem::Specification::find_by_name(@gem_name_for_base_dir).gem_dir
+      # There is no way to say "give me the latest prerelease OR normal version of this gem.
+      # So we first ask if there is a normal version, and if there is not, we ask if there
+      # is a prerelease version.  ">= 0.a" is how we ask for a prerelease version, because a
+      # prerelease version is defined as "any version with a letter in it."
+      gem = Gem::Specification::find_by_name(@gem_name_for_base_dir)
+      gem ||= Gem::Specification::find_by_name(@gem_name_for_base_dir, '>= 0.a')
+      gem.gem_dir
     end
 
     def gem_base_dir=(gem_name)
@@ -152,4 +158,3 @@ module ChefDK
 
   end
 end
-

data/lib/chef-dk/exceptions.rb

@@ -17,40 +17,6 @@
 
 module ChefDK
 
-  # Base class for errors raised by ChefDK::PolicyfileServices objects. Don't
-  # raise this directly, create a descriptively-named subclass. You can rescue
-  # this to catch all errors from PolicyfileServices objects though.
-  class PolicyfileServiceError < StandardError
-  end
-
-  class PolicyfileNotFound < PolicyfileServiceError
-  end
-
-  class LockfileNotFound < PolicyfileServiceError
-  end
-
-  class PolicyfileInstallError < PolicyfileServiceError
-
-    attr_reader :cause
-
-    def initialize(message, cause)
-      super(message)
-      @cause = cause
-    end
-
-  end
-
-  class PolicyfilePushError < PolicyfileServiceError
-
-    attr_reader :cause
-
-    def initialize(message, cause)
-      super(message)
-      @cause = cause
-    end
-
-  end
-
   class CachedCookbookNotFound < StandardError
   end
 
@@ -96,4 +62,7 @@ module ChefDK
   class InvalidLockfile < StandardError
   end
 
+  class InvalidPolicyfileFilename < StandardError
+  end
+
 end

data/lib/chef-dk/helpers.rb

@@ -50,8 +50,12 @@ module ChefDK
     # Locates the omnibus directories
     #
 
+    def omnibus_install?
+      File.exist?(omnibus_chefdk_location)
+    end
+
     def omnibus_root
-      @omnibus_root ||= omnibus_expand_path(Gem.ruby, "..", "..", "..")
+      @omnibus_root ||= omnibus_expand_path(expected_omnibus_root)
     end
 
     def omnibus_apps_dir
@@ -66,6 +70,10 @@ module ChefDK
       @omnibus_embedded_bin_dir ||= omnibus_expand_path(omnibus_root, "embedded", "bin")
     end
 
+    def omnibus_chefdk_location
+      @omnibus_chefdk_location ||= File.expand_path('embedded/apps/chef-dk', expected_omnibus_root)
+    end
+
     private
 
     def omnibus_expand_path(*paths)
@@ -74,6 +82,10 @@ module ChefDK
       dir
     end
 
+    def expected_omnibus_root
+      File.expand_path(File.join(Gem.ruby, "..", "..", ".."))
+    end
+
     #
     # environment vars for omnibus
     #
@@ -83,7 +95,7 @@ module ChefDK
         begin
           user_bin_dir = File.expand_path(File.join(Gem.user_dir, 'bin'))
           {
-            'PATH' => "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}",
+            'PATH' => [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH'] ].join(File::PATH_SEPARATOR),
             'GEM_ROOT' => Gem.default_dir.inspect,
             'GEM_HOME' => Gem.user_dir,
             'GEM_PATH' => Gem.path.join(':'),
@@ -91,5 +103,11 @@ module ChefDK
         end
     end
 
+    # Open a file. By default, the mode is for read+write,
+    # and binary so that windows writes out what we tell it,
+    # as this is the most common case we have.
+    def with_file(path, mode='wb+', &block)
+      File.open(path, mode, &block)
+    end
   end
 end

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

@@ -279,6 +279,7 @@ module ChefDK
 
         @identifier_updated = false
         @version_updated = false
+        @cookbook_in_git_repo = nil
       end
 
       def cookbook_path
@@ -286,7 +287,7 @@ module ChefDK
       end
 
       def scm_profiler
-        if File.exist?(File.join(cookbook_path, ".git"))
+        if cookbook_in_git_repo?
           CookbookProfiler::Git.new(cookbook_path)
         else
           CookbookProfiler::NullSCM.new(cookbook_path)
@@ -373,6 +374,23 @@ module ChefDK
         end
       end
 
+      def cookbook_in_git_repo?
+        return @cookbook_in_git_repo unless @cookbook_in_git_repo.nil?
+
+        @cookbook_in_git_repo = false
+
+        dot_git = Pathname.new(".git")
+        Pathname.new(cookbook_path).ascend do |parent_dir|
+          possbile_git_dir = parent_dir + dot_git
+          if possbile_git_dir.exist?
+            @cookbook_in_git_repo = true
+            break
+          end
+        end
+
+        @cookbook_in_git_repo
+      end
+
     end
   end
 end

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

@@ -15,8 +15,9 @@
 # limitations under the License.
 #
 
+# This fixes a missing require in chef/digester:
+require 'singleton'
 require 'chef/cookbook/cookbook_version_loader'
-
 require 'chef/cookbook/chefignore'
 
 module ChefDK
@@ -47,6 +48,15 @@ module ChefDK
           begin
             cookbook_version = loader.cookbook_version
             cookbook_version.version = version_override
+
+            # Fixup manifest.
+            # What happens is, the 'manifest' representation of cookbook
+            # version is created, it has a "name" field like foo-1.0.0, then we
+            # change the version to 1234.5678.9876 but the manifest is not
+            # regenerated so erchef rejects our upload b/c the name field
+            # doesn't match the expected `$cookbook_name-$version` based on the
+            # other fields.
+            cookbook_version.manifest[:name] = "#{cookbook_version.name}-#{version_override}"
             cookbook_version.freeze_version
             cookbook_version
           end