chef-cli 1.0.3

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-cli/policyfile_compiler"
+require "chef-cli/policyfile_lock.rb"
+
+describe ChefCLI::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("ChefCLI::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("ChefCLI::Policyfile::CommunityCookbookSource")
+  end
+
+  let(:policyfile) do
+    policyfile = ChefCLI::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(ChefCLI::Policyfile::CookbookLocationSpecification).to receive(:new) do |cookbook_name, version_constraint, source_opts, storage_config|
+      double = instance_double("ChefCLI::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
+      ChefCLI::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(ChefCLI::Policyfile::CachedCookbook).to receive(:new) do |name, storage_config|
+        mock = ChefCLI::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

@@ -0,0 +1,1065 @@
+# -*- coding: UTF-8 -*-
+#
+# Copyright:: Copyright (c) 2014-2018 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 "shared/setup_git_cookbooks"
+require "shared/fixture_cookbook_checksums"
+require "chef-cli/policyfile/storage_config"
+require "chef-cli/policyfile_lock.rb"
+
+describe ChefCLI::PolicyfileLock, "building a lockfile" do
+
+  include_context "fixture cookbooks checksums"
+
+  # For debugging giant nested hashes...
+  def expect_hash_equal(actual, expected)
+    expected.each do |key, expected_value|
+      expect(actual).to have_key(key)
+      if expected_value.kind_of?(Hash)
+        expect_hash_equal(actual[key], expected_value)
+      else
+        expect(actual[key]).to eq(expected_value)
+      end
+    end
+    expect(actual).to eq(expected)
+  end
+
+  let(:cache_path) do
+    File.expand_path("spec/unit/fixtures/cookbook_cache", project_root)
+  end
+
+  let(:relative_paths_root) do
+    File.expand_path("spec/unit/fixtures/", project_root)
+  end
+
+  let(:storage_config) do
+    ChefCLI::Policyfile::StorageConfig.new( cache_path: cache_path, relative_paths_root: relative_paths_root )
+  end
+
+  context "when a cached cookbook omits the cache key" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "invalid_cache_key_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.cached_cookbook("nosuchthing") do |cb|
+        end
+      end
+    end
+
+    it "raises a descriptive error" do
+      expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::CachedCookbookNotFound)
+    end
+
+  end
+
+  context "when a local cookbook omits the path" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "invalid_local_cookbook"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.local_cookbook("nosuchthing") do |cb|
+        end
+      end
+    end
+
+    it "raises a descriptive error" do
+      expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::LocalCookbookNotFound)
+    end
+  end
+
+  context "when a local cookbook has an incorrect path" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "invalid_local_cookbook"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.local_cookbook("nosuchthing") do |cb|
+          cb.source = "nopenopenope"
+        end
+      end
+    end
+
+    it "raises a descriptive error" do
+      expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::LocalCookbookNotFound)
+    end
+  end
+
+  context "when a cookbook is not in the cache" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "invalid_cache_key_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.cached_cookbook("nosuchthing") do |cb|
+          cb.cache_key = "nosuchthing-1.0.0"
+        end
+      end
+    end
+
+    it "raises a descriptive error" do
+      expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::CachedCookbookNotFound)
+    end
+
+  end
+
+  describe "policyfiles with invalid attributes" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "invalid_cache_key_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+        end
+
+        p.default_attributes = default_attributes
+      end
+    end
+
+    context "invalid floats - infinity" do
+
+      let(:default_attributes) { { "infinity" => Float::INFINITY } }
+
+      it "raises a descriptive error" do
+        expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::InvalidPolicyfileAttribute)
+      end
+    end
+
+    context "invalid floats - nan" do
+
+      let(:default_attributes) { { "infinity" => Float::NAN } }
+
+      it "raises a descriptive error" do
+        expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::InvalidPolicyfileAttribute)
+      end
+    end
+
+    context "non-string hash/object keys" do
+
+      let(:default_attributes) { { 1906 => "lol nope" } }
+
+      it "raises a descriptive error" do
+        expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::InvalidPolicyfileAttribute)
+      end
+    end
+
+    context "values that are not Hash/Array/String/Float/Integer/true/false/nil" do
+
+      let(:default_attributes) { { "raw object" => Object.new } }
+
+      it "raises a descriptive error" do
+        expect { policyfile_lock.to_lock }.to raise_error(ChefCLI::InvalidPolicyfileAttribute)
+      end
+    end
+
+  end
+
+  context "with a minimal policyfile" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "minimal_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+        end
+
+      end
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:minimal_policyfile
+        run-list-item:recipe[foo]
+        cookbook:foo;id:f24326bbf81d67fcab6a5615c75092d1c6da81cc
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+        "revision_id" => expected_revision_id,
+
+        "name" => "minimal_policyfile",
+
+        "run_list" => ["recipe[foo]"],
+
+        "cookbook_locks" => {
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "cache_key" => "foo-1.0.0",
+            "origin" => nil,
+            "source_options" => nil,
+          },
+        },
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "has a cache path" do
+      expect(policyfile_lock.cache_path).to eq(cache_path)
+    end
+
+    it "computes a minimal policyfile" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  context "with a policyfile containing attributes" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "minimal_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+        end
+
+        p.default_attributes = {
+          "foo" => "bar",
+          "aaa".encode("utf-16") => "aaa".encode("utf-16"),
+          "ddd" => true,
+          "ccc" => false,
+          "bbb" => nil,
+          "e" => 1.2,
+          "f" => 5,
+          "g" => 1_000_000_000_000_000.0,
+          "nested" => { "a" => "b" },
+        }
+        p.override_attributes = { "foo2" => "baz" }
+
+      end
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:minimal_policyfile
+        run-list-item:recipe[foo]
+        cookbook:foo;id:f24326bbf81d67fcab6a5615c75092d1c6da81cc
+        default_attributes:{"aaa":"aaa","bbb":null,"ccc":false,"ddd":true,"e":1.2,"f":5,"foo":"bar","g":1e+15,"nested":{"a":"b"}}
+        override_attributes:{"foo2":"baz"}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+        "revision_id" => expected_revision_id,
+
+        "name" => "minimal_policyfile",
+
+        "run_list" => ["recipe[foo]"],
+
+        "cookbook_locks" => {
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "cache_key" => "foo-1.0.0",
+            "origin" => nil,
+            "source_options" => nil,
+          },
+        },
+        "default_attributes" => {
+          "foo" => "bar",
+          "aaa".encode("utf-16") => "aaa".encode("utf-16"),
+          "ddd" => true,
+          "ccc" => false,
+          "bbb" => nil,
+          "e" => 1.2,
+          "f" => 5,
+          "g" => 1_000_000_000_000_000.0,
+          "nested" => { "a" => "b" },
+        },
+        "override_attributes" => { "foo2" => "baz" },
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "has a cache path" do
+      expect(policyfile_lock.cache_path).to eq(cache_path)
+    end
+
+    it "computes a minimal policyfile" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  context "with a policyfile containing a local cookbook" do
+
+    include_context "setup git cookbooks"
+    include_context "setup git cookbook remote"
+
+    let(:relative_paths_root) do
+      tempdir
+    end
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "dev_cookbook"
+
+        p.run_list = [ "recipe[bar]" ]
+        p.local_cookbook("bar") do |cb|
+          cb.source = "bar"
+        end
+
+      end
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:dev_cookbook
+        run-list-item:recipe[bar]
+        cookbook:bar;id:#{cookbook_bar_cksum}
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "dev_cookbook",
+
+        "run_list" => ["recipe[bar]"],
+
+        "cookbook_locks" => {
+
+          "bar" => {
+            "version" => "0.1.0",
+            "identifier" => cookbook_bar_cksum,
+            "dotted_decimal_identifier" => cookbook_bar_cksum_dotted,
+
+            "source" => "bar",
+            "cache_key" => nil,
+            "scm_info" => {
+              "scm" => "git",
+              "remote" => remote_url,
+              "revision" => current_rev,
+              "working_tree_clean" => true,
+              "published" => true,
+              "synchronized_remote_branches" => ["origin/master"],
+            },
+            "source_options" => nil,
+          },
+        },
+
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "computes a lockfile including git data" do
+      actual_lock = policyfile_lock.to_lock
+      expect(actual_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  context "with a policyfile using custom identifiers" do
+
+    include_context "setup git cookbooks"
+
+    let(:relative_paths_root) do
+      tempdir
+    end
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "custom_identifier"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+
+          # Explicitly set the identifier and dotted decimal identifiers to the
+          # version number (but it could be anything).
+          cb.identifier = "1.0.0"
+          cb.dotted_decimal_identifier = "1.0.0"
+        end
+
+        p.local_cookbook("bar") do |cb|
+          cb.source = "bar"
+          cb.identifier = "0.1.0"
+          cb.dotted_decimal_identifier = "0.1.0"
+        end
+      end
+
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:custom_identifier
+        run-list-item:recipe[foo]
+        cookbook:bar;id:0.1.0
+        cookbook:foo;id:1.0.0
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "custom_identifier",
+
+        "run_list" => ["recipe[foo]"],
+
+        "cookbook_locks" => {
+
+          "bar" => {
+            "version" => "0.1.0",
+            "identifier" => "0.1.0",
+            "dotted_decimal_identifier" => "0.1.0",
+
+            "source" => "bar",
+            "cache_key" => nil,
+            "scm_info" => {
+              "scm" => "git",
+              "remote" => nil,
+              "revision" => current_rev,
+              "working_tree_clean" => true,
+              "published" => false,
+              "synchronized_remote_branches" => [],
+            },
+            "source_options" => nil,
+          },
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => "1.0.0",
+            "dotted_decimal_identifier" => "1.0.0",
+            "cache_key" => "foo-1.0.0",
+            "origin" => nil,
+            "source_options" => nil,
+          },
+
+        },
+
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "generates a lockfile with custom identifiers" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  context "with a policyfile lock with a mix of cached and local cookbooks" do
+
+    include_context "setup git cookbooks"
+
+    let(:relative_paths_root) do
+      tempdir
+    end
+
+    let(:policyfile_lock) do
+
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        # Required
+        p.name = "basic_example"
+
+        # Required. Should be fully expanded without roles
+        p.run_list = ["recipe[foo]", "recipe[bar]", "recipe[baz::non_default]"]
+
+        # A cached_cookbook is stored in the cache directory in a subdirectory
+        # given by 'cache_key'. It is assumed to be static (not modified by the
+        # user).
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+
+          # Optional attribute that humans can use to understand where a cookbook
+          # came from.
+          cb.origin = "https://community.chef.io/api/cookbooks/foo/1.0.0"
+        end
+
+        p.local_cookbook("bar") do |cb|
+          cb.source = "bar"
+        end
+
+        p.cached_cookbook("baz") do |cb|
+          cb.cache_key = "baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb"
+          cb.origin = "git://github.com/chef-cookbooks/bar.git"
+        end
+
+        p.cached_cookbook("dep_of_bar") do |cb|
+          cb.cache_key = "dep_of_bar-1.2.3"
+          cb.origin = "https://chef-server.example.com/cookbooks/dep_of_bar/1.2.3"
+        end
+      end
+
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:basic_example
+        run-list-item:recipe[foo]
+        run-list-item:recipe[bar]
+        run-list-item:recipe[baz::non_default]
+        cookbook:bar;id:#{cookbook_bar_cksum}
+        cookbook:baz;id:#{cookbook_baz_cksum}
+        cookbook:dep_of_bar;id:#{cookbook_dep_of_bar_cksum}
+        cookbook:foo;id:#{cookbook_foo_cksum}
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "basic_example",
+
+        "run_list" => ["recipe[foo]", "recipe[bar]", "recipe[baz::non_default]"],
+
+        "cookbook_locks" => {
+
+          "bar" => {
+            "version" => "0.1.0",
+            "identifier" => cookbook_bar_cksum,
+            "dotted_decimal_identifier" => cookbook_bar_cksum_dotted,
+            "source" => "bar",
+            "cache_key" => nil,
+
+            "scm_info" => {
+              "scm" => "git",
+              "remote" => nil,
+              "revision" => current_rev,
+              "working_tree_clean" => true,
+              "published" => false,
+              "synchronized_remote_branches" => [],
+            },
+            "source_options" => nil,
+          },
+
+          "baz" => {
+            "version" => "1.2.3",
+            "identifier" => cookbook_baz_cksum,
+            "dotted_decimal_identifier" => cookbook_baz_cksum_dotted,
+            "cache_key" => "baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb",
+            "origin" => "git://github.com/chef-cookbooks/bar.git",
+            "source_options" => nil,
+          },
+
+          "dep_of_bar" => {
+            "version" => "1.2.3",
+            "identifier" => cookbook_dep_of_bar_cksum,
+            "dotted_decimal_identifier" => cookbook_dep_of_bar_cksum_dotted,
+            "origin" => "https://chef-server.example.com/cookbooks/dep_of_bar/1.2.3",
+            "cache_key" => "dep_of_bar-1.2.3",
+            "source_options" => nil,
+
+          },
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "origin" => "https://community.chef.io/api/cookbooks/foo/1.0.0",
+            "cache_key" => "foo-1.0.0",
+            "source_options" => nil,
+          },
+
+        },
+
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "generates a lockfile with the relevant profile data for each cookbook" do
+      generated = policyfile_lock.to_lock
+      expect(generated["name"]).to eq(compiled_policyfile["name"])
+      expect(generated["run_list"]).to eq(compiled_policyfile["run_list"])
+
+      generated_locks = generated["cookbook_locks"]
+      expected_locks = compiled_policyfile["cookbook_locks"]
+
+      # test individually so failures are easier to read
+      expect(generated_locks["foo"]).to eq(expected_locks["foo"])
+      expect(generated_locks["bar"]).to eq(expected_locks["bar"])
+      expect(generated_locks["baz"]).to eq(expected_locks["baz"])
+      expect(generated_locks["dep_of_bar"]).to eq(expected_locks["dep_of_bar"])
+
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  context "with solution dependencies specified" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "minimal_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+        end
+
+        p.dependencies do |deps|
+          deps.add_cookbook_dep("foo", "1.0.0", [])
+        end
+
+      end
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:minimal_policyfile
+        run-list-item:recipe[foo]
+        cookbook:foo;id:#{cookbook_foo_cksum}
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "minimal_policyfile",
+
+        "run_list" => ["recipe[foo]"],
+
+        "cookbook_locks" => {
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "cache_key" => "foo-1.0.0",
+            "origin" => nil,
+            "source_options" => nil,
+          },
+        },
+
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => {
+          "Policyfile" => [],
+          "dependencies" => { "foo (1.0.0)" => [] },
+        },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "computes a minimal policyfile" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+  end
+
+  context "with named run_lists specified" do
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build(storage_config) do |p|
+
+        p.name = "minimal_policyfile"
+
+        p.run_list = [ "recipe[foo]" ]
+
+        p.named_run_lists = { "rl2" => [ "recipe[foo::bar]" ] }
+
+        p.cached_cookbook("foo") do |cb|
+          cb.cache_key = "foo-1.0.0"
+        end
+
+      end
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:minimal_policyfile
+        run-list-item:recipe[foo]
+        named-run-list:rl2;run-list-item:recipe[foo::bar]
+        cookbook:foo;id:#{cookbook_foo_cksum}
+        default_attributes:{}
+        override_attributes:{}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "minimal_policyfile",
+
+        "run_list" => ["recipe[foo]"],
+
+        "named_run_lists" => { "rl2" => [ "recipe[foo::bar]" ] },
+
+        "cookbook_locks" => {
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "cache_key" => "foo-1.0.0",
+            "origin" => nil,
+            "source_options" => nil,
+          },
+        },
+
+        "default_attributes" => {},
+        "override_attributes" => {},
+
+        "solution_dependencies" => { "Policyfile" => [], "dependencies" => {} },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "includes the named run lists in the compiled policyfile" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+  describe "building a policyfile lock from a policyfile compiler" do
+
+    include_context "setup git cookbooks"
+
+    let(:relative_paths_root) do
+      tempdir
+    end
+
+    let(:cached_cookbook_uri) { "https://supermarket.chef.io/api/v1/cookbooks/foo/versions/1.0.0/download" }
+
+    let(:cached_location_spec) do
+      double( "ChefCLI::Policyfile::CookbookLocationSpecification",
+              mirrors_canonical_upstream?: true,
+              cache_key: "foo-1.0.0",
+              uri: cached_cookbook_uri,
+              source_options_for_lock: { "artifactserver" => cached_cookbook_uri, "version" => "1.0.0" })
+    end
+
+    let(:local_location_spec) do
+      double( "ChefCLI::Policyfile::CookbookLocationSpecification",
+              mirrors_canonical_upstream?: false,
+              relative_paths_root: relative_paths_root,
+              relative_path: "bar",
+              source_options_for_lock: { "path" => "bar" })
+    end
+
+    let(:policyfile_solution_dependencies) do
+      ChefCLI::Policyfile::SolutionDependencies.new.tap do |s|
+        s.add_policyfile_dep("foo", "~> 1.0")
+        s.add_cookbook_dep("foo", "1.0.0", [])
+        s.add_cookbook_dep("bar", "0.1.0", [])
+      end
+    end
+
+    let(:policyfile_default_attrs) do
+      {
+        "foo" => "bar",
+        "abc" => { "def" => { "ghi" => "xyz" } },
+        "baz" => {
+          "more_nested_stuff" => "yup",
+          "an_array" => %w{a b c},
+        },
+      }
+    end
+
+    let(:canonicalized_default_attrs) do
+      elements = [
+        %q{"abc":{"def":{"ghi":"xyz"}}},
+        %q{"baz":{"an_array":["a","b","c"],"more_nested_stuff":"yup"}},
+        %q{"foo":"bar"},
+      ]
+      "{" + elements.join(",") + "}"
+    end
+
+    let(:policyfile_override_attrs) do
+      {
+        "foo" => "bar",
+        "abc" => { "def" => { "ghi" => "xyz" } },
+        "baz" => {
+          "more_nested_stuff" => "yup",
+          "an_array" => %w{a b c},
+        },
+      }
+    end
+
+    let(:canonicalized_override_attrs) { canonicalized_default_attrs }
+
+    let(:policyfile_compiler) do
+      double( "ChefCLI::PolicyfileCompiler",
+              name: "my-policyfile",
+              normalized_run_list: %w{recipe[foo::default] recipe[bar::default]},
+              normalized_named_run_lists: { "rl2" => %w{recipe[bar::default]} },
+              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,
+              included_policies: []
+            )
+    end
+
+    let(:policyfile_lock) do
+      ChefCLI::PolicyfileLock.build_from_compiler(policyfile_compiler, storage_config)
+    end
+
+    let(:expected_canonical_revision_string) do
+      <<~REVISION_STRING
+        name:my-policyfile
+        run-list-item:recipe[foo::default]
+        run-list-item:recipe[bar::default]
+        named-run-list:rl2;run-list-item:recipe[bar::default]
+        cookbook:bar;id:#{cookbook_bar_cksum}
+        cookbook:foo;id:#{cookbook_foo_cksum}
+        default_attributes:#{canonicalized_default_attrs}
+        override_attributes:#{canonicalized_override_attrs}
+      REVISION_STRING
+    end
+
+    let(:expected_revision_id) do
+      Digest::SHA256.new.hexdigest(expected_canonical_revision_string)
+    end
+
+    let(:compiled_policyfile) do
+      {
+
+        "revision_id" => expected_revision_id,
+
+        "name" => "my-policyfile",
+
+        "run_list" => ["recipe[foo::default]", "recipe[bar::default]"],
+
+        "named_run_lists" => { "rl2" => ["recipe[bar::default]"] },
+
+        "cookbook_locks" => {
+
+          "foo" => {
+            "version" => "1.0.0",
+            "identifier" => cookbook_foo_cksum,
+            "dotted_decimal_identifier" => cookbook_foo_cksum_dotted,
+            "cache_key" => "foo-1.0.0",
+            "origin" => cached_cookbook_uri,
+            "source_options" => { "artifactserver" => cached_cookbook_uri, "version" => "1.0.0" },
+          },
+
+          "bar" => {
+            "version" => "0.1.0",
+            "identifier" => cookbook_bar_cksum,
+            "dotted_decimal_identifier" => cookbook_bar_cksum_dotted,
+            "source" => "bar",
+            "cache_key" => nil,
+
+            "scm_info" => {
+              "scm" => "git",
+              "remote" => nil,
+              "revision" => current_rev,
+              "working_tree_clean" => true,
+              "published" => false,
+              "synchronized_remote_branches" => [],
+            },
+            "source_options" => { "path" => "bar" },
+          },
+        },
+
+        "default_attributes" => {
+          "foo" => "bar",
+          "abc" => { "def" => { "ghi" => "xyz" } },
+          "baz" => {
+            "more_nested_stuff" => "yup",
+            "an_array" => %w{a b c},
+          },
+        },
+
+        "override_attributes" => {
+          "foo" => "bar",
+          "abc" => { "def" => { "ghi" => "xyz" } },
+          "baz" => {
+            "more_nested_stuff" => "yup",
+            "an_array" => %w{a b c},
+          },
+        },
+        "solution_dependencies" => {
+          "Policyfile" => [ [ "foo", "~> 1.0" ] ],
+          "dependencies" => { "foo (1.0.0)" => [], "bar (0.1.0)" => [] },
+        },
+        "included_policy_locks" => [],
+      }
+    end
+
+    it "adds a cached cookbook lock generator for the compiler's cached cookbook" do
+      expect(policyfile_lock.cookbook_locks).to have_key("foo")
+      cb_lock = policyfile_lock.cookbook_locks["foo"]
+      expect(cb_lock.origin).to eq(cached_location_spec.uri)
+      expect(cb_lock.cache_key).to eq(cached_location_spec.cache_key)
+    end
+
+    it "adds a local cookbook lock generator for the compiler's local cookbook" do
+      expect(policyfile_lock.cookbook_locks).to have_key("bar")
+      cb_lock = policyfile_lock.cookbook_locks["bar"]
+      expect(cb_lock.source).to eq(local_location_spec.relative_path)
+    end
+
+    it "sets named run lists on the policyfile lock" do
+      expect(policyfile_lock.named_run_lists).to eq("rl2" => %w{recipe[bar::default]})
+    end
+
+    it "generates a lockfile data structure" do
+      expect(policyfile_lock.to_lock).to eq(compiled_policyfile)
+    end
+
+    it "generates a canonical revision string" do
+      expect(policyfile_lock.canonical_revision_string).to eq(expected_canonical_revision_string)
+    end
+
+    it "generates a revision id" do
+      expect(policyfile_lock.revision_id).to eq(expected_revision_id)
+    end
+
+  end
+
+end