chef-dk 0.3.5 → 0.4.0

data/spec/unit/command/export_spec.rb

@@ -0,0 +1,176 @@
+#
+# 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/command_with_ui_object'
+require 'chef-dk/command/export'
+
+describe ChefDK::Command::Export do
+
+  it_behaves_like "a command with a UI object"
+
+  let(:params) { [] }
+
+  let(:command) do
+    described_class.new
+  end
+
+  let(:policyfile_lock) do
+    instance_double(ChefDK::PolicyfileLock, name: "example-policy")
+  end
+
+  let(:export_service) do
+    instance_double(ChefDK::PolicyfileServices::ExportRepo,
+                    policyfile_lock: policyfile_lock)
+  end
+
+  context "after evaluating params" do
+
+    let(:params) { [ "path/to/export" ] }
+
+    before do
+      command.apply_params!(params)
+    end
+
+    it "disables debug by default" do
+      expect(command.debug?).to be(false)
+    end
+
+    context "when debug mode is set" do
+
+      let(:params) { [ "path/to/export", "-D" ] }
+
+      it "enables debug" do
+        expect(command.debug?).to be(true)
+      end
+    end
+
+    context "when the path to the exported repo is given" do
+
+      let(:params) { [ "path/to/export" ] }
+
+      it "configures the export service with the export path" do
+        expect(command.export_service.export_dir).to eq(File.expand_path("path/to/export"))
+      end
+
+      it "uses the default policyfile name" do
+        expect(command.export_service.policyfile_filename).to eq(File.expand_path("Policyfile.rb"))
+      end
+
+    end
+
+    context "when a Policyfile relative path and export path are given" do
+
+      let(:params) { [ "CustomNamedPolicy.rb", "path/to/export" ] }
+
+      it "configures the export service with the export path" do
+        expect(command.export_service.export_dir).to eq(File.expand_path("path/to/export"))
+      end
+
+      it "configures the export service with the policyfile relative path" do
+        expect(command.export_service.policyfile_filename).to eq(File.expand_path("CustomNamedPolicy.rb"))
+      end
+    end
+  end
+
+  describe "running the export" do
+
+    let(:params) { [ "/path/to/export" ] }
+
+    let(:ui) { TestHelpers::TestUI.new }
+
+    before do
+      command.ui = ui
+      allow(command).to receive(:export_service).and_return(export_service)
+    end
+
+    context "with no arguments" do
+
+      it "exits non-zero and prints a help message" do
+        expect(command.run).to eq(1)
+      end
+
+    end
+
+    context "when the command is successful" do
+
+      before do
+        expect(export_service).to receive(:run)
+      end
+
+      it "returns 0" do
+        expect(command.run(params)).to eq(0)
+      end
+    end
+
+    context "when the command is unsuccessful" 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::PolicyfileExportRepoError.new("export failed", cause)
+      end
+
+      before do
+        expect(export_service).to receive(:run).and_raise(exception)
+      end
+
+      it "returns 1" do
+        expect(command.run(params)).to eq(1)
+      end
+
+      it "displays the exception and cause" do
+        expected_error_text=<<-E
+Error: export failed
+Reason: (StandardError) some operation failed
+
+E
+
+        command.run(params)
+        expect(ui.output).to eq(expected_error_text)
+      end
+
+      context "and debug is enabled" do
+
+        let(:params) { [ "path/to/export", "-D"] }
+
+        it "displays the exception and cause with backtrace" do
+          expected_error_text=<<-E
+Error: export failed
+Reason: (StandardError) some operation failed
+
+
+E
+
+          expected_error_text << backtrace.join("\n") << "\n"
+
+          command.run(params)
+          expect(ui.output).to eq(expected_error_text)
+        end
+      end
+
+    end
+
+  end
+end
+

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

@@ -16,6 +16,7 @@
 #
 
 require 'spec_helper'
+require 'shared/custom_generator_cookbook'
 require 'chef-dk/command/generator_commands/app'
 
 describe ChefDK::Command::GeneratorCommands::App do
@@ -29,12 +30,23 @@ describe ChefDK::Command::GeneratorCommands::App do
     %w[
       .gitignore
       .kitchen.yml
+      test
+      test/integration
+      test/integration/default
+      test/integration/default/serverspec
+      test/integration/default/serverspec/default_spec.rb
+      test/integration/default/serverspec/spec_helper.rb
       README.md
       cookbooks/new_app/Berksfile
       cookbooks/new_app/chefignore
       cookbooks/new_app/metadata.rb
       cookbooks/new_app/recipes
       cookbooks/new_app/recipes/default.rb
+      cookbooks/new_app/spec
+      cookbooks/new_app/spec/spec_helper.rb
+      cookbooks/new_app/spec/unit
+      cookbooks/new_app/spec/unit/recipes
+      cookbooks/new_app/spec/unit/recipes/default_spec.rb
     ]
   end
 
@@ -54,6 +66,14 @@ describe ChefDK::Command::GeneratorCommands::App do
     ChefDK::Generator.reset
   end
 
+  include_examples "custom generator cookbook" do
+
+    let(:generator_arg) { "new_app" }
+
+    let(:generator_name) { "app" }
+
+  end
+
   context "when given the name of the cookbook to generate" do
 
     before do
@@ -67,6 +87,7 @@ describe ChefDK::Command::GeneratorCommands::App do
       expect(generator_context.app_name).to eq("new_app")
       expect(generator_context.cookbook_root).to eq(File.join(Dir.pwd, "new_app", "cookbooks"))
       expect(generator_context.cookbook_name).to eq("new_app")
+      expect(generator_context.recipe_name).to eq("default")
     end
 
     describe "generated files" do
@@ -110,6 +131,14 @@ describe ChefDK::Command::GeneratorCommands::App do
         end
       end
 
+      describe "test/integration/default/serverspec/default_spec.rb" do
+        let(:file) { File.join(tempdir, "new_app", "test", "integration", "default", "serverspec", "default_spec.rb") }
+
+        include_examples "a generated file", :cookbook_name do
+          let(:line) { "describe 'new_app::default' do" }
+        end
+      end
+
       describe "cookbooks/new_app/metadata.rb" do
         let(:file) { File.join(tempdir, "new_app", "cookbooks", "new_app", "metadata.rb") }
 
@@ -125,6 +154,15 @@ describe ChefDK::Command::GeneratorCommands::App do
           let(:line) { "# Cookbook Name:: new_app" }
         end
       end
+
+      describe "cookbooks/new_app/spec/unit/recipes/default_spec.rb" do
+        let(:file) { File.join(tempdir, "new_app", "cookbooks", "new_app", "spec", "unit", "recipes", "default_spec.rb") }
+
+        include_examples "a generated file", :cookbook_name do
+          let(:line) { "describe \'new_app::default\' do" }
+        end
+      end
+
     end
   end
 end

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

@@ -16,6 +16,7 @@
 #
 
 require 'spec_helper'
+require 'shared/custom_generator_cookbook'
 require 'chef-dk/command/generator_commands/cookbook'
 
 describe ChefDK::Command::GeneratorCommands::Cookbook do
@@ -29,12 +30,23 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
     %w[
       .gitignore
       .kitchen.yml
+      test
+      test/integration
+      test/integration/default
+      test/integration/default/serverspec
+      test/integration/default/serverspec/default_spec.rb
+      test/integration/default/serverspec/spec_helper.rb
       Berksfile
       chefignore
       metadata.rb
       README.md
       recipes
       recipes/default.rb
+      spec
+      spec/spec_helper.rb
+      spec/unit
+      spec/unit/recipes
+      spec/unit/recipes/default_spec.rb
     ]
   end
 
@@ -58,6 +70,14 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
     ChefDK::Generator.reset
   end
 
+  include_examples "custom generator cookbook" do
+
+    let(:generator_arg) { "new_cookbook" }
+
+    let(:generator_name) { "cookbook" }
+
+  end
+
   it "configures the chef runner" do
     expect(cookbook_generator.chef_runner).to be_a(ChefDK::ChefRunner)
     expect(cookbook_generator.chef_runner.cookbook_path).to eq(File.expand_path('lib/chef-dk/skeletons', project_root))
@@ -97,6 +117,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       cookbook_generator.setup_context
       expect(generator_context.cookbook_root).to eq(Dir.pwd)
       expect(generator_context.cookbook_name).to eq("new_cookbook")
+      expect(generator_context.recipe_name).to eq("default")
     end
 
     it "creates a new cookbook" do
@@ -139,6 +160,14 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       end
     end
 
+    describe "test/integration/default/serverspec/default_spec.rb" do
+      let(:file) { File.join(tempdir, "new_cookbook", "test", "integration", "default", "serverspec", "default_spec.rb") }
+
+      include_examples "a generated file", :cookbook_name do
+        let(:line) { "describe 'new_cookbook::default' do" }
+      end
+    end
+
     describe "metadata.rb" do
       let(:file) { File.join(tempdir, "new_cookbook", "metadata.rb") }
 
@@ -155,6 +184,14 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       end
     end
 
+    describe "spec/unit/recipes/default_spec.rb" do
+      let(:file) { File.join(tempdir, "new_cookbook", "spec", "unit", "recipes", "default_spec.rb") }
+
+      include_examples "a generated file", :cookbook_name do
+        let(:line) { "describe \'new_cookbook::default\' do" }
+      end
+    end
+
   end
 
   context "when given the path to the cookbook to generate" do
@@ -173,34 +210,6 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
   end
 
-  context "when given a generator-cookbook path" do
-    let(:generator_cookbook_path) { File.join(tempdir, 'a_generator_cookbook') }
-    let(:argv) { ["new_cookbook", "--generator-cookbook", generator_cookbook_path] }
-
-    before do
-      reset_tempdir
-    end
-
-    it "configures the generator context" do
-      cookbook_generator.read_and_validate_params
-      cookbook_generator.setup_context
-      expect(generator_context.cookbook_root).to eq(Dir.pwd)
-      expect(generator_context.cookbook_name).to eq("new_cookbook")
-      expect(cookbook_generator.chef_runner.cookbook_path).to eq(generator_cookbook_path)
-    end
-
-    it "creates a new cookbook" do
-      Dir.chdir(tempdir) do
-        allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
-        cookbook_generator.run
-      end
-      generated_files = Dir.glob("#{tempdir}/new_cookbook/**/*", File::FNM_DOTMATCH)
-      expected_cookbook_files.each do |expected_file|
-        expect(generated_files).to include(expected_file)
-      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 " ] }
 

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

@@ -24,9 +24,11 @@ describe ChefDK::Command::GeneratorCommands::Recipe do
   include_examples "a file generator" do
 
     let(:generator_name) { "recipe" }
-    let(:generated_files) { [ "recipes/new_recipe.rb" ] }
+    let(:generated_files) { [ "recipes/new_recipe.rb",
+                              "spec/spec_helper.rb",
+                              "spec/unit/recipes/new_recipe_spec.rb" ] }
     let(:new_file_name) { "new_recipe" }
 
   end
-end
 
+end

data/spec/unit/command/install_spec.rb

@@ -16,10 +16,13 @@
 #
 
 require 'spec_helper'
+require 'shared/command_with_ui_object'
 require 'chef-dk/command/install'
 
 describe ChefDK::Command::Install do
 
+  it_behaves_like "a command with a UI object"
+
   let(:params) { [] }
 
   let(:command) do
@@ -34,12 +37,6 @@ describe ChefDK::Command::Install do
     expect(command.debug?).to be(false)
   end
 
-  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
-
   context "when debug mode is set" do
 
     let(:params) { [ "-D" ] }

data/spec/unit/command/push_spec.rb

@@ -16,10 +16,13 @@
 #
 
 require 'spec_helper'
+require 'shared/command_with_ui_object'
 require 'chef-dk/command/push'
 
 describe ChefDK::Command::Push do
 
+  it_behaves_like "a command with a UI object"
+
   let(:policy_group) { "dev" }
 
   let(:params) { [policy_group] }
@@ -51,12 +54,6 @@ describe ChefDK::Command::Push do
       expect(command.debug?).to be(false)
     end
 
-    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
-
     describe "when configuring components that depend on chef config" do
 
       before do

data/spec/unit/command/shell_init_spec.rb

@@ -30,84 +30,112 @@ describe ChefDK::Command::ShellInit do
     end
   end
 
-  before do
-    stub_const("File::PATH_SEPARATOR", ':')
-  end
+  shared_context "shell init script" do |shell|
+    let(:user_bin_dir) { File.expand_path(File.join(Gem.user_dir, 'bin')) }
+    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.to_s }
+    let(:expected_gem_home) { Gem.user_dir }
+    let(:expected_gem_path) { Gem.path.join(File::PATH_SEPARATOR) }
+
+    context "with no explicit omnibus directory" do
+
+      let(:omnibus_bin_dir) { "/foo/bin" }
+      let(:omnibus_embedded_bin_dir) { "/foo/embedded/bin" }
+      let(:argv) { [shell] }
+
+      before do
+        allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
+        allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+      end
 
-  let(:argv) { ['bash'] }
+      it "emits a script to add ChefDK's ruby to the shell environment" do
+        command_instance.run(argv)
+        expect(stdout_io.string).to eq(expected_environment_commands)
+      end
+    end
 
-  let(:user_bin_dir) { File.expand_path(File.join(Gem.user_dir, 'bin')) }
+    context "with an explicit omnibus directory as an argument" do
 
-  let(:expected_path) { [omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV['PATH']].join(File::PATH_SEPARATOR) }
+      let(:omnibus_root) { File.join(fixtures_path, "eg_omnibus_dir/valid/") }
+      let(:omnibus_bin_dir) { File.join(omnibus_root, "bin") }
+      let(:omnibus_embedded_bin_dir) { File.join(omnibus_root, "embedded/bin") }
 
-  let(:expected_gem_root) { Gem.default_dir.to_s }
+      let(:argv) { [shell, "--omnibus-dir", omnibus_root] }
 
-  let(:expected_gem_home) { Gem.user_dir }
+      it "emits a script to add ChefDK's ruby to the shell environment" do
+        command_instance.run(argv)
+        expect(stdout_io.string).to eq(expected_environment_commands)
+      end
+    end
+  end
 
-  let(:expected_gem_path) { Gem.path.join(':') }
+  shared_examples "a posix shell script" do |shell|
+    before do
+      stub_const("File::PATH_SEPARATOR", ':')
+    end
 
-  let(:expected_environment_commands) do
-    <<-EOH
-export PATH=#{expected_path}
+    let(:expected_environment_commands) do
+      <<-EOH
+export PATH="#{expected_path}"
 export GEM_ROOT="#{expected_gem_root}"
-export GEM_HOME=#{expected_gem_home}
-export GEM_PATH=#{expected_gem_path}
+export GEM_HOME="#{expected_gem_home}"
+export GEM_PATH="#{expected_gem_path}"
 EOH
+    end
+    include_context "shell init script", shell
   end
 
-  context "with no explicit omnibus directory" do
-
-    let(:omnibus_bin_dir) { "/foo/bin" }
-    let(:omnibus_embedded_bin_dir) { "/foo/embedded/bin" }
-
+  shared_examples "a powershell script" do |shell|
     before do
-      allow(command_instance).to receive(:omnibus_embedded_bin_dir).and_return(omnibus_embedded_bin_dir)
-      allow(command_instance).to receive(:omnibus_bin_dir).and_return(omnibus_bin_dir)
+      stub_const("File::PATH_SEPARATOR", ';')
     end
 
-    it "emits a script to add ChefDK's ruby to the shell environment" do
-      command_instance.run(argv)
-      expect(stdout_io.string).to eq(expected_environment_commands)
+    let(:expected_environment_commands) do
+      <<-EOH
+$env:PATH="#{expected_path}"
+$env:GEM_ROOT="#{expected_gem_root}"
+$env:GEM_HOME="#{expected_gem_home}"
+$env:GEM_PATH="#{expected_gem_path}"
+EOH
     end
+    include_context "shell init script", shell
+  end
 
-    context "when no shell is specified" do
-
-      let(:argv) { [] }
-
-      it "exits with an error message" do
-        expect(command_instance.run(argv)).to eq(1)
-        expect(stderr_io.string).to include("Please specify what shell you are using")
-      end
-
+  ['bash', 'sh', 'zsh'].each do |shell|
+    context "for #{shell}" do
+      it_behaves_like "a posix shell script", shell
     end
+  end
 
-    context "when an unsupported shell is specified" do
+  ['powershell', 'posh'].each do |shell|
+    context "for #{shell}" do
+      it_behaves_like "a powershell script", shell
+    end
+  end
 
-      let(:argv) { ['nosuchsh'] }
+  context "when no shell is specified" do
 
-      it "exits with an error message" do
-        expect(command_instance.run(argv)).to eq(1)
-        expect(stderr_io.string).to include("Shell `nosuchsh' is not currently supported")
-        expect(stderr_io.string).to include("Supported shells are: bash zsh sh")
-      end
+    let(:argv) { [] }
 
+    it "exits with an error message" do
+      expect(command_instance.run(argv)).to eq(1)
+      expect(stderr_io.string).to include("Please specify what shell you are using")
     end
 
   end
 
-  context "with an explicit omnibus directory as an argument" do
+  context "when an unsupported shell is specified" do
 
-    let(:omnibus_root) { File.join(fixtures_path, "eg_omnibus_dir/valid/") }
-    let(:omnibus_bin_dir) { File.join(omnibus_root, "bin") }
-    let(:omnibus_embedded_bin_dir) { File.join(omnibus_root, "embedded/bin") }
+    let(:argv) { ['nosuchsh'] }
 
-    let(:argv) { ["bash", "--omnibus-dir", omnibus_root] }
-
-    it "emits a script to add ChefDK's ruby to the shell environment" do
-      command_instance.run(argv)
-      expect(stdout_io.string).to eq(expected_environment_commands)
+    it "exits with an error message" do
+      expect(command_instance.run(argv)).to eq(1)
+      expect(stderr_io.string).to include("Shell `nosuchsh' is not currently supported")
+      expect(stderr_io.string).to include("Supported shells are: bash zsh sh powershell posh")
     end
+
   end
 
+
 end