chef-cli 1.0.3

data/lib/chef-cli/policyfile/attribute_merge_checker.rb

@@ -0,0 +1,110 @@
+#
+# 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/mash"
+
+module ChefCLI
+  module Policyfile
+    class AttributeMergeChecker
+      # A ConflictError is used to specify a conflict has occurred
+      class ConflictError < StandardError
+        attr_reader :attribute_path
+        attr_reader :provided_by
+
+        def initialize(attribute_path, provided_by)
+          @attribute_path = attribute_path
+          @provided_by = provided_by
+          super("Attribute '#{attribute_path}' provided conflicting values by the following sources #{provided_by}")
+        end
+      end
+
+      # A Leaf is used to mark an individual attribute that has already
+      # been provided, along with its value and by who
+      #
+      # @api private
+      class Leaf
+        attr_reader :provided_by
+        attr_reader :val
+
+        def initialize(provided_by, val)
+          @provided_by = provided_by
+          @val = val
+        end
+      end
+
+      # An AttributeHashInfo holds a set of attributes along with where they came from
+      class AttributeHashInfo
+        attr_reader :source_name
+        attr_reader :hash
+        def initialize(source_name, hash)
+          @source_name = source_name
+          @hash = hash
+        end
+      end
+
+      # @return [Array<AttributeHashInfo>] A list of attributes and who they were provided by
+      attr_reader :attribute_hash_infos
+
+      def initialize
+        @attribute_hash_infos = []
+      end
+
+      # Add a hash of attributes to the set of attributes that will be compared
+      # for conflicts
+      #
+      # @param source_name [String] Where the attributes came from
+      # @param hash [Hash] attributes from source_name
+      def with_attributes(source_name, hash)
+        attribute_hash_infos << AttributeHashInfo.new(source_name, hash)
+      end
+
+      # Check all added attributes for conflicts. Different sources can provide
+      # the same attribute if they have the same value. Otherwise, it is considered
+      # a conflict
+      #
+      # @raise ConflictError if there are conflicting attributes
+      def check!
+        check_struct = Mash.new
+        attribute_hash_infos.each do |attr_hash_info|
+          fill!(check_struct, attr_hash_info.source_name, "", attr_hash_info.hash)
+        end
+      end
+
+      private
+
+      def fill!(acc, source_name, path, hash)
+        hash.each do |(key, val)|
+          new_path = "#{path}[#{key}]"
+          if val.kind_of?(Hash)
+            acc[key] ||= Mash.new
+            fill!(acc[key], source_name, new_path, val)
+          else
+            if acc[key].nil?
+              acc[key] = Leaf.new(source_name, val)
+            else
+              leaf = acc[key]
+              if leaf.val != val
+                raise ConflictError.new(new_path, [leaf.provided_by, source_name])
+              end
+            end
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/chef-cli/policyfile/chef_repo_cookbook_source.rb

@@ -0,0 +1,138 @@
+#
+# 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_relative "../exceptions"
+require "chef/cookbook_loader"
+require "chef/cookbook/file_system_file_vendor"
+require_relative "../ui"
+
+module ChefCLI
+  module Policyfile
+    class ChefRepoCookbookSource
+
+      # path to a chef-repo or the cookbook path under it
+      attr_reader :path
+      # UI object for output
+      attr_accessor :ui
+
+      attr_reader :preferred_cookbooks
+
+      # Constructor
+      #
+      # @param path [String] path to a chef-repo or the cookbook path under it
+      def initialize(path)
+        self.path = path
+        @ui = UI.new
+        @preferred_cookbooks = []
+        yield self if block_given?
+      end
+
+      def default_source_args
+        [:chef_repo, path]
+      end
+
+      def preferred_for(*cookbook_names)
+        preferred_cookbooks.concat(cookbook_names)
+      end
+
+      def preferred_source_for?(cookbook_name)
+        preferred_cookbooks.include?(cookbook_name)
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.path == path && other.preferred_cookbooks == preferred_cookbooks
+      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
+        slurp_metadata! if @universe_graph.nil?
+        @universe_graph
+      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)
+        { path: cookbook_version_paths[cookbook_name][cookbook_version], version: cookbook_version }
+      end
+
+      def null?
+        false
+      end
+
+      def desc
+        "chef_repo(#{path})"
+      end
+
+      private
+
+      # Setter for setting the path.  It may either be a full chef-repo with
+      # a cookbooks directory in it, or only a path to the cookbooks directory,
+      # and it autodetects which it is passed.
+      #
+      # @param path [String] path to a chef-repo or the cookbook path under it
+      def path=(path)
+        cookbooks_path = "#{path}/cookbooks"
+        if Dir.exist?(cookbooks_path)
+          @path = cookbooks_path
+        else
+          @path = path
+        end
+      end
+
+      # Calls the slurp_metadata! helper once to calculate the @universe_graph
+      # and @cookbook_version_paths metadata.  Returns the @cookbook_version_paths.
+      #
+      # @return [Hash] cookbook_version_paths
+      def cookbook_version_paths
+        slurp_metadata! if @cookbook_version_paths.nil?
+        @cookbook_version_paths
+      end
+
+      # Helper to compute the @universe_graph and @cookbook_version_paths once
+      # from the Chef::CookbookLoader on-disk cookbook repo.
+      def slurp_metadata!
+        @universe_graph = {}
+        @cookbook_version_paths = {}
+        cookbook_repo.load_cookbooks
+        cookbook_repo.each do |cookbook_name, cookbook_version|
+          metadata = cookbook_version.metadata
+          if metadata.name.nil?
+            ui.err("WARN: #{cookbook_name} cookbook missing metadata or no name field, skipping")
+            next
+          end
+          @universe_graph[metadata.name] ||= {}
+          @universe_graph[metadata.name][metadata.version] = metadata.dependencies.to_a
+          @cookbook_version_paths[metadata.name] ||= {}
+          @cookbook_version_paths[metadata.name][metadata.version] = cookbook_version.root_dir
+        end
+      end
+
+      # @return [Chef::CookbookLoader] cookbook loader using on disk FileVendor
+      def cookbook_repo
+        @cookbook_repo ||= begin
+          Chef::Cookbook::FileVendor.fetch_from_disk(path)
+          Chef::CookbookLoader.new(path)
+        end
+      end
+
+    end
+  end
+end

data/lib/chef-cli/policyfile/chef_server_cookbook_source.rb

@@ -0,0 +1,99 @@
+#
+# 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 "ffi_yajl" unless defined?(FFI_Yajl)
+require_relative "../exceptions"
+require_relative "source_uri"
+require_relative "../chef_server_api_multi"
+
+module ChefCLI
+  module Policyfile
+    class ChefServerCookbookSource
+      attr_reader :uri
+      attr_reader :preferred_cookbooks
+      attr_reader :chef_config
+
+      def initialize(uri, chef_config: nil)
+        @uri = SourceURI.parse(uri)
+        @http_connections = {}
+        @chef_config = chef_config
+        @preferred_cookbooks = []
+        yield self if block_given?
+      end
+
+      def default_source_args
+        [:chef_server, uri]
+      end
+
+      def ==(other)
+        other.kind_of?(self.class) && other.uri == uri && other.preferred_cookbooks == preferred_cookbooks
+      end
+
+      def preferred_for(*cookbook_names)
+        preferred_cookbooks.concat(cookbook_names)
+      end
+
+      def preferred_source_for?(cookbook_name)
+        preferred_cookbooks.include?(cookbook_name)
+      end
+
+      def universe_graph
+        @universe_graph ||= begin
+          full_chef_server_graph.inject({}) do |normalized_graph, (cookbook_name, metadata_by_version)|
+            normalized_graph[cookbook_name] = metadata_by_version.inject({}) do |deps_by_version, (version, metadata)|
+              deps_by_version[version] = metadata["dependencies"]
+              deps_by_version
+            end
+            normalized_graph
+          end
+        end
+      end
+
+      def source_options_for(cookbook_name, cookbook_version)
+        {
+          chef_server: uri.to_s,
+          version: cookbook_version,
+          http_client: http_connection_for(uri.to_s),
+        }
+      end
+
+      def null?
+        false
+      end
+
+      def desc
+        "chef_server(#{uri})"
+      end
+
+      private
+
+      def http_connection_for(base_url)
+        @http_connections[base_url] ||=
+          ChefServerAPIMulti.new(base_url,
+                                 signing_key_filename: chef_config.client_key,
+                                 client_name: chef_config.node_name)
+      end
+
+      def full_chef_server_graph
+        @full_chef_server_graph ||=
+          begin
+            http_connection_for(uri.to_s).get("/universe")
+          end
+      end
+    end
+  end
+end

data/lib/chef-cli/policyfile/chef_server_lock_fetcher.rb

@@ -0,0 +1,167 @@
+#
+# 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_relative "../policyfile_lock"
+require_relative "../exceptions"
+
+module ChefCLI
+  module Policyfile
+
+    # A policyfile lock fetcher that can read a lock from a chef server
+    class ChefServerLockFetcher
+
+      attr_accessor :name
+      attr_accessor :source_options
+      attr_accessor :chef_config
+
+      # Initialize a LocalLockFetcher
+      #
+      # @param name [String] The name of the policyfile
+      # @param source_options [Hash] A hash with a :server key pointing at the chef server,
+      # along with :policy_name and either :policy_group or :policy_revision_id. If :policy_name
+      # is not provided, name is used.
+      # @param chef_config [Chef::Config, ChefConfig::Config]
+      #
+      # @example ChefServerLockFetcher for a policyfile with a specific revision id
+      #   ChefServerLockFetcher.new("foo",
+      #     {server: "http://example.com", policy_revision_id: "abcdabcdabcd"},
+      #     chef_config)
+      #
+      #   ChefServerLockFetcher.new("foo",
+      #     {server: "http://example.com", policy_name: "foo", policy_revision_id: "abcdabcdabcd"},
+      #     chef_config)
+      #
+      # @example ChefServerLockFetcher for a policyfile with the latest revision_id for a policy group
+      #   ChefServerLockFetcher.new("foo",
+      #     {server: "http://example.com", policy_group: "dev"},
+      #     chef_config)
+      #
+      #   ChefServerLockFetcher.new("foo",
+      #     {server: "http://example.com", policy_name: "foo", policy_group: "dev"},
+      #     chef_config)
+      def initialize(name, source_options, chef_config)
+        @name = name
+        @source_options = source_options
+        @chef_config = chef_config
+
+        @source_options[:policy_name] ||= name
+      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 = []
+
+        [:server, :policy_name].each do |key|
+          error_messages << "include_policy for #{name} is missing key #{key}" unless source_options[key]
+        end
+
+        if [:policy_revision_id, :policy_group].all? { |key| source_options[key].nil? }
+          error_messages << "include_policy for #{name} must specify policy_revision_id or policy_group"
+        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.merge({
+          policy_revision_id: lock_data["revision_id"],
+        })
+      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)
+        options = options_from_lock.inject({}) do |acc, (key, value)|
+          acc[key.to_sym] = value
+          acc
+        end
+        source_options.merge!(options)
+        raise ChefCLI::InvalidLockfile, "Invalid source_options provided from lock data: #{options_from_lock_file.inspect}" if !valid?
+      end
+
+      # @return [String] of the policyfile lock data
+      def lock_data
+        @lock_data ||= fetch_lock_data.tap do |data|
+          data["cookbook_locks"].each do |cookbook_name, cookbook_lock|
+            cookbook_lock["source_options"] = {
+              "chef_server_artifact" => server,
+              "identifier" => cookbook_lock["identifier"],
+            }
+          end
+        end
+      end
+
+      private
+
+      def fetch_lock_data
+        if revision
+          http_client.get("policies/#{policy_name}/revisions/#{revision}")
+        elsif policy_group
+          http_client.get("policy_groups/#{policy_group}/policies/#{policy_name}")
+        else
+          raise ChefCLI::BUG.new("The source_options should have been validated: #{source_options.inspect}")
+        end
+      rescue Net::ProtocolError => e
+        if e.respond_to?(:response) && e.response.code.to_s == "404"
+          raise ChefCLI::PolicyfileLockDownloadError.new("No Policyfile lock named '#{policy_name}' found with revision '#{revision}' at #{http_client.url}") if revision
+          raise ChefCLI::PolicyfileLockDownloadError.new("No Policyfile lock named '#{policy_name}' found with policy group '#{policy_group}' at #{http_client.url}") if policy_group
+        else
+          raise ChefCLI::PolicyfileLockDownloadError.new("HTTP error attempting to fetch policyfile lock from #{http_client.url}")
+        end
+      rescue => e
+        raise e
+      end
+
+      def policy_name
+        source_options[:policy_name]
+      end
+
+      def revision
+        source_options[:policy_revision_id]
+      end
+
+      def policy_group
+        source_options[:policy_group]
+      end
+
+      def server
+        source_options[:server]
+      end
+
+      # @see Chef:ServerAPI
+      # @see Chef::HTTP::JSONInput#get
+      # @return [Hash] Returns a parsed JSON object... I think.
+      def http_client
+        @http_client ||= Chef::ServerAPI.new(source_options[:server],
+                                             signing_key_filename: chef_config.client_key,
+                                             client_name: chef_config.node_name)
+      end
+
+    end
+  end
+end