chef-dk 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94244db1cc86a696a390adabc245a53374d1b835
-  data.tar.gz: 072880810b95fff7874a0db745ffbf4150718fbb
+  metadata.gz: c81c455d50627e20c42188704938e34cfa526f3f
+  data.tar.gz: e15449542b4ba8c836af7f01d88c1cc6fc6b60ff
 SHA512:
-  metadata.gz: 9479250504d84f68b2ecffcc03828965181fc8acd4f6f126594019be414eff0cad29d4758aeac02cffbbc628e140b525fcc8b4e967fd93627fccde30807d9643
-  data.tar.gz: ae7845cefdb1b2f6cefbd7bcda5649d30b22d0f50867ce41213d1984fc8a3d64db28d2ebdf01ead4f443a7f3c189937861fcebf296c53a4333ad63ec97122ae7
+  metadata.gz: cd8b9e20419e414b1ef2fb4fc3b7b8dca2e6c669f885bf1bffc36ae267a2c6265e3c7eb004fad42a11c733603621fdbb09b62b0035b4f878a31a51ee1cb288f7
+  data.tar.gz: 15ebcd787a65d08cf39c634c563f41e48634c5504d65d0b8d646f6c3faf40c8a3fe73a6c4d2273e288102a8012f810a42499b5c19e67b8d771ddf8fcf796f768

data/Gemfile

@@ -19,6 +19,11 @@ source 'https://rubygems.org'
 
 gemspec :name => "chef-dk"
 
+# TODO remove when Chef is released with net-ssh pinned
+gem 'chef', github: 'chef/chef'
+# TODO remove when chef-provisioning is released with net-ssh pinned
+gem 'chef-provisioning', github: 'chef/chef-provisioning'
+
 group(:dev) do
   gem 'guard'
   gem 'guard-rspec'

data/README.md

@@ -9,8 +9,8 @@ Chef Development Kit (ChefDK) brings Chef and the development tools developed by
 * [Foodcritic][]
 
 This repository contains the code for the `chef` command. The full
-package is built via the 'chefdk' project in
-[omnibus-chef](https://github.com/opscode/omnibus-chef).
+package is built with omnibus. Project and component build definitions
+are in the omnibus directory in this repo.
 
 ## Installation
 
@@ -240,7 +240,9 @@ echo 'eval (chef shell-init SHELL_NAME)' >> ~/.config/fish/config.fish
 
 ### Mac OS X
 
-You can uninstall Chef Development Kit on Mac using below commands:
+You can uninstall Chef Development Kit on Mac using the below commands.
+
+First, remove the main package files:
 
 ```sh
 # Remove the installed files
@@ -248,11 +250,24 @@ sudo rm -rf /opt/chefdk
 
 # Remove the system installation entry
 sudo pkgutil --forget com.getchef.pkg.chefdk
+```
+
+Next, remove the symlinks which the Chef Development Kit installs. The location for these differs based on your OS X version.
 
-# Remove the symlinks under /usr/bin for Chef Development Kit
+Pre-El Capitan:
+
+```sh
+# Symlinks are in /usr/bin
 ls -la /usr/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/bin/%
 ```
 
+Post-El Capitan:
+
+```sh
+# Symlinks are in /usr/local/bin
+ls -la /usr/local/bin | egrep '/opt/chefdk' | awk '{ print $9 }' | sudo xargs -I % rm -f /usr/local/bin/%
+```
+
 ### Windows
 
 You can use `Add / Remove Programs` on Windows to remove the Chef Development

data/Rakefile

@@ -16,3 +16,12 @@
 #
 
 require "bundler/gem_tasks"
+
+require "github_changelog_generator/task"
+
+GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+  config.future_release = ChefDK::VERSION
+  config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature".split(",")
+  config.bug_labels = "bug,Bug,Improvement,Upstream Bug".split(",")
+  config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Discussion".split(",")
+end

data/chef-dk.gemspec

@@ -42,7 +42,7 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "minitar", "~> 0.5.4"
 
-  gem.add_dependency "chef", "~> 12.0", ">= 12.2.1"
+  gem.add_dependency "chef", "~> 12.5"
 
   gem.add_dependency "solve", "~> 2.0", ">= 2.0.1"
 
@@ -53,6 +53,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "chef-provisioning", "~> 1.2"
 
+  gem.add_development_dependency "github_changelog_generator"
+
   %w(rspec-core rspec-expectations rspec-mocks).each do |dev_gem|
     gem.add_development_dependency dev_gem, "~> 3.0"
   end

data/lib/chef-dk/chef_runner.rb

@@ -17,6 +17,7 @@
 
 require 'chef-dk/exceptions'
 require 'chef-dk/service_exceptions'
+require 'chef/policy_builder/dynamic'
 require 'chef'
 
 module ChefDK
@@ -71,6 +72,14 @@ module ChefDK
       Chef::Config.color = true
       Chef::Config.diff_disabled = true
 
+      # If the user has set policyfile configuration in the workstation config
+      # file, the underlying chef-client code may enable policyfile mode and
+      # then fail because chef-solo doesn't support policyfiles.
+      Chef::Config.use_policyfile = false
+      Chef::Config.policy_name = nil
+      Chef::Config.policy_group = nil
+      Chef::Config.deployment_group = nil
+
       # atomic file operations on Windows require Administrator privileges to be able to read the SACL from a file
       # Using file_staging_uses_destdir(true) will get us inherited permissions indirectly on tempfile creation
       Chef::Config.file_atomic_update = false if Chef::Platform.windows?

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

@@ -85,6 +85,12 @@ E
         return 1 unless apply_params!(params)
         export_service.run
         ui.msg("Exported policy '#{export_service.policyfile_lock.name}' to #{export_target}")
+        unless archive?
+          ui.msg("")
+          ui.msg("To converge this system with the exported policy, run:")
+          ui.msg("  cd #{export_dir}")
+          ui.msg("  chef-client -z")
+        end
         0
       rescue ExportDirNotEmpty => e
         ui.err("ERROR: " + e.message)

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

@@ -37,19 +37,19 @@ module ChefDK
         :short => "-I LICENSE",
         :long => "--license LICENSE",
         :description => "all_rights, apache2, mit, gplv2, gplv3 - defaults to all_rights",
-        :default => "all_rights"
+        :default => nil
 
       option :copyright_holder,
         :short => "-C COPYRIGHT",
         :long => "--copyright COPYRIGHT",
         :description => "Name of the copyright holder - defaults to 'The Authors'",
-        :default => "The Authors"
+        :default => nil
 
       option :email,
         :short => "-m EMAIL",
         :long => "--email EMAIL",
         :description => "Email address of the author - defaults to 'you@example.com'",
-        :default => 'you@example.com'
+        :default => nil
 
       option :generator_cookbook,
         :short => "-g GENERATOR_COOKBOOK_PATH",

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

@@ -65,6 +65,7 @@ module ChefDK
 
         # Sets git related generator_context values.
         def setup_context
+          apply_generator_values_from_config
           Generator.add_attr_to_context(:have_git, have_git?)
           Generator.add_attr_to_context(:skip_git_init, false)
           config.each do |k,v|
@@ -115,6 +116,32 @@ module ChefDK
           config[:generator_cookbook] || chefdk_config.generator_cookbook
         end
 
+        # Load any values that were not defined via cli switches from Chef
+        # configuration
+        #
+        def apply_generator_values_from_config
+          config[:copyright_holder] ||= coerce_generator_copyright_holder
+          config[:email] ||= coerce_generator_email
+          config[:license] ||= coerce_generator_license
+        end
+
+        def coerce_generator_copyright_holder
+          generator_config.copyright_holder ||
+          knife_config.cookbook_copyright ||
+          "The Authors"
+        end
+
+        def coerce_generator_email
+          generator_config.email ||
+          knife_config.cookbook_email ||
+          "you@example.com"
+        end
+
+        def coerce_generator_license
+          generator_config.license ||
+          knife_config.cookbook_license ||
+          "all_rights"
+        end
       end
     end
   end

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

@@ -19,12 +19,15 @@ require 'chef-dk/command/base'
 require 'chef-dk/ui'
 require 'chef-dk/policyfile_services/install'
 require 'chef-dk/policyfile_services/update_attributes'
+require 'chef-dk/configurable'
 
 module ChefDK
   module Command
 
     class Update < Base
 
+      include Configurable
+
       banner(<<-BANNER)
 Usage: chef update [ POLICY_FILE ] [options]
 
@@ -45,6 +48,11 @@ Options:
 
 BANNER
 
+      option :config_file,
+        short:       "-c CONFIG_FILE",
+        long:        "--config CONFIG_FILE",
+        description: "Path to configuration file"
+
       option :debug,
         short:        "-D",
         long:         "--debug",
@@ -74,6 +82,13 @@ BANNER
 
       def run(params = [])
         return 1 unless apply_params!(params)
+
+        # Force config file to be loaded. We don't use the configuration
+        # directly, but the user may have SSL configuration options that they
+        # need to talk to a private supermarket (e.g., trusted_certs or
+        # ssl_verify_mode)
+        chef_config
+
         if update_attributes?
           attributes_updater.run
         else
@@ -98,6 +113,10 @@ BANNER
         !!config[:debug]
       end
 
+      def config_path
+        config[:config_file]
+      end
+
       def update_attributes?
         !!config[:update_attributes]
       end

data/lib/chef-dk/configurable.rb

@@ -32,6 +32,12 @@ class Chef::Config
 
     default(:generator_cookbook, File.expand_path("../skeletons/code_generator", __FILE__))
 
+    config_context(:generator) do
+      config_strict_mode(true)
+      configurable :copyright_holder
+      configurable :email
+      configurable :license
+    end
   end
 end
 
@@ -52,6 +58,12 @@ module ChefDK
       @config_loader ||= Chef::WorkstationConfigLoader.new(config[:config_file])
     end
 
+    def generator_config
+      chefdk_config.generator
+    end
+
+    def knife_config
+      chef_config.knife
+    end
   end
 end
-

data/lib/chef-dk/exceptions.rb

@@ -38,6 +38,9 @@ module ChefDK
   class CachedCookbookModified < StandardError
   end
 
+  class CookbookDoesNotContainRequiredRecipe < StandardError
+  end
+
   class InvalidPolicyfileAttribute < StandardError
   end
 

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

@@ -123,6 +123,11 @@ module ChefDK
         cached_cookbook.dependencies
       end
 
+      def cookbook_has_recipe?(recipe_name)
+        expected_path = cookbook_path.join("recipes/#{recipe_name}.rb")
+        expected_path.exist?
+      end
+
       def cached_cookbook
         # TODO: handle 'bad' return values here (cookbook not installed yet)
         installer.cached_cookbook
@@ -136,6 +141,14 @@ module ChefDK
         !source_options.empty? && installer.nil?
       end
 
+      def cookbook_path
+        if installer.respond_to?(:expanded_path)
+          installer.expanded_path
+        else
+          installer.install_path.expand_path
+        end
+      end
+
     end
   end
 end

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

@@ -446,7 +446,7 @@ module ChefDK
       # So the cookbook will be located in a path like:
       #   cookbooks/nginx-111.222.333
       def cookbook_path
-        File.join(relative_paths_root, "cookbooks", "#{name}-#{dotted_decimal_identifier}")
+        File.join(relative_paths_root, "cookbook_artifacts", "#{name}-#{identifier}")
       end
 
       # We trust that archived cookbooks haven't been modified, so just return

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

@@ -20,11 +20,14 @@ require 'chef-dk/policyfile/cookbook_location_specification'
 require 'chef-dk/policyfile/storage_config'
 
 require 'chef/node/attribute'
+require 'chef/run_list/run_list_item'
 
 module ChefDK
   module Policyfile
     class DSL
 
+      RUN_LIST_ITEM_COMPONENT = %r/^[.[:alnum:]_-]+$/.freeze
+
       include StorageConfigDelegation
 
       attr_writer :name
@@ -60,12 +63,20 @@ module ChefDK
 
       def run_list(*run_list_items)
         run_list_items = run_list_items.flatten
-        @run_list = run_list_items unless run_list_items.empty?
+        unless run_list_items.empty?
+          validate_run_list_items(run_list_items)
+          @run_list = run_list_items
+        end
         @run_list
       end
 
       def named_run_list(name, *run_list_items)
-        @named_run_lists[name] = run_list_items.flatten
+        run_list_items = run_list_items.flatten
+        unless run_list_items.empty?
+          validate_run_list_items(run_list_items, name)
+          @named_run_lists[name] = run_list_items
+        end
+        @named_run_lists[name]
       end
 
       def default_source(source_type = nil, source_argument = nil, &block)
@@ -182,6 +193,33 @@ module ChefDK
         handle_preferred_cookbooks_conflicts
       end
 
+      def validate_run_list_items(items, run_list_name = nil)
+        items.each do |item|
+
+          run_list_desc = run_list_name.nil? ? "Run List Item '#{item}'" : "Named Run List '#{run_list_name}' Item '#{item}'"
+
+          item_name = Chef::RunList::RunListItem.new(item).name
+          cookbook, separator, recipe = item_name.partition('::')
+
+          if RUN_LIST_ITEM_COMPONENT.match(cookbook).nil?
+            message = "#{run_list_desc} has invalid cookbook name '#{cookbook}'.\nCookbook names can only contain alphanumerics, hyphens, and underscores."
+
+            # Special case when there's only one colon instead of two:
+            if cookbook =~ /[^:]:[^:]/
+              message << "\nDid you mean '#{item.sub(":", "::")}'?"
+            end
+
+            @errors << message
+          end
+          unless separator.empty?
+            # we have a cookbook and recipe
+            if RUN_LIST_ITEM_COMPONENT.match(recipe).nil?
+              @errors << "#{run_list_desc} has invalid recipe name '#{recipe}'.\nRecipe names can only contain alphanumerics, hyphens, and underscores."
+            end
+          end
+        end
+      end
+
       def handle_preferred_cookbooks_conflicts
         conflicting_source_messages = []
         default_source.combination(2).each do |source_a, source_b|

data/lib/chef-dk/policyfile_compiler.rb

@@ -116,6 +116,14 @@ module ChefDK
     def install
       ensure_cache_dir_exists
 
+      cookbook_and_recipe_list = combined_run_lists.map(&:name).map do |recipe_spec|
+        cookbook, _separator, recipe = recipe_spec.partition("::")
+        recipe = "default" if recipe.empty?
+        [cookbook, recipe]
+      end
+
+      missing_recipes_by_cb_spec = {}
+
       graph_solution.each do |cookbook_name, version|
         spec = cookbook_location_spec_for(cookbook_name)
         if spec.nil? or !spec.version_fixed?
@@ -123,7 +131,29 @@ module ChefDK
           install_report.installing_cookbook(spec)
           spec.ensure_cached
         end
+
+        required_recipes = cookbook_and_recipe_list.select { |cb_name, _recipe| cb_name == spec.name }
+        missing_recipes = required_recipes.select {|_cb_name, recipe| !spec.cookbook_has_recipe?(recipe) }
+
+        unless missing_recipes.empty?
+          missing_recipes_by_cb_spec[spec] = missing_recipes
+        end
+      end
+
+      unless missing_recipes_by_cb_spec.empty?
+        message = "The installed cookbooks do not contain all the recipes required by your run list(s):\n"
+        missing_recipes_by_cb_spec.each do |spec, missing_items|
+          message << "#{spec.to_s}\nis missing the following required recipes:\n"
+          missing_items.each { |_cb, recipe| message << "* #{recipe}\n" }
+        end
+
+        message << "\n"
+        message << "You may have specified an incorrect recipe in your run list,\nor this recipe may not be available in that version of the cookbook\n"
+
+        raise CookbookDoesNotContainRequiredRecipe, message
       end
+
+
     end
 
     def create_spec_for_cookbook(cookbook_name, version)
@@ -134,7 +164,7 @@ module ChefDK
     end
 
     def all_cookbook_location_specs
-      # in the installation proces, we create "artifact_server_cookbook_location_specs"
+      # in the installation process, we create "artifact_server_cookbook_location_specs"
       # for any cookbook that isn't sourced from a single-version source (e.g.,
       # path and git only support one version at a time), but we might have
       # specs for them to track additional version constraint demands. Merging
@@ -252,14 +282,23 @@ module ChefDK
     end
 
     def cookbooks_in_run_list
-      combined_run_lists = expanded_named_run_lists.values.inject(expanded_run_list.to_a) do |accum_run_lists, run_list|
+      recipes = combined_run_lists.map {|recipe| recipe.name }
+      recipes.map { |r| r[/^([^:]+)/, 1] }
+    end
+
+    def combined_run_lists
+      expanded_named_run_lists.values.inject(expanded_run_list.to_a) do |accum_run_lists, run_list|
         accum_run_lists |= run_list.to_a
       end
+    end
 
-      recipes = combined_run_lists.map {|recipe| recipe.name }
-      recipes.map { |r| r[/^([^:]+)/, 1] }
+    def combined_run_lists_by_cb_name
+      combined_run_lists.inject({}) do |by_name_accum, run_list_item|
+        by_name_accum
+      end
     end
 
+
     def build
       yield @dsl
       self