chef-dk 2.6.2 → 3.0.36

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

@@ -1,57 +1,57 @@
-#
-# Copyright:: Copyright (c) 2016 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 "addressable/uri"
-require "chef-dk/exceptions"
-
-module ChefDK
-  module Policyfile
-    class SourceURI < Addressable::URI
-      class << self
-        # Returns a URI object based on the parsed string.
-        #
-        # @param [String, Addressable::URI, #to_str] uri The URI
-        # string to parse.  No parsing is performed if the object
-        # is already an <code>Addressable::URI</code>.
-        #
-        # @raise [ChefDK::InvalidPolicyfileSourceURI]
-        #
-        # @return [ChefDK::Policyfile::SourceURI]
-        def parse(uri)
-          parsed_uri = super(uri)
-          parsed_uri.send(:validate)
-          parsed_uri
-        rescue TypeError, ArgumentError => ex
-          raise ChefDK::InvalidPolicyfileSourceURI.new(uri, ex)
-        end
-      end
-
-      VALID_SCHEMES = %w{ https http }.freeze
-
-      # @raise [ChefDK::InvalidPolicyfileSourceURI]
-      def validate
-        super
-
-        unless VALID_SCHEMES.include?(scheme)
-          raise InvalidPolicyfileSourceURI.new(self, "invalid URI scheme '#{scheme}'. Valid schemes: #{VALID_SCHEMES}")
-        end
-      rescue Addressable::URI::InvalidURIError => ex
-        raise InvalidPolicyfileSourceURI.new(self, ex)
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2016 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 "addressable/uri"
+require "chef-dk/exceptions"
+
+module ChefDK
+  module Policyfile
+    class SourceURI < Addressable::URI
+      class << self
+        # Returns a URI object based on the parsed string.
+        #
+        # @param [String, Addressable::URI, #to_str] uri The URI
+        # string to parse.  No parsing is performed if the object
+        # is already an <code>Addressable::URI</code>.
+        #
+        # @raise [ChefDK::InvalidPolicyfileSourceURI]
+        #
+        # @return [ChefDK::Policyfile::SourceURI]
+        def parse(uri)
+          parsed_uri = super(uri)
+          parsed_uri.send(:validate)
+          parsed_uri
+        rescue TypeError, ArgumentError => ex
+          raise ChefDK::InvalidPolicyfileSourceURI.new(uri, ex)
+        end
+      end
+
+      VALID_SCHEMES = %w{ https http }.freeze
+
+      # @raise [ChefDK::InvalidPolicyfileSourceURI]
+      def validate
+        super
+
+        unless VALID_SCHEMES.include?(scheme)
+          raise InvalidPolicyfileSourceURI.new(self, "invalid URI scheme '#{scheme}'. Valid schemes: #{VALID_SCHEMES}")
+        end
+      rescue Addressable::URI::InvalidURIError => ex
+        raise InvalidPolicyfileSourceURI.new(self, ex)
+      end
+    end
+  end
+end

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

@@ -1,102 +1,112 @@
-#
-# 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 "chef-dk/cookbook_omnifetch"
-require "chef-dk/exceptions"
-
-module ChefDK
-  module Policyfile
-
-    class StorageConfig
-
-      attr_accessor :relative_paths_root
-      attr_accessor :cache_path
-
-      attr_reader :policyfile_filename
-      attr_reader :policyfile_lock_filename
-
-      def initialize(options = {})
-        @relative_paths_root = Dir.pwd
-        @cache_path = CookbookOmnifetch.storage_path
-        @policyfile_filename = "<< Policyfile filename not specified >>"
-        @policyfile_lock_filename = "<< Policyfile lock filename not specified >>"
-        handle_options(options)
-      end
-
-      def use_policyfile(policyfile_filename)
-        if policyfile_filename.end_with?(".lock.json")
-          return use_policyfile_lock(policyfile_filename)
-        end
-        unless policyfile_filename.end_with?(".rb")
-          raise InvalidPolicyfileFilename, "Policyfile filenames must end with `.rb' extension (you gave: `#{policyfile_filename}')"
-        end
-        @policyfile_filename = policyfile_filename
-        @policyfile_lock_filename = policyfile_filename.sub(/\.rb\Z/, ".lock.json")
-        @relative_paths_root = File.dirname(policyfile_filename)
-        self
-      end
-
-      def use_policyfile_lock(policyfile_lock_filename)
-        @policyfile_lock_filename = policyfile_lock_filename
-        @policyfile_filename = policyfile_lock_filename.sub(/\.lock\.json\Z/, ".rb")
-        @relative_paths_root = File.dirname(policyfile_lock_filename)
-        self
-      end
-
-      def policyfile_expanded_path
-        File.expand_path(policyfile_filename, relative_paths_root)
-      end
-
-      def policyfile_lock_expanded_path
-        File.expand_path(policyfile_lock_filename, relative_paths_root)
-      end
-
-      private
-
-      def handle_options(options)
-        @cache_path = options[:cache_path] if options[:cache_path]
-        @relative_paths_root = options[:relative_paths_root] if options.key?(:relative_paths_root)
-      end
-
-    end
-
-    module StorageConfigDelegation
-
-      def cache_path
-        storage_config.cache_path
-      end
-
-      def relative_paths_root
-        storage_config.relative_paths_root
-      end
-
-      def policyfile_filename
-        storage_config.policyfile_filename
-      end
-
-      def policyfile_expanded_path
-        storage_config.policyfile_expanded_path
-      end
-
-      def policyfile_lock_expanded_path
-        storage_config.policyfile_lock_expanded_path
-      end
-
-    end
-
-  end
-end
+#
+# 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/cookbook_omnifetch"
+require "chef-dk/exceptions"
+
+module ChefDK
+  module Policyfile
+
+    # Provides handling of relative paths, such as on disk cookbooks which
+    # are specified relative to the Policyfile and local caching of compiled
+    # Policyfile artifacts.
+    #
+    # @author Dan DeLeo
+    # @since 0.11.0
+    # @attr_accessor [String] relative_paths_root Root path relative to the named Policyfile
+    # @attr_accessor [String] cache_path Local cache directory for
+    # @attr_reader [String] policyfile_filename Uncompiled Policyfile filename.
+    # @attr_reader [String] policyfile_lock_filename Filename of compiled Policyfile.
+    class StorageConfig
+
+      attr_accessor :relative_paths_root
+      attr_accessor :cache_path
+
+      attr_reader :policyfile_filename
+      attr_reader :policyfile_lock_filename
+
+      def initialize(options = {})
+        @relative_paths_root = Dir.pwd
+        @cache_path = CookbookOmnifetch.storage_path
+        @policyfile_filename = "<< Policyfile filename not specified >>"
+        @policyfile_lock_filename = "<< Policyfile lock filename not specified >>"
+        handle_options(options)
+      end
+
+      def use_policyfile(policyfile_filename)
+        if policyfile_filename.end_with?(".lock.json")
+          return use_policyfile_lock(policyfile_filename)
+        end
+        unless policyfile_filename.end_with?(".rb")
+          raise InvalidPolicyfileFilename, "Policyfile filenames must end with `.rb' extension (you gave: `#{policyfile_filename}')"
+        end
+        @policyfile_filename = policyfile_filename
+        @policyfile_lock_filename = policyfile_filename.sub(/\.rb\Z/, ".lock.json")
+        @relative_paths_root = File.dirname(policyfile_filename)
+        self
+      end
+
+      def use_policyfile_lock(policyfile_lock_filename)
+        @policyfile_lock_filename = policyfile_lock_filename
+        @policyfile_filename = policyfile_lock_filename.sub(/\.lock\.json\Z/, ".rb")
+        @relative_paths_root = File.dirname(policyfile_lock_filename)
+        self
+      end
+
+      def policyfile_expanded_path
+        File.expand_path(policyfile_filename, relative_paths_root)
+      end
+
+      def policyfile_lock_expanded_path
+        File.expand_path(policyfile_lock_filename, relative_paths_root)
+      end
+
+      private
+
+      def handle_options(options)
+        @cache_path = options[:cache_path] if options[:cache_path]
+        @relative_paths_root = options[:relative_paths_root] if options.key?(:relative_paths_root)
+      end
+
+    end
+
+    module StorageConfigDelegation
+
+      def cache_path
+        storage_config.cache_path
+      end
+
+      def relative_paths_root
+        storage_config.relative_paths_root
+      end
+
+      def policyfile_filename
+        storage_config.policyfile_filename
+      end
+
+      def policyfile_expanded_path
+        storage_config.policyfile_expanded_path
+      end
+
+      def policyfile_lock_expanded_path
+        storage_config.policyfile_lock_expanded_path
+      end
+
+    end
+
+  end
+end

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

@@ -1,139 +1,139 @@
-#
-# Copyright:: Copyright (c) 2015 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
-
-    class UndoRecord
-
-      PolicyGroupRestoreData = Struct.new(:policy_name, :policy_group, :data) do
-
-        def load(data)
-          self.policy_name = data["policy_name"]
-          self.policy_group = data["policy_group"]
-          self.data = data["data"]
-          self
-        end
-
-        def for_serialization
-          {
-            "policy_name" => policy_name,
-            "policy_group" => policy_group,
-            "data" => data,
-          }
-        end
-
-      end
-
-      attr_reader :policy_groups
-
-      attr_reader :policy_revisions
-
-      attr_accessor :description
-
-      def initialize
-        reset!
-      end
-
-      def ==(other)
-        other.kind_of?(UndoRecord) &&
-          other.policy_groups == policy_groups &&
-          other.policy_revisions == policy_revisions
-      end
-
-      def add_policy_group(name)
-        @policy_groups << name
-      end
-
-      def add_policy_revision(policy_name, policy_group, data)
-        @policy_revisions << PolicyGroupRestoreData.new(policy_name, policy_group, data)
-      end
-
-      def load(data)
-        reset!
-
-        unless data.kind_of?(Hash)
-          raise InvalidUndoRecord, "Undo data is incorrectly formatted. Must be a Hash, got '#{data}'."
-        end
-        missing_fields = %w{ format_version description backup_data }.select { |key| !data.key?(key) }
-        unless missing_fields.empty?
-          raise InvalidUndoRecord, "Undo data is missing mandatory field(s) #{missing_fields.join(', ')}. Undo data: '#{data}'"
-        end
-
-        @description = data["description"]
-
-        policy_data = data["backup_data"]
-        unless policy_data.kind_of?(Hash)
-          raise InvalidUndoRecord, "'backup_data' in the undo record is incorrectly formatted. Must be a Hash, got '#{policy_data}'"
-        end
-        missing_policy_data_fields = %w{ policy_groups policy_revisions }.select { |key| !policy_data.key?(key) }
-        unless missing_policy_data_fields.empty?
-          raise InvalidUndoRecord,
-            "'backup_data' in the undo record is missing mandatory field(s) #{missing_policy_data_fields.join(', ')}. Backup data: #{policy_data}"
-        end
-
-        policy_groups = policy_data["policy_groups"]
-
-        unless policy_groups.kind_of?(Array)
-          raise InvalidUndoRecord,
-            "'policy_groups' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_groups}'"
-        end
-
-        @policy_groups = policy_groups
-
-        policy_revisions = policy_data["policy_revisions"]
-        unless policy_revisions.kind_of?(Array)
-          raise InvalidUndoRecord,
-            "'policy_revisions' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_revisions}'"
-        end
-
-        policy_revisions.each do |revision|
-          unless revision.kind_of?(Hash)
-            raise InvalidUndoRecord,
-              "Invalid item in 'policy_revisions' in the undo record. Must be a Hash, got '#{revision}'"
-          end
-
-          @policy_revisions << PolicyGroupRestoreData.new.load(revision)
-        end
-
-        self
-      end
-
-      def for_serialization
-        {
-          "format_version" => 1,
-          "description" => description,
-          "backup_data" => {
-            "policy_groups" => policy_groups,
-            "policy_revisions" => policy_revisions.map(&:for_serialization),
-          },
-        }
-      end
-
-      private
-
-      def reset!
-        @description = ""
-        @policy_groups = []
-        @policy_revisions = []
-      end
-
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2015 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
+
+    class UndoRecord
+
+      PolicyGroupRestoreData = Struct.new(:policy_name, :policy_group, :data) do
+
+        def load(data)
+          self.policy_name = data["policy_name"]
+          self.policy_group = data["policy_group"]
+          self.data = data["data"]
+          self
+        end
+
+        def for_serialization
+          {
+            "policy_name" => policy_name,
+            "policy_group" => policy_group,
+            "data" => data,
+          }
+        end
+
+      end
+
+      attr_reader :policy_groups
+
+      attr_reader :policy_revisions
+
+      attr_accessor :description
+
+      def initialize
+        reset!
+      end
+
+      def ==(other)
+        other.kind_of?(UndoRecord) &&
+          other.policy_groups == policy_groups &&
+          other.policy_revisions == policy_revisions
+      end
+
+      def add_policy_group(name)
+        @policy_groups << name
+      end
+
+      def add_policy_revision(policy_name, policy_group, data)
+        @policy_revisions << PolicyGroupRestoreData.new(policy_name, policy_group, data)
+      end
+
+      def load(data)
+        reset!
+
+        unless data.kind_of?(Hash)
+          raise InvalidUndoRecord, "Undo data is incorrectly formatted. Must be a Hash, got '#{data}'."
+        end
+        missing_fields = %w{ format_version description backup_data }.select { |key| !data.key?(key) }
+        unless missing_fields.empty?
+          raise InvalidUndoRecord, "Undo data is missing mandatory field(s) #{missing_fields.join(', ')}. Undo data: '#{data}'"
+        end
+
+        @description = data["description"]
+
+        policy_data = data["backup_data"]
+        unless policy_data.kind_of?(Hash)
+          raise InvalidUndoRecord, "'backup_data' in the undo record is incorrectly formatted. Must be a Hash, got '#{policy_data}'"
+        end
+        missing_policy_data_fields = %w{ policy_groups policy_revisions }.select { |key| !policy_data.key?(key) }
+        unless missing_policy_data_fields.empty?
+          raise InvalidUndoRecord,
+            "'backup_data' in the undo record is missing mandatory field(s) #{missing_policy_data_fields.join(', ')}. Backup data: #{policy_data}"
+        end
+
+        policy_groups = policy_data["policy_groups"]
+
+        unless policy_groups.kind_of?(Array)
+          raise InvalidUndoRecord,
+            "'policy_groups' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_groups}'"
+        end
+
+        @policy_groups = policy_groups
+
+        policy_revisions = policy_data["policy_revisions"]
+        unless policy_revisions.kind_of?(Array)
+          raise InvalidUndoRecord,
+            "'policy_revisions' data in the undo record is incorrectly formatted. Must be an Array, got '#{policy_revisions}'"
+        end
+
+        policy_revisions.each do |revision|
+          unless revision.kind_of?(Hash)
+            raise InvalidUndoRecord,
+              "Invalid item in 'policy_revisions' in the undo record. Must be a Hash, got '#{revision}'"
+          end
+
+          @policy_revisions << PolicyGroupRestoreData.new.load(revision)
+        end
+
+        self
+      end
+
+      def for_serialization
+        {
+          "format_version" => 1,
+          "description" => description,
+          "backup_data" => {
+            "policy_groups" => policy_groups,
+            "policy_revisions" => policy_revisions.map(&:for_serialization),
+          },
+        }
+      end
+
+      private
+
+      def reset!
+        @description = ""
+        @policy_groups = []
+        @policy_revisions = []
+      end
+
+    end
+  end
+end