chef-dk 0.7.0 → 0.8.0

data/lib/chef-dk/service_exceptions.rb

@@ -118,6 +118,17 @@ module ChefDK
   class PolicyfileCleanError < PolicyfileNestedException
   end
 
+  class DeletePolicyGroupError < PolicyfileNestedException
+  end
+
+  class DeletePolicyError < PolicyfileNestedException
+  end
+  class PolicyCookbookCleanError < PolicyfileNestedException
+  end
+
+  class UndeleteError < PolicyfileNestedException
+  end
+
   class ChefRunnerError < StandardError
 
     include NestedExceptionWithInspector

data/lib/chef-dk/skeletons/code_generator/files/default/chefignore

@@ -51,9 +51,11 @@ spec/*
 spec/fixtures/*
 test/*
 features/*
+examples/*
 Guardfile
 Procfile
-.kitchen
+.kitchen*
+.rubocop.yml
 
 # SCM #
 #######
@@ -77,7 +79,9 @@ tmp
 
 # Cookbooks #
 #############
-CONTRIBUTING
+CONTRIBUTING*
+CHANGELOG*
+TESTING*
 
 # Strainer #
 ############

data/lib/chef-dk/skeletons/code_generator/files/default/repo/README.md

@@ -20,7 +20,7 @@ Configuration
 
 The config file, `.chef/knife.rb` is a repository specific configuration file for knife. If you're using the Chef Platform, you can download one for your organization from the management console. If you're using the Open Source Chef Server, you can generate a new one with `knife configure`. For more information about configuring Knife, see the Knife documentation.
 
-http://docs.chef.io/knife.html
+https://docs.chef.io/knife.html
 
 Next Steps
 ==========

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/attributes/default.rb

@@ -4,4 +4,4 @@
 # Set a default name
 default["example"]["name"] = "Sam Doe"
 
-# For further information, see the Chef documentation (http://docs.getchef.com/essentials_cookbook_attribute_files.html).
+# For further information, see the Chef documentation (https://docs.getchef.com/essentials_cookbook_attribute_files.html).

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb

@@ -5,4 +5,4 @@ log "Welcome to Chef, #{node["example"]["name"]}!" do
   level :info
 end
 
-# For more information, see the documentation: http://docs.getchef.com/essentials_cookbook_recipes.html
+# For more information, see the documentation: https://docs.getchef.com/essentials_cookbook_recipes.html

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/kitchen/provisioner/policyfile_zero.rb

@@ -41,6 +41,7 @@ module Kitchen
       default_config :json_attributes, true
       default_config :chef_zero_host, nil
       default_config :chef_zero_port, 8889
+      default_config :policyfile, "Policyfile.rb"
 
       default_config :chef_client_path do |provisioner|
         provisioner.
@@ -122,7 +123,9 @@ module Kitchen
       def policy_exporter
         # Must force this because TK by default copies the current cookbook to the sandbox
         # See ChefDK::PolicyfileServices::ExportRepo#assert_export_dir_clean!
-        @policy_exporter ||= ChefDK::PolicyfileServices::ExportRepo.new(export_dir: sandbox_path, force: true)
+        @policy_exporter ||= ChefDK::PolicyfileServices::ExportRepo.new(policyfile: config[:policyfile],
+                                                                        export_dir: sandbox_path,
+                                                                        force: true)
       end
 
       # Writes a fake (but valid) validation.pem into the sandbox directory.

data/spec/unit/command/base_spec.rb

@@ -22,6 +22,11 @@ describe ChefDK::Command::Base do
   class TestCommand < ChefDK::Command::Base
     banner "use me please"
 
+    option :argue,
+      short:       "-a ARG",
+      long:        "--arg ARG",
+      description: "An option with a required argument"
+
     option :user,
       :short        => "-u",
       :long         => "--user",
@@ -96,14 +101,34 @@ describe ChefDK::Command::Base do
     it "prints the help banner and exits gracefully" do
       expect(run_command(%w[-foo])).to eq(1)
 
-      expect(stderr).to eq("invalid option: -foo\n")
+      expect(stderr).to eq("ERROR: invalid option: -foo\n\n")
+
+      expected = <<-E
+use me please
+    -a, --arg ARG                    An option with a required argument
+    -u, --user                       If the user exists
+
+E
+      expect(stdout).to eq(expected)
+    end
+
+  end
+
+  describe "when given an option that requires an argument with no argument" do
+
+    it "prints the help banner and exits gracefully" do
+      expect(run_command(%w[-a])).to eq(1)
+
+      expect(stderr).to eq("ERROR: missing argument: -a\n\n")
 
       expected = <<-E
 use me please
+    -a, --arg ARG                    An option with a required argument
     -u, --user                       If the user exists
 
 E
       expect(stdout).to eq(expected)
+
     end
 
   end

data/spec/unit/command/clean_policy_cookbooks_spec.rb

@@ -0,0 +1,181 @@
+#
+# Copyright:: Copyright (c) 2015 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 'shared/command_with_ui_object'
+require 'chef-dk/command/clean_policy_cookbooks'
+
+describe ChefDK::Command::CleanPolicyCookbooks do
+
+  it_behaves_like "a command with a UI object"
+
+  subject(:command) do
+    described_class.new
+  end
+
+  let(:clean_policy_cookbooks_service) { command.clean_policy_cookbooks_service }
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:chef_config) { double("Chef::Config") }
+
+  # nil means the config loader will do the default path lookup
+  let(:config_arg) { nil }
+
+  before do
+    stub_const("Chef::Config", chef_config)
+    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+  end
+
+  describe "parsing args and options" do
+    let(:params) { [] }
+
+    before do
+      command.apply_params!(params)
+    end
+
+    context "when given a path to the config" do
+
+      let(:params) { %w[ -c ~/otherstuff/config.rb ] }
+
+      let(:config_arg) { "~/otherstuff/config.rb" }
+
+      before do
+        expect(chef_config_loader).to receive(:load)
+      end
+
+      it "reads the chef/knife config" do
+        expect(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+        expect(command.chef_config).to eq(chef_config)
+        expect(clean_policy_cookbooks_service.chef_config).to eq(chef_config)
+      end
+
+    end
+
+    describe "settings that require loading chef config" do
+
+      before do
+        allow(chef_config_loader).to receive(:load)
+      end
+
+      context "with no params" do
+
+        it "disables debug by default" do
+          expect(command.debug?).to be(false)
+        end
+
+      end
+
+      context "when debug mode is set" do
+
+        let(:params) { [ "-D" ] }
+
+        it "enables debug" do
+          expect(command.debug?).to be(true)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "running the command" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      allow(chef_config_loader).to receive(:load)
+      command.ui = ui
+    end
+
+    context "when given too many arguments" do
+
+      let(:params) { %w[ wut-is-this ] }
+
+      it "shows usage and exits" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+
+    context "when the clean policies service raises an exception" do
+
+      let(:backtrace) { caller[0...3] }
+
+      let(:cause) do
+        e = StandardError.new("some operation failed")
+        e.set_backtrace(backtrace)
+        e
+      end
+
+      let(:exception) do
+        ChefDK::PolicyfileCleanError.new("Failed to delete some policy revisions.", cause)
+      end
+
+      before do
+        allow(clean_policy_cookbooks_service).to receive(:run).and_raise(exception)
+      end
+
+      it "prints a debugging message and exits non-zero" do
+        expect(command.run([])).to eq(1)
+
+        expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+E
+
+        expect(ui.output).to eq(expected_output)
+      end
+
+      context "when debug is enabled" do
+
+        it "includes the backtrace in the error" do
+
+          command.run(%w[ -D ])
+
+          expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+
+E
+          expected_output << backtrace.join("\n") << "\n"
+
+          expect(ui.output).to eq(expected_output)
+        end
+
+      end
+
+    end
+
+    context "when the clean policies service executes successfully" do
+
+      before do
+        expect(clean_policy_cookbooks_service).to receive(:run)
+      end
+
+      it "exits 0" do
+        expect(command.run([])).to eq(0)
+      end
+
+    end
+
+  end
+end
+

data/spec/unit/command/clean_policy_revisions_spec.rb

@@ -0,0 +1,181 @@
+#
+# Copyright:: Copyright (c) 2015 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 'shared/command_with_ui_object'
+require 'chef-dk/command/clean_policy_revisions'
+
+describe ChefDK::Command::CleanPolicyRevisions do
+
+  it_behaves_like "a command with a UI object"
+
+  subject(:command) do
+    described_class.new
+  end
+
+  let(:clean_policies_service) { command.clean_policies_service }
+
+  let(:chef_config_loader) { instance_double("Chef::WorkstationConfigLoader") }
+
+  let(:chef_config) { double("Chef::Config") }
+
+  # nil means the config loader will do the default path lookup
+  let(:config_arg) { nil }
+
+  before do
+    stub_const("Chef::Config", chef_config)
+    allow(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+  end
+
+  describe "parsing args and options" do
+    let(:params) { [] }
+
+    before do
+      command.apply_params!(params)
+    end
+
+    context "when given a path to the config" do
+
+      let(:params) { %w[ -c ~/otherstuff/config.rb ] }
+
+      let(:config_arg) { "~/otherstuff/config.rb" }
+
+      before do
+        expect(chef_config_loader).to receive(:load)
+      end
+
+      it "reads the chef/knife config" do
+        expect(Chef::WorkstationConfigLoader).to receive(:new).with(config_arg).and_return(chef_config_loader)
+        expect(command.chef_config).to eq(chef_config)
+        expect(clean_policies_service.chef_config).to eq(chef_config)
+      end
+
+    end
+
+    describe "settings that require loading chef config" do
+
+      before do
+        allow(chef_config_loader).to receive(:load)
+      end
+
+      context "with no params" do
+
+        it "disables debug by default" do
+          expect(command.debug?).to be(false)
+        end
+
+      end
+
+      context "when debug mode is set" do
+
+        let(:params) { [ "-D" ] }
+
+        it "enables debug" do
+          expect(command.debug?).to be(true)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "running the command" do
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      allow(chef_config_loader).to receive(:load)
+      command.ui = ui
+    end
+
+    context "when given too many arguments" do
+
+      let(:params) { %w[ wut-is-this ] }
+
+      it "shows usage and exits" do
+        expect(command.run(params)).to eq(1)
+      end
+
+    end
+
+    context "when the clean policies service raises an exception" do
+
+      let(:backtrace) { caller[0...3] }
+
+      let(:cause) do
+        e = StandardError.new("some operation failed")
+        e.set_backtrace(backtrace)
+        e
+      end
+
+      let(:exception) do
+        ChefDK::PolicyfileCleanError.new("Failed to delete some policy revisions.", cause)
+      end
+
+      before do
+        allow(clean_policies_service).to receive(:run).and_raise(exception)
+      end
+
+      it "prints a debugging message and exits non-zero" do
+        expect(command.run([])).to eq(1)
+
+        expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+E
+
+        expect(ui.output).to eq(expected_output)
+      end
+
+      context "when debug is enabled" do
+
+        it "includes the backtrace in the error" do
+
+          command.run(%w[ -D ])
+
+          expected_output=<<-E
+Error: Failed to delete some policy revisions.
+Reason: (StandardError) some operation failed
+
+
+E
+          expected_output << backtrace.join("\n") << "\n"
+
+          expect(ui.output).to eq(expected_output)
+        end
+
+      end
+
+    end
+
+    context "when the clean policies service executes successfully" do
+
+      before do
+        expect(clean_policies_service).to receive(:run)
+      end
+
+      it "exits 0" do
+        expect(command.run([])).to eq(0)
+      end
+
+    end
+
+  end
+end
+