chef-dk 3.9.0 → 3.10.1

data/lib/chef-dk/policyfile/local_lock_fetcher.rb

@@ -1,129 +1,132 @@
-#
-# 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 "chef-dk/policyfile_lock"
-require "chef-dk/exceptions"
-
-module ChefDK
-  module Policyfile
-
-    # A policyfile lock fetcher that can read a lock from a local disk
-    class LocalLockFetcher
-
-      attr_reader :name
-      attr_reader :source_options
-      attr_reader :storage_config
-
-      # Initialize a LocalLockFetcher
-      #
-      # @param name [String] The name of the policyfile
-      # @param source_options [Hash] A hash with a :path key pointing at the location
-      #                              of the lock
-      # @param storage_config [StorageConfig]
-      def initialize(name, source_options, storage_config)
-        @name = name
-        @source_options = source_options
-        @storage_config = storage_config
-      end
-
-      # @return [True] if there were no errors with the provided source_options
-      # @return [False] if there were errors with the provided source_options
-      def valid?
-        errors.empty?
-      end
-
-      # Check the options provided when craeting this class for errors
-      #
-      # @return [Array<String>] A list of errors found
-      def errors
-        error_messages = []
-
-        [:path].each do |key|
-          error_messages << "include_policy for #{name} is missing key #{key}" unless source_options[key]
-        end
-
-        error_messages
-      end
-
-      # @return [Hash] The source_options that describe how to fetch this exact lock again
-      def source_options_for_lock
-        source_options
-      end
-
-      # Applies source options from a lock file. This is used to make sure that the same
-      # policyfile lock is loaded that was locked
-      #
-      # @param options_from_lock [Hash] The source options loaded from a policyfile lock
-      def apply_locked_source_options(options_from_lock)
-        # There are no options the lock could provide
-      end
-
-      # @return [String] of the policyfile lock data
-      def lock_data
-        FFI_Yajl::Parser.new.parse(content).tap do |data|
-          data["cookbook_locks"].each do |cookbook_name, cookbook_lock|
-            cookbook_path = cookbook_lock["source_options"]["path"]
-            if !cookbook_path.nil?
-              cookbook_lock["source_options"]["path"] = transform_path(cookbook_path)
-            end
-          end
-        end
-      end
-
-      private
-
-      # Transforms cookbook paths to a path relative to the current
-      # cookbook for which we are generating a new lock file.
-      # Eg: '../cookbooks/base_cookbook'
-      #
-      # @param path_to_transform [String] Path to dependent cookbook.
-      # @return [Pathname] Path to dependent cookbook relative to the current cookbook/Policyfile.
-      def transform_path(path_to_transform)
-        cur_path = Pathname.new(storage_config.relative_paths_root)
-        include_path = Pathname.new(path).dirname
-        include_path.relative_path_from(cur_path).join(path_to_transform).to_s
-      end
-
-      def content
-        IO.read(path)
-      end
-
-      def path
-        @path ||= begin
-          path = abs_path
-          if path.directory?
-            path = path.join("#{name}.lock.json")
-            if !path.file?
-              raise ChefDK::LocalPolicyfileLockNotFound.new(
-                "Expected to find file #{name}.lock.json inside #{source_options[:path]}. If the file name is different than this, provide the file name as part of the path.")
-            end
-          else
-            if !path.file?
-              raise ChefDK::LocalPolicyfileLockNotFound.new(
-                "The provided path #{source_options[:path]} does not exist.")
-            end
-          end
-          path
-        end
-      end
-
-      def abs_path
-        Pathname.new(source_options[:path]).expand_path(storage_config.relative_paths_root)
-      end
-    end
-  end
-end
+#
+# 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 "chef-dk/policyfile_lock"
+require "chef-dk/policyfile/lock_fetcher_mixin"
+require "chef-dk/exceptions"
+
+module ChefDK
+  module Policyfile
+
+    # A policyfile lock fetcher that can read a lock from a local disk
+    class LocalLockFetcher
+      include LockFetcherMixin
+
+      attr_reader :name
+      attr_reader :source_options
+      attr_reader :storage_config
+
+      # Initialize a LocalLockFetcher
+      #
+      # @param name [String] The name of the policyfile
+      # @param source_options [Hash] A hash with a :path key pointing at the location
+      #                              of the lock
+      # @param storage_config [StorageConfig]
+      def initialize(name, source_options, storage_config)
+        @name = name
+        @source_options = source_options
+        @storage_config = storage_config
+      end
+
+      # @return [True] if there were no errors with the provided source_options
+      # @return [False] if there were errors with the provided source_options
+      def valid?
+        errors.empty?
+      end
+
+      # Check the options provided when craeting this class for errors
+      #
+      # @return [Array<String>] A list of errors found
+      def errors
+        error_messages = []
+
+        [:path].each do |key|
+          error_messages << "include_policy for #{name} is missing key #{key}" unless source_options[key]
+        end
+
+        error_messages
+      end
+
+      # @return [Hash] The source_options that describe how to fetch this exact lock again
+      def source_options_for_lock
+        source_options
+      end
+
+      # Applies source options from a lock file. This is used to make sure that the same
+      # policyfile lock is loaded that was locked
+      #
+      # @param options_from_lock [Hash] The source options loaded from a policyfile lock
+      def apply_locked_source_options(options_from_lock)
+        # There are no options the lock could provide
+      end
+
+      # @return [String] of the policyfile lock data
+      def lock_data
+        FFI_Yajl::Parser.new.parse(content).tap do |data|
+          validate_revision_id(data["revision_id"], source_options)
+          data["cookbook_locks"].each do |cookbook_name, cookbook_lock|
+            cookbook_path = cookbook_lock["source_options"]["path"]
+            if !cookbook_path.nil?
+              cookbook_lock["source_options"]["path"] = transform_path(cookbook_path)
+            end
+          end
+        end
+      end
+
+      private
+
+      # Transforms cookbook paths to a path relative to the current
+      # cookbook for which we are generating a new lock file.
+      # Eg: '../cookbooks/base_cookbook'
+      #
+      # @param path_to_transform [String] Path to dependent cookbook.
+      # @return [Pathname] Path to dependent cookbook relative to the current cookbook/Policyfile.
+      def transform_path(path_to_transform)
+        cur_path = Pathname.new(storage_config.relative_paths_root)
+        include_path = Pathname.new(path).dirname
+        include_path.relative_path_from(cur_path).join(path_to_transform).to_s
+      end
+
+      def content
+        IO.read(path)
+      end
+
+      def path
+        @path ||= begin
+          path = abs_path
+          if path.directory?
+            path = path.join("#{name}.lock.json")
+            if !path.file?
+              raise ChefDK::LocalPolicyfileLockNotFound.new(
+                "Expected to find file #{name}.lock.json inside #{source_options[:path]}. If the file name is different than this, provide the file name as part of the path.")
+            end
+          else
+            if !path.file?
+              raise ChefDK::LocalPolicyfileLockNotFound.new(
+                "The provided path #{source_options[:path]} does not exist.")
+            end
+          end
+          path
+        end
+      end
+
+      def abs_path
+        Pathname.new(source_options[:path]).expand_path(storage_config.relative_paths_root)
+      end
+    end
+  end
+end

data/lib/chef-dk/policyfile/lock_applier.rb

@@ -1,80 +1,80 @@
-#
-# 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.
-#
-
-module ChefDK
-  module Policyfile
-
-    # A class that can apply constraints from a lock to a compiler
-    class LockApplier
-      attr_reader :unlocked_policies
-      attr_reader :policyfile_lock
-      attr_reader :policyfile_compiler
-
-      # Initialize a LockApplier. By default, all locked data this class knows
-      # about will be applied to the compiler. Currently, it applies locks only
-      # for included policies.
-      #
-      # @param policyfile_lock [PolicyfileLock] contains the locked data to use
-      # @param policyfile_compiler [PolicyfileCompiler] the compiler to apply the locked data
-      def initialize(policyfile_lock, policyfile_compiler)
-        @policyfile_lock = policyfile_lock
-        @policyfile_compiler = policyfile_compiler
-        @unlocked_policies = []
-      end
-
-      # Unlocks included policies
-      #
-      # @param policies [:all] Unconstrain all policies
-      # @param policies [Array<String>] Unconstrain a specific policy by name
-      def with_unlocked_policies(policies)
-        if policies == :all || unlocked_policies == :all
-          @unlocked_policies = :all
-        else
-          policies.each do |policy|
-            @unlocked_policies << policy
-          end
-        end
-        self
-      end
-
-      # Apply locks described in policyfile_lock allowing for the deviations asked
-      # for.
-      #
-      # @note No changes are applied until apply! is invoked
-      def apply!
-        prepare_constraints_for_policies
-      end
-
-      private
-
-      def prepare_constraints_for_policies
-        if unlocked_policies == :all
-          return
-        end
-
-        policyfile_compiler.included_policies.each do |policy|
-          if !unlocked_policies.include?(policy.name)
-            lock = policyfile_lock.included_policy_locks.find do |policy_lock|
-              policy_lock["name"] == policy.name
-            end
-            policy.apply_locked_source_options(lock["source_options"])
-          end
-        end
-      end
-    end
-  end
-end
+#
+# 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.
+#
+
+module ChefDK
+  module Policyfile
+
+    # A class that can apply constraints from a lock to a compiler
+    class LockApplier
+      attr_reader :unlocked_policies
+      attr_reader :policyfile_lock
+      attr_reader :policyfile_compiler
+
+      # Initialize a LockApplier. By default, all locked data this class knows
+      # about will be applied to the compiler. Currently, it applies locks only
+      # for included policies.
+      #
+      # @param policyfile_lock [PolicyfileLock] contains the locked data to use
+      # @param policyfile_compiler [PolicyfileCompiler] the compiler to apply the locked data
+      def initialize(policyfile_lock, policyfile_compiler)
+        @policyfile_lock = policyfile_lock
+        @policyfile_compiler = policyfile_compiler
+        @unlocked_policies = []
+      end
+
+      # Unlocks included policies
+      #
+      # @param policies [:all] Unconstrain all policies
+      # @param policies [Array<String>] Unconstrain a specific policy by name
+      def with_unlocked_policies(policies)
+        if policies == :all || unlocked_policies == :all
+          @unlocked_policies = :all
+        else
+          policies.each do |policy|
+            @unlocked_policies << policy
+          end
+        end
+        self
+      end
+
+      # Apply locks described in policyfile_lock allowing for the deviations asked
+      # for.
+      #
+      # @note No changes are applied until apply! is invoked
+      def apply!
+        prepare_constraints_for_policies
+      end
+
+      private
+
+      def prepare_constraints_for_policies
+        if unlocked_policies == :all
+          return
+        end
+
+        policyfile_compiler.included_policies.each do |policy|
+          if !unlocked_policies.include?(policy.name)
+            lock = policyfile_lock.included_policy_locks.find do |policy_lock|
+              policy_lock["name"] == policy.name
+            end
+            policy.apply_locked_source_options(lock["source_options"])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/chef-dk/policyfile/lock_fetcher_mixin.rb

@@ -0,0 +1,37 @@
+#
+# 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 "chef-dk/exceptions"
+
+module ChefDK
+  module Policyfile
+    module LockFetcherMixin
+      def validate_revision_id(included_id, source_options)
+        expected_id = source_options[:policy_revision_id]
+        if expected_id
+          if included_id.eql?(expected_id) # are they the same?
+            return
+          elsif included_id[0, 10].eql?(expected_id) # did they use the 10 char substring
+            return
+          else
+            raise ChefDK::InvalidLockfile, "Expected policy_revision_id '#{expected_id}' does not match included_policy '#{included_id}'."
+          end
+        end
+      end
+    end
+  end
+end