chef-dk 0.10.0 → 0.11.0

data/spec/unit/policyfile_evaluation_spec.rb

@@ -88,6 +88,91 @@ E
         end
       end
 
+      context "when given an invalid run list item" do
+
+        context "when there is only one colon between cookbook and recipe name" do
+
+          let(:policyfile_rb) do
+            <<-EOH
+              name "hello"
+
+              # Should be "foo::bar" (missing a colon)
+              run_list "foo:bar"
+            EOH
+          end
+
+          it "has an error message with the offending run list item" do
+            expect(policyfile.errors).to_not be_empty
+            expected_message = "Run List Item 'foo:bar' has invalid cookbook name 'foo:bar'.\n" +
+              "Cookbook names can only contain alphanumerics, hyphens, and underscores.\n" +
+              "Did you mean 'foo::bar'?"
+            expect(policyfile.errors.first).to eq(expected_message)
+          end
+        end
+
+        context "when there is only one colon between cookbook and recipe name in fully qualified form" do
+
+          let(:policyfile_rb) do
+            <<-EOH
+              name "hello"
+
+              # Should be "foo::bar" (missing a colon)
+              run_list "recipe[foo:bar]"
+            EOH
+          end
+
+          it "has an error message with the offending run list item" do
+            expect(policyfile.errors).to_not be_empty
+            expected_message = "Run List Item 'recipe[foo:bar]' has invalid cookbook name 'foo:bar'.\n" +
+              "Cookbook names can only contain alphanumerics, hyphens, and underscores.\n" +
+              "Did you mean 'recipe[foo::bar]'?"
+            expect(policyfile.errors.first).to eq(expected_message)
+          end
+        end
+
+        context "when the recipe name is empty" do
+
+          let(:policyfile_rb) do
+            <<-EOH
+              name "hello"
+
+              # Should be "foo::default" or just "foo"
+              run_list "foo::"
+            EOH
+          end
+
+          it "has an error message with the offending run list item" do
+            expect(policyfile.errors).to_not be_empty
+            expected_message = "Run List Item 'foo::' has invalid recipe name ''.\nRecipe names can only contain alphanumerics, hyphens, and underscores."
+            expect(policyfile.errors.first).to eq(expected_message)
+          end
+
+        end
+
+        context "with an invalid run list item in a named run list" do
+
+          let(:policyfile_rb) do
+            <<-EOH
+              name "hello"
+
+              # this one is valid:
+              run_list "foo"
+
+              named_run_list :oops, "foo:bar"
+            EOH
+          end
+
+          it "has an error message with the offending run list item" do
+            expect(policyfile.errors).to_not be_empty
+            expected_message = "Named Run List 'oops' Item 'foo:bar' has invalid cookbook name 'foo:bar'.\n" +
+              "Cookbook names can only contain alphanumerics, hyphens, and underscores.\n" +
+              "Did you mean 'foo::bar'?"
+            expect(policyfile.errors.first).to eq(expected_message)
+          end
+
+        end
+      end
+
       context "when policyfile evaluation is aborted by user signal" do
 
         let(:policyfile_rb) { "raise Interrupt" }

data/spec/unit/policyfile_lock_serialization_spec.rb

@@ -412,7 +412,7 @@ describe ChefDK::PolicyfileLock, "when reading a Policyfile.lock" do
       cb_foo = locks["foo"]
       expect(cb_foo).to be_a(ChefDK::Policyfile::ArchivedCookbook)
 
-      expected_path = File.join(storage_config.relative_paths_root, "cookbooks", "foo-111.222.333")
+      expected_path = File.join(storage_config.relative_paths_root, "cookbook_artifacts", "foo-68c13b136a49b4e66cfe9d8aa2b5a85167b5bf9b")
 
       expect(cb_foo.cookbook_path).to eq(expected_path)
       expect(cb_foo.dotted_decimal_identifier).to eq("111.222.333")

data/spec/unit/policyfile_services/export_repo_spec.rb

@@ -106,9 +106,12 @@ describe ChefDK::PolicyfileServices::ExportRepo do
 
       let(:local_cookbook_path) { File.join(fixtures_path, "local_path_cookbooks/local-cookbook") }
 
+      let(:revision_id) { "60e5ad638dce219d8f87d589463ec4a9884007ba5e2adbb4c0a7021d67204f1a" }
+
       let(:lockfile_content) do
         <<-E
 {
+  "revision_id": "#{revision_id}",
   "name": "install-example",
   "run_list": [
     "recipe[local-cookbook::default]"
@@ -204,12 +207,17 @@ E
           let(:expected_files_relative) do
             metadata_rb = Pathname.new("metadata.rb")
             expected = cookbook_files.delete_if { |p| p == metadata_rb }
+
+            # Berksfile is chefignored
+            berksfile = Pathname.new("Berksfile")
+            expected = expected.delete_if { |p| p == berksfile }
+
             expected << Pathname.new("metadata.json")
           end
 
-          let(:cookbook_with_version) { "local-cookbook-70567763561641081.489844270461035.258281553147148" }
+          let(:cookbook_with_version) { "local-cookbook-fab501cfaf747901bd82c1bc706beae7dc3a350c" }
 
-          let(:exported_cookbook_root) { Pathname.new(File.join(export_dir, "cookbooks", cookbook_with_version)) }
+          let(:exported_cookbook_root) { Pathname.new(File.join(export_dir, "cookbook_artifacts", cookbook_with_version)) }
 
           let(:expected_files) do
             expected_files_relative.map do |file_rel_path|
@@ -223,20 +231,28 @@ E
             end
           end
 
-          # This behavior does two things:
-          # * ensures that Chef Zero uses our hacked version number
-          # * works around external dependencies (e.g., using `git` in backticks)
-          #   in metadata.rb issue
+          # Using JSON form of metadata ensures that we don't rely on anything
+          # in the ruby code in metadata.rb; commonly folks will do things like
+          # shell out to git for the version number, etc.
           it "writes metadata.json in the exported cookbook, removing metadata.rb" do
             metadata_json_path = File.join(exported_cookbook_root, "metadata.json")
             metadata_json = FFI_Yajl::Parser.parse(IO.read(metadata_json_path))
-            expect(metadata_json["version"]).to eq("70567763561641081.489844270461035.258281553147148")
+            expect(metadata_json["version"]).to eq("2.3.4")
           end
 
-          it "copies the policyfile lock in data item format to data_bags/policyfiles" do
-            data_bag_item_path = File.join(export_dir, "data_bags", "policyfiles", "install-example-local.json")
-            data_item_json = FFI_Yajl::Parser.parse(IO.read(data_bag_item_path))
-            expect(data_item_json["id"]).to eq("install-example-local")
+          it "copies the policyfile lock to policies/POLICY_NAME.json" do
+            exported_policy_path = File.join(export_dir, "policies", "install-example-#{revision_id}.json")
+            exported_policy_json = IO.read(exported_policy_path)
+            expect(exported_policy_json).to eq(FFI_Yajl::Encoder.encode(export_service.policyfile_lock.to_lock, pretty: true))
+          end
+
+          it "creates a policy_group file for the local policy group with the revision id of the exported policy" do
+            exported_policy_group_path = File.join(export_dir, "policy_groups", "local.json")
+            exported_policy_group_data = FFI_Yajl::Parser.parse(IO.read(exported_policy_group_path))
+
+            expected_data = { "policies" => { "install-example" => { "revision_id" => revision_id } } }
+
+            expect(exported_policy_group_data).to eq(expected_data)
           end
 
           it "copies the policyfile lock in standard format to Policyfile.lock.json" do
@@ -257,23 +273,39 @@ E
 # The settings in this file will configure chef to apply the exported policy in
 # this directory. To use it, run:
 #
-# chef-client -c client.rb -z
+# chef-client -z
 #
 
-use_policyfile true
+policy_name 'install-example'
+policy_group 'local'
 
-# compatibility mode settings are used because chef-zero doesn't yet support
-# native mode:
-deployment_group 'install-example-local'
-versioned_cookbooks true
-policy_document_native_api false
+use_policyfile true
+policy_document_native_api true
+
+# In order to use this repo, you need a version of Chef Client and Chef Zero
+# that supports policyfile "native mode" APIs:
+current_version = Gem::Version.new(Chef::VERSION)
+unless Gem::Requirement.new(">= 12.7").satisfied_by?(current_version)
+  puts("!" * 80)
+  puts(<<-MESSAGE)
+This Chef Repo requires features introduced in Chef 12.7, but you are using
+Chef \#{Chef::VERSION}. Please upgrade to Chef 12.7 or later.
+MESSAGE
+  puts("!" * 80)
+  exit!(1)
+end
 
 CONFIG
-            config_path = File.join(export_dir, "client.rb")
+            config_path = File.join(export_dir, ".chef", "config.rb")
             expect(File).to exist(config_path)
             expect(IO.read(config_path)).to eq(expected_config_text)
           end
 
+          it "generates a README.md in the exported repo" do
+            readme_path = File.join(export_dir, "README.md")
+            expect(File).to exist(readme_path)
+          end
+
         end
 
         context "when the export dir is empty" do
@@ -315,8 +347,9 @@ CONFIG
             expect(File).to exist(file_in_export_dir)
             expect(File).to exist(extra_data_bag_item)
 
-            expect(File).to be_directory(File.join(export_dir, "cookbooks"))
-            expect(File).to be_directory(File.join(export_dir, "data_bags"))
+            expect(File).to be_directory(File.join(export_dir, "cookbook_artifacts"))
+            expect(File).to be_directory(File.join(export_dir, "policies"))
+            expect(File).to be_directory(File.join(export_dir, "policy_groups"))
           end
 
           include_examples "successful_export"
@@ -327,32 +360,39 @@ CONFIG
 
           let(:non_conflicting_file_in_export_dir) { File.join(export_dir, "some_random_cruft") }
 
-          let(:cookbooks_dir) { File.join(export_dir, "cookbooks") }
+          let(:cookbook_artifacts_dir) { File.join(export_dir, "cookbook_artifacts") }
+
+          let(:file_in_cookbook_artifacts_dir) { File.join(cookbook_artifacts_dir, "some_random_cruft") }
+
+          let(:policies_dir) { File.join(export_dir, "policies") }
 
-          let(:file_in_cookbooks_dir) { File.join(cookbooks_dir, "some_random_cruft") }
+          let(:policy_groups_dir) { File.join(export_dir, "policy_groups") }
 
-          let(:policyfiles_data_bag_dir) { File.join(export_dir, "data_bags", "policyfiles") }
+          let(:extra_policy_item) { File.join(policies_dir, "leftover-policy.json") }
 
-          let(:extra_policyfile_data_item) { File.join(policyfiles_data_bag_dir, "leftover-policy.json") }
+          let(:extra_policy_group_item) { File.join(policy_groups_dir, "leftover-policy-group.json") }
 
           let(:conflicting_policyfile_lock) { File.join(export_dir, "Policyfile.lock.json") }
 
           before do
             FileUtils.mkdir_p(export_dir)
-            FileUtils.mkdir_p(cookbooks_dir)
-            FileUtils.mkdir_p(policyfiles_data_bag_dir)
+            FileUtils.mkdir_p(cookbook_artifacts_dir)
+            FileUtils.mkdir_p(policies_dir)
+            FileUtils.mkdir_p(policy_groups_dir)
             File.open(non_conflicting_file_in_export_dir, "wb+") { |f| f.print "some random cruft" }
-            File.open(file_in_cookbooks_dir, "wb+") { |f| f.print "some random cruft" }
-            File.open(extra_policyfile_data_item, "wb+") { |f| f.print "some random cruft" }
+            File.open(file_in_cookbook_artifacts_dir, "wb+") { |f| f.print "some random cruft" }
+            File.open(extra_policy_item, "wb+") { |f| f.print "some random cruft" }
+            File.open(extra_policy_group_item, "wb+") { |f| f.print "some random cruft" }
             File.open(conflicting_policyfile_lock, "wb+") { |f| f.print "some random cruft" }
           end
 
           it "raises a PolicyfileExportRepoError" do
-            message = "Export dir (#{export_dir}) not clean. Refusing to export. (Conflicting files: #{file_in_cookbooks_dir}, #{extra_policyfile_data_item}, #{conflicting_policyfile_lock})"
+            message = "Export dir (#{export_dir}) not clean. Refusing to export. (Conflicting files: #{file_in_cookbook_artifacts_dir}, #{extra_policy_item}, #{extra_policy_group_item}, #{conflicting_policyfile_lock})"
             expect { export_service.run }.to raise_error(ChefDK::ExportDirNotEmpty, message)
             expect(File).to exist(non_conflicting_file_in_export_dir)
-            expect(File).to exist(file_in_cookbooks_dir)
-            expect(File).to exist(extra_policyfile_data_item)
+            expect(File).to exist(file_in_cookbook_artifacts_dir)
+            expect(File).to exist(extra_policy_item)
+            expect(File).to exist(extra_policy_group_item)
           end
 
           context "and the force option is set" do
@@ -362,13 +402,15 @@ CONFIG
             it "clears the export dir and exports" do
               export_service.run
 
-              expect(File).to_not exist(file_in_cookbooks_dir)
-              expect(File).to_not exist(extra_policyfile_data_item)
+              expect(File).to_not exist(file_in_cookbook_artifacts_dir)
+              expect(File).to_not exist(extra_policy_item)
+              expect(File).to_not exist(extra_policy_group_item)
 
               expect(File).to exist(non_conflicting_file_in_export_dir)
 
-              expect(File).to be_directory(File.join(export_dir, "cookbooks"))
-              expect(File).to be_directory(File.join(export_dir, "data_bags"))
+              expect(File).to be_directory(File.join(export_dir, "cookbook_artifacts"))
+              expect(File).to be_directory(File.join(export_dir, "policies"))
+              expect(File).to be_directory(File.join(export_dir, "policy_groups"))
             end
 
           end

data/spec/unit/policyfile_services/install_spec.rb

@@ -111,6 +111,26 @@ E
         expect(generated_lock.cookbook_locks).to have_key("local-cookbook")
       end
 
+      it "prints the policy name" do
+        install_service.run
+        expect(ui.output).to include("Building policy install-example")
+      end
+
+      it "prints the expanded run list" do
+        install_service.run
+        expect(ui.output).to include("Expanded run list: recipe[local-cookbook]")
+      end
+
+      it "prints the lockfile path" do
+        install_service.run
+        expect(ui.output).to include("Lockfile written to #{working_dir}/Policyfile.lock.json")
+      end
+
+      it "prints the lockfile's revision id" do
+        install_service.run
+        expect(ui.output).to include("Policy revision id: 60e5ad638dce219d8f87d589463ec4a9884007ba5e2adbb4c0a7021d67204f1a")
+      end
+
     end
 
     context "and a lockfile exists and `overwrite` is specified" do

data/spec/unit/policyfile_services/push_archive_spec.rb

@@ -221,7 +221,7 @@ E
 
       end
 
-      context "when the archive has no cookbooks/ directory" do
+      context "when the archive has no cookbook_artifacts/ directory" do
 
         let(:archive_files) { [ FileToTar.new("Policyfile.lock.json", "") ] }
 
@@ -229,14 +229,14 @@ E
           expect(exception).to_not be_nil
           expect(exception.message).to eq("Failed to publish archived policy")
           expect(exception_cause).to be_a(ChefDK::InvalidPolicyArchive)
-          expect(exception_cause.message).to eq("Archive does not contain a cookbooks directory")
+          expect(exception_cause.message).to eq("Archive does not contain a cookbook_artifacts directory")
         end
 
       end
 
       context "when the archive has the correct files but the lockfile is invalid" do
 
-        let(:archive_dirs) { ["cookbooks"] }
+        let(:archive_dirs) { ["cookbook_artifacts"] }
 
         let(:archive_files) { [ FileToTar.new("Policyfile.lock.json", lockfile_content) ] }
 
@@ -279,6 +279,39 @@ E
           end
 
         end
+
+        # `chef export` previously generated Chef repos designed for
+        # compatibility mode Policyfile usage. We don't intend to be backwards
+        # compatible, but we want to kindly explain what's going on.
+        context "when the archive is in the old format" do
+
+          let(:lockfile_content) { valid_lockfile }
+
+          let(:archive_dirs) { %w{ cookbooks data_bags } }
+
+          let(:archive_files) do
+            [
+              FileToTar.new("Policyfile.lock.json", lockfile_content),
+              FileToTar.new("client.rb", "#content"),
+            ]
+          end
+
+          it "errors out, explaining the compatibility issue" do
+            expect(exception).to_not be_nil
+            expect(exception.message).to eq("Failed to publish archived policy")
+            expect(exception_cause).to be_a(ChefDK::InvalidPolicyArchive)
+
+            msg = <<-MESSAGE
+This archive is in an unsupported format.
+
+This archive was created with an older version of ChefDK. This version of
+ChefDK does not support archives in the older format. Re-create the archive
+with a newer version of ChefDK or downgrade ChefDK.
+MESSAGE
+            expect(exception_cause.message).to eq(msg)
+          end
+
+        end
       end
     end
 
@@ -290,18 +323,18 @@ E
 
     let(:cookbook_name) { "local-cookbook" }
 
-    let(:dotted_decimal_identifier) { "70567763561641081.489844270461035.258281553147148" }
+    let(:identifier) { "fab501cfaf747901bd82c1bc706beae7dc3a350c" }
 
-    let(:cookbook_dir) { File.join("cookbooks", "#{cookbook_name}-#{dotted_decimal_identifier}") }
+    let(:cookbook_artifact_dir) { File.join("cookbook_artifacts", "#{cookbook_name}-#{identifier}") }
 
-    let(:recipes_dir) { File.join(cookbook_dir, "recipes") }
+    let(:recipes_dir) { File.join(cookbook_artifact_dir, "recipes") }
 
-    let(:archive_dirs) { ["cookbooks", cookbook_dir, recipes_dir] }
+    let(:archive_dirs) { ["cookbook_artifacts", cookbook_artifact_dir, recipes_dir] }
 
     let(:archive_files) do
       [
         FileToTar.new("Policyfile.lock.json", lockfile_content),
-        FileToTar.new(File.join(cookbook_dir, "metadata.rb"), "name 'local-cookbook'"),
+        FileToTar.new(File.join(cookbook_artifact_dir, "metadata.rb"), "name 'local-cookbook'"),
         FileToTar.new(File.join(recipes_dir, "default.rb"), "puts 'hello'")
       ]
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-dk
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Daniel DeLeo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-09 00:00:00.000000000 Z
+date: 2016-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -80,20 +80,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.2.1
+        version: '12.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.2.1
+        version: '12.5'
 - !ruby/object:Gem::Dependency
   name: solve
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +170,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: github_changelog_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec-core
   requirement: !ruby/object:Gem::Requirement
@@ -402,6 +410,7 @@ files:
 - spec/unit/command/generate_spec.rb
 - spec/unit/command/generator_commands/app_spec.rb
 - spec/unit/command/generator_commands/attribute_spec.rb
+- spec/unit/command/generator_commands/base_spec.rb
 - spec/unit/command/generator_commands/cookbook_file_spec.rb
 - spec/unit/command/generator_commands/cookbook_spec.rb
 - spec/unit/command/generator_commands/generator_generator_spec.rb
@@ -421,6 +430,7 @@ files:
 - spec/unit/command/verify_spec.rb
 - spec/unit/commands_map_spec.rb
 - spec/unit/component_test_spec.rb
+- spec/unit/configurable_spec.rb
 - spec/unit/cookbook_metadata_spec.rb
 - spec/unit/cookbook_profiler/git_spec.rb
 - spec/unit/cookbook_profiler/identifiers_spec.rb
@@ -428,6 +438,8 @@ files:
 - spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb
 - spec/unit/fixtures/command/cli_test_command.rb
 - spec/unit/fixtures/command/explicit_path_example.rb
+- spec/unit/fixtures/configurable/test_config_loader.rb
+- spec/unit/fixtures/configurable/test_configurable.rb
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md
@@ -577,7 +589,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A streamlined development and deployment workflow for Chef platform.
@@ -604,6 +616,7 @@ test_files:
 - spec/unit/command/generate_spec.rb
 - spec/unit/command/generator_commands/app_spec.rb
 - spec/unit/command/generator_commands/attribute_spec.rb
+- spec/unit/command/generator_commands/base_spec.rb
 - spec/unit/command/generator_commands/cookbook_file_spec.rb
 - spec/unit/command/generator_commands/cookbook_spec.rb
 - spec/unit/command/generator_commands/generator_generator_spec.rb
@@ -623,6 +636,7 @@ test_files:
 - spec/unit/command/verify_spec.rb
 - spec/unit/commands_map_spec.rb
 - spec/unit/component_test_spec.rb
+- spec/unit/configurable_spec.rb
 - spec/unit/cookbook_metadata_spec.rb
 - spec/unit/cookbook_profiler/git_spec.rb
 - spec/unit/cookbook_profiler/identifiers_spec.rb
@@ -630,6 +644,8 @@ test_files:
 - spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb
 - spec/unit/fixtures/command/cli_test_command.rb
 - spec/unit/fixtures/command/explicit_path_example.rb
+- spec/unit/fixtures/configurable/test_config_loader.rb
+- spec/unit/fixtures/configurable/test_configurable.rb
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/.kitchen.yml
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/Berksfile
 - spec/unit/fixtures/cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb/README.md