chef-dk 0.15.16 → 0.16.28

data/spec/unit/command/generator_commands/chef_exts/recipe_dsl_ext_spec.rb

@@ -0,0 +1,111 @@
+#
+# Copyright:: Copyright (c) 2016 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 'stringio'
+
+require 'chef/config'
+require 'chef/recipe'
+require 'chef/run_context'
+require 'chef/event_dispatch/dispatcher'
+require 'chef/policy_builder'
+require 'chef/formatters/doc'
+require 'chef/cookbook/file_vendor'
+require 'chef/cookbook/file_system_file_vendor'
+require 'chef/cookbook/cookbook_collection'
+require 'chef/cookbook_loader'
+
+require 'ohai/system'
+
+require 'chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext'
+require 'chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter'
+
+describe ChefDK::RecipeDSLExt do
+
+  before(:all) { Chef.reset! }
+
+  let(:stdout) { StringIO.new }
+
+  let(:stderr) { StringIO.new }
+
+  let(:doc_formatter) do
+    Chef::Formatters.new(:chefdk_doc, stdout, stderr)
+  end
+
+  let(:event_dispatcher) do
+    Chef::EventDispatch::Dispatcher.new.tap do |d|
+      d.register(doc_formatter)
+    end
+  end
+
+  let(:run_list) { [ ] }
+
+  let(:ohai) do
+    Ohai::System.new.tap do |o|
+      o.all_plugins(["platform", "platform_version"])
+    end
+  end
+
+  let(:policy_builder) do
+    Chef::PolicyBuilder::Dynamic.new("chef-dk", ohai.data, {}, nil, event_dispatcher).tap do |b|
+      b.load_node
+      b.build_node
+      b.node.run_list(*run_list)
+      b.expand_run_list
+    end
+  end
+
+  # In some circumstances (not totally clear about what), compat resource gets
+  # loaded and it does some weird stuff to `Chef::Recipe.new` which can fail if
+  # you pass in a cookbook name that is bogus and not-falsey. Using `nil` for
+  # the cookbook name works around that.
+  # https://github.com/chef-cookbooks/compat_resource/blob/3d948a5a9cabccddc7cf5e48dfea796a6b557a44/files/lib/chef_compat/monkeypatches/chef/recipe.rb#L8-L15
+  let(:cookbook_name) { nil }
+
+  let(:recipe_name) { "example" }
+
+  let(:run_context) { policy_builder.setup_run_context }
+
+  let(:recipe) { Chef::Recipe.new(cookbook_name, recipe_name, run_context) }
+
+  before do
+    Chef::Config.solo_legacy_mode = true
+    Chef::Config.color = true
+    Chef::Config.diff_disabled = true
+    Chef::Config.use_policyfile = false
+  end
+
+  describe "silence_chef_formatter" do
+
+    before do
+      recipe.silence_chef_formatter
+    end
+
+    let(:formatter) { run_context.events.subscribers.first }
+
+    it "replaces the default formatter with a null formatter" do
+      expect(formatter).to be_a(Chef::Formatters::NullFormatter)
+    end
+
+    it "passes stdout and stderr from the default formatter to the new one" do
+      expect(formatter.output.out).to be(stdout)
+      expect(formatter.output.err).to be(stderr)
+    end
+
+  end
+
+end

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

@@ -1,32 +1,32 @@
-#
-# 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/cookbook_file'
-
-describe ChefDK::Command::GeneratorCommands::CookbookFile do
-
-  include_examples "a file generator" do
-
-    let(:generator_name) { "file" }
-    let(:generated_files) { [ "files/default/new_file.txt" ] }
-    let(:new_file_name) { "new_file.txt" }
-
-  end
-end
-
+#
+# 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/cookbook_file'
+
+describe ChefDK::Command::GeneratorCommands::CookbookFile do
+
+  include_examples "a file generator" do
+
+    let(:generator_name) { "file" }
+    let(:generated_files) { [ "files/default/new_file.txt" ] }
+    let(:new_file_name) { "new_file.txt" }
+
+  end
+end
+

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

@@ -34,11 +34,8 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       .gitignore
       .kitchen.yml
       test
-      test/integration
-      test/integration/default
-      test/integration/default/serverspec
-      test/integration/default/serverspec/default_spec.rb
-      test/integration/helpers/serverspec/spec_helper.rb
+      test/recipes
+      test/recipes/default_test.rb
       Berksfile
       chefignore
       metadata.rb
@@ -59,6 +56,23 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
     end
   end
 
+    let(:non_delivery_breadcrumb) do
+<<-EOF
+Your cookbook is ready. Type `cd new_cookbook` to enter it.
+
+There are several commands you can run to get started locally developing and testing your cookbook.
+Type `delivery local --help` to see a full list.
+
+Why not start by writing a test? Tests for the default recipe are stored at:
+
+test/recipes/default_test.rb
+
+If you'd prefer to dive right in, the default recipe can be found at:
+
+recipes/default.rb
+EOF
+   end
+
   subject(:cookbook_generator) do
     g = described_class.new(argv)
     allow(g).to receive(:cookbook_path_in_git_repo?).and_return(false)
@@ -112,6 +126,12 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       expect(stderr_io.string).to include(message)
     end
 
+    it "errors if a hyphenated cookbook name is passed" do
+      expect(with_argv(%w{my-cookbook}).run).to eq(1)
+      message = "Hyphens are not allowed in cookbook names. Please specify a cookbook name without hyphens."
+      expect(stderr_io.string).to include(message)
+    end
+
   end
 
   context "when given the name of the cookbook to generate" do
@@ -128,6 +148,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       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")
+      expect(generator_context.verbose).to be(false)
     end
 
     it "creates a new cookbook" do
@@ -141,6 +162,263 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       end
     end
 
+    context "by default configure for delivery" do
+
+      let(:dot_delivery) { File.join(tempdir, "new_cookbook", ".delivery") }
+
+      before do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+      end
+
+      describe ".delivery/project.toml" do
+
+        let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "project.toml") }
+
+        let(:expected_content) do
+          <<-PROJECT_DOT_TOML
+# Delivery Prototype for Local Phases Execution
+#
+# The purpose of this file is to prototype a new way to execute
+# phases locally on your workstation. The delivery-cli will read
+# this file and execute the command(s) that are configured for
+# each phase. You can customize them by just modifying the phase
+# key on this file.
+#
+# By default these phases are configured for Cookbook Workflow only
+#
+# As this is still a prototype we are not modifying the current
+# config.json file and it will continue working as usual. 
+
+[local_phases]
+unit = "rspec spec/"
+lint = "cookstyle"
+syntax = "foodcritic . --exclude spec -f any"
+provision = "chef exec kitchen create"
+deploy = "chef exec kitchen converge"
+smoke = "chef exec kitchen verify"
+cleanup = "chef exec kitchen destroy"
+  PROJECT_DOT_TOML
+        end
+
+        it "exists with default config for Cookbook Workflow" do
+          expect(IO.read(file)).to eq(expected_content)
+        end
+
+      end
+
+      describe ".delivery/config.json" do
+
+        let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "config.json") }
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+{
+  "version": "2",
+  "build_cookbook": {
+    "name": "build_cookbook",
+    "path": ".delivery/build_cookbook"
+  },
+  "skip_phases": [],
+  "build_nodes": {},
+  "dependencies": []
+}
+  CONFIG_DOT_JSON
+        end
+
+        it "configures delivery to use a local build cookbook" do
+          expect(IO.read(file)).to eq(expected_content)
+        end
+
+      end
+
+      describe "build cookbook recipes" do
+
+        let(:file) do
+          File.join(dot_delivery, "build_cookbook", "recipes", "publish.rb")
+        end
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+#
+# Cookbook Name:: build_cookbook
+# Recipe:: publish
+#
+# Copyright (c) 2016 The Authors, All Rights Reserved.
+include_recipe 'delivery-truck::publish'
+  CONFIG_DOT_JSON
+        end
+
+        it "delegates functionality to delivery-truck" do
+          expect(IO.read(file)).to include(expected_content)
+        end
+
+      end
+
+      describe "build cookbook Berksfile" do
+
+        let(:file) do
+          File.join(dot_delivery, "build_cookbook", "Berksfile")
+        end
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+source 'https://supermarket.chef.io'
+
+metadata
+
+cookbook 'delivery-truck',
+  git: 'https://github.com/chef-cookbooks/delivery-truck.git',
+  branch: 'master'
+
+# This is so we know where to get delivery-truck's dependency
+cookbook 'delivery-sugar',
+  git: 'https://github.com/chef-cookbooks/delivery-sugar.git',
+  branch: 'master'
+
+group :delivery do
+  cookbook 'delivery_build', git: 'https://github.com/chef-cookbooks/delivery_build'
+  cookbook 'delivery-base', git: 'https://github.com/chef-cookbooks/delivery-base'
+  cookbook 'test', path: './test/fixtures/cookbooks/test'
+end
+  CONFIG_DOT_JSON
+        end
+
+        it "sets the sources for delivery library cookbooks to github" do
+         expect(IO.read(file)).to include(expected_content)
+        end
+
+      end
+    end
+
+    context "when passed delivery option" do
+
+      let(:argv) { %w[new_cookbook --delivery] }
+
+      it 'still works with no action' do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+      end
+    end
+
+    context "when given the verbose flag" do
+
+      let(:argv) { %w[ new_cookbook --verbose ] }
+
+      it "configures the generator context with verbose mode enabled" do
+        cookbook_generator.read_and_validate_params
+        cookbook_generator.setup_context
+        expect(generator_context.verbose).to be(true)
+      end
+
+      it "emits verbose output" do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+
+        # The normal chef formatter puts a heading for each recipe like this.
+        # Full output is large and subject to change with minor changes in the
+        # generator cookbook, so we just look for this line
+        expected_line = "Recipe: code_generator::cookbook"
+
+        actual = stdout_io.string
+
+        expect(actual).to include(expected_line)
+      end
+    end
+
+    context "when no delivery CLI configuration is present" do
+
+      it "detects no delivery config" do
+        Dir.chdir(tempdir) do
+          expect(cookbook_generator.have_delivery_config?).to be(false)
+        end
+      end
+
+      it "emits concise output" do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+
+        expected = <<-OUTPUT
+Generating cookbook new_cookbook
+- Ensuring correct cookbook file content
+- Committing cookbook files to git
+- Ensuring delivery configuration
+- Ensuring correct delivery build cookbook content
+- Adding delivery configuration to feature branch
+- Adding build cookbook to feature branch
+- Merging delivery content feature branch to master
+
+#{non_delivery_breadcrumb}
+OUTPUT
+
+        actual = stdout_io.string
+
+        # the formatter will add escape sequences to turn off any colors
+        actual.gsub!("\e[0m", "")
+        expect(actual).to eq(expected)
+      end
+    end
+
+    context "when a delivery CLI config is present" do
+
+      # Setup a situation like this:
+      # there is a dir for the delivery organization with the
+      # `.delivery/cli.toml` in it. Inside that is another dir (maybe IRL this
+      # would be "cookbooks"), then we create the cookbook inside that.
+
+      let(:tempdir_subdir) { File.join(tempdir, "subdirectory") }
+
+      let(:dot_delivery_dir) { File.join(tempdir, ".delivery") }
+
+      let(:dot_delivery_cli_toml) { File.join(dot_delivery_dir, "cli.toml") }
+
+      before do
+        Dir.mkdir(tempdir_subdir)
+        Dir.mkdir(dot_delivery_dir)
+        FileUtils.touch(dot_delivery_cli_toml)
+      end
+
+      it "detects the delivery config" do
+        Dir.chdir(tempdir_subdir) do
+          expect(cookbook_generator.have_delivery_config?).to be(true)
+        end
+      end
+
+      it "emits concise output" do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+
+        expected = <<-OUTPUT
+Generating cookbook new_cookbook
+- Ensuring correct cookbook file content
+- Committing cookbook files to git
+- Ensuring delivery configuration
+- Ensuring correct delivery build cookbook content
+- Adding delivery configuration to feature branch
+- Adding build cookbook to feature branch
+- Merging delivery content feature branch to master
+
+Your cookbook is ready. To setup the pipeline, type `cd new_cookbook`, then run `delivery init`
+OUTPUT
+
+        actual = stdout_io.string
+
+        # the formatter will add escape sequences to turn off any colors
+        actual.gsub!("\e[0m", "")
+        expect(actual).to eq(expected)
+      end
+    end
+
     shared_examples_for "a generated file" do |context_var|
       before do
         Dir.chdir(tempdir) do
@@ -185,11 +463,11 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         end
 
-        describe "test/integration/default/serverspec/default_spec.rb" do
-          let(:file) { File.join(tempdir, "new_cookbook", "test", "integration", "default", "serverspec", "default_spec.rb") }
+        describe "test/recipes/default_test.rb" do
+          let(:file) { File.join(tempdir, "new_cookbook", "test", "recipes", "default_test.rb") }
 
           include_examples "a generated file", :cookbook_name do
-            let(:line) { "describe 'new_cookbook::default' do" }
+            let(:line) { "describe port" }
           end
         end
       end
@@ -284,11 +562,8 @@ provisioner:
 
 #  require_chef_omnibus: 12.8.1
 
-# Uncomment the following verifier to leverage Inspec instead of Busser (the
-# default verifier)
-# verifier:
-#   name: inspec
-#   format: doc
+verifier:
+  name: inspec
 
 platforms:
   - name: ubuntu-16.04
@@ -355,11 +630,8 @@ driver:
 provisioner:
   name: chef_zero
 
-# Uncomment the following verifier to leverage Inspec instead of Busser (the
-# default verifier)
-# verifier:
-#   name: inspec
-#   format: doc
+verifier:
+  name: inspec
 
 platforms:
   - name: ubuntu-16.04
@@ -388,98 +660,6 @@ SPEC_HELPER
 
     end
 
-    context "when configured for delivery" do
-
-      let(:argv) { %w[new_cookbook --delivery] }
-
-      let(:dot_delivery) { File.join(tempdir, "new_cookbook", ".delivery") }
-
-      before do
-        Dir.chdir(tempdir) do
-          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
-          expect(cookbook_generator.run).to eq(0)
-        end
-      end
-
-      describe ".delivery/config.json" do
-
-        let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "config.json") }
-
-        let(:expected_content) do
-          <<-CONFIG_DOT_JSON
-{
-  "version": "2",
-  "build_cookbook": {
-    "name": "build-cookbook",
-    "path": ".delivery/build-cookbook"
-  },
-  "skip_phases": [],
-  "build_nodes": {},
-  "dependencies": []
-}
-CONFIG_DOT_JSON
-        end
-
-        it "configures delivery to use a local build cookbook" do
-          expect(IO.read(file)).to eq(expected_content)
-        end
-
-      end
-
-      describe "build cookbook recipes" do
-
-        let(:file) do
-          File.join(dot_delivery, "build-cookbook", "recipes", "publish.rb")
-        end
-
-        let(:expected_content) do
-          <<-CONFIG_DOT_JSON
-include_recipe 'delivery-truck::publish'
-CONFIG_DOT_JSON
-        end
-
-        it "delegates functionality to delivery-truck" do
-          expect(IO.read(file)).to include(expected_content)
-        end
-
-      end
-
-      describe "build cookbook Berksfile" do
-
-        let(:file) do
-          File.join(dot_delivery, "build-cookbook", "Berksfile")
-        end
-
-        let(:expected_content) do
-          <<-CONFIG_DOT_JSON
-source 'https://supermarket.chef.io'
-
-metadata
-
-cookbook 'delivery-truck',
-  git: 'https://github.com/chef-cookbooks/delivery-truck.git',
-  branch: 'master'
-
-# This is so we know where to get delivery-truck's dependency
-cookbook 'delivery-sugar',
-  git: 'https://github.com/chef-cookbooks/delivery-sugar.git',
-  branch: 'master'
-
-group :delivery do
-  cookbook 'delivery_build', git: 'https://github.com/chef-cookbooks/delivery_build'
-  cookbook 'delivery-base', git: 'https://github.com/chef-cookbooks/delivery-base'
-  cookbook 'test', path: './test/fixtures/cookbooks/test'
-end
-CONFIG_DOT_JSON
-        end
-
-        it "sets the sources for delivery library cookbooks to github" do
-          expect(IO.read(file)).to include(expected_content)
-        end
-
-      end
-    end
-
     describe "metadata.rb" do
       let(:file) { File.join(tempdir, "new_cookbook", "metadata.rb") }
 
@@ -500,7 +680,7 @@ CONFIG_DOT_JSON
       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" }
+        let(:line) { "describe 'new_cookbook::default' do" }
       end
     end