chef: Use test/smoke/default instead of test/recipes for generated cookbooks/recipes

RELEASE_NOTES.md

@@ -1 +1,7 @@
 # ChefDK 1.1 Release notes
+
+## New Inspec Test Location
+To address bugs and confusion with the previous `test/recipes` location, all newly generated
+cookbooks and recipes will place their Inspec tests in `test/smoke/default`. This
+placement creates the association of the `smoke` Workflow phase and the `default` Kitchen suite
+where the tests are run.

lib/chef-dk/command/generator_commands/cookbook.rb

@@ -105,7 +105,7 @@ def emit_post_create_message
             msg("\nThere are several commands you can run to get started locally developing and testing your cookbook.")
             msg("Type `delivery local --help` to see a full list.")
             msg("\nWhy not start by writing a test? Tests for the default recipe are stored at:\n")
-            msg("test/recipes/default_test.rb")
+            msg("test/smoke/default/default_test.rb")
             msg("\nIf you'd prefer to dive right in, the default recipe can be found at:")
             msg("\nrecipes/default.rb\n")
           end

lib/chef-dk/skeletons/code_generator/recipes/app.rb

@@ -17,11 +17,11 @@
 end
 
 # Inspec
-directory "#{app_dir}/test/recipes" do
+directory "#{app_dir}/test/smoke/default" do
   recursive true
 end
 
-template "#{app_dir}/test/recipes/default_test.rb" do
+template "#{app_dir}/test/smoke/default/default_test.rb" do
   source 'inspec_default_test.rb.erb'
   helpers(ChefDK::Generator::TemplateHelper)
   action :create_if_missing

lib/chef-dk/skeletons/code_generator/recipes/cookbook.rb

@@ -55,11 +55,11 @@
 end
 
 # Inspec
-directory "#{cookbook_dir}/test/recipes" do
+directory "#{cookbook_dir}/test/smoke/default" do
   recursive true
 end
 
-template "#{cookbook_dir}/test/recipes/default_test.rb" do
+template "#{cookbook_dir}/test/smoke/default/default_test.rb" do
   source 'inspec_default_test.rb.erb'
   helpers(ChefDK::Generator::TemplateHelper)
   action :create_if_missing

lib/chef-dk/skeletons/code_generator/recipes/recipe.rb

@@ -3,11 +3,23 @@
 cookbook_dir = File.join(context.cookbook_root, context.cookbook_name)
 recipe_path = File.join(cookbook_dir, "recipes", "#{context.new_file_basename}.rb")
 spec_helper_path = File.join(cookbook_dir, "spec", "spec_helper.rb")
-spec_path = File.join(cookbook_dir, "spec", "unit", "recipes", "#{context.new_file_basename}_spec.rb")
-inspec_path = File.join(cookbook_dir, "test", "recipes", "#{context.new_file_basename}.rb")
+spec_dir = File.join(cookbook_dir, "spec", "unit", "recipes")
+spec_path = File.join(spec_dir, "#{context.new_file_basename}_spec.rb")
+inspec_dir = File.join(cookbook_dir, "test", "smoke", "default")
+inspec_path = File.join(inspec_dir, "#{context.new_file_basename}.rb")
+
+if File.directory?(File.join(cookbook_dir, "test", "recipes"))
+  Chef::Log.deprecation <<-EOH
+It appears that you have Inspec tests located at "test/recipes". This location can
+cause issues with Foodcritic and has been deprecated in favor of "test/smoke/default".
+Please move your existing Inspec tests to the newly created "test/smoke/default"
+directory, and update the 'inspec_tests' value in your .kitchen.yml file(s) to
+point to "test/smoke/default".
+  EOH
+end
 
 # Chefspec
-directory "#{cookbook_dir}/spec/unit/recipes" do
+directory spec_dir do
   recursive true
 end
 
@@ -22,7 +34,7 @@
 end
 
 # Inspec
-directory "#{cookbook_dir}/test/recipes" do
+directory inspec_dir do
   recursive true
 end
 
@@ -37,4 +49,3 @@
   source "recipe.rb.erb"
   helpers(ChefDK::Generator::TemplateHelper)
 end
-

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

@@ -22,5 +22,5 @@ suites:
       - recipe[<%= cookbook_name %>::default]
     verifier:
       inspec_tests:
-        - test/recipes
+        - test/smoke/default
     attributes:

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

@@ -29,5 +29,5 @@ suites:
   - name: default
     verifier:
       inspec_tests:
-        - test/recipes
+        - test/smoke/default
     attributes:

spec/unit/command/generator_commands/app_spec.rb

@@ -31,8 +31,9 @@
       .gitignore
       .kitchen.yml
       test
-      test/recipes
-      test/recipes/default_test.rb
+      test/smoke
+      test/smoke/default
+      test/smoke/default/default_test.rb
       README.md
       cookbooks/new_app/Berksfile
       cookbooks/new_app/chefignore
@@ -128,8 +129,8 @@ def generator_context
         end
       end
 
-      describe "test/recipes/default_test.rb" do
-        let(:file) { File.join(tempdir, "new_app", "test", "recipes", "default_test.rb") }
+      describe "test/smoke/default/default_test.rb" do
+        let(:file) { File.join(tempdir, "new_app", "test", "smoke", "default", "default_test.rb") }
 
         include_examples "a generated file", :cookbook_name do
           let(:line) { "describe port" }
@@ -163,4 +164,3 @@ def generator_context
     end
   end
 end
-

spec/unit/command/generator_commands/cookbook_spec.rb

@@ -34,8 +34,8 @@
       .gitignore
       .kitchen.yml
       test
-      test/recipes
-      test/recipes/default_test.rb
+      test/smoke
+      test/smoke/default/default_test.rb
       Berksfile
       chefignore
       metadata.rb
@@ -65,7 +65,7 @@
 
 Why not start by writing a test? Tests for the default recipe are stored at:
 
-test/recipes/default_test.rb
+test/smoke/default/default_test.rb
 
 If you'd prefer to dive right in, the default recipe can be found at:
 
@@ -460,8 +460,8 @@ def with_argv(argv)
 
         end
 
-        describe "test/recipes/default_test.rb" do
-          let(:file) { File.join(tempdir, "new_cookbook", "test", "recipes", "default_test.rb") }
+        describe "test/smoke/default/default_test.rb" do
+          let(:file) { File.join(tempdir, "new_cookbook", "test", "smoke", "default", "default_test.rb") }
 
           include_examples "a generated file", :cookbook_name do
             let(:line) { "describe port" }
@@ -570,7 +570,7 @@ def with_argv(argv)
   - name: default
     verifier:
       inspec_tests:
-        - test/recipes
+        - test/smoke/default
     attributes:
 KITCHEN_YML
         end
@@ -647,7 +647,7 @@ def with_argv(argv)
       - recipe[new_cookbook::default]
     verifier:
       inspec_tests:
-        - test/recipes
+        - test/smoke/default
     attributes:
 KITCHEN_YML
         end

spec/unit/command/generator_commands/recipe_spec.rb

@@ -27,7 +27,7 @@
     let(:generated_files) { [ "recipes/new_recipe.rb",
                               "spec/spec_helper.rb",
                               "spec/unit/recipes/new_recipe_spec.rb",
-                              "test/recipes/new_recipe.rb"
+                              "test/smoke/default/new_recipe.rb"
                             ] }
     let(:new_file_name) { "new_recipe" }