chef-dk 0.3.0 → 0.3.5

data/lib/chef-dk/service_exceptions.rb

@@ -0,0 +1,77 @@
+#
+# 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.
+#
+
+##
+# Exceptions for Service classes have more complex behaviors and more
+# dependencies, so they are split into their own file here.
+##
+
+require 'chef-dk/service_exception_inspectors'
+
+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 PolicyfileNestedException < PolicyfileServiceError
+
+    attr_reader :cause
+    attr_reader :inspector
+
+    def initialize(message, cause)
+      super(message)
+      @inspector = inspector_for(cause)
+      @cause = cause
+    end
+
+    def reason
+      "(#{cause.class.name}) #{inspector.message}"
+    end
+
+    def extended_error_info
+      inspector.extended_error_info
+    end
+
+    private
+
+    def inspector_for(exception)
+      if exception.respond_to?(:response)
+        ServiceExceptionInspectors::HTTP.new(exception)
+      else
+        ServiceExceptionInspectors::Base.new(exception)
+      end
+    end
+
+  end
+
+  class PolicyfileInstallError < PolicyfileNestedException
+  end
+
+  class PolicyfilePushError < PolicyfileNestedException
+  end
+
+end
+

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

@@ -0,0 +1,8 @@
+
+context = ChefDK::Generator.context
+policyfile_path = File.join(context.policyfile_dir, "#{context.new_file_basename}.rb")
+
+template policyfile_path do
+  source "Policyfile.rb.erb"
+  helpers(ChefDK::Generator::TemplateHelper)
+end

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

@@ -0,0 +1,16 @@
+# Policyfile.rb - Describe how you want Chef to build your system.
+#
+# For more information on the Policyfile feature, visit
+# https://github.com/opscode/chef-dk/blob/master/POLICYFILE_README.md
+
+# A name that describes what the system you're building with Chef does.
+name "example_application"
+
+# Where to find external cookbooks:
+default_source :community
+
+# run_list: chef-client will run these recipes in the order specified.
+run_list "cookbook::recipe", "other_cookbook::recipe"
+
+# Specify a custom source for a single cookbook:
+# cookbook "development_cookbook", path: "../cookbooks/development_cookbook"

data/lib/chef-dk/skeletons/code_generator/templates/default/kitchen.yml.erb

@@ -7,7 +7,7 @@ provisioner:
 
 platforms:
   - name: ubuntu-12.04
-  - name: centos-6.4
+  - name: centos-6.5
 
 suites:
   - name: default

data/lib/chef-dk/version.rb

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

data/spec/unit/cli_spec.rb

@@ -166,85 +166,146 @@ E
   end
 
   context "sanity_check!" do
-    context "on unix" do
-      it "complains if embedded is first" do
-        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin:/opt/chefdk/bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).not_to eq(base_help_message)
-        expect(stdout).to include("please reverse that order")
-        expect(stdout).to include("chef shell-init")
-      end
 
-      it "complains if only embedded is present" do
-        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).not_to eq(base_help_message)
-        expect(stdout).to include("you must add")
-        expect(stdout).to include("chef shell-init")
-      end
+    before do
+      allow(Gem).to receive(:ruby).and_return(ruby_path)
+      allow(File).to receive(:exist?).with(chefdk_embedded_path).and_return(true)
+      allow(cli).to receive(:omnibus_chefdk_location).and_return(chefdk_embedded_path)
+    end
 
-      it "passes when both are present in the correct order" do
-        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin:/opt/chefdk/embedded/bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).to eq(base_help_message)
+    context "when installed via omnibus" do
+
+      context "on unix" do
+
+        let(:ruby_path) { '/opt/chefdk/embedded/bin/ruby' }
+        let(:chefdk_embedded_path) { '/opt/chefdk/embedded/apps/chef-dk' }
+        
+        before do
+          stub_const("File::PATH_SEPARATOR", ':')
+          allow(Chef::Util::PathHelper).to receive(:cleanpath) do |path|
+            path
+          end
+        end
+
+        it "complains if embedded is first" do
+          allow(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin:/opt/chefdk/bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+          expect(stderr).to include("please reverse that order")
+          expect(stderr).to include("chef shell-init")
+        end
+
+        it "complains if only embedded is present" do
+          allow(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/embedded/bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+          expect(stderr).to include("you must add")
+          expect(stderr).to include("chef shell-init")
+        end
+
+        it "passes when both are present in the correct order" do
+          allow(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin:/opt/chefdk/embedded/bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+        end
+
+        it "passes when only the omnibus bin dir is present" do
+          allow(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+        end
       end
 
-      it "passes when only the omnibus bin dir is present" do
-        expect(cli).to receive(:env).and_return({'PATH' => '/opt/chefdk/bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("/opt/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("/opt/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).to eq(base_help_message)
+      context "on windows" do
+
+        let(:ruby_path) { "c:/opscode/chefdk/embedded/bin/ruby.exe" }
+        let(:chefdk_embedded_path) { "c:/opscode/chefdk/embedded/apps/chef-dk" }
+
+        before do
+          # Would be preferable not to stub this, but `File.expand_path` does
+          # weird things with windows paths on unix machines.
+          #
+          # I manually verified the behavior:
+          #
+          #   $ /c/opscode/chefdk/embedded/bin/ruby -e 'p File.expand_path(File.join(Gem.ruby, "..", "..", ".."))'
+          #   "c:/opscode/chefdk"
+          allow(cli).to receive(:omnibus_chefdk_location).and_return(chefdk_embedded_path)
+
+          allow(Chef::Platform).to receive(:windows?).and_return(true)
+          stub_const("File::PATH_SEPARATOR", ';')
+          allow(Chef::Util::PathHelper).to receive(:cleanpath) do |path|
+            path.gsub "/", "\\"
+          end
+        end
+
+        it "complains if embedded is first" do
+          allow(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin;C:\opscode\chefdk\bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+          expect(stderr).to include("please reverse that order")
+          expect(stderr).to include("chef shell-init")
+        end
+
+        it "complains if only embedded is present" do
+          allow(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+          expect(stderr).to include("you must add")
+          expect(stderr).to include("chef shell-init")
+        end
+
+        it "passes when both are present in the correct order" do
+          allow(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin;C:\opscode\chefdk\embedded\bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+        end
+
+        it "passes when only the omnibus bin dir is present" do
+          allow(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin' })
+          allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
+          allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+          run_cli_with_sanity_check(0)
+          expect(stdout).to eq(base_help_message)
+        end
       end
     end
 
-    context "on windows" do
-      before do
-        allow(Chef::Platform).to receive(:windows?).and_return(true)
-        stub_const("File::PATH_SEPARATOR", ';')
-      end
+    context "when not installed via omnibus" do
 
-      it "complains if embedded is first" do
-        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin;C:\opscode\chefdk\bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).not_to eq(base_help_message)
-        expect(stdout).to include("please reverse that order")
-        expect(stdout).to include("chef shell-init")
-      end
+      let(:ruby_path) { '/Users/bog/.lots_o_rubies/2.1.2/bin/ruby' }
+      let(:chefdk_embedded_path) { '/Users/bog/.lots_o_rubies/embedded/apps/chef-dk' }
 
-      it "complains if only embedded is present" do
-        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\embedded\bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).not_to eq(base_help_message)
-        expect(stdout).to include("you must add")
-        expect(stdout).to include("chef shell-init")
+      before do
+        allow(File).to receive(:exist?).with(chefdk_embedded_path).and_return(false)
+
+        [
+          :omnibus_root,
+          :omnibus_apps_dir,
+          :omnibus_bin_dir,
+          :omnibus_embedded_bin_dir
+        ].each do |method_name|
+          allow(cli).to receive(method_name).and_raise(ChefDK::OmnibusInstallNotFound.new)
+        end
       end
 
-      it "passes when both are present in the correct order" do
-        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin;C:\opscode\chefdk\embedded\bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
+      it "skips the sanity check without error" do
         run_cli_with_sanity_check(0)
-        expect(stdout).to eq(base_help_message)
       end
 
-      it "passes when only the omnibus bin dir is present" do
-        expect(cli).to receive(:env).and_return({'PATH' => 'C:\opscode\chefdk\bin' })
-        allow(cli).to receive(:omnibus_embedded_bin_dir).and_return("c:/opscode/chefdk/embedded/bin")
-        allow(cli).to receive(:omnibus_bin_dir).and_return("c:/opscode/chefdk/bin")
-        run_cli_with_sanity_check(0)
-        expect(stdout).to eq(base_help_message)
-      end
     end
   end
 end

data/spec/unit/command/exec_spec.rb

@@ -58,6 +58,11 @@ describe ChefDK::Command::Exec do
 
     before do
       allow(Gem).to receive(:ruby).and_return(ruby_path)
+
+      # Using a fake path separator to keep to prevent people from accidently
+      # getting things correct on their system. This enforces that, in general,
+      # you should use the path separator ruby is telling you to use.
+      stub_const("File::PATH_SEPARATOR", '<>')
     end
 
     context "when running exec env" do
@@ -69,7 +74,7 @@ describe ChefDK::Command::Exec do
 
       let(:omnibus_bin_dir) { "/foo/bin" }
 
-      let(:expected_PATH) { "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}" }
+      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 }
 
@@ -103,7 +108,7 @@ describe ChefDK::Command::Exec do
 
       let(:omnibus_embedded_bin_dir) { "/foo/embedded/bin" }
 
-      let(:expected_PATH) { "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}" }
+      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 }
 

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

@@ -201,5 +201,31 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
     end
   end
 
-end
+  context "when given generic arguments to populate the generator context" do
+    let(:argv) { [ "new_cookbook", "--generator-arg", "key1=value1", "-a", "key2=value2", "-a", " key3 = value3 " ] }
+
+    before do
+      reset_tempdir
+    end
+
+    it "configures the generator context for long form option key1" do
+      cookbook_generator.read_and_validate_params
+      cookbook_generator.setup_context
+      expect(generator_context.key1).to eq('value1')
+    end
+
+    it "configures the generator context for short form option key2" do
+      cookbook_generator.read_and_validate_params
+      cookbook_generator.setup_context
+      expect(generator_context.key2).to eq('value2')
+    end
+
+    it "configures the generator context for key3 containing additional spaces" do
+      cookbook_generator.read_and_validate_params
+      cookbook_generator.setup_context
+      expect(generator_context.key3).to eq('value3')
+    end
 
+  end
+
+end

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

@@ -0,0 +1,125 @@
+#
+# 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 'shared/a_file_generator'
+require 'chef-dk/command/generator_commands/policyfile'
+
+describe ChefDK::Command::GeneratorCommands::Policyfile do
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  subject(:generator) do
+    generator = described_class.new(argv)
+    allow(generator).to receive(:stdout).and_return(stdout_io)
+    allow(generator).to receive(:stderr).and_return(stderr_io)
+    generator
+  end
+
+  def generator_context
+    ChefDK::Generator.context
+  end
+
+  before do
+    allow(generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+    ChefDK::Generator.reset
+    reset_tempdir
+  end
+
+  after(:each) do
+    ChefDK::Generator::Context.reset
+  end
+
+  shared_examples_for "it creates a Policyfile" do
+
+    it "configures the generator context" do
+      Dir.chdir(tempdir) do
+        generator.read_and_validate_params
+        generator.setup_context
+
+        expect(generator_context.policyfile_dir).to eq(tempdir)
+        expect(generator_context.new_file_basename).to eq(new_file_basename)
+      end
+    end
+
+    it "generates a Policyfile.rb in the CWD" do
+      Dir.chdir(tempdir) do
+        expect(generator.run).to eq(0)
+        expect(File).to exist(File.join(tempdir, expected_file_name))
+      end
+    end
+
+  end
+
+  context "when ARGV is empty" do
+
+    let(:argv) { [] }
+
+    let(:expected_file_name) { "Policyfile.rb" }
+    let(:new_file_basename) { "Policyfile" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when ARGV is a relative path with no `.rb' extension" do
+
+    let(:argv) { ["MyPolicy"] }
+
+    let(:expected_file_name) { "MyPolicy.rb" }
+    let(:new_file_basename) { "MyPolicy" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when ARGV is a relative path with a `.rb' extension" do
+
+    let(:argv) { ["MyApplication.rb"] }
+
+    let(:expected_file_name) { "MyApplication.rb" }
+    let(:new_file_basename) { "MyApplication" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when ARGV has too many arguments" do
+
+    let(:argv) { %w{ foo bar baz } }
+
+    it "shows usage and exits" do
+      expected_stdout = "Usage: chef generate policyfile [NAME] [options]"
+
+      expect(generator.run).to eq(1)
+      expect(stdout).to include(expected_stdout)
+    end
+
+  end
+
+end
+
+