chef-dk 0.2.1 → 0.3.0

data/spec/unit/policyfile/solution_dependencies_spec.rb

@@ -20,7 +20,7 @@ require 'chef-dk/policyfile/solution_dependencies'
 
 describe ChefDK::Policyfile::SolutionDependencies do
 
-  let(:dependency_data) { {} }
+  let(:dependency_data) { {"Policyfile" => [], "dependencies" => {}} }
 
   let(:solution_dependencies) do
     s = described_class.new

data/spec/unit/policyfile/uploader_spec.rb

@@ -79,17 +79,6 @@ describe ChefDK::Policyfile::Uploader do
     expect(uploader.http_client).to eq(http_client)
   end
 
-  context "when created without an HTTP client" do
-
-    let(:http_client) { nil }
-
-    it "creates an HTTP client with default config" do
-      skip "TODO: determine correct behavior"
-    end
-
-  end
-
-
   describe "creating uploading documents in compat mode" do
 
     let(:cookbook_locks) { {} }
@@ -132,6 +121,8 @@ describe ChefDK::Policyfile::Uploader do
 
       lock = instance_double("ChefDK::Policyfile::CookbookLock",
                              name: name,
+                             version: "1.0.0",
+                             identifier: "64b3e64306cff223206348e46af545b19032b170",
                              dotted_decimal_identifier: dotted_decimal_id,
                              cookbook_path: cache_path)
 
@@ -212,7 +203,13 @@ describe ChefDK::Policyfile::Uploader do
       it "lists the cookbooks in the lock as possibly needing to be uploaded" do
         expect(policyfile_lock).to receive(:validate_cookbooks!)
 
-        expect(uploader.cookbook_versions_for_policy).to eq(cookbook_versions.values)
+        expected_versions_for_policy = cookbook_versions.keys.map do |cb_name|
+          cb = cookbook_versions[cb_name]
+          lock = cookbook_locks[cb_name]
+          ChefDK::Policyfile::Uploader::LockedCookbookForUpload.new(cb, lock)
+        end
+
+        expect(uploader.cookbook_versions_for_policy).to eq(expected_versions_for_policy)
       end
 
       it "lists all cookbooks in the lock as needing to be uploaded" do

data/spec/unit/policyfile_lock_serialization_spec.rb

@@ -0,0 +1,292 @@
+#
+# Copyright:: Copyright (c) 2014 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_lock'
+
+describe ChefDK::PolicyfileLock, "when reading a Policyfile.lock" do
+
+  let(:valid_lock_data) do
+    {
+      "name" => "example",
+      "run_list" => [ "recipe[cookbook::recipe_name]" ],
+      "cookbook_locks" => {
+        # TODO: add some valid locks
+      },
+      "solution_dependencies" => {
+        "Policyfile" => [],
+        "dependencies" => {}
+      }
+    }
+  end
+
+  let(:storage_config) { ChefDK::Policyfile::StorageConfig.new }
+
+  let(:lockfile) { ChefDK::PolicyfileLock.new(storage_config) }
+
+  describe "validating required fields" do
+
+    it "does not raise an error when all fields are valid" do
+      expect { lockfile.build_from_lock_data(valid_lock_data) }.to_not raise_error
+    end
+
+    it "requires the name to be present" do
+      missing_name = valid_lock_data.dup
+      missing_name.delete("name")
+
+      expect { lockfile.build_from_lock_data(missing_name) }.to raise_error(ChefDK::InvalidLockfile)
+
+      blank_name = valid_lock_data.dup
+      blank_name["name"] = ""
+      expect { lockfile.build_from_lock_data(blank_name) }.to raise_error(ChefDK::InvalidLockfile)
+
+      invalid_name = valid_lock_data.dup
+      invalid_name["name"] = {}
+      expect { lockfile.build_from_lock_data(invalid_name) }.to raise_error(ChefDK::InvalidLockfile)
+    end
+
+    it "requires the run_list to be present" do
+      no_run_list = valid_lock_data.dup
+      no_run_list.delete("run_list")
+
+      expect { lockfile.build_from_lock_data(no_run_list) }.to raise_error(ChefDK::InvalidLockfile)
+
+      bad_run_list = valid_lock_data.dup
+      bad_run_list["run_list"] = "bad data"
+      expect { lockfile.build_from_lock_data(bad_run_list) }.to raise_error(ChefDK::InvalidLockfile)
+    end
+
+    it "validates the format of run_list items" do
+      bad_run_list = valid_lock_data.dup
+      bad_run_list["run_list"] = [ "bad data" ]
+
+      expect { lockfile.build_from_lock_data(bad_run_list) }.to raise_error(ChefDK::InvalidLockfile)
+    end
+
+    it "requires the `cookbook_locks` section be present and its value is a Hash" do
+      missing_locks = valid_lock_data.dup
+      missing_locks.delete("cookbook_locks")
+
+      expect { lockfile.build_from_lock_data(missing_locks) }.to raise_error(ChefDK::InvalidLockfile)
+
+      invalid_locks = valid_lock_data.dup
+      invalid_locks["cookbook_locks"] = []
+      expect { lockfile.build_from_lock_data(invalid_locks) }.to raise_error(ChefDK::InvalidLockfile)
+    end
+
+    describe "validating solution_dependencies" do
+
+      it "requires the `solution_dependencies' section be present" do
+        missing_soln_deps = valid_lock_data.dup
+        missing_soln_deps.delete("solution_dependencies")
+
+        expect { lockfile.build_from_lock_data(missing_soln_deps) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires the solution_dependencies object be a Hash" do
+        invalid_soln_deps = valid_lock_data.dup
+        invalid_soln_deps["solution_dependencies"] = []
+        expect { lockfile.build_from_lock_data(invalid_soln_deps) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires the solution_dependencies object have a 'Policyfile' and 'dependencies' key" do
+        missing_keys_soln_deps = valid_lock_data.dup
+        missing_keys_soln_deps["solution_dependencies"] = {}
+        expect { lockfile.build_from_lock_data(missing_keys_soln_deps) }.to raise_error(ChefDK::InvalidLockfile)
+
+        missing_policyfile_key = valid_lock_data.dup
+        missing_policyfile_key["solution_dependencies"] = {"dependencies" => {} }
+        expect { lockfile.build_from_lock_data(missing_policyfile_key) }.to raise_error(ChefDK::InvalidLockfile)
+
+        missing_dependencies_key = valid_lock_data.dup
+        missing_dependencies_key["solution_dependencies"] = { "Policyfile" => [] }
+        expect { lockfile.build_from_lock_data(missing_dependencies_key) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires the Policyfile dependencies be an Array" do
+        invalid_policyfile_deps = valid_lock_data.dup
+        invalid_policyfile_deps["solution_dependencies"] = {"Policyfile" => 42, "dependencies" => {} }
+        expect { lockfile.build_from_lock_data(invalid_policyfile_deps) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it %q(requires the Policyfile dependencies be formatted like [ "COOKBOOK_NAME", "CONSTRAINT" ]) do
+        invalid_policyfile_deps_content = valid_lock_data.dup
+        invalid_policyfile_deps_content["solution_dependencies"] = { "Policyfile" => [ "bad" ], "dependencies" => {} }
+        expect { lockfile.build_from_lock_data(invalid_policyfile_deps_content) }.to raise_error(ChefDK::InvalidLockfile)
+
+        invalid_policyfile_deps_content2 = valid_lock_data.dup
+        invalid_policyfile_deps_content2["solution_dependencies"] = { "Policyfile" => [ [42, "~> 2.0"] ], "dependencies" => {} }
+        expect { lockfile.build_from_lock_data(invalid_policyfile_deps_content2) }.to raise_error(ChefDK::InvalidLockfile)
+
+        invalid_policyfile_deps_content3 = valid_lock_data.dup
+        invalid_policyfile_deps_content3["solution_dependencies"] = { "Policyfile" => [ ["cookbook_name", "bad"] ], "dependencies" => {} }
+        expect { lockfile.build_from_lock_data(invalid_policyfile_deps_content3) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires the cookbook dependencies be a Hash" do
+        invalid_cookbook_deps = valid_lock_data.dup
+        invalid_cookbook_deps["solution_dependencies"] = { "Policyfile" => [], "dependencies" => 42 }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_deps) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires the cookbook dependencies entries be in the correct format" do
+        invalid_cookbook_deps = valid_lock_data.dup
+        bad_deps = { 42 => 42 }
+        invalid_cookbook_deps["solution_dependencies"] = { "Policyfile" => [], "dependencies" => bad_deps }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_deps) }.to raise_error(ChefDK::InvalidLockfile)
+
+        invalid_cookbook_deps2 = valid_lock_data.dup
+        bad_deps2 = { "bad-format" => [] }
+        invalid_cookbook_deps2["solution_dependencies"] = { "Policyfile" => [], "dependencies" => bad_deps2 }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_deps2) }.to raise_error(ChefDK::InvalidLockfile)
+
+        invalid_cookbook_deps3 = valid_lock_data.dup
+        bad_deps3 = { "cookbook (1.0.0)" => 42 }
+        invalid_cookbook_deps3["solution_dependencies"] = { "Policyfile" => [], "dependencies" => bad_deps3 }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_deps3) }.to raise_error(ChefDK::InvalidLockfile)
+
+        invalid_cookbook_deps4 = valid_lock_data.dup
+        bad_deps4 = { "cookbook (1.0.0)" => [ 42 ] }
+        invalid_cookbook_deps4["solution_dependencies"] = { "Policyfile" => [], "dependencies" => bad_deps4 }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_deps4) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+    end
+
+    describe "validating cookbook_locks entries" do
+
+      # TODO: also check non-cached cookbook
+      let(:valid_cookbook_lock) do
+        {
+          "version" => "1.0.0",
+          "identifier" => "68c13b136a49b4e66cfe9d8aa2b5a85167b5bf9b",
+          "dotted_decimal_identifier" => "111.222.333",
+          "cache_key" => "foo-1.0.0",
+          "source_options" => {}
+        }
+      end
+
+      it "requires that each cookbook lock be a Hash" do
+        invalid_cookbook_lock = valid_lock_data.dup
+        invalid_cookbook_lock["cookbook_locks"] = { "foo" => 42 }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_lock) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that cookbook locks not be empty" do
+        invalid_cookbook_lock = valid_lock_data.dup
+        invalid_cookbook_lock["cookbook_locks"] = { "foo" => {} }
+        expect { lockfile.build_from_lock_data(invalid_cookbook_lock) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that each cookbook lock have a version" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock.delete("version")
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that the version be a string" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock["version"] = 42
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that each cookbook lock have an identifier" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock.delete("identifier")
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that the identifier be a string" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock["identifier"] = 42
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that a cookbook lock have a key named `cache_key'" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock.delete("cache_key")
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that the cache_key be a string or null" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock["cache_key"] = 42
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that a cookbook lock have a source_options attribute" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock.delete("source_options")
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that source options be a Hash" do
+        invalid_lockfile = valid_lock_data.dup
+        invalid_cookbook_lock = valid_cookbook_lock.dup
+        invalid_cookbook_lock["source_options"] = 42
+        invalid_lockfile["cookbook_locks"] = { "foo" => invalid_cookbook_lock }
+        expect { lockfile.build_from_lock_data(invalid_lockfile) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that a cookbook lock be a valid local cookbook if `cache_key' is null/nil" do
+        valid_lock_with_local_cookbook = valid_lock_data.dup
+        valid_local_cookbook = valid_cookbook_lock.dup
+        valid_local_cookbook["cache_key"] = nil
+        valid_local_cookbook["source"] = "path/to/foo"
+        valid_lock_with_local_cookbook["cookbook_locks"] = { "foo" => valid_local_cookbook }
+        expect { lockfile.build_from_lock_data(valid_lock_with_local_cookbook) }.to_not raise_error
+
+        invalid_lock_with_local_cookbook = valid_lock_data.dup
+        invalid_local_cookbook = valid_cookbook_lock.dup
+        invalid_local_cookbook["cache_key"] = nil
+        invalid_local_cookbook["source"] = 42
+        invalid_lock_with_local_cookbook["cookbook_locks"] = { "foo" => invalid_local_cookbook }
+        expect { lockfile.build_from_lock_data(invalid_lock_with_local_cookbook) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+      it "requires that a cookbook lock w/ a key named `cache_key' be a valid cached cookbook structure" do
+        valid_lock_with_cached_cookbook = valid_lock_data.dup
+        valid_cached_cookbook = valid_cookbook_lock.dup
+        valid_cached_cookbook["cache_key"] = nil
+        valid_cached_cookbook["source"] = "path/to/foo"
+        valid_lock_with_cached_cookbook["cookbook_locks"] = { "foo" => valid_cached_cookbook }
+        expect { lockfile.build_from_lock_data(valid_lock_with_cached_cookbook) }.to_not raise_error
+
+        invalid_lock_with_cached_cookbook = valid_lock_data.dup
+        invalid_cached_cookbook = valid_cookbook_lock.dup
+        invalid_cached_cookbook["cache_key"] = 42
+        invalid_lock_with_cached_cookbook["cookbook_locks"] = { "foo" => invalid_cached_cookbook }
+        expect { lockfile.build_from_lock_data(invalid_lock_with_cached_cookbook) }.to raise_error(ChefDK::InvalidLockfile)
+      end
+
+    end
+  end
+
+end

data/spec/unit/policyfile_services/install_spec.rb

@@ -0,0 +1,170 @@
+#
+# Copyright:: Copyright (c) 2014 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_services/install'
+
+describe ChefDK::PolicyfileServices::Install do
+
+  let(:working_dir) do
+    path = File.join(tempdir, "policyfile_services_test_working_dir")
+    Dir.mkdir(path)
+    path
+  end
+
+  let(:policyfile_rb_explicit_name) { nil }
+
+  let(:policyfile_rb_name) { policyfile_rb_explicit_name || "Policyfile.rb" }
+
+  let(:policyfile_lock_name) { "Policyfile.lock.json" }
+
+  let(:policyfile_rb_path) { File.join(working_dir, policyfile_rb_name) }
+
+  let(:policyfile_lock_path) { File.join(working_dir, policyfile_lock_name) }
+
+  let(:local_cookbooks_root) do
+    File.join(fixtures_path, "local_path_cookbooks")
+  end
+
+  let(:policyfile_content) do
+    <<-E
+name 'install-example'
+
+run_list 'local-cookbook'
+
+cookbook 'local-cookbook', path: '#{local_cookbooks_root}/local-cookbook'
+E
+  end
+
+  let(:ui) { TestHelpers::TestUI.new }
+
+  let(:install_service) { described_class.new(policyfile: policyfile_rb_name, ui: ui, root_dir: working_dir) }
+
+  let(:storage_config) do
+    ChefDK::Policyfile::StorageConfig.new( cache_path: nil, relative_paths_root: local_cookbooks_root )
+  end
+
+  def result_policyfile_lock
+    expect(File).to exist(policyfile_lock_path)
+    content = IO.read(policyfile_lock_path)
+    lock_data = FFI_Yajl::Parser.parse(content)
+    ChefDK::PolicyfileLock.new(storage_config).build_from_lock_data(lock_data)
+  end
+
+  context "when no Policyfile is present or specified" do
+
+    it "errors out" do
+      expect { install_service.run }.to raise_error(ChefDK::PolicyfileNotFound, "Policyfile not found at path #{policyfile_rb_path}")
+    end
+
+  end
+
+  context "when a Policyfile exists" do
+
+    before do
+      File.open(policyfile_rb_path, "w+") { |f| f.print(policyfile_content) }
+    end
+
+    it "infers that the Policyfile.rb is located at $CWD/Policyfile.rb" do
+      expect(install_service.policyfile_path).to eq(policyfile_rb_path)
+    end
+
+    it "reads the policyfile from disk" do
+      expect(install_service.policyfile_content).to eq(policyfile_content)
+    end
+
+    context "and the policyfile has an error" do
+
+      let(:policyfile_content) { 'raise "borkbork"' }
+
+      it "errors out and creates no lockfile" do
+        expect { install_service.run }.to raise_error(ChefDK::PolicyfileInstallError)
+        expect(File).to_not exist(policyfile_lock_path)
+      end
+
+    end
+
+    context "and no lockfile exists" do
+
+      it "solves the Policyfile demands, installs cookbooks, emits a lockfile" do
+        install_service.run
+        generated_lock = result_policyfile_lock
+        expect(generated_lock.name).to eq('install-example')
+        expect(generated_lock.cookbook_locks).to have_key("local-cookbook")
+      end
+
+    end
+
+    context "and a lockfile exists" do
+
+      before do
+        install_service.dup.run
+      end
+
+      it "reads the policyfile lock from disk" do
+        lock = install_service.policyfile_lock
+        expect(lock).to be_an_instance_of(ChefDK::PolicyfileLock)
+        expect(lock.name).to eq('install-example')
+        expect(lock.cookbook_locks).to have_key("local-cookbook")
+      end
+
+      it "ensures that cookbooks are installed" do
+        expect(install_service.policyfile_lock).to receive(:install_cookbooks).and_call_original
+        install_service.run
+      end
+
+      describe "when an error occurs during the install" do
+
+        before do
+          expect(install_service.policyfile_lock).to receive(:install_cookbooks).and_raise("some error")
+        end
+
+        it "raises a PolicyfileInstallError" do
+          expect { install_service.run }.to raise_error(ChefDK::PolicyfileInstallError)
+        end
+
+
+      end
+
+      context "and the Policyfile has updated dependendencies" do
+
+        # For very first iteration, we won't tackle this case if it's hard
+        it "Conservatively updates deps, recomputes lock, and installs"
+
+      end
+
+    end
+
+    context "and an explicit Policyfile name is given" do
+
+      let(:policyfile_rb_explicit_name) { "MyPolicy.rb" }
+
+      let(:policyfile_lock_name) { "MyPolicy.lock.json" }
+
+      it "infers that the Policyfile.rb is located at $CWD/$POLICYFILE_NAME" do
+        expect(install_service.policyfile_path).to eq(policyfile_rb_path)
+      end
+
+      it "reads the policyfile from disk" do
+        expect(install_service.policyfile_content).to eq(policyfile_content)
+      end
+
+    end
+  end
+
+end
+