chef-dk 0.3.5 → 0.4.0

data/lib/chef-dk/skeletons/code_generator/recipes/recipe.rb

@@ -2,7 +2,25 @@
 context = ChefDK::Generator.context
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 recipe_path = File.join(cookbook_dir, "recipes", "#{context.new_file_basename}.rb")
+spec_helper_path = File.join(cookbook_dir, "spec", "spec_helper.rb")
+spec_path = File.join(cookbook_dir, "spec", "unit", "recipes", "#{context.new_file_basename}_spec.rb")
 
+# Chefspec
+directory "#{cookbook_dir}/spec/unit/recipes" do
+  recursive true
+end
+
+cookbook_file spec_helper_path do
+  action :create_if_missing
+end
+
+template spec_path do
+  source "recipe_spec.rb.erb"
+  helpers(ChefDK::Generator::TemplateHelper)
+  action :create_if_missing
+end
+
+# Recipe
 template recipe_path do
   source "recipe.rb.erb"
   helpers(ChefDK::Generator::TemplateHelper)

data/lib/chef-dk/skeletons/code_generator/templates/default/recipe.rb.erb

@@ -0,0 +1,5 @@
+#
+# Cookbook Name:: <%= cookbook_name %>
+# Recipe:: <%= recipe_name %>
+#
+<%= license_description('#') %>

data/lib/chef-dk/skeletons/code_generator/templates/default/recipe_spec.rb.erb

@@ -0,0 +1,23 @@
+#
+# Cookbook Name:: <%= cookbook_name %>
+# Spec:: default
+#
+<%= license_description('#') %>
+
+require 'spec_helper'
+
+describe '<%= cookbook_name %>::<%= recipe_name %>' do
+
+  context 'When all attributes are default, on an unspecified platform' do
+
+    let(:chef_run) do
+      runner = ChefSpec::ServerRunner.new
+      runner.converge(described_recipe)
+    end
+
+    it 'converges successfully' do
+      chef_run # This should not raise an error
+    end
+
+  end
+end

data/lib/chef-dk/skeletons/code_generator/templates/default/serverspec_default_spec.rb.erb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe '<%= cookbook_name %>::default' do
+
+  # Serverspec examples can be found at
+  # http://serverspec.org/resource_types.html
+  
+  it 'does something' do
+    skip 'Replace this with meaningful tests'
+  end
+
+end

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.3.5"
+  VERSION = "0.4.0"
 end

data/lib/kitchen/provisioner/policyfile_zero.rb

@@ -0,0 +1,149 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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 "kitchen/provisioner/chef_base"
+
+# TODO: chef-dk and kitchen can only co-exist if kitchen and chef-dk agree on
+# the version of mixlib-shellout to use. Kitchen currently locked at 1.x,
+# chef-dk is on 2.x
+require 'chef-dk/policyfile_services/export_repo'
+
+module Kitchen
+
+  module Provisioner
+
+    # Policyfile + Chef Zero provisioner.
+    #
+    # @author Daniel DeLeo <dan@chef.io>
+    class PolicyfileZero < ChefBase
+
+      # This provsioner will forcibly set the following config options:
+      # * `use_policyfile`: `true`
+      # * `versioned_cookbooks`: `true`
+      # * `deployment_group`: `POLICY_NAME-local`
+      # Since it makes no sense to modify these, they are hardcoded elsewhere.
+      default_config :client_rb, {}
+      default_config :ruby_bindir, "/opt/chef/embedded/bin"
+
+      # Policyfile mode does not support the `-j dna.json` option to
+      # `chef-client`.
+      default_config :json_attributes, false
+      default_config :chef_zero_port, 8889
+
+      default_config :chef_client_path do |provisioner|
+        File.join(provisioner[:chef_omnibus_root], %w[bin chef-client])
+      end
+
+      # Emit a warning that Policyfile stuff is still experimental.
+      #
+      # (see Base#finalize_config!)
+      def finalize_config!(*args)
+        super
+        banner("Using experimental policyfile mode for chef-client")
+        warn("The Policyfile feature is under active development.")
+        warn("For best results, always use the latest chef-client version")
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        super
+        prepare_validation_pem
+        prepare_client_rb
+      end
+
+      # (see Base#run_command)
+      def run_command
+        level = config[:log_level] == :info ? :auto : config[:log_level]
+        chef_client_bin = sudo(config[:chef_client_path])
+
+        cmd = "#{chef_client_bin} --local-mode"
+        args = [
+          "--config #{config[:root_path]}/client.rb",
+          "--log_level #{level}",
+          "--force-formatter",
+          "--no-color"
+        ]
+        if config[:chef_zero_port]
+          args <<  "--chef-zero-port #{config[:chef_zero_port]}"
+        end
+        if config[:log_file]
+          args << "--logfile #{config[:log_file]}"
+        end
+
+        Util.wrap_command([cmd, *args].join(" "))
+      end
+
+      private
+
+      # Overrides behavior of parent class so that dna.json isn't created; we
+      # don't need it.
+      #
+      # @api private
+      def prepare_json
+      end
+
+      # Copies the policyfile's cookbooks to the sandbox.
+      #
+      # @api private
+      def prepare_cookbooks
+        Kitchen.mutex.synchronize do
+          policy_exporter.run
+        end
+      end
+
+      # An instance of ChefDK::PolicyfileServices::ExportRepo, configured with
+      # the sandbox path. Calling `#run` on this copies the cookbooks to the
+      # sandbox. Calling `#policy_name` returns the policy's name.
+      #
+      # @api private
+      def policy_exporter
+        @policy_exporter ||= ChefDK::PolicyfileServices::ExportRepo.new(export_dir: sandbox_path)
+      end
+
+      # Writes a fake (but valid) validation.pem into the sandbox directory.
+      #
+      # @api private
+      def prepare_validation_pem
+        info("Preparing validation.pem")
+        debug("Using a dummy validation.pem")
+
+        source = File.join(Kitchen.source_root, %w[support dummy-validation.pem])
+        FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
+      end
+
+      # Writes a client.rb configuration file to the sandbox directory.
+      #
+      # @api private
+      def prepare_client_rb
+        data = default_config_rb.merge(config[:client_rb])
+
+        data["use_policyfile"] = true
+        data["versioned_cookbooks"] = true
+        data["deployment_group"] = "#{policy_exporter.policy_name}-local"
+
+        info("Preparing client.rb")
+        debug("Creating client.rb from #{data.inspect}")
+
+        File.open(File.join(sandbox_path, "client.rb"), "wb") do |file|
+          file.write(format_config_file(data))
+        end
+      end
+
+    end
+  end
+end

data/spec/shared/a_file_generator.rb

@@ -63,6 +63,7 @@ shared_examples_for "a file generator" do
         expect(generator_context.cookbook_root).to eq(expected_cookbook_root)
         expect(generator_context.cookbook_name).to eq(cookbook_name)
         expect(generator_context.new_file_basename).to eq(new_file_name)
+        expect(generator_context.recipe_name).to eq(new_file_name)
       end
     end
 

data/spec/shared/command_with_ui_object.rb

@@ -0,0 +1,11 @@
+shared_examples_for "a command with a UI object" do
+
+  subject(:command) { described_class.new }
+
+  it "configures a default UI component" do
+    ui = command.ui
+    expect(ui.out_stream).to eq($stdout)
+    expect(ui.err_stream).to eq($stderr)
+  end
+
+end

data/spec/shared/custom_generator_cookbook.rb

@@ -0,0 +1,117 @@
+
+# Required `let` bindings:
+# * `generator_name` in lowercase, e.g., "cookbook", "app"
+# * `generator_arg`: argument to the generator command
+# * `expected_cookbook_files`: a list of files the generator should create
+shared_examples_for "custom generator cookbook" do
+
+  context "when given a generator-cookbook path" do
+
+    let(:default_generator_cookbook_path) { File.expand_path('lib/chef-dk/skeletons/code_generator', project_root) }
+
+    let(:generator_cookbook_path) { File.join(tempdir, 'a_generator_cookbook') }
+
+    let(:argv) { [generator_arg, "--generator-cookbook", generator_cookbook_path] }
+
+    subject(:code_generator) { described_class.new(argv) }
+
+    before do
+      reset_tempdir
+      code_generator.read_and_validate_params
+      allow(code_generator.config_loader).to receive(:load)
+    end
+
+    it "configures the generator context" do
+      code_generator.setup_context
+      expect(generator_context.cookbook_name).to eq(generator_arg)
+      expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+      expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+    end
+
+    context "when the generator cookbook is configured in a configuration file" do
+
+      let(:argv) { [generator_arg] }
+
+      let(:chefdk_config) { double("Mixlib::Config context for ChefDK", generator_cookbook: generator_cookbook_path) }
+
+      before do
+        allow(code_generator).to receive(:chefdk_config).and_return(chefdk_config)
+      end
+
+      it "configures the generator context" do
+        code_generator.setup_context
+        expect(generator_context.cookbook_name).to eq(generator_arg)
+        expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+        expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+      end
+    end
+
+    context "with an invalid generator-cookbook path" do
+
+      it "fails with an informative error" do
+        Dir.chdir(tempdir) do
+          allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          allow(code_generator).to receive(:stderr).and_return(stderr_io)
+          expect(code_generator.run).to eq(1)
+        end
+
+        cookbook_path = File.dirname(generator_cookbook_path)
+        expected_msg = %Q(ERROR: Could not find cookbook(s) to satisfy run list ["recipe[a_generator_cookbook::#{generator_name}]"] in #{cookbook_path})
+
+        expect(stderr_io.string).to include(expected_msg)
+      end
+
+    end
+
+    context "with a generator-cookbook path to a specific cookbook" do
+
+      let(:metadata_file) { File.join(generator_cookbook_path, "metadata.rb") }
+
+      before do
+        FileUtils.cp_r(default_generator_cookbook_path, generator_cookbook_path)
+
+        # have to update metadata with the correct name
+        IO.binwrite(metadata_file, "name 'a_generator_cookbook'")
+      end
+
+      it "creates the new files" do
+        expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+        expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+
+        Dir.chdir(tempdir) do
+          allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          code_generator.run
+        end
+      end
+
+    end
+
+    context "with a generator-cookbook path to a directory containing a 'code_generator' cookbook" do
+
+      before do
+        FileUtils.mkdir_p(generator_cookbook_path)
+        FileUtils.cp_r(default_generator_cookbook_path, generator_cookbook_path)
+
+        allow(code_generator).to receive(:stderr).and_return(stderr_io)
+      end
+
+      it "creates the new_files (and warns about deprecated usage)" do
+        allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+
+        Dir.chdir(tempdir) do
+          code_generator.run
+        end
+        generated_files = Dir.glob("#{tempdir}/#{generator_arg}/**/*", File::FNM_DOTMATCH)
+        expected_cookbook_files.each do |expected_file|
+          expect(generated_files).to include(expected_file)
+        end
+
+        code_generator_path = File.join(generator_cookbook_path, "code_generator")
+        warning_message = "WARN: Please configure the generator cookbook by giving the full path to the desired cookbook (like '#{code_generator_path}')"
+
+        expect(stderr_io.string).to include(warning_message)
+      end
+    end
+  end
+end
+

data/spec/unit/chef_runner_spec.rb

@@ -72,6 +72,32 @@ describe ChefDK::ChefRunner do
     expect(test_state[:loaded_recipes]).to eq([ "recipe_one", "recipe_two" ])
     expect(test_state[:converged_recipes]).to eq([ "recipe_one", "recipe_two" ])
   end
+
+  context "when the embedded chef run fails" do
+
+    let(:embedded_runner) { instance_double("Chef::Runner") }
+
+    before do
+      allow(Chef::Runner).to receive(:new).and_return(embedded_runner)
+      allow(embedded_runner).to receive(:converge).and_raise("oops")
+    end
+
+    it "wraps the exception in a ChefConvergeError" do
+      expect { chef_runner.converge }.to raise_error(ChefDK::ChefConvergeError)
+    end
+
+  end
+
+  context "when cookbook_path is relative" do
+
+    let(:default_cookbook_path) { "~/heres_some_cookbooks" }
+
+    it "expands the path" do
+      expect(chef_runner.cookbook_path).to eq(File.expand_path(default_cookbook_path))
+    end
+
+  end
+
 end
 
 

data/spec/unit/command/exec_spec.rb

@@ -24,7 +24,7 @@ describe ChefDK::Command::Exec do
   let(:command_options) { [] }
 
   def run_command
-    command_instance.run(command_options)
+    command_instance.run_with_default_options(command_options)
   end
 
   it "has a usage banner" do
@@ -76,11 +76,11 @@ describe ChefDK::Command::Exec do
 
       let(:expected_PATH) { [omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH']].join(File::PATH_SEPARATOR) }
 
-      let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
+      let(:expected_GEM_ROOT) { Gem.default_dir }
 
       let(:expected_GEM_HOME) { Gem.user_dir }
 
-      let(:expected_GEM_PATH) { Gem.path.join(':') }
+      let(:expected_GEM_PATH) { Gem.path.join(File::PATH_SEPARATOR) }
 
       before do
         allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
@@ -97,6 +97,47 @@ describe ChefDK::Command::Exec do
         expect{ run_command }.to raise_error # XXX: this isn't a test we just need to swallow the exception
       end
 
+      ['-v', '--version', '-h', '--help'].each do |switch|
+        context "when running a command with #{switch}" do
+          let(:command_options) { %W[gem list #{switch}] }
+
+          it "should call exec to fire off the command with the correct environment" do
+            expect(ENV).to receive(:[]=).with("PATH", expected_PATH)
+            expect(ENV).to receive(:[]=).with("GEM_ROOT", expected_GEM_ROOT)
+            expect(ENV).to receive(:[]=).with("GEM_HOME", expected_GEM_HOME)
+            expect(ENV).to receive(:[]=).with("GEM_PATH", expected_GEM_PATH)
+
+            expect(command_instance).to receive(:exec).with(*command_options)
+            expect{ run_command }.to raise_error # XXX: this isn't a test we just need to swallow the exception
+          end
+        end
+      end
+
+      ['-h', '--help'].each do |switch|
+        context "when running a exec with #{switch} and things after it" do
+          let(:command_options) { %W[#{switch} gem] }
+
+          it "should call not call exec, but it should print the banner" do
+            allow(command_instance).to receive(:msg)
+            expect(ENV).not_to receive(:[]=)
+            expect(command_instance).to receive(:banner)
+            expect(command_instance).not_to receive(:exec)
+            run_command
+          end
+        end
+
+        context "when running a exec with #{switch}" do
+          let(:command_options) { ["#{switch}"] }
+
+          it "should call not call exec, but it should print the banner" do
+            allow(command_instance).to receive(:msg)
+            expect(ENV).not_to receive(:[]=)
+            expect(command_instance).to receive(:banner)
+            expect(command_instance).not_to receive(:exec)
+            run_command
+          end
+        end
+      end
     end
 
     context "when running command that does not exist" do
@@ -110,11 +151,11 @@ describe ChefDK::Command::Exec do
 
       let(:expected_PATH) { [omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH']].join(File::PATH_SEPARATOR) }
 
-      let(:expected_GEM_ROOT) { Gem.default_dir.inspect }
+      let(:expected_GEM_ROOT) { Gem.default_dir }
 
       let(:expected_GEM_HOME) { Gem.user_dir }
 
-      let(:expected_GEM_PATH) { Gem.path.join(':') }
+      let(:expected_GEM_PATH) { Gem.path.join(File::PATH_SEPARATOR) }
 
 
       before do