chef-dk 0.10.0 → 0.11.0

data/spec/unit/chef_runner_spec.rb

@@ -81,6 +81,34 @@ describe ChefDK::ChefRunner do
     expect(test_state[:converged_recipes]).to eq([ "recipe_one", "recipe_two" ])
   end
 
+  context "when policyfile options are set in the workstation config" do
+
+    before do
+      Chef::Config.use_policyfile true
+      Chef::Config.policy_name "workstation"
+      Chef::Config.policy_group "test"
+
+      # chef-client ignores `deployment_group` unless
+      # `policy_document_native_api` is set to false
+      Chef::Config.deployment_group "workstation-test"
+      Chef::Config.policy_document_native_api false
+    end
+
+    it "unsets the options" do
+      chef_runner.configure
+
+      expect(Chef::Config.use_policyfile).to be(false)
+      expect(Chef::Config.policy_name).to be_nil
+      expect(Chef::Config.policy_group).to be_nil
+      expect(Chef::Config.deployment_group).to be_nil
+    end
+
+    it "converges successfully" do
+      expect { chef_runner.converge }.to_not raise_error
+    end
+
+  end
+
   context "when the embedded chef run fails" do
 
     let(:embedded_runner) { instance_double("Chef::Runner") }

data/spec/unit/command/export_spec.rb

@@ -128,6 +128,17 @@ describe ChefDK::Command::Export do
       it "returns 0" do
         expect(command.run(params)).to eq(0)
       end
+
+      it "prints instructions for running chef-client in the repo" do
+        command.run(params)
+
+        expected_message = <<-MESSAGE
+To converge this system with the exported policy, run:
+  cd /path/to/export
+  chef-client -z
+MESSAGE
+        expect(ui.output).to include(expected_message)
+      end
     end
 
     context "when the command is unsuccessful" do

data/spec/unit/command/generator_commands/base_spec.rb

@@ -0,0 +1,136 @@
+#
+# 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 'pry'
+require 'spec_helper'
+require 'chef-dk/command/generator_commands/base'
+
+describe ChefDK::Command::GeneratorCommands::Base do
+  describe 'parsing Chef configuration' do
+    let(:cli_args) do
+      [
+        "-C", "Business Man",
+        "-I", "Serious Business",
+        "-m", "business.man@corporation.com"
+      ]
+    end
+
+    before do
+      Chef::Config.reset
+    end
+
+    context 'when generator configuration is defined' do
+      before do
+        Chef::Config.reset
+        Chef::Config.chefdk.generator.copyright_holder = "This Guy"
+        Chef::Config.chefdk.generator.email = "this.guy@twothumbs.net"
+        Chef::Config.chefdk.generator.license = "Two Thumbs License"
+      end
+
+      it 'uses the defined values' do
+        cmd = ChefDK::Command::GeneratorCommands::Base.new([])
+        cmd.parse_options
+        cmd.setup_context
+        cfg = cmd.config
+        expect(cfg[:copyright_holder]).to eq('This Guy')
+        expect(cfg[:email]).to eq('this.guy@twothumbs.net')
+        expect(cfg[:license]).to eq('Two Thumbs License')
+      end
+
+      context 'when cli overrides are provided' do
+        before do
+          Chef::Config.reset
+          Chef::Config.chefdk.generator.copyright_holder = "This Guy"
+          Chef::Config.chefdk.generator.email = "this.guy@twothumbs.net"
+          Chef::Config.chefdk.generator.license = "Two Thumbs License"
+        end
+
+        it 'uses the cli args' do
+          cmd = ChefDK::Command::GeneratorCommands::Base.new(cli_args)
+          cmd.parse_options(cli_args)
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq('Business Man')
+          expect(cfg[:email]).to eq('business.man@corporation.com')
+          expect(cfg[:license]).to eq('Serious Business')
+        end
+      end
+
+      context 'when knife configuration is also defined' do
+
+        before do
+          Chef::Config.reset
+          Chef::Config.chefdk.generator.copyright_holder = "This Guy"
+          Chef::Config.chefdk.generator.email = "this.guy@twothumbs.net"
+          Chef::Config.chefdk.generator.license = "Two Thumbs License"
+          Chef::Config.knife.cookbook_copyright = "Knife User"
+          Chef::Config.knife.cookbook_email = "knife.user@example.com"
+          Chef::Config.knife.cookbook_license = "GPLv9000"
+        end
+
+        it 'uses the generator configuration' do
+          cmd = ChefDK::Command::GeneratorCommands::Base.new([])
+          cmd.parse_options
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq('This Guy')
+          expect(cfg[:email]).to eq('this.guy@twothumbs.net')
+          expect(cfg[:license]).to eq('Two Thumbs License')
+        end
+      end
+    end
+
+    context 'when knife configuration is defined' do
+      before do
+        Chef::Config.reset
+        Chef::Config.knife.cookbook_copyright = "Knife User"
+        Chef::Config.knife.cookbook_email = "knife.user@example.com"
+        Chef::Config.knife.cookbook_license = "GPLv9000"
+      end
+
+      it 'uses the defined values' do
+        cmd = ChefDK::Command::GeneratorCommands::Base.new([])
+        cmd.parse_options
+        cmd.setup_context
+        cfg = cmd.config
+        expect(cfg[:copyright_holder]).to eq('Knife User')
+        expect(cfg[:email]).to eq('knife.user@example.com')
+        expect(cfg[:license]).to eq('GPLv9000')
+      end
+
+      context 'when cli overrides are provided' do
+
+        before do
+          Chef::Config.reset
+          Chef::Config.knife.cookbook_copyright = "Knife User"
+          Chef::Config.knife.cookbook_email = "knife.user@example.com"
+          Chef::Config.knife.cookbook_license = "GPLv9000"
+        end
+
+        it 'uses the cli args' do
+          cmd = ChefDK::Command::GeneratorCommands::Base.new(cli_args)
+          cmd.parse_options(cli_args)
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq('Business Man')
+          expect(cfg[:email]).to eq('business.man@corporation.com')
+          expect(cfg[:license]).to eq('Serious Business')
+        end
+      end
+    end
+  end
+end

data/spec/unit/command/update_spec.rb

@@ -39,6 +39,10 @@ describe ChefDK::Command::Update do
     expect(command.debug?).to be(false)
   end
 
+  it "doesn't set a config path by default" do
+    expect(command.config_path).to be_nil
+  end
+
   context "when debug mode is set" do
 
     let(:params) { [ "-D" ] }
@@ -48,6 +52,26 @@ describe ChefDK::Command::Update do
     end
   end
 
+  context "when an explicit config file path is given" do
+
+    let(:params) { %w[ -c ~/.chef/alternate_config.rb ] }
+
+    let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+    it "sets the config file path to the given value" do
+      expect(command.config_path).to eq("~/.chef/alternate_config.rb")
+    end
+
+    it "loads the config from the given path" do
+      expect(Chef::WorkstationConfigLoader).to receive(:new).
+        with("~/.chef/alternate_config.rb").
+        and_return(chef_config_loader)
+      expect(chef_config_loader).to receive(:load)
+      expect(command.chef_config).to eq(Chef::Config)
+    end
+
+  end
+
   context "when attributes update mode is set" do
 
     let(:params) { ["-a"] }

data/spec/unit/configurable_spec.rb

@@ -0,0 +1,41 @@
+#
+# 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 'spec_helper'
+require 'chef-dk/configurable'
+require 'unit/fixtures/configurable/test_configurable'
+
+describe ChefDK::Configurable do
+
+  let(:includer) { TestConfigurable.new }
+
+  it 'provides chef_config' do
+    expect(includer.chef_config).to eq Chef::Config
+  end
+
+  it 'provides chefdk_config' do
+    expect(includer.chefdk_config).to eq Chef::Config.chefdk
+  end
+
+  it 'provides knife_config' do
+    expect(includer.knife_config).to eq Chef::Config.knife
+  end
+
+  it 'provides generator_config' do
+    expect(includer.generator_config).to eq Chef::Config.chefdk.generator
+  end
+end

data/spec/unit/fixtures/configurable/test_config_loader.rb

@@ -0,0 +1,5 @@
+class TestConfigLoader
+  def load
+    true
+  end
+end

data/spec/unit/fixtures/configurable/test_configurable.rb

@@ -0,0 +1,10 @@
+require 'unit/fixtures/configurable/test_config_loader'
+
+class TestConfigurable
+  include ChefDK::Configurable
+
+  # don't use the workstation config loader
+  def config_loader
+    @config_loader ||= TestConfigLoader.new
+  end
+end

data/spec/unit/policyfile/cookbook_location_specification_spec.rb

@@ -30,7 +30,9 @@ describe ChefDK::Policyfile::CookbookLocationSpecification do
 
   let(:cached_cookbook) { double("ChefDK::CookbookMetadata") }
 
-  let(:installer) { double("CookbookOmnifetch location", cached_cookbook: cached_cookbook) }
+  let(:install_path) { Pathname.new("~/.chefdk/cache/cookbooks/my_cookbook-1.0.0") }
+
+  let(:installer) { double("CookbookOmnifetch location", cached_cookbook: cached_cookbook, install_path: install_path) }
 
   let(:storage_config) do
     ChefDK::Policyfile::StorageConfig.new.use_policyfile(policyfile_filename)
@@ -135,6 +137,24 @@ describe ChefDK::Policyfile::CookbookLocationSpecification do
       expect(cookbook_location_spec.dependencies).to eq("apt" => "~> 1.2.3")
     end
 
+    it "determines whether a cookbook has a given recipe" do
+      cookbook_path = cookbook_location_spec.cookbook_path
+      # "cache" cookbook_path so we stub the correct object
+      allow(cookbook_location_spec).to receive(:cookbook_path).and_return(cookbook_path)
+
+      default_recipe_path = install_path.join("recipes/default.rb")
+      nope_recipe_path = install_path.join("recipes/nope.rb")
+
+      expect(cookbook_path).to receive(:join).with("recipes/default.rb").and_return(default_recipe_path)
+      expect(cookbook_path).to receive(:join).with("recipes/nope.rb").and_return(nope_recipe_path)
+
+      expect(default_recipe_path).to receive(:exist?).and_return(true)
+      expect(nope_recipe_path).to receive(:exist?).and_return(false)
+
+      expect(cookbook_location_spec.cookbook_has_recipe?("default")).to be(true)
+      expect(cookbook_location_spec.cookbook_has_recipe?("nope")).to be(false)
+    end
+
   end
 
   describe "when created with no source" do

data/spec/unit/policyfile/cookbook_locks_spec.rb

@@ -468,7 +468,7 @@ describe ChefDK::Policyfile::ArchivedCookbook do
     described_class.new(wrapped_cookbook_lock, storage_config)
   end
 
-  let(:archived_cookbook_path) { File.join(storage_config.relative_paths_root, "cookbooks", "nginx-111.222.333") }
+  let(:archived_cookbook_path) { File.join(storage_config.relative_paths_root, "cookbook_artifacts", "nginx-abc123") }
 
   it "sets cookbook_path to the path within the archive" do
     expect(cookbook_lock.cookbook_path).to eq(archived_cookbook_path)

data/spec/unit/policyfile_demands_spec.rb

@@ -182,6 +182,212 @@ describe ChefDK::PolicyfileCompiler, "when expressing the Policyfile graph deman
     expect(policyfile.errors).to eq([])
   end
 
+  context "Given resolvable cookbook demands" do
+
+    let(:default_source) { [:supermarket] }
+
+    let(:trimmed_cookbook_universe) do
+      {
+        "remote-cb" => {
+          "1.1.1" => [ ]
+        }
+
+      }
+    end
+
+    let(:remote_cb_source_opts) do
+      { artifactserver: "https://supermarket.example/c/remote-cb/1.1.1/download", version: "1.1.1" }
+    end
+
+    let(:default_source_obj) do
+      instance_double("ChefDK::Policyfile::CommunityCookbookSource")
+    end
+
+    let(:cb_location_spec) do
+      s = "Cookbook 'remote-cb'"
+      s << " = 1.1.1"
+      s << " #{remote_cb_source_opts}"
+
+      instance_double("ChefDK::Policyfile::CookbookLocationSpecification",
+                      name: "remote-cb",
+                      version_constraint: Semverse::Constraint.new("= 1.1.1"),
+                      ensure_cached: nil,
+                      to_s: s)
+    end
+
+    before do
+      policyfile.default_source.replace([ default_source_obj ])
+
+      allow(default_source_obj).to receive(:universe_graph).
+        and_return(trimmed_cookbook_universe)
+
+      allow(default_source_obj).to receive(:preferred_source_for?).
+        with("remote-cb").
+        and_return(true)
+
+      allow(default_source_obj).to receive(:source_options_for).
+        with("remote-cb", "1.1.1").
+        and_return(remote_cb_source_opts)
+
+
+      allow(ChefDK::Policyfile::CookbookLocationSpecification).to receive(:new).
+        with("remote-cb", "= 1.1.1", remote_cb_source_opts, policyfile.storage_config).
+        and_return(cb_location_spec)
+
+      allow(cb_location_spec).to receive(:installed?).and_return(true)
+    end
+
+    context "when the resolved cookbooks have the recipes requested by the run list" do
+
+      context "with an implied default recipe" do
+
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("default").
+            and_return(true)
+        end
+
+        let(:run_list) { ["remote-cb"] }
+
+        it "installs without error" do
+          expect { policyfile.install }.to_not raise_error
+        end
+
+      end
+
+      context "with an explicit recipe name" do
+
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_exists").
+            and_return(true)
+        end
+
+        let(:run_list) { ["remote-cb::this_exists"] }
+
+        it "installs without error" do
+          expect { policyfile.install }.to_not raise_error
+        end
+
+      end
+
+      context "with a fully qualified recipe name" do
+
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_exists").
+            and_return(true)
+        end
+
+        let(:run_list) { ["recipe[remote-cb::this_exists]"] }
+
+        it "installs without error" do
+          expect { policyfile.install }.to_not raise_error
+        end
+
+      end
+
+    end
+
+    context "when the resolved cookbooks do not have the recipes requested by the run list" do
+
+      context "when the cookbook with a missing recipe appears once in the run list" do
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_recipe_doesnt_exist").
+            and_return(false)
+        end
+
+        let(:run_list) { ["remote-cb::this_recipe_doesnt_exist"] }
+
+        it "emits an error" do
+          message =<<-MESSAGE
+The installed cookbooks do not contain all the recipes required by your run list(s):
+Cookbook 'remote-cb' = 1.1.1 {:artifactserver=>"https://supermarket.example/c/remote-cb/1.1.1/download", :version=>"1.1.1"}
+is missing the following required recipes:
+* this_recipe_doesnt_exist
+
+You may have specified an incorrect recipe in your run list,
+or this recipe may not be available in that version of the cookbook
+MESSAGE
+
+          expect { policyfile.install }.to raise_error do |e|
+            expect(e).to be_a(ChefDK::CookbookDoesNotContainRequiredRecipe)
+            expect(e.message).to eq(message)
+          end
+        end
+      end
+
+      context "when there is one valid item and one invalid item in the run list" do
+
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("default").
+            and_return(true)
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_recipe_doesnt_exist").
+            and_return(false)
+        end
+
+
+        let(:run_list) { ["remote-cb::default", "remote-cb::this_recipe_doesnt_exist"] }
+
+        it "emits an error" do
+          message =<<-MESSAGE
+The installed cookbooks do not contain all the recipes required by your run list(s):
+Cookbook 'remote-cb' = 1.1.1 {:artifactserver=>"https://supermarket.example/c/remote-cb/1.1.1/download", :version=>"1.1.1"}
+is missing the following required recipes:
+* this_recipe_doesnt_exist
+
+You may have specified an incorrect recipe in your run list,
+or this recipe may not be available in that version of the cookbook
+MESSAGE
+
+          expect { policyfile.install }.to raise_error do |e|
+            expect(e).to be_a(ChefDK::CookbookDoesNotContainRequiredRecipe)
+            expect(e.message).to eq(message)
+          end
+        end
+
+      end
+
+      context "when there are multiple invalid items in the run list" do
+
+        before do
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_recipe_doesnt_exist").
+            and_return(false)
+          expect(cb_location_spec).to receive(:cookbook_has_recipe?).
+            with("this_also_doesnt_exist").
+            and_return(false)
+        end
+
+        let(:run_list) { ["remote-cb::this_recipe_doesnt_exist", "remote-cb::this_also_doesnt_exist"] }
+
+        it "emits an error" do
+          message =<<-MESSAGE
+The installed cookbooks do not contain all the recipes required by your run list(s):
+Cookbook 'remote-cb' = 1.1.1 {:artifactserver=>"https://supermarket.example/c/remote-cb/1.1.1/download", :version=>"1.1.1"}
+is missing the following required recipes:
+* this_recipe_doesnt_exist
+* this_also_doesnt_exist
+
+You may have specified an incorrect recipe in your run list,
+or this recipe may not be available in that version of the cookbook
+MESSAGE
+
+          expect { policyfile.install }.to raise_error do |e|
+            expect(e).to be_a(ChefDK::CookbookDoesNotContainRequiredRecipe)
+            expect(e.message).to eq(message)
+          end
+        end
+
+      end
+
+
+    end
+  end
+
   context "Given no local or git cookbooks, no default source, and an empty run list" do
 
     let(:run_list) { [] }