chef-dk 0.4.0 → 0.5.0.rc.1

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/metadata.rb

@@ -0,0 +1,3 @@
+name 'example'
+description 'An example cookbook'
+version '1.0.0'

data/lib/chef-dk/skeletons/code_generator/files/default/repo/cookbooks/example/recipes/default.rb

@@ -0,0 +1,8 @@
+# This is a Chef recipe file. It can be used to specify resources which will
+# apply configuration to a server.
+
+log "Welcome to Chef, #{node["example"]["name"]}!" do
+  level :info
+end
+
+# For more information, see the documentation: http://docs.getchef.com/essentials_cookbook_recipes.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/README.md

@@ -3,28 +3,19 @@ Data Bags
 
 This directory contains directories of the various data bags you create for your infrastructure. Each subdirectory corresponds to a data bag on the Chef Server, and contains JSON files of the items that go in the bag.
 
-First, create a directory for the data bag.
+For example, in this directory you'll find an example data bag directory called `example`, which contains an item definition called `example_item.json` 
+ 
+Before uploading this item to the server, we must first create the data bag on the Chef Server.
 
-    mkdir data_bags/BAG
+    knife data bag create example
 
-Then create the JSON files for items that will go into that bag.
+Then we can upload the items in the data bag's directory to the Chef Server.
 
-    $EDITOR data_bags/BAG/ITEM.json
-
-The JSON for the ITEM must contain a key named "id" with a value equal to "ITEM". For example,
-
-    {
-      "id": "foo"
-    }
-
-Next, create the data bag on the Chef Server.
-
-    knife data bag create BAG
-
-Then upload the items in the data bag's directory to the Chef Server.
-
-    knife data bag from file BAG ITEM.json
+    knife data bag from file example example_item.json
 
+For more information on data bags, see the Chef wiki page:
+                               
+https://docs.getchef.com/essentials_data_bags.html
 
 Encrypted Data Bags
 -------------------
@@ -61,3 +52,7 @@ Use the secret_key to view the contents.
     id:        mysql
     password:  abc123
 
+
+For more information on encrypted data bags, see the Chef wiki page:
+                               
+https://docs.getchef.com/essentials_data_bags.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/data_bags/example/example_item.json

@@ -0,0 +1,4 @@
+{
+    "id": "example_item",
+    "key": "value"
+}

data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/README.md

@@ -1,5 +1,9 @@
-Requires Chef 0.10.0+.
+Create environments here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install environments on the server, use knife.
 
-This directory is for Ruby DSL and JSON files for environments. For more information see "About Environments" in the Chef documentation:
+For example, in this directory you'll find an example environment file called `example.json` which can be uploaded to the Chef Server:
 
-http://docs.chef.io/environments.html
+    knife environment from file environments/example.json
+
+For more information on environments, see the Chef wiki page:
+
+https://docs.chef.io/environments.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/environments/example.json

@@ -0,0 +1,13 @@
+{
+    "name": "example",
+    "description": "This is an example environment defined as JSON",
+    "chef_type": "environment",
+    "json_class": "Chef::Environment",
+    "default_attributes": {
+    },
+    "override_attributes": {
+    },
+    "cookbook_versions": {
+        "example": "= 1.0.0"
+    }
+}

data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/README.md

@@ -1,16 +1,9 @@
 Create roles here, in either the Role Ruby DSL (.rb) or JSON (.json) files. To install roles on the server, use knife.
 
-For example, create `roles/base_example.rb`:
-
-    name "base_example"
-    description "Example base role applied to all nodes."
-    # List of recipes and roles to apply. Requires Chef 0.8, earlier versions use 'recipes()'.
-    #run_list()
-    # Attributes applied if the node doesn't have it set already.
-    #default_attributes()
-    # Attributes applied no matter what the node has set already.
-    #override_attributes()
-
-Then upload it to the Chef Server:
+For example, in this directory you'll find an example role file called `example.json` which can be uploaded to the Chef Server:
     
-    knife role from file roles/base_example.rb
+    knife role from file roles/example.json
+
+For more information on roles, see the Chef wiki page:
+                               
+https://docs.getchef.com/essentials_roles.html

data/lib/chef-dk/skeletons/code_generator/files/default/repo/roles/example.json

@@ -0,0 +1,13 @@
+{
+    "name": "example",
+    "description": "This is an example role defined as JSON",
+    "chef_type": "role",
+    "json_class": "Chef::Role",
+    "default_attributes": {
+    },
+    "override_attributes": {
+    },
+    "run_list": [
+        "recipe[example]"
+    ]
+}

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

@@ -22,7 +22,11 @@ directory "#{app_dir}/test/integration/default/serverspec" do
   recursive true
 end
 
-cookbook_file "#{app_dir}/test/integration/default/serverspec/spec_helper.rb" do
+directory "#{app_dir}/test/integration/helpers/serverspec" do
+  recursive true
+end
+
+cookbook_file "#{app_dir}/test/integration/helpers/serverspec/spec_helper.rb" do
   source 'serverspec_spec_helper.rb'
   action :create_if_missing
 end

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

@@ -36,7 +36,11 @@ directory "#{cookbook_dir}/test/integration/default/serverspec" do
   recursive true
 end
 
-cookbook_file "#{cookbook_dir}/test/integration/default/serverspec/spec_helper.rb" do
+directory "#{cookbook_dir}/test/integration/helpers/serverspec" do
+  recursive true
+end
+
+cookbook_file "#{cookbook_dir}/test/integration/helpers/serverspec/spec_helper.rb" do
   source 'serverspec_spec_helper.rb'
   action :create_if_missing
 end

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

@@ -14,36 +14,21 @@ cookbook_file "#{repo_dir}/README.md" do
   source "repo/README.md"
 end
 
-cookbook_file "#{repo_dir}/Rakefile" do
-  source "repo/Rakefile"
-end
-
 cookbook_file "#{repo_dir}/chefignore" do
   source "chefignore"
 end
 
-directory "#{repo_dir}/config"
-
-template "#{repo_dir}/config/rake.rb" do
-  source "repo/config/rake.rb.erb"
-  helpers(ChefDK::Generator::TemplateHelper)
-end
-
-%w{certificates data_bags environments roles}.each do |tlo|
-  directory "#{repo_dir}/#{tlo}"
-
-  cookbook_file "#{repo_dir}/#{tlo}/README.md" do
-    source "repo/#{tlo}/README.md"
+%w{cookbooks data_bags environments roles}.each do |tlo|
+  remote_directory "#{repo_dir}/#{tlo}" do
+    source "repo/#{tlo}"
   end
 end
 
-directory "#{repo_dir}/cookbooks"
-
 cookbook_file "#{repo_dir}/cookbooks/README.md" do
   if context.policy_only
-    source "repo/cookbooks/README-policy.md"
+    source "cookbook_readmes/README-policy.md"
   else
-    source "repo/cookbooks/README.md"
+    source "cookbook_readmes/README.md"
   end
 end
 

data/lib/chef-dk/version.rb

@@ -16,5 +16,5 @@
 #
 
 module ChefDK
-  VERSION = "0.4.0"
+  VERSION = "0.5.0.rc.1"
 end

data/lib/kitchen/provisioner/policyfile_zero.rb

@@ -19,7 +19,7 @@
 require "kitchen/provisioner/chef_base"
 
 # TODO: chef-dk and kitchen can only co-exist if kitchen and chef-dk agree on
-# the version of mixlib-shellout to use. Kitchen currently locked at 1.x,
+# the version of mixlib-shellout to use. Kitchen currently locked at 1.4,
 # chef-dk is on 2.x
 require 'chef-dk/policyfile_services/export_repo'
 
@@ -38,15 +38,19 @@ module Kitchen
       # * `deployment_group`: `POLICY_NAME-local`
       # Since it makes no sense to modify these, they are hardcoded elsewhere.
       default_config :client_rb, {}
-      default_config :ruby_bindir, "/opt/chef/embedded/bin"
-
-      # Policyfile mode does not support the `-j dna.json` option to
-      # `chef-client`.
-      default_config :json_attributes, false
+      default_config :json_attributes, true
+      default_config :chef_zero_host, nil
       default_config :chef_zero_port, 8889
 
       default_config :chef_client_path do |provisioner|
-        File.join(provisioner[:chef_omnibus_root], %w[bin chef-client])
+        provisioner.
+          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} bin chef-client]).
+          tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      default_config :ruby_bindir do |provisioner|
+        provisioner.
+          remote_path_join(%W[#{provisioner[:chef_omnibus_root]} embedded bin])
       end
 
       # Emit a warning that Policyfile stuff is still experimental.
@@ -62,6 +66,7 @@ module Kitchen
       # (see Base#create_sandbox)
       def create_sandbox
         super
+        prepare_cookbooks
         prepare_validation_pem
         prepare_client_rb
       end
@@ -85,7 +90,10 @@ module Kitchen
           args << "--logfile #{config[:log_file]}"
         end
 
-        Util.wrap_command([cmd, *args].join(" "))
+        wrap_shell_code(
+          [cmd, *args].join(" ").
+          tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+        )
       end
 
       private
@@ -112,7 +120,9 @@ module Kitchen
       #
       # @api private
       def policy_exporter
-        @policy_exporter ||= ChefDK::PolicyfileServices::ExportRepo.new(export_dir: sandbox_path)
+        # Must force this because TK by default copies the current cookbook to the sandbox
+        # See ChefDK::PolicyfileServices::ExportRepo#assert_export_dir_clean!
+        @policy_exporter ||= ChefDK::PolicyfileServices::ExportRepo.new(export_dir: sandbox_path, force: true)
       end
 
       # Writes a fake (but valid) validation.pem into the sandbox directory.
@@ -135,6 +145,8 @@ module Kitchen
         data["use_policyfile"] = true
         data["versioned_cookbooks"] = true
         data["deployment_group"] = "#{policy_exporter.policy_name}-local"
+        # TODO this will need to be updated when chef-zero supports erchef paths (policy_group vs policies)
+        data["policy_document_native_api"] = false
 
         info("Preparing client.rb")
         debug("Creating client.rb from #{data.inspect}")

data/spec/spec_helper.rb

@@ -19,10 +19,18 @@ require 'rubygems'
 require 'rspec/mocks'
 require 'test_helpers'
 
+# needed since we stub it for every test
+require 'chef/workstation_config_loader'
+
 RSpec.configure do |c|
   c.include ChefDK
   c.include TestHelpers
 
+  # Avoid loading config.rb/knife.rb unintentionally
+  c.before(:each) do
+    allow_any_instance_of(Chef::WorkstationConfigLoader).to receive(:load)
+  end
+
   c.after(:all) { clear_tempdir }
 
   c.filter_run :focus => true

data/spec/unit/cli_spec.rb

@@ -67,6 +67,14 @@ E
     cli.run
   end
 
+  def mock_shell_out(exitstatus, stdout, stderr)
+    shell_out = double("mixlib_shell_out")
+    allow(shell_out).to receive(:exitstatus).and_return(exitstatus)
+    allow(shell_out).to receive(:stdout).and_return(stdout)
+    allow(shell_out).to receive(:stderr).and_return(stderr)
+    shell_out
+  end
+
   subject(:cli) do
     ChefDK::CLI.new(argv).tap do |c|
       allow(c).to receive(:commands_map).and_return(commands_map)
@@ -106,12 +114,50 @@ E
   context "given -v" do
     let(:argv) { %w[-v] }
 
-    it "prints the version" do
+    let(:tools) {
+      {
+        "chef-client" => {
+          "version_output" => "Chef: 12.0.3",
+          "expected_version" => "12.0.3"
+        },
+        "berks" => {
+          "version_output" => "3.2.3",
+          "expected_version" => "3.2.3"
+        },
+        "kitchen" => {
+          "version_output" => "Test Kitchen version 1.3.1",
+          "expected_version" => "1.3.1"
+        }
+      }
+    }
+
+    it "does not print versions of tools with missing or errored tools" do
+      full_version_message = version_message
+      tools.each do |name, version|
+        if name == "berks"
+          expect(cli).to receive(:shell_out).with("#{name} --version").and_return(mock_shell_out(1, "#{version["version_output"]}", ''))
+          full_version_message += "#{name} version: ERROR\n"
+        else
+          expect(cli).to receive(:shell_out).with("#{name} --version").and_return(mock_shell_out(0, "#{version["version_output"]}", ''))
+          full_version_message += "#{name} version: #{version["expected_version"]}\n"
+        end
+      end
+      run_cli(0)
+      expect(stdout).to eq(full_version_message)
+    end
+
+    it "prints the version and versions of chef-dk tools" do
+      full_version_message = version_message
+      tools.each do |name, version|
+        expect(cli).to receive(:shell_out).with("#{name} --version").and_return(mock_shell_out(0, "#{version["version_output"]}", ''))
+        full_version_message += "#{name} version: #{version["expected_version"]}\n"
+      end
       run_cli(0)
-      expect(stdout).to eq(version_message)
+      expect(stdout).to eq(full_version_message)
     end
   end
 
+
   context "given an invalid option" do
 
     let(:argv) { %w[-nope] }
@@ -179,7 +225,7 @@ E
 
         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|

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

@@ -35,7 +35,7 @@ describe ChefDK::Command::GeneratorCommands::App do
       test/integration/default
       test/integration/default/serverspec
       test/integration/default/serverspec/default_spec.rb
-      test/integration/default/serverspec/spec_helper.rb
+      test/integration/helpers/serverspec/spec_helper.rb
       README.md
       cookbooks/new_app/Berksfile
       cookbooks/new_app/chefignore

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

@@ -35,7 +35,7 @@ describe ChefDK::Command::GeneratorCommands::Cookbook do
       test/integration/default
       test/integration/default/serverspec
       test/integration/default/serverspec/default_spec.rb
-      test/integration/default/serverspec/spec_helper.rb
+      test/integration/helpers/serverspec/spec_helper.rb
       Berksfile
       chefignore
       metadata.rb

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

@@ -153,14 +153,6 @@ describe ChefDK::Command::GeneratorCommands::Repo do
         end
       end
 
-      describe "Rakefile" do
-        let(:file) { "Rakefile" }
-
-        it "loads the common tasks" do
-          expect(file_contents).to match(/load 'chef\/tasks\/chef_repo\.rake'/)
-        end
-      end
-
       describe "chefignore" do
         let(:file) { "chefignore" }
 
@@ -189,16 +181,6 @@ describe ChefDK::Command::GeneratorCommands::Repo do
         end
       end
 
-      describe "certificates" do
-        describe "README.md" do
-          let(:file) { "certificates/README.md" }
-
-          it "has the right contents" do
-            expect(file_contents).to match(/rake ssl_cert FQDN=monitoring.example.com/)
-          end
-        end
-      end
-
       describe "cookbooks" do
         describe "README.md" do
           let(:file) { "cookbooks/README.md" }
@@ -215,6 +197,30 @@ describe ChefDK::Command::GeneratorCommands::Repo do
             end
           end
         end
+
+        describe "example/metadata.rb" do
+          let(:file) { "cookbooks/example/metadata.rb" }
+
+          it "has the right contents" do
+            expect(file_contents).to match(/name 'example'/)
+          end
+        end
+
+        describe "example/attributes/default.rb" do
+          let(:file) { "cookbooks/example/attributes/default.rb" }
+
+          it "has the right contents" do
+            expect(file_contents).to match(/default\["example"\]\["name"\] = "Sam Doe"/)
+          end
+        end
+
+        describe "example/recipes/default.rb" do
+          let(:file) { "cookbooks/example/recipes/default.rb" }
+
+          it "has the right contents" do
+            expect(file_contents).to match(/log "Welcome to Chef, \#\{node\["example"\]\["name"\]\}!" do/)
+          end
+        end
       end
 
       describe "data_bags" do
@@ -225,58 +231,48 @@ describe ChefDK::Command::GeneratorCommands::Repo do
             expect(file_contents).to match(/This directory contains directories of the various data bags/)
           end
         end
-      end
 
-      describe "environments" do
-        describe "README.md" do
-          let(:file) { "environments/README.md" }
+        describe "example_item.json" do
+          let(:file) { "data_bags/example/example_item.json" }
 
           it "has the right contents" do
-            expect(file_contents).to match(/This directory is for Ruby DSL and JSON files for environments\./)
+            expect(file_contents).to match(/"id": "example_item"/)
           end
         end
       end
 
-      describe "roles" do
+      describe "environments" do
         describe "README.md" do
-          let(:file) { "roles/README.md" }
+          let(:file) { "environments/README.md" }
 
           it "has the right contents" do
-            expect(file_contents).to match(/Create roles here/)
+            expect(file_contents).to match(/Create environments here, in either the Role Ruby DSL \(\.rb\) or JSON \(\.json\) files\./)
           end
         end
-      end
 
-      describe "config" do
-        describe "rake.rb" do
-          let(:file) { "config/rake.rb" }
+        describe "example.json" do
+          let(:file) { "environments/example.json" }
 
-          it "has the preamble" do
-            expect(file_contents).to match(/Configure the Rakefile's tasks\./)
-          end
-
-          it "defaults the copyright to The Authors" do
-            expect(file_contents).to match(/COMPANY_NAME = "The Authors"/)
-          end
-
-          it "defaults the license to all_rights" do
-            expect(file_contents).to match(/NEW_COOKBOOK_LICENSE = :all_rights/)
+          it "has the right contents" do
+            expect(file_contents).to match(/"description": "This is an example environment defined as JSON"/)
           end
+        end
+      end
 
-          context "with a license" do
-            let(:argv) { ["new_repo", "-I", "gplv3" ] }
+      describe "roles" do
+        describe "README.md" do
+          let(:file) { "roles/README.md" }
 
-            it "uses the license" do
-              expect(file_contents).to match(/NEW_COOKBOOK_LICENSE = :gplv3/)
-            end
+          it "has the right contents" do
+            expect(file_contents).to match(/Create roles here, in either the Role Ruby DSL \(\.rb\) or JSON \(\.json\) files\./)
           end
+        end
 
-          context "with a copyright holder" do
-            let(:argv) { ["new_repo", "-C", "GiantCo, Inc." ] }
+        describe "example.json" do
+          let(:file) { "roles/example.json" }
 
-            it "uses the copyright holder" do
-              expect(file_contents).to match(/COMPANY_NAME = "GiantCo, Inc\."/)
-            end
+          it "has the right contents" do
+            expect(file_contents).to match(/"description": "This is an example role defined as JSON"/)
           end
         end
       end