chef-dk 3.11.3 → 3.12.0

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

@@ -7,26 +7,20 @@
 require 'spec_helper'
 
 describe '<%= cookbook_name %>::<%= recipe_name %>' do
-  context 'When all attributes are default, on Ubuntu 16.04' do
-    let(:chef_run) do
-      # for a complete list of available platforms and versions see:
-      # https://github.com/customink/fauxhai/blob/master/PLATFORMS.md
-      runner = ChefSpec::ServerRunner.new(platform: 'ubuntu', version: '16.04')
-      runner.converge(described_recipe)
-    end
+  context 'When all attributes are default, on Ubuntu 18.04' do
+    # for a complete list of available platforms and versions see:
+    # https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md
+    platform 'ubuntu', '18.04'
 
     it 'converges successfully' do
       expect { chef_run }.to_not raise_error
     end
   end
 
-  context 'When all attributes are default, on CentOS 7.4.1708' do
-    let(:chef_run) do
-      # for a complete list of available platforms and versions see:
-      # https://github.com/customink/fauxhai/blob/master/PLATFORMS.md
-      runner = ChefSpec::ServerRunner.new(platform: 'centos', version: '7.4.1708')
-      runner.converge(described_recipe)
-    end
+  context 'When all attributes are default, on CentOS 7' do
+    # for a complete list of available platforms and versions see:
+    # https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md
+    platform 'centos', '7'
 
     it 'converges successfully' do
       expect { chef_run }.to_not raise_error

data/lib/chef-dk/skeletons/code_generator/templates/default/repo/gitignore.erb

@@ -52,33 +52,33 @@ nodes
 # tmp/*
 # public/system/*
 
-# ##nodejs
+# ## nodejs
 # node_modules
 
-# # Nuget (exclude all exes except for the one in the global build folder)
+# ## Nuget (exclude all exes except for the one in the global build folder)
 # nuget.exe
 # !build/nuget/nuget.exe
 # *.nupkg
 # # NuGet packages (based on default naming convention)
 # [Bb]uild/[Pp]ackages/
 
-# # Build System # common build output folders
+# ## Build System # common build output folders
 # build-common/
 # output/
 
-# ## Probably not a good idea to be keeing VM inages in source control
+# ## VM images
 # *.vhd
 # *.vhdx
 
 # ## Pester Test summary
 # Test.xml
 
-# ##Webstorm files
+# ## JetBrains files
 # *.idea
 # .idea
 # .idea/
 
-# ##Mono (or something?) files
+# ## Mono files
 # *.pidb
 # *.userprefs
 
@@ -114,14 +114,14 @@ nodes
 # [Rr]elease*/
 # Ankh.NoLoad
 
-# ##Tooling
+# ## Tooling
 # _ReSharper*/
 # *.[Rr]e[Ss]harper
 # [Tt]est[Rr]esult*
 # .[Jj]ust[Cc]ode
 # *ncrunch*
 
-# ##Subversion files
+# ## Subversion files
 # .svn
 
 # ## Office Temp Files

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "3.11.3".freeze
+  VERSION = "3.12.0".freeze
 end

data/spec/spec_helper.rb

@@ -48,4 +48,8 @@ RSpec.configure do |c|
     mocks.verify_partial_doubles = true
   end
 
+  # better diffs when expects fail
+  c.expect_with :rspec do |r|
+    r.max_formatted_output_length = 400
+  end
 end

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

@@ -29,7 +29,7 @@ describe ChefDK::Command::GeneratorCommands::App do
   let(:expected_cookbook_file_relpaths) do
     %w{
       .gitignore
-      .kitchen.yml
+      kitchen.yml
       test
       test/integration
       test/integration/default
@@ -50,7 +50,7 @@ describe ChefDK::Command::GeneratorCommands::App do
 
   let(:expected_cookbook_files) do
     expected_cookbook_file_relpaths.map do |relpath|
-      File.join(tempdir, "new_app", relpath)
+      File.join(Dir["#{tempdir}"], "new_app", relpath)
     end
   end
 
@@ -121,8 +121,8 @@ describe ChefDK::Command::GeneratorCommands::App do
         end
       end
 
-      describe ".kitchen.yml" do
-        let(:file) { File.join(tempdir, "new_app", ".kitchen.yml") }
+      describe "kitchen.yml" do
+        let(:file) { File.join(tempdir, "new_app", "kitchen.yml") }
 
         include_examples "a generated file", :cookbook_name do
           let(:line) { /\s*- recipe\[new_app::default\]/ }

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

@@ -32,7 +32,7 @@ describe ChefDK::Command::GeneratorCommands::BuildCookbook do
 
   let(:expected_cookbook_file_relpaths) do
     %w{
-      .kitchen.yml
+      kitchen.yml
       data_bags
       data_bags/keys
       data_bags/keys/delivery_builder_keys.json
@@ -67,7 +67,7 @@ describe ChefDK::Command::GeneratorCommands::BuildCookbook do
 
   let(:expected_cookbook_files) do
     expected_cookbook_file_relpaths.map do |relpath|
-      File.join(tempdir, "delivery_project", ".delivery", "build_cookbook", relpath)
+      File.join(Dir["#{tempdir}"], "delivery_project", ".delivery", "build_cookbook", relpath)
     end
   end
 
@@ -162,9 +162,9 @@ describe ChefDK::Command::GeneratorCommands::BuildCookbook do
           end
         end
 
-        let(:file) { File.join(tempdir, "delivery_project", ".delivery", "build_cookbook", ".kitchen.yml") }
+        let(:file) { File.join(tempdir, "delivery_project", ".delivery", "build_cookbook", "kitchen.yml") }
 
-        it "creates a .kitchen.yml with the expected content" do
+        it "creates a kitchen.yml with the expected content" do
           expect(IO.read(file)).to eq(expected_kitchen_yml_content)
         end
 

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

@@ -24,7 +24,7 @@ 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(:generated_files) { [ "files/new_file.txt" ] }
     let(:new_file_name) { "new_file.txt" }
 
   end

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

@@ -32,7 +32,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
   let(:expected_cookbook_file_relpaths) do
     %w{
       .gitignore
-      .kitchen.yml
+      kitchen.yml
       test
       test/integration
       test/integration/default/default_test.rb
@@ -54,7 +54,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
   let(:expected_cookbook_files) do
     expected_cookbook_file_relpaths.map do |relpath|
-      File.join(tempdir, "new_cookbook", relpath)
+      File.join(Dir["#{tempdir}"], "new_cookbook", relpath)
     end
   end
 
@@ -63,9 +63,9 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       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.
+      Type `delivery local --help` to see a full list of local testing commands.
 
-      Why not start by writing a test? Tests for the default recipe are stored at:
+      Why not start by writing an InSpec test? Tests for the default recipe are stored at:
 
       test/integration/default/default_test.rb
 
@@ -180,18 +180,15 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         let(:expected_content) do
           <<~PROJECT_DOT_TOML
-            # Delivery Prototype for Local Phases Execution
+            # Delivery 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.
+            # This file allows you to execute test phases locally on a workstation or
+            # in a CI pipeline. 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 = "chef exec rspec spec/"
@@ -211,9 +208,10 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
             # Remote project.toml file
             #
-            # Specify a remote URI location for the `project.toml` file.
-            # This is useful for teams that wish to centrally manage the behavior
-            # of the `delivery local` command across many different projects.
+            # Instead of the local phases above, you may specify a remote URI location for
+            # the `project.toml` file. This is useful for teams that wish to centrally
+            # manage the behavior of the `delivery local` command across many different
+            # projects.
             #
             # remote_file = "https://url/project.toml"
           PROJECT_DOT_TOML
@@ -270,6 +268,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
             # Recipe:: publish
             #
             # Copyright:: 2019, The Authors, All Rights Reserved.
+
             include_recipe 'delivery-truck::publish'
           CONFIG_DOT_JSON
         end
@@ -360,7 +359,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         expected = <<~OUTPUT
           Generating cookbook new_cookbook
-          - Ensuring correct cookbook file content
+          - Ensuring correct cookbook content
           - Committing cookbook files to git
           - Ensuring delivery configuration
           - Ensuring correct delivery build cookbook content
@@ -412,7 +411,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         expected = <<~OUTPUT
           Generating cookbook new_cookbook
-          - Ensuring correct cookbook file content
+          - Ensuring correct cookbook content
           - Committing cookbook files to git
           - Ensuring delivery configuration
           - Ensuring correct delivery build cookbook content
@@ -475,9 +474,9 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
             end
           end
 
-          let(:file) { File.join(tempdir, "new_cookbook", ".kitchen.yml") }
+          let(:file) { File.join(tempdir, "new_cookbook", "kitchen.yml") }
 
-          it "creates a .kitchen.yml with the expected content" do
+          it "creates a kitchen.yml with the expected content" do
             expect(IO.read(file)).to eq(expected_kitchen_yml_content)
           end
 
@@ -526,7 +525,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         let(:expected_content) do
           <<~POLICYFILE_RB
-            # Policyfile.rb - Describe how you want Chef to build your system.
+            # Policyfile.rb - Describe how you want Chef Infra Client to build your system.
             #
             # For more information on the Policyfile feature, visit
             # https://docs.chef.io/policyfile.html
@@ -568,7 +567,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
             ## The forwarded_port port feature lets you connect to ports on the VM guest via
             ## localhost on the host.
-            ## see also: https://docs.vagrantup.com/v2/networking/forwarded_ports.html
+            ## see also: https://www.vagrantup.com/docs/networking/forwarded_ports.html
 
             #  network:
             #    - ["forwarded_port", {guest: 80, host: 8080}]
@@ -576,17 +575,16 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
             provisioner:
               name: chef_zero
 
-            ## require_chef_omnibus specifies a specific chef version to install. You can
-            ## also set this to `true` to always use the latest version.
-            ## see also: https://docs.chef.io/config_yml_kitchen.html
-
-            #  require_chef_omnibus: 12.8.1
+              ## product_name and product_version specifies a specific Chef product and version to install.
+              ## see the Chef documentation for more details: https://docs.chef.io/config_yml_kitchen.html
+              #  product_name: chef
+              #  product_version: 14
 
             verifier:
               name: inspec
 
             platforms:
-              - name: ubuntu-16.04
+              - name: ubuntu-18.04
               - name: centos-7
 
             suites:
@@ -604,7 +602,6 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         let(:expected_chefspec_spec_helper_content) do
           <<~SPEC_HELPER
-            # frozen_string_literal: true
             require 'chefspec'
             require 'chefspec/policyfile'
           SPEC_HELPER
@@ -624,7 +621,6 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         let(:expected_content) do
           <<~POLICYFILE_RB
-            # frozen_string_literal: true
             source 'https://supermarket.chef.io'
 
             metadata
@@ -652,6 +648,13 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
             driver:
               name: vagrant
 
+            ## The forwarded_port port feature lets you connect to ports on the VM guest via
+            ## localhost on the host.
+            ## see also: https://www.vagrantup.com/docs/networking/forwarded_ports.html
+
+            #  network:
+            #    - ["forwarded_port", {guest: 80, host: 8080}]
+
             provisioner:
               name: chef_zero
               # You may wish to disable always updating cookbooks in CI or other testing environments.
@@ -659,11 +662,16 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
               #   always_update_cookbooks: <%= !ENV['CI'] %>
               always_update_cookbooks: true
 
+              ## product_name and product_version specifies a specific Chef product and version to install.
+              ## see the Chef documentation for more details: https://docs.chef.io/config_yml_kitchen.html
+              #  product_name: chef
+              #  product_version: 14
+
             verifier:
               name: inspec
 
             platforms:
-              - name: ubuntu-16.04
+              - name: ubuntu-18.04
               - name: centos-7
 
             suites:
@@ -683,7 +691,6 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
 
         let(:expected_chefspec_spec_helper_content) do
           <<~SPEC_HELPER
-            # frozen_string_literal: true
             require 'chefspec'
             require 'chefspec/berkshelf'
           SPEC_HELPER

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

@@ -59,14 +59,14 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
     let(:argv) { [] }
 
     let(:expected_files_full_paths) do
-      expected_files_relpaths.map { |p| File.join(tempdir, "code_generator", p) }
+      expected_files_relpaths.map { |p| File.join(Dir["#{tempdir}"], "code_generator", p) }
     end
 
     it "creates a copy of code_generator in the CWD" do
       Dir.chdir(tempdir) do
         expect(generator_generator.run).to eq(0)
       end
-      base_path = File.join(tempdir, "code_generator")
+      base_path = File.join(Dir["#{tempdir}"], "code_generator")
       expect(actual_files(base_path)).to match_array(expected_files_full_paths)
     end
 
@@ -105,7 +105,7 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
 
         it "fails" do
           expect(generator_generator.run).to eq(1)
-          expect(actual_files(tempdir)).to eq([ conflicting_dir ])
+          expect(actual_files(tempdir)).to eq(Dir["#{conflicting_dir}"])
 
           expected_msg = "ERROR: file or directory #{conflicting_dir} exists.\n"
 
@@ -116,7 +116,7 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
       context "and there isn't a directory named code_generator in that directory" do
 
         let(:expected_files_full_paths) do
-          expected_files_relpaths.map { |p| File.join(tempdir, "code_generator", p) }
+          expected_files_relpaths.map { |p| File.join(Dir["#{tempdir}"], "code_generator", p) }
         end
 
         it "names the cookbook code_generator" do
@@ -127,7 +127,7 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
         it "copies the code_generator to GIVEN_DIR/code_generator" do
           expect(generator_generator.run).to eq(0)
 
-          base_path = File.join(tempdir, "code_generator")
+          base_path = File.join(Dir["#{tempdir}"], "code_generator")
           expect(actual_files(base_path)).to match_array(expected_files_full_paths)
         end
       end
@@ -136,7 +136,7 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
 
     context "when the path is a regular file" do
 
-      let(:conflicting_file) { File.join(tempdir, "roadblock") }
+      let(:conflicting_file) { File.join(Dir["#{tempdir}"], "roadblock") }
 
       let(:argv) { [ conflicting_file ] }
 
@@ -157,7 +157,7 @@ describe ChefDK::Command::GeneratorCommands::GeneratorGenerator do
 
     context "when the last element of the given path doesn't exist" do
 
-      let(:target_dir) { File.join(tempdir, "my_cool_generator") }
+      let(:target_dir) { File.join(Dir["#{tempdir}"], "my_cool_generator") }
 
       let(:argv) { [ target_dir ] }