chef-dk 2.3.4 → 2.4.17

data/spec/unit/policyfile_install_with_includes_spec.rb

@@ -0,0 +1,232 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright:: Copyright (c) 2017 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 "chef-dk/policyfile_compiler"
+require "chef-dk/policyfile_lock.rb"
+
+describe ChefDK::PolicyfileLock, "installing cookbooks from included policies" do
+
+  let(:run_list) { ["local::default"] }
+
+  let(:default_source) { [:community] }
+
+  let(:external_cookbook_universe) do
+    {
+      "cookbookA" => {
+        "1.0.0" => [ ],
+        "2.0.0" => [ ["cookbookB", "= 2.0.0" ]],
+      },
+      "cookbookB" => {
+        "1.0.0" => [ ],
+        "2.0.0" => [ ],
+      },
+      "cookbookC" => {
+        "1.0.0" => [ ],
+        "2.0.0" => [ ],
+      },
+      "local" => {
+        "1.0.0" => [ ["cookbookC", "= 1.0.0" ] ],
+      },
+      "local_easy" => {
+        "1.0.0" => [ ["cookbookC", "= 2.0.0" ] ],
+      },
+    }
+  end
+
+  let(:included_policy_cookbook_universe) { external_cookbook_universe }
+
+  let(:included_policy_default_attributes) { {} }
+  let(:included_policy_override_attributes) { {} }
+  let(:included_policy_expanded_named_runlist) { nil }
+  let(:included_policy_expanded_runlist) { ["recipe[cookbookA::default]"] }
+  let(:included_policy_cookbooks) do
+    [
+      {
+        name: "cookbookA",
+        version: "2.0.0",
+      },
+      # We need to manually specify the dependencies of cookbookA
+      {
+        name: "cookbookB",
+        version: "2.0.0",
+      },
+    ]
+  end
+
+  let(:included_policy_source_options) do
+    {
+      "cookbookA" => {
+        "2.0.0" => { artifactserver: "https://supermarket.example/c/cookbookA/2.0.0/download", version: "2.0.0", from_included_policy: "withavalue" },
+      },
+      "cookbookB" => {
+        "2.0.0" => { artifactserver: "https://supermarket.example/c/cookbookB/2.0.0/download", version: "2.0.0", from_included_policy: "withavalue" },
+      },
+    }
+  end
+
+  let(:included_policy_lock_data) do
+    cookbook_locks = included_policy_cookbooks.inject({}) do |acc, cookbook_info|
+      acc[cookbook_info[:name]] = {
+        "version" => cookbook_info[:version],
+        "identifier" => "identifier",
+        "dotted_decimal_identifier" => "dotted_decimal_identifier",
+        "cache_key" => "#{cookbook_info[:name]}-#{cookbook_info[:version]}",
+        "origin" => "uri",
+        "source_options" => included_policy_source_options[cookbook_info[:name]][cookbook_info[:version]],
+      }
+      acc
+    end
+
+    solution_dependencies_lock = included_policy_cookbooks.map do |cookbook_info|
+      [cookbook_info[:name], cookbook_info[:version]]
+    end
+
+    solution_dependencies_cookbooks = included_policy_cookbooks.inject({}) do |acc, cookbook_info|
+      acc["#{cookbook_info[:name]} (#{cookbook_info[:version]})"] = included_policy_cookbook_universe[cookbook_info[:name]][cookbook_info[:version]]
+      acc
+    end
+
+    {
+      "name" => "included_policyfile",
+      "revision_id" => "myrevisionid",
+      "run_list" => included_policy_expanded_runlist,
+      "cookbook_locks" => cookbook_locks,
+      "default_attributes" => included_policy_default_attributes,
+      "override_attributes" => included_policy_override_attributes,
+      "solution_dependencies" => {
+        "Policyfile" => solution_dependencies_lock,
+        "dependencies" => solution_dependencies_cookbooks,
+      },
+    }.tap do |core|
+      core["named_run_lists"] = included_policy_expanded_named_runlist if included_policy_expanded_named_runlist
+    end
+  end
+
+  let(:lock_source_options) { { :path => "somelocation" } }
+
+  let(:included_policy_lock_name) { "included" }
+
+  let(:included_policy_fetcher) do
+    instance_double("ChefDK::Policyfile::LocalLockFetcher").tap do |double|
+      allow(double).to receive(:lock_data).and_return(included_policy_lock_data)
+      allow(double).to receive(:valid?).and_return(true)
+      allow(double).to receive(:errors).and_return([])
+    end
+  end
+
+  let(:default_source_obj) do
+    instance_double("ChefDK::Policyfile::CommunityCookbookSource")
+  end
+
+  let(:policyfile) do
+    policyfile = ChefDK::PolicyfileCompiler.new.build do |p|
+      p.run_list(*run_list)
+    end
+
+    allow(policyfile.dsl).to receive(:default_source).and_return([default_source_obj])
+
+    allow(default_source_obj).to receive(:universe_graph).
+      and_return(external_cookbook_universe)
+
+    allow(default_source_obj).to receive(:null?).and_return(false)
+    allow(default_source_obj).to receive(:preferred_cookbooks).and_return([])
+
+    allow(policyfile).to receive(:included_policies).and_return([included_policy_lock_spec])
+
+    policyfile
+  end
+
+  before do
+
+    allow(default_source_obj).to receive(:preferred_source_for?).and_return(false)
+
+    allow(default_source_obj).to receive(:source_options_for) do |cookbook_name, version|
+      { artifactserver: "https://supermarket.example/c/#{cookbook_name}/#{version}/download", version: version }
+    end
+
+    allow(ChefDK::Policyfile::CookbookLocationSpecification).to receive(:new) do |cookbook_name, version_constraint, source_opts, storage_config|
+      double = instance_double("ChefDK::Policyfile::CookbookLocationSpecification",
+                      name: cookbook_name,
+                      version_constraint: Semverse::Constraint.new(version_constraint),
+                      ensure_cached: nil,
+                      to_s: "#{cookbook_name} #{version_constraint}")
+      allow(double).to receive(:cookbook_has_recipe?).and_return(true)
+      allow(double).to receive(:installed?).and_return(true)
+      allow(double).to receive(:mirrors_canonical_upstream?).and_return(true)
+      allow(double).to receive(:cache_key).and_return("#{cookbook_name}-#{version_constraint}-#{source_opts}")
+      allow(double).to receive(:uri).and_return("uri://#{cookbook_name}-#{version_constraint}-#{source_opts}")
+      allow(double).to receive(:source_options_for_lock).and_return(source_opts)
+      double
+    end
+  end
+
+  context "when a policy is included" do
+    let(:included_policy_lock_spec) do
+      ChefDK::Policyfile::PolicyfileLocationSpecification.new(included_policy_lock_name, lock_source_options, nil).tap do |spec|
+        allow(spec).to receive(:valid?).and_return(true)
+        allow(spec).to receive(:fetcher).and_return(included_policy_fetcher)
+        allow(spec).to receive(:source_options_for_lock).and_return(lock_source_options)
+      end
+    end
+
+    before do
+      policyfile.install
+    end
+
+    it "maintains the correct source locations for cookbooks from the included policy" do
+      expect(policyfile.lock.cookbook_locks["cookbookA"].source_options).to eq(included_policy_source_options["cookbookA"]["2.0.0"])
+      expect(policyfile.lock.cookbook_locks["cookbookB"].source_options).to eq(included_policy_source_options["cookbookB"]["2.0.0"])
+    end
+
+    it "maintains the correct source locations for cookbooks from the current policy" do
+      expect(policyfile.lock.cookbook_locks["local"].source_options).to eq(default_source_obj.source_options_for("local", "1.0.0"))
+      expect(policyfile.lock.cookbook_locks["cookbookC"].source_options).to eq(default_source_obj.source_options_for("cookbookC", "1.0.0"))
+    end
+
+    it "maintains identifiers for remote cookbooks" do
+      allow(ChefDK::Policyfile::CachedCookbook).to receive(:new) do |name, storage_config|
+        mock = ChefDK::Policyfile::CachedCookbook.allocate
+        mock.send(:initialize, name, storage_config)
+        allow(mock).to receive(:installed?).and_return(true)
+        allow(mock).to receive(:validate!)
+        allow(mock).to receive(:cookbook_version) do
+          instance_double("Chef::CookbookVersion",
+                          version: mock.source_options[:version],
+                          manifest_records_by_path: [])
+        end
+        mock
+      end
+      expect(policyfile.lock.to_lock["cookbook_locks"]["cookbookA"]["source_options"]).to eq(included_policy_source_options["cookbookA"]["2.0.0"])
+      expect(policyfile.lock.to_lock["cookbook_locks"]["cookbookB"]["source_options"]).to eq(included_policy_source_options["cookbookB"]["2.0.0"])
+    end
+
+    it "emits the included policy in the lock file" do
+      lock = policyfile.lock
+      allow(lock).to receive(:cookbook_locks_for_lockfile).and_return({})
+      expect(lock.to_lock["included_policy_locks"]).to eq(
+        [
+          {
+            "name" => included_policy_lock_name,
+            "revision_id" => "myrevisionid",
+            "source_options" => lock_source_options,
+          },
+        ])
+    end
+  end
+end

data/spec/unit/policyfile_lock_build_spec.rb

@@ -238,6 +238,7 @@ REVISION_STRING
         "override_attributes" => {},
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
       }
     end
 
@@ -334,6 +335,7 @@ REVISION_STRING
         "override_attributes" => { "foo2" => "baz" },
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
       }
     end
 
@@ -425,6 +427,7 @@ REVISION_STRING
         "override_attributes" => {},
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
       }
     end
 
@@ -535,6 +538,7 @@ REVISION_STRING
         "override_attributes" => {},
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
       }
     end
 
@@ -680,7 +684,7 @@ REVISION_STRING
         "override_attributes" => {},
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
-
+        "included_policy_locks" => [],
       }
     end
 
@@ -772,6 +776,7 @@ REVISION_STRING
           "Policyfile" => [],
           "dependencies" => { "foo (1.0.0)" => [] },
         },
+        "included_policy_locks" => [],
       }
     end
 
@@ -841,6 +846,7 @@ REVISION_STRING
         "override_attributes" => {},
 
         "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
       }
     end
 
@@ -933,7 +939,9 @@ REVISION_STRING
               all_cookbook_location_specs: { "foo" => cached_location_spec, "bar" => local_location_spec },
               solution_dependencies: policyfile_solution_dependencies,
               default_attributes: policyfile_default_attrs,
-              override_attributes: policyfile_override_attrs )
+              override_attributes: policyfile_override_attrs,
+              included_policies: []
+            )
     end
 
     let(:policyfile_lock) do
@@ -1019,6 +1027,7 @@ REVISION_STRING
           "Policyfile" => [ [ "foo", "~> 1.0" ] ],
           "dependencies" => { "foo (1.0.0)" => [], "bar (0.1.0)" => [] },
         },
+        "included_policy_locks" => [],
       }
     end
 

data/spec/unit/policyfile_services/update_attributes_spec.rb

@@ -134,6 +134,7 @@ E
           "Policyfile" => [["local-cookbook", ">= 0.0.0"]],
           "dependencies" => { "local-cookbook (2.3.4)" => [] },
         },
+        "included_policy_locks" => [],
       }
     end
 
@@ -168,6 +169,18 @@ E
         expect(ui.output).to include(message)
       end
 
+      context "when a policyfile is included" do
+        let(:lock_applier) { instance_double("ChefDK::Policyfile::LockApplier") }
+
+        it "locks the included policyfile" do
+          expect(ChefDK::Policyfile::LockApplier).to receive(:new).with(
+            update_attrs_service.policyfile_lock, update_attrs_service.policyfile_compiler).and_return(lock_applier)
+          expect(lock_applier).not_to receive(:with_unlocked_policies)
+          expect(lock_applier).to receive(:apply!)
+
+          update_attrs_service.run
+        end
+      end
     end
 
     context "when the Policyfile.rb has different attributes than the lockfile" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-dk
 version: !ruby/object:Gem::Version
-  version: 2.3.4
+  version: 2.4.17
 platform: ruby
 authors:
 - Daniel DeLeo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-22 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
@@ -262,6 +262,7 @@ files:
 - lib/chef-dk/authenticated_http.rb
 - lib/chef-dk/builtin_commands.rb
 - lib/chef-dk/chef_runner.rb
+- lib/chef-dk/chef_server_api_multi.rb
 - lib/chef-dk/cli.rb
 - lib/chef-dk/command/base.rb
 - lib/chef-dk/command/clean_policy_cookbooks.rb
@@ -317,8 +318,10 @@ files:
 - lib/chef-dk/helpers.rb
 - lib/chef-dk/pager.rb
 - lib/chef-dk/policyfile/artifactory_cookbook_source.rb
+- lib/chef-dk/policyfile/attribute_merge_checker.rb
 - lib/chef-dk/policyfile/chef_repo_cookbook_source.rb
 - lib/chef-dk/policyfile/chef_server_cookbook_source.rb
+- lib/chef-dk/policyfile/chef_server_lock_fetcher.rb
 - lib/chef-dk/policyfile/community_cookbook_source.rb
 - lib/chef-dk/policyfile/comparison_base.rb
 - lib/chef-dk/policyfile/cookbook_location_specification.rb
@@ -327,8 +330,12 @@ files:
 - lib/chef-dk/policyfile/delivery_supermarket_source.rb
 - lib/chef-dk/policyfile/differ.rb
 - lib/chef-dk/policyfile/dsl.rb
+- lib/chef-dk/policyfile/included_policies_cookbook_source.rb
 - lib/chef-dk/policyfile/lister.rb
+- lib/chef-dk/policyfile/local_lock_fetcher.rb
+- lib/chef-dk/policyfile/lock_applier.rb
 - lib/chef-dk/policyfile/null_cookbook_source.rb
+- lib/chef-dk/policyfile/policyfile_location_specification.rb
 - lib/chef-dk/policyfile/read_cookbook_for_compat_mode_upload.rb
 - lib/chef-dk/policyfile/reports/install.rb
 - lib/chef-dk/policyfile/reports/table_printer.rb
@@ -430,6 +437,7 @@ files:
 - spec/spec_helper.rb
 - spec/test_helpers.rb
 - spec/unit/chef_runner_spec.rb
+- spec/unit/chef_server_api_multi_spec.rb
 - spec/unit/cli_spec.rb
 - spec/unit/command/base_spec.rb
 - spec/unit/command/clean_policy_cookbooks_spec.rb
@@ -562,15 +570,20 @@ files:
 - spec/unit/generator_spec.rb
 - spec/unit/pager_spec.rb
 - spec/unit/policyfile/artifactory_cookbook_source_spec.rb
+- spec/unit/policyfile/attribute_merge_checker_spec.rb
 - spec/unit/policyfile/chef_repo_cookbook_source_spec.rb
 - spec/unit/policyfile/chef_server_cookbook_source_spec.rb
+- spec/unit/policyfile/chef_server_lock_fetcher_spec.rb
 - spec/unit/policyfile/community_cookbook_source_spec.rb
 - spec/unit/policyfile/comparison_base_spec.rb
 - spec/unit/policyfile/cookbook_location_specification_spec.rb
 - spec/unit/policyfile/cookbook_locks_spec.rb
 - spec/unit/policyfile/delivery_supermarket_source_spec.rb
 - spec/unit/policyfile/differ_spec.rb
+- spec/unit/policyfile/included_policies_cookbook_source_spec.rb
 - spec/unit/policyfile/lister_spec.rb
+- spec/unit/policyfile/local_lock_fetcher_spec.rb
+- spec/unit/policyfile/lock_applier_spec.rb
 - spec/unit/policyfile/null_cookbook_source_spec.rb
 - spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb
 - spec/unit/policyfile/reports/install_spec.rb
@@ -583,6 +596,9 @@ files:
 - spec/unit/policyfile/uploader_spec.rb
 - spec/unit/policyfile_demands_spec.rb
 - spec/unit/policyfile_evaluation_spec.rb
+- spec/unit/policyfile_includes_dsl_spec.rb
+- spec/unit/policyfile_includes_spec.rb
+- spec/unit/policyfile_install_with_includes_spec.rb
 - spec/unit/policyfile_lock_build_spec.rb
 - spec/unit/policyfile_lock_install_spec.rb
 - spec/unit/policyfile_lock_serialization_spec.rb
@@ -636,7 +652,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: A streamlined development and deployment workflow for Chef platform.
@@ -651,6 +667,7 @@ test_files:
 - spec/spec_helper.rb
 - spec/test_helpers.rb
 - spec/unit/chef_runner_spec.rb
+- spec/unit/chef_server_api_multi_spec.rb
 - spec/unit/cli_spec.rb
 - spec/unit/command/base_spec.rb
 - spec/unit/command/clean_policy_cookbooks_spec.rb
@@ -783,15 +800,20 @@ test_files:
 - spec/unit/generator_spec.rb
 - spec/unit/pager_spec.rb
 - spec/unit/policyfile/artifactory_cookbook_source_spec.rb
+- spec/unit/policyfile/attribute_merge_checker_spec.rb
 - spec/unit/policyfile/chef_repo_cookbook_source_spec.rb
 - spec/unit/policyfile/chef_server_cookbook_source_spec.rb
+- spec/unit/policyfile/chef_server_lock_fetcher_spec.rb
 - spec/unit/policyfile/community_cookbook_source_spec.rb
 - spec/unit/policyfile/comparison_base_spec.rb
 - spec/unit/policyfile/cookbook_location_specification_spec.rb
 - spec/unit/policyfile/cookbook_locks_spec.rb
 - spec/unit/policyfile/delivery_supermarket_source_spec.rb
 - spec/unit/policyfile/differ_spec.rb
+- spec/unit/policyfile/included_policies_cookbook_source_spec.rb
 - spec/unit/policyfile/lister_spec.rb
+- spec/unit/policyfile/local_lock_fetcher_spec.rb
+- spec/unit/policyfile/lock_applier_spec.rb
 - spec/unit/policyfile/null_cookbook_source_spec.rb
 - spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb
 - spec/unit/policyfile/reports/install_spec.rb
@@ -804,6 +826,9 @@ test_files:
 - spec/unit/policyfile/uploader_spec.rb
 - spec/unit/policyfile_demands_spec.rb
 - spec/unit/policyfile_evaluation_spec.rb
+- spec/unit/policyfile_includes_dsl_spec.rb
+- spec/unit/policyfile_includes_spec.rb
+- spec/unit/policyfile_install_with_includes_spec.rb
 - spec/unit/policyfile_lock_build_spec.rb
 - spec/unit/policyfile_lock_install_spec.rb
 - spec/unit/policyfile_lock_serialization_spec.rb