chef-dk 3.9.0 → 3.10.1

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

@@ -1,156 +1,156 @@
-#
-# 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/ui"
-
-module ChefDK
-  module Policyfile
-    class IncludedPoliciesCookbookSource
-
-      class ConflictingCookbookVersions < StandardError
-      end
-
-      class ConflictingCookbookDependencies < StandardError
-      end
-
-      class ConflictingCookbookSources < StandardError
-      end
-
-      # Why do we need this class?
-      # If we rely on default sources, we may not have the the universe of cookbooks
-      # provided in the included policies
-      #
-      # This is not meant to be used from the DSL
-
-      # A list of included policies
-      attr_reader :included_policy_location_specs
-      # UI object for output
-      attr_accessor :ui
-
-      # Constructor
-      #
-      def initialize(included_policy_location_specs)
-        @included_policy_location_specs = included_policy_location_specs
-        @ui = UI.new
-        @preferred_cookbooks = []
-        yield self if block_given?
-      end
-
-      def default_source_args
-        [:included_policies, []]
-      end
-
-      def check_for_conflicts!
-        source_options
-        universe_graph
-      end
-
-      # All are preferred here
-      def preferred_source_for?(cookbook_name)
-        universe_graph.include?(cookbook_name)
-      end
-
-      def preferred_cookbooks
-        universe_graph.keys
-      end
-
-      def ==(other)
-        other.kind_of?(self.class) && other.included_policy_location_specs == included_policy_location_specs
-      end
-
-      # Calls the slurp_metadata! helper once to calculate the @universe_graph
-      # and @cookbook_version_paths metadata.  Returns the @universe_graph.
-      #
-      # @return [Hash] universe_graph
-      def universe_graph
-        @universe_graph ||= build_universe
-      end
-
-      # Returns the metadata (path and version) for an individual cookbook
-      #
-      # @return [Hash] metadata for a single cookbook version
-      def source_options_for(cookbook_name, cookbook_version)
-        source_options[cookbook_name][cookbook_version]
-      end
-
-      def null?
-        false
-      end
-
-      def desc
-        "included_policies()"
-      end
-
-      private
-
-      def build_universe
-        included_policy_location_specs.inject({}) do |acc, policy_spec|
-          lock = policy_spec.policyfile_lock
-          cookbook_dependencies = lock.solution_dependencies.cookbook_dependencies
-          cookbook_dependencies.each do |(cookbook, deps)|
-            name = cookbook.name
-            version = cookbook.version
-            mapped_deps = deps.map do |dep|
-              [dep[0], dep[1].to_s]
-            end
-            if acc[name]
-              if acc[name][version]
-                if acc[name][version] != mapped_deps
-                  raise ConflictingCookbookDependencies.new("Conflicting dependencies provided for cookbook #{name}")
-                end
-              else
-                raise ConflictingCookbookVersions.new("Multiple versions provided for cookbook #{name}")
-              end
-            else
-              acc[name] = {}
-              acc[name][version] = mapped_deps
-            end
-          end
-          acc
-        end
-      end
-
-      def source_options
-        @source_options ||= build_source_options
-      end
-
-      ## Collect all the source options
-      def build_source_options
-        included_policy_location_specs.inject({}) do |acc, policy_spec|
-          lock = policy_spec.policyfile_lock
-          lock.cookbook_locks.each do |(name, cookbook_lock)|
-            version = cookbook_lock.version
-            if acc[name]
-              if acc[name][version]
-                if acc[name][version] != cookbook_lock.source_options
-                  raise ConflictingCookbookSources.new("Conflicting sources provided for cookbook #{name}")
-                end
-              else
-                raise ConflictingCookbookVersions.new("Multiple sources provided for cookbook #{name}")
-              end
-            else
-              acc[name] = {}
-              acc[name][version] = cookbook_lock.source_options
-            end
-          end
-          acc
-        end
-      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/ui"
+
+module ChefDK
+  module Policyfile
+    class IncludedPoliciesCookbookSource
+
+      class ConflictingCookbookVersions < StandardError
+      end
+
+      class ConflictingCookbookDependencies < StandardError
+      end
+
+      class ConflictingCookbookSources < StandardError
+      end
+
+      # Why do we need this class?
+      # If we rely on default sources, we may not have the the universe of cookbooks
+      # provided in the included policies
+      #
+      # This is not meant to be used from the DSL
+
+      # A list of included policies
+      attr_reader :included_policy_location_specs
+      # UI object for output
+      attr_accessor :ui
+
+      # Constructor
+      #
+      def initialize(included_policy_location_specs)
+        @included_policy_location_specs = included_policy_location_specs
+        @ui = UI.new
+        @preferred_cookbooks = []
+        yield self if block_given?
+      end
+
+      def default_source_args
+        [:included_policies, []]
+      end
+
+      def check_for_conflicts!
+        source_options
+        universe_graph
+      end
+
+      # All are preferred here
+      def preferred_source_for?(cookbook_name)
+        universe_graph.include?(cookbook_name)
+      end
+
+      def preferred_cookbooks
+        universe_graph.keys
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.included_policy_location_specs == included_policy_location_specs
+      end
+
+      # Calls the slurp_metadata! helper once to calculate the @universe_graph
+      # and @cookbook_version_paths metadata.  Returns the @universe_graph.
+      #
+      # @return [Hash] universe_graph
+      def universe_graph
+        @universe_graph ||= build_universe
+      end
+
+      # Returns the metadata (path and version) for an individual cookbook
+      #
+      # @return [Hash] metadata for a single cookbook version
+      def source_options_for(cookbook_name, cookbook_version)
+        source_options[cookbook_name][cookbook_version]
+      end
+
+      def null?
+        false
+      end
+
+      def desc
+        "included_policies()"
+      end
+
+      private
+
+      def build_universe
+        included_policy_location_specs.inject({}) do |acc, policy_spec|
+          lock = policy_spec.policyfile_lock
+          cookbook_dependencies = lock.solution_dependencies.cookbook_dependencies
+          cookbook_dependencies.each do |(cookbook, deps)|
+            name = cookbook.name
+            version = cookbook.version
+            mapped_deps = deps.map do |dep|
+              [dep[0], dep[1].to_s]
+            end
+            if acc[name]
+              if acc[name][version]
+                if acc[name][version] != mapped_deps
+                  raise ConflictingCookbookDependencies.new("Conflicting dependencies provided for cookbook #{name}")
+                end
+              else
+                raise ConflictingCookbookVersions.new("Multiple versions provided for cookbook #{name}")
+              end
+            else
+              acc[name] = {}
+              acc[name][version] = mapped_deps
+            end
+          end
+          acc
+        end
+      end
+
+      def source_options
+        @source_options ||= build_source_options
+      end
+
+      ## Collect all the source options
+      def build_source_options
+        included_policy_location_specs.inject({}) do |acc, policy_spec|
+          lock = policy_spec.policyfile_lock
+          lock.cookbook_locks.each do |(name, cookbook_lock)|
+            version = cookbook_lock.version
+            if acc[name]
+              if acc[name][version]
+                if acc[name][version] != cookbook_lock.source_options
+                  raise ConflictingCookbookSources.new("Conflicting sources provided for cookbook #{name}")
+                end
+              else
+                raise ConflictingCookbookVersions.new("Multiple sources provided for cookbook #{name}")
+              end
+            else
+              acc[name] = {}
+              acc[name][version] = cookbook_lock.source_options
+            end
+          end
+          acc
+        end
+      end
+
+    end
+  end
+end

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

@@ -1,229 +1,229 @@
-#
-# 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 "set"
-
-require "chef/server_api"
-require "chef-dk/service_exceptions"
-
-module ChefDK
-  module Policyfile
-
-    class RevIDLockDataMap
-
-      attr_reader :policy_name
-      attr_reader :lock_info_by_rev_id
-
-      def initialize(policy_name, lock_info_by_rev_id)
-        @policy_name = policy_name
-        @lock_info_by_rev_id = lock_info_by_rev_id
-      end
-
-      def cb_info_for(rev_id, cookbook_name)
-        lock = lock_info_by_rev_id[rev_id]
-        cookbook_lock = lock["cookbook_locks"][cookbook_name]
-
-        if cookbook_lock
-          [cookbook_lock["version"], cookbook_lock["identifier"] ]
-        else
-          nil
-        end
-      end
-
-      def cbs_with_differing_ids
-        cbs_with_differing_ids = Set.new
-        all_cookbook_names.each do |cookbook_name|
-          all_identifiers = lock_info_by_rev_id.inject(Set.new) do |id_set, (_rev_id, rev_info)|
-            cookbook_lock = rev_info["cookbook_locks"][cookbook_name]
-            identifier = cookbook_lock && cookbook_lock["identifier"]
-            id_set << identifier
-          end
-          cbs_with_differing_ids << cookbook_name if all_identifiers.size > 1
-        end
-        cbs_with_differing_ids
-      end
-
-      def all_cookbook_names
-        lock_info_by_rev_id.inject(Set.new) do |cb_set, (_rev_id, rev_info)|
-          cb_set.merge(rev_info["cookbook_locks"].keys)
-        end
-      end
-    end
-
-    class PolicyGroupRevIDMap
-
-      include Enumerable
-
-      attr_reader :policy_name
-      attr_reader :revision_ids_by_group
-
-      def initialize(policy_name, revision_ids_by_group)
-        @policy_name = policy_name
-        @revision_ids_by_group = revision_ids_by_group
-      end
-
-      def unique_revision_ids
-        revision_ids_by_group.values.uniq
-      end
-
-      def policy_group_names
-        revision_ids_by_group.keys
-      end
-
-      def max_group_name_length
-        policy_group_names.map(&:size).max
-      end
-
-      def format_revision_ids
-        revision_ids_by_group.inject({}) do |map, (group_name, rev_id)|
-          map[group_name] = yield rev_id
-          map
-        end
-      end
-
-      def empty?
-        policy_group_names.empty?
-      end
-
-      def each
-        revision_ids_by_group.each do |group_name, rev_id|
-          yield group_name, rev_id
-        end
-      end
-    end
-
-    class Lister
-
-      attr_accessor :policy_lock_content
-
-      attr_reader :config
-
-      def initialize(config: nil)
-        @config = config
-        @policies_by_name = nil
-        @policies_by_group = nil
-        @policy_lock_content = {}
-        @active_revisions = nil
-      end
-
-      # A Hash with the following format
-      #   {
-      #     "appserver" => {
-      #       "1111111111111111111111111111111111111111111111111111111111111111" => {},
-      #       "2222222222222222222222222222222222222222222222222222222222222222" => {}
-      #     },
-      def policies_by_name
-        @policies_by_name || fetch_policy_lists
-        @policies_by_name
-      end
-
-      # A Hash with the following format:
-      #   "dev" => {
-      #     "appserver" => "1111111111111111111111111111111111111111111111111111111111111111",
-      #     "load-balancer" => "5555555555555555555555555555555555555555555555555555555555555555",
-      #     "db" => "9999999999999999999999999999999999999999999999999999999999999999"
-      #   }
-      def policies_by_group
-        @policies_by_group || fetch_policy_lists
-        @policies_by_group
-      end
-
-      def revision_info_for(policy_name, _revision_id_list)
-        RevIDLockDataMap.new(policy_name, policy_lock_content[policy_name])
-      end
-
-      def revision_ids_by_group_for_each_policy
-        policies_by_name.each do |policy_name, _policies|
-          rev_id_by_group = revision_ids_by_group_for(policy_name)
-          yield policy_name, rev_id_by_group
-        end
-      end
-
-      def revision_ids_by_group_for(policy_name)
-        map = policies_by_group.inject({}) do |rev_id_map, (group_name, rev_id_map_for_group)|
-          rev_id_map[group_name] = rev_id_map_for_group[policy_name]
-          rev_id_map
-        end
-        PolicyGroupRevIDMap.new(policy_name, map)
-      end
-
-      def orphaned_revisions(policy_name)
-        orphans = []
-        policies_by_name[policy_name].each do |rev_id, _data|
-          orphans << rev_id unless active_revisions.include?(rev_id)
-        end
-        orphans
-      end
-
-      def active_revisions
-        @active_revisions ||= policies_by_group.inject(Set.new) do |set, (_group, policy_name_rev_id_map)|
-          policy_name_rev_id_map.each do |policy_name, rev_id|
-            set << rev_id
-          end
-          set
-        end
-      end
-
-      def empty?
-        policies_by_name.empty? && policies_by_group.empty?
-      end
-
-      def http_client
-        @http_client ||= Chef::ServerAPI.new(config.chef_server_url,
-                                                       signing_key_filename: config.client_key,
-                                                       client_name: config.node_name)
-      end
-
-      # @api private
-      # Sets internal copy of policyfile data to policies_by_name and
-      # policies_by_group. Used for internal testing.
-      def set!(policies_by_name, policies_by_group)
-        @policies_by_name = policies_by_name
-        @policies_by_group = policies_by_group
-        @active_revisions = nil
-      end
-
-      private
-
-      def fetch_policy_lists
-        policy_list_data = http_client.get("policies")
-        set_policies_by_name_from_api(policy_list_data)
-
-        policy_group_data = http_client.get("policy_groups")
-        set_policies_by_group_from_api(policy_group_data)
-      end
-
-      def set_policies_by_name_from_api(policy_list_data)
-        @policies_by_name = policy_list_data.inject({}) do |map, (policy_name, policy_info)|
-          map[policy_name] = policy_info["revisions"]
-          map
-        end
-      end
-
-      def set_policies_by_group_from_api(policy_group_data)
-        @policies_by_group = policy_group_data.inject({}) do |map, (policy_group, policy_info)|
-          map[policy_group] = (policy_info["policies"] || []).inject({}) do |rev_map, (policy_name, rev_info)|
-            rev_map[policy_name] = rev_info["revision_id"]; rev_map
-          end
-
-          map
-        end
-      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 "set"
+
+require "chef/server_api"
+require "chef-dk/service_exceptions"
+
+module ChefDK
+  module Policyfile
+
+    class RevIDLockDataMap
+
+      attr_reader :policy_name
+      attr_reader :lock_info_by_rev_id
+
+      def initialize(policy_name, lock_info_by_rev_id)
+        @policy_name = policy_name
+        @lock_info_by_rev_id = lock_info_by_rev_id
+      end
+
+      def cb_info_for(rev_id, cookbook_name)
+        lock = lock_info_by_rev_id[rev_id]
+        cookbook_lock = lock["cookbook_locks"][cookbook_name]
+
+        if cookbook_lock
+          [cookbook_lock["version"], cookbook_lock["identifier"] ]
+        else
+          nil
+        end
+      end
+
+      def cbs_with_differing_ids
+        cbs_with_differing_ids = Set.new
+        all_cookbook_names.each do |cookbook_name|
+          all_identifiers = lock_info_by_rev_id.inject(Set.new) do |id_set, (_rev_id, rev_info)|
+            cookbook_lock = rev_info["cookbook_locks"][cookbook_name]
+            identifier = cookbook_lock && cookbook_lock["identifier"]
+            id_set << identifier
+          end
+          cbs_with_differing_ids << cookbook_name if all_identifiers.size > 1
+        end
+        cbs_with_differing_ids
+      end
+
+      def all_cookbook_names
+        lock_info_by_rev_id.inject(Set.new) do |cb_set, (_rev_id, rev_info)|
+          cb_set.merge(rev_info["cookbook_locks"].keys)
+        end
+      end
+    end
+
+    class PolicyGroupRevIDMap
+
+      include Enumerable
+
+      attr_reader :policy_name
+      attr_reader :revision_ids_by_group
+
+      def initialize(policy_name, revision_ids_by_group)
+        @policy_name = policy_name
+        @revision_ids_by_group = revision_ids_by_group
+      end
+
+      def unique_revision_ids
+        revision_ids_by_group.values.uniq
+      end
+
+      def policy_group_names
+        revision_ids_by_group.keys
+      end
+
+      def max_group_name_length
+        policy_group_names.map(&:size).max
+      end
+
+      def format_revision_ids
+        revision_ids_by_group.inject({}) do |map, (group_name, rev_id)|
+          map[group_name] = yield rev_id
+          map
+        end
+      end
+
+      def empty?
+        policy_group_names.empty?
+      end
+
+      def each
+        revision_ids_by_group.each do |group_name, rev_id|
+          yield group_name, rev_id
+        end
+      end
+    end
+
+    class Lister
+
+      attr_accessor :policy_lock_content
+
+      attr_reader :config
+
+      def initialize(config: nil)
+        @config = config
+        @policies_by_name = nil
+        @policies_by_group = nil
+        @policy_lock_content = {}
+        @active_revisions = nil
+      end
+
+      # A Hash with the following format
+      #   {
+      #     "appserver" => {
+      #       "1111111111111111111111111111111111111111111111111111111111111111" => {},
+      #       "2222222222222222222222222222222222222222222222222222222222222222" => {}
+      #     },
+      def policies_by_name
+        @policies_by_name || fetch_policy_lists
+        @policies_by_name
+      end
+
+      # A Hash with the following format:
+      #   "dev" => {
+      #     "appserver" => "1111111111111111111111111111111111111111111111111111111111111111",
+      #     "load-balancer" => "5555555555555555555555555555555555555555555555555555555555555555",
+      #     "db" => "9999999999999999999999999999999999999999999999999999999999999999"
+      #   }
+      def policies_by_group
+        @policies_by_group || fetch_policy_lists
+        @policies_by_group
+      end
+
+      def revision_info_for(policy_name, _revision_id_list)
+        RevIDLockDataMap.new(policy_name, policy_lock_content[policy_name])
+      end
+
+      def revision_ids_by_group_for_each_policy
+        policies_by_name.each do |policy_name, _policies|
+          rev_id_by_group = revision_ids_by_group_for(policy_name)
+          yield policy_name, rev_id_by_group
+        end
+      end
+
+      def revision_ids_by_group_for(policy_name)
+        map = policies_by_group.inject({}) do |rev_id_map, (group_name, rev_id_map_for_group)|
+          rev_id_map[group_name] = rev_id_map_for_group[policy_name]
+          rev_id_map
+        end
+        PolicyGroupRevIDMap.new(policy_name, map)
+      end
+
+      def orphaned_revisions(policy_name)
+        orphans = []
+        policies_by_name[policy_name].each do |rev_id, _data|
+          orphans << rev_id unless active_revisions.include?(rev_id)
+        end
+        orphans
+      end
+
+      def active_revisions
+        @active_revisions ||= policies_by_group.inject(Set.new) do |set, (_group, policy_name_rev_id_map)|
+          policy_name_rev_id_map.each do |policy_name, rev_id|
+            set << rev_id
+          end
+          set
+        end
+      end
+
+      def empty?
+        policies_by_name.empty? && policies_by_group.empty?
+      end
+
+      def http_client
+        @http_client ||= Chef::ServerAPI.new(config.chef_server_url,
+                                                       signing_key_filename: config.client_key,
+                                                       client_name: config.node_name)
+      end
+
+      # @api private
+      # Sets internal copy of policyfile data to policies_by_name and
+      # policies_by_group. Used for internal testing.
+      def set!(policies_by_name, policies_by_group)
+        @policies_by_name = policies_by_name
+        @policies_by_group = policies_by_group
+        @active_revisions = nil
+      end
+
+      private
+
+      def fetch_policy_lists
+        policy_list_data = http_client.get("policies")
+        set_policies_by_name_from_api(policy_list_data)
+
+        policy_group_data = http_client.get("policy_groups")
+        set_policies_by_group_from_api(policy_group_data)
+      end
+
+      def set_policies_by_name_from_api(policy_list_data)
+        @policies_by_name = policy_list_data.inject({}) do |map, (policy_name, policy_info)|
+          map[policy_name] = policy_info["revisions"]
+          map
+        end
+      end
+
+      def set_policies_by_group_from_api(policy_group_data)
+        @policies_by_group = policy_group_data.inject({}) do |map, (policy_group, policy_info)|
+          map[policy_group] = (policy_info["policies"] || []).inject({}) do |rev_map, (policy_name, rev_info)|
+            rev_map[policy_name] = rev_info["revision_id"]; rev_map
+          end
+
+          map
+        end
+      end
+
+    end
+  end
+end