chef-dk 0.2.0 → 0.2.1

data/spec/unit/policyfile/cookbook_locks_spec.rb

@@ -0,0 +1,354 @@
+#
+# 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/cookbook_locks'
+
+shared_examples_for "Cookbook Lock" do
+
+  let(:cookbook_lock_data) { cookbook_lock.to_lock }
+
+  it "has a cookbook name" do
+    expect(cookbook_lock.name).to eq(cookbook_name)
+  end
+
+  it "has a source_options attribute" do
+    cookbook_lock.source_options = { artifactserver: "https://artifacts.example.com/nginx/1.0.0/download" }
+    expect(cookbook_lock.source_options).to eq({ artifactserver: "https://artifacts.example.com/nginx/1.0.0/download" })
+  end
+
+  it "has an identifier attribute" do
+    cookbook_lock.identifier = "my-opaque-id"
+    expect(cookbook_lock.identifier).to eq("my-opaque-id")
+  end
+
+  it "has a dotted_decimal_identifier attribute" do
+    cookbook_lock.dotted_decimal_identifier = "123.456.789"
+    expect(cookbook_lock.dotted_decimal_identifier).to eq("123.456.789")
+  end
+
+  it "has a version attribute" do
+    cookbook_lock.version = "1.2.3"
+    expect(cookbook_lock.version).to eq("1.2.3")
+  end
+
+  it "has a storage config" do
+    expect(cookbook_lock.storage_config).to eq(storage_config)
+  end
+
+  context "when the underlying cookbook has not been mutated, or #refresh! has not been called" do
+
+    it "is not updated" do
+      expect(cookbook_lock).to_not be_updated
+    end
+
+    it "does not have an updated identifier" do
+      expect(cookbook_lock.identifier_updated?).to be false
+    end
+
+    it "does not have an updated version" do
+      expect(cookbook_lock.version_updated?).to be false
+    end
+
+  end
+
+  context "when version and identifier attributes are populated" do
+
+    before do
+      allow(cookbook_lock).to receive(:validate!)
+
+      cookbook_lock.identifier = "my-opaque-id"
+      cookbook_lock.dotted_decimal_identifier = "123.456.789"
+      cookbook_lock.version = "1.2.3"
+      cookbook_lock.source_options = { :sourcekey => "location info" }
+    end
+
+    it "includes the identifier in the lock data" do
+      expect(cookbook_lock_data["identifier"]).to eq("my-opaque-id")
+    end
+
+    it "includes the dotted decimal identifier in the lock data" do
+      expect(cookbook_lock_data["dotted_decimal_identifier"]).to eq("123.456.789")
+    end
+
+    it "includes the version in lock data" do
+      expect(cookbook_lock_data["version"]).to eq("1.2.3")
+    end
+
+    it "includes the source_options in lock data" do
+      expect(cookbook_lock_data["source_options"]).to eq({ :sourcekey => "location info" })
+    end
+
+    it "creates a CookbookLocationSpecification with the source and version data" do
+      location_spec = cookbook_lock.cookbook_location_spec
+      expect(location_spec.name).to eq(cookbook_name)
+      expect(location_spec.version_constraint).to eq(Semverse::Constraint.new("= 1.2.3"))
+      expect(location_spec.source_options).to eq({ sourcekey: "location info" })
+    end
+
+    it "delegates #dependencies to cookbook_location_spec" do
+      deps = [ [ "foo", ">= 0.0.0"], [ "bar", "~> 2.1" ] ]
+      expect(cookbook_lock.cookbook_location_spec).to receive(:dependencies).and_return(deps)
+      expect(cookbook_lock.dependencies).to eq(deps)
+    end
+
+  end
+
+  context "when created from lock data" do
+
+    let(:lock_data) do
+      {
+        "identifier" => "my-opaque-id",
+        "dotted_decimal_identifier" => "123.456.789",
+        "version" => "1.2.3",
+        "source_options" => { "sourcekey" => "location info" }
+      }
+    end
+
+    before do
+      cookbook_lock.build_from_lock_data(lock_data)
+    end
+
+    it "sets the identifier attribute" do
+      expect(cookbook_lock.identifier).to eq("my-opaque-id")
+    end
+
+    it "sets the dotted_decimal_identifier attribute" do
+      expect(cookbook_lock.dotted_decimal_identifier).to eq("123.456.789")
+    end
+
+    it "sets the version attribute" do
+      expect(cookbook_lock.version).to eq("1.2.3")
+    end
+
+    it "sets the source options" do
+      expect(cookbook_lock.source_options).to eq({ sourcekey: "location info" })
+    end
+  end
+
+end
+
+
+describe ChefDK::Policyfile::CachedCookbook do
+
+  let(:cookbook_name) { "nginx" }
+
+  let(:storage_config) { ChefDK::Policyfile::StorageConfig.new }
+
+  let(:cookbook_lock) do
+    described_class.new(cookbook_name, storage_config)
+  end
+
+  include_examples "Cookbook Lock"
+
+  it "has a cache_key attribute" do
+    cookbook_lock.cache_key = "nginx-1.0.0-example.com"
+    expect(cookbook_lock.cache_key).to eq("nginx-1.0.0-example.com")
+  end
+
+  it "has an origin attribute" do
+    cookbook_lock.origin = "https://artifacts.example.com/nginx/1.0.0/download"
+    expect(cookbook_lock.origin).to eq("https://artifacts.example.com/nginx/1.0.0/download")
+  end
+
+  it "errors locating the cookbook when the cache key is not set" do
+    expect { cookbook_lock.cookbook_path }.to raise_error(ChefDK::MissingCookbookLockData)
+  end
+
+  it "ignores calls to #refresh!" do
+    expect { cookbook_lock.refresh! }.to_not raise_error
+  end
+
+  context "when populated with valid data" do
+
+    let(:cookbook_name) { "foo" }
+
+    let(:cache_path) { File.join(fixtures_path, "cached_cookbooks") }
+
+    before do
+      cookbook_lock.cache_key = "foo-1.0.0"
+
+      storage_config.cache_path = cache_path
+    end
+
+    it "gives the path to the cookbook in the cache" do
+      expect(cookbook_lock.cookbook_path).to eq(File.join(cache_path, "foo-1.0.0"))
+    end
+
+  end
+
+end
+
+describe ChefDK::Policyfile::LocalCookbook do
+
+  let(:cookbook_name) { "nginx" }
+
+  let(:storage_config) { ChefDK::Policyfile::StorageConfig.new }
+
+  let(:cookbook_lock) do
+    lock = described_class.new(cookbook_name, storage_config)
+    allow(lock).to receive(:scm_info).and_return({})
+    lock
+  end
+
+  include_examples "Cookbook Lock"
+
+  describe "gathering identifier info" do
+    let(:identifiers) do
+      instance_double("ChefDK::CookbookProfiler::Identifiers",
+                     content_identifier: "abc123",
+                     dotted_decimal_identifier: "111.222.333",
+                     semver_version: "1.2.3")
+    end
+
+    before do
+      allow(cookbook_lock).to receive(:identifiers).and_return(identifiers)
+      cookbook_lock.gather_profile_data
+    end
+
+    it "sets the content identifier" do
+      expect(cookbook_lock.identifier).to eq("abc123")
+    end
+
+    it "sets the backwards compatible dotted decimal identifer equivalent" do
+      expect(cookbook_lock.dotted_decimal_identifier).to eq("111.222.333")
+    end
+
+    it "collects the 'real' SemVer version of the cookbook" do
+      expect(cookbook_lock.version).to eq("1.2.3")
+    end
+
+  end
+
+  context "when loading data from a serialized form" do
+
+    let(:previous_lock_data) do
+      {
+        "identifier" => "abc123",
+        "dotted_decimal_identifier" => "111.222.333",
+        "version" => "1.2.3",
+        "source" => "../my_repo/nginx",
+        "source_options" => {
+          "path" => "../my_repo/nginx"
+        }
+      }
+    end
+
+    before do
+      cookbook_lock.build_from_lock_data(previous_lock_data)
+    end
+
+    it "sets the identifier" do
+      expect(cookbook_lock.identifier).to eq("abc123")
+    end
+
+    it "sets the dotted_decimal_identifier" do
+      expect(cookbook_lock.dotted_decimal_identifier).to eq("111.222.333")
+    end
+
+    it "sets the version" do
+      expect(cookbook_lock.version).to eq("1.2.3")
+    end
+
+    it "sets the source attribute" do
+      expect(cookbook_lock.source).to eq("../my_repo/nginx")
+    end
+
+    it "sets the source options, symbolizing keys so the data is compatible with CookbookLocationSpecification" do
+      expected = { path: "../my_repo/nginx" }
+      expect(cookbook_lock.source_options).to eq(expected)
+    end
+
+    context "after the data has been refreshed" do
+
+      before do
+        allow(cookbook_lock).to receive(:identifiers).and_return(identifiers)
+        cookbook_lock.refresh!
+      end
+
+      context "and the underlying hasn't been mutated" do
+
+        let(:identifiers) do
+          instance_double("ChefDK::CookbookProfiler::Identifiers",
+                         content_identifier: "abc123",
+                         dotted_decimal_identifier: "111.222.333",
+                         semver_version: "1.2.3")
+        end
+
+        it "has the correct identifier" do
+          expect(cookbook_lock.identifier).to eq("abc123")
+        end
+
+        it "has the correct dotted_decimal_identifier" do
+          expect(cookbook_lock.dotted_decimal_identifier).to eq("111.222.333")
+        end
+
+        it "has the correct version" do
+          expect(cookbook_lock.version).to eq("1.2.3")
+        end
+
+        it "sets the updated flag to false" do
+          expect(cookbook_lock).to_not be_updated
+        end
+
+        it "sets the version_updated flag to false" do
+          expect(cookbook_lock.version_updated?).to be(false)
+        end
+
+        it "sets the identifier_updated flag to false" do
+          expect(cookbook_lock.identifier_updated?).to be(false)
+        end
+
+      end
+
+      context "and the underlying data has been mutated" do
+        # represents the updated state of the cookbook
+        let(:identifiers) do
+          instance_double("ChefDK::CookbookProfiler::Identifiers",
+                         content_identifier: "def456",
+                         dotted_decimal_identifier: "777.888.999",
+                         semver_version: "7.8.9")
+        end
+
+        it "sets the content identifier to the new identifier" do
+          expect(cookbook_lock.identifier).to eq("def456")
+        end
+
+        it "sets the dotted_decimal_identifier to the new identifier" do
+          expect(cookbook_lock.dotted_decimal_identifier).to eq("777.888.999")
+        end
+
+        it "sets the SemVer version to the new version" do
+          expect(cookbook_lock.version).to eq("7.8.9")
+        end
+
+        it "sets the updated flag to true" do
+          expect(cookbook_lock).to be_updated
+        end
+
+        it "sets the version_updated flag to true" do
+          expect(cookbook_lock.version_updated?).to be(true)
+        end
+
+        it "sets the identifier_updated flag to true" do
+          expect(cookbook_lock.identifier_updated?).to be(true)
+        end
+      end
+    end
+  end
+
+end

data/spec/unit/policyfile/read_cookbook_for_compat_mode_upload_spec.rb

@@ -0,0 +1,85 @@
+#
+# 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/read_cookbook_for_compat_mode_upload'
+
+describe ChefDK::Policyfile::ReadCookbookForCompatModeUpload do
+
+  let(:cookbook_name) { "noignore" }
+
+  let(:version_override) { "123.456.789" }
+
+  let(:directory_path) { File.join(fixtures_path, "local_path_cookbooks/noignore-f59ee7a5bca6a4e606b67f7f856b768d847c39bb") }
+
+  let(:reader) { described_class.new(cookbook_name, version_override, directory_path) }
+
+  it "has a cookbook_name" do
+    expect(reader.cookbook_name).to eq(cookbook_name)
+  end
+
+  it "has a version number override" do
+    expect(reader.version_override).to eq(version_override)
+  end
+
+  it "has a directory path" do
+    expect(reader.directory_path).to eq(directory_path)
+  end
+
+  it "has an empty chefignore when the cookbook doesn't include one" do
+    expect(reader.chefignore.ignores).to eq([])
+  end
+
+  it "loads the cookbook with the correct name" do
+    expect(reader.cookbook_version.name).to eq(:noignore)
+  end
+
+  it "loads the cookbook with the correct version" do
+    expect(reader.cookbook_version.version).to eq(version_override)
+  end
+
+  it "freezes the cookbook version" do
+    expect(reader.cookbook_version.frozen_version?).to be true
+  end
+
+  context "when a cookbook has a chefignore file" do
+
+    let(:directory_path) { File.join(fixtures_path, "cookbook_cache/baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb") }
+
+    let(:copied_cookbook_path) { File.join(tempdir, "baz-f59ee7a5bca6a4e606b67f7f856b768d847c39bb") }
+
+    let(:chefignored_file) { File.join(copied_cookbook_path, "Guardfile") }
+
+    let(:reader_with_ignored_files) do
+      described_class.new(cookbook_name, version_override, copied_cookbook_path)
+    end
+
+    before do
+      FileUtils.cp_r(directory_path, copied_cookbook_path)
+      File.open(chefignored_file, "w+") { |f| f.puts "This file should not affect the cookbooks checksum" }
+    end
+
+    after do
+      clear_tempdir
+    end
+
+    it "excludes ignored files from the list of cookbook files" do
+      expect(reader_with_ignored_files.cookbook_version.root_filenames).to_not include(chefignored_file)
+    end
+
+  end
+end

data/spec/unit/policyfile/solution_dependencies_spec.rb

@@ -0,0 +1,145 @@
+#
+# 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/solution_dependencies'
+
+describe ChefDK::Policyfile::SolutionDependencies do
+
+  let(:dependency_data) { {} }
+
+  let(:solution_dependencies) do
+    s = described_class.new
+    s.consume_lock_data(dependency_data)
+    s
+  end
+
+  it "has a list of dependencies declared in the Policyfile" do
+    expect(solution_dependencies.policyfile_dependencies).to eq([])
+  end
+
+  it "has a map of dependencies declared by cookbooks" do
+    expect(solution_dependencies.cookbook_dependencies).to eq({})
+  end
+
+  context "when populated with dependency data from a lockfile" do
+
+    let(:dependency_data) do
+      {
+        "Policyfile" => [
+          [ "nginx", "~> 1.0"], ["postgresql", ">= 0.0.0" ]
+        ],
+        "dependencies" => {
+          "nginx (1.2.3)" => [ ["apt", "~> 2.3"], ["yum", "~>3.4"] ],
+          "apt (2.5.6)" => [],
+          "yum (3.4.1)" => [],
+          "postgresql (5.0.0)" => []
+        }
+      }
+    end
+
+    it "has a list of dependencies from the policyfile" do
+      expected = [ "nginx", "~> 1.0"], ["postgresql", ">= 0.0.0" ]
+      expect(solution_dependencies.policyfile_dependencies_for_lock).to eq(expected)
+    end
+
+    it "has a list of dependencies from cookbooks" do
+      expected = {
+        "nginx (1.2.3)" => [ ["apt", "~> 2.3"], ["yum", "~> 3.4"] ],
+        "apt (2.5.6)" => [],
+        "yum (3.4.1)" => [],
+        "postgresql (5.0.0)" => []
+      }
+      expect(solution_dependencies.cookbook_deps_for_lock).to eq(expected)
+    end
+
+  end
+
+  context "when populated with dependency data" do
+
+    let(:expected_deps_for_lock) do
+      {
+        "nginx (1.2.3)" => [ ["apt", "~> 2.3"], ["yum", "~> 3.4"] ],
+        "apt (2.5.6)" => [],
+        "yum (3.4.1)" => [],
+        "postgresql (5.0.0)" => []
+      }
+    end
+
+    let(:expected_policyfile_deps_for_lock) do
+      [ [ "nginx", "~> 1.0"], ["postgresql", ">= 0.0.0" ] ]
+    end
+
+    before do
+      solution_dependencies.add_policyfile_dep("nginx", "~> 1.0")
+      solution_dependencies.add_policyfile_dep("postgresql", ">= 0.0.0")
+      solution_dependencies.add_cookbook_dep("nginx", "1.2.3", [ ["apt", "~> 2.3"], ["yum", "~>3.4"] ])
+      solution_dependencies.add_cookbook_dep("apt", "2.5.6", [])
+      solution_dependencies.add_cookbook_dep("yum", "3.4.1", [])
+      solution_dependencies.add_cookbook_dep("postgresql", "5.0.0", [])
+    end
+
+    it "has a list of dependencies from the Policyfile" do
+      expect(solution_dependencies.policyfile_dependencies_for_lock).to eq(expected_policyfile_deps_for_lock)
+    end
+
+    it "has a list of dependencies from cookbooks" do
+      expect(solution_dependencies.cookbook_deps_for_lock).to eq(expected_deps_for_lock)
+    end
+
+    it "generates lock info containing both policyfile and cookbook dependencies" do
+      expected = {"Policyfile" => expected_policyfile_deps_for_lock, "dependencies" => expected_deps_for_lock}
+      expect(solution_dependencies.to_lock).to eq(expected)
+    end
+
+    describe "checking for dependency conflicts" do
+
+      it "does not raise if a cookbook that's in the dependency set with a different version doesn't conflict" do
+        solution_dependencies.update_cookbook_dep("yum", "3.5.0", [ ])
+        expect(solution_dependencies.test_conflict!('yum', '3.5.0')).to be(false)
+      end
+
+      it "raises if a cookbook is not in the current solution set" do
+        expected_message = "Cookbook foo (1.0.0) not in the working set, cannot test for conflicts"
+        expect { solution_dependencies.test_conflict!('foo', '1.0.0') }.to raise_error(ChefDK::CookbookNotInWorkingSet, expected_message)
+      end
+
+      it "raises when a cookbook conflicts with a Policyfile constraint" do
+        solution_dependencies.update_cookbook_dep("nginx", "2.0.0", [])
+
+        expected_message = "Cookbook nginx (2.0.0) conflicts with other dependencies:\nPolicyfile depends on nginx ~> 1.0"
+        expect { solution_dependencies.test_conflict!('nginx', '2.0.0') }.to raise_error(ChefDK::DependencyConflict, expected_message)
+      end
+
+      it "raises when a cookbook conflicts with another cookbook's dependency constraint" do
+        solution_dependencies.update_cookbook_dep("apt", "3.0.0", [])
+
+        expected_message = "Cookbook apt (3.0.0) conflicts with other dependencies:\nnginx (1.2.3) depends on apt ~> 2.3"
+        expect { solution_dependencies.test_conflict!('apt', '3.0.0') }.to raise_error(ChefDK::DependencyConflict, expected_message)
+      end
+
+      it "raises when a cookbook's dependencies are no longer satisfiable" do
+        solution_dependencies.update_cookbook_dep("nginx", "1.2.3", [ [ "apt", "~> 3.0" ] ])
+        expected_message = "Cookbook nginx (1.2.3) has dependency constraints that cannot be met by the existing cookbook set:\n" +
+          "Dependency on apt ~> 3.0 conflicts with existing version apt (2.5.6)"
+        expect { solution_dependencies.test_conflict!('nginx', '1.2.3') }.to raise_error(ChefDK::DependencyConflict, expected_message)
+      end
+
+    end
+  end
+
+end