chef-dk 3.9.0 → 3.10.1

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

@@ -0,0 +1,108 @@
+#
+# Copyright:: Copyright (c) 2019 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"
+require "chef/http"
+require "tempfile"
+
+module ChefDK
+  module Policyfile
+
+    # A policyfile lock fetcher that can read a lock from a remote location.
+    class RemoteLockFetcher
+      include LockFetcherMixin
+
+      attr_reader :name
+      attr_reader :source_options
+
+      # Initialize a RemoteLockFetcher
+      #
+      # @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
+      def initialize(name, source_options)
+        @name = name
+        @source_options = source_options
+      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 creating this class for errors
+      #
+      # @return [Array<String>] A list of errors found
+      def errors
+        error_messages = []
+
+        [:remote].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
+        fetch_lock_data.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?
+              raise ChefDK::InvalidLockfile, "Invalid cookbook path: #{cookbook_path}. Remote Policyfiles should only use remote cookbooks."
+            end
+          end
+        end
+      end
+
+      private
+
+      def fetch_lock_data
+        FFI_Yajl::Parser.parse(http_client.get(""))
+      rescue Net::ProtocolError => e
+        if e.respond_to?(:response) && e.response.code.to_s == "404"
+          raise ChefDK::PolicyfileLockDownloadError.new("No remote policyfile lock '#{name}' found at #{http_client.url}")
+        else
+          raise ChefDK::PolicyfileLockDownloadError.new("HTTP error attempting to fetch policyfile lock from #{http_client.url}")
+        end
+      rescue => e
+        raise e
+      end
+
+      def http_client
+        @http_client ||= Chef::HTTP.new(source_options[:remote])
+      end
+    end
+  end
+end

data/lib/chef-dk/policyfile/reports/install.rb

@@ -1,69 +1,69 @@
-#
-# 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/policyfile/reports/table_printer"
-
-module ChefDK
-  module Policyfile
-    module Reports
-
-      class Install
-
-        attr_reader :ui
-        attr_reader :policyfile_compiler
-
-        def initialize(ui: nil, policyfile_compiler: nil)
-          @ui = ui
-          @policyfile_compiler = policyfile_compiler
-
-          @fixed_version_install_table = nil
-          @install_table = nil
-        end
-
-        def installing_fixed_version_cookbook(cookbook_spec)
-          verb = cookbook_spec.installed? ? "Using     " : "Installing"
-          fixed_version_install_table.print_row(verb, cookbook_spec.name, cookbook_spec.version_constraint.to_s, "from #{cookbook_spec.source_type}")
-        end
-
-        def installing_cookbook(cookbook_spec)
-          verb = cookbook_spec.installed? ? "Using     " : "Installing"
-          install_table.print_row(verb, cookbook_spec.name, cookbook_spec.version_constraint.version)
-        end
-
-        private
-
-        def fixed_version_install_table
-          @fixed_version_install_table ||= TablePrinter.new(ui) do |t|
-            t.column(%w{Using Installing})
-            t.column(policyfile_compiler.fixed_version_cookbooks_specs.keys)
-            t.column
-            t.column
-          end
-        end
-
-        def install_table
-          @install_table ||= TablePrinter.new(ui) do |t|
-            t.column(%w{Using Installing})
-            t.column(policyfile_compiler.graph_solution.keys)
-            t.column(policyfile_compiler.graph_solution.values)
-          end
-        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/policyfile/reports/table_printer"
+
+module ChefDK
+  module Policyfile
+    module Reports
+
+      class Install
+
+        attr_reader :ui
+        attr_reader :policyfile_compiler
+
+        def initialize(ui: nil, policyfile_compiler: nil)
+          @ui = ui
+          @policyfile_compiler = policyfile_compiler
+
+          @fixed_version_install_table = nil
+          @install_table = nil
+        end
+
+        def installing_fixed_version_cookbook(cookbook_spec)
+          verb = cookbook_spec.installed? ? "Using     " : "Installing"
+          fixed_version_install_table.print_row(verb, cookbook_spec.name, cookbook_spec.version_constraint.to_s, "from #{cookbook_spec.source_type}")
+        end
+
+        def installing_cookbook(cookbook_spec)
+          verb = cookbook_spec.installed? ? "Using     " : "Installing"
+          install_table.print_row(verb, cookbook_spec.name, cookbook_spec.version_constraint.version)
+        end
+
+        private
+
+        def fixed_version_install_table
+          @fixed_version_install_table ||= TablePrinter.new(ui) do |t|
+            t.column(%w{Using Installing})
+            t.column(policyfile_compiler.fixed_version_cookbooks_specs.keys)
+            t.column
+            t.column
+          end
+        end
+
+        def install_table
+          @install_table ||= TablePrinter.new(ui) do |t|
+            t.column(%w{Using Installing})
+            t.column(policyfile_compiler.graph_solution.keys)
+            t.column(policyfile_compiler.graph_solution.values)
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/chef-dk/policyfile/reports/table_printer.rb

@@ -1,57 +1,57 @@
-#
-# 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.
-#
-
-module ChefDK
-  module Policyfile
-    module Reports
-
-      # Defines a table with a flexible number of columns and prints rows in
-      # the table. Columns are defined ahead of time, by calling the #column
-      # method, individual rows are printed by calling #print_row with the data
-      # for each cell.
-      class TablePrinter
-
-        attr_reader :ui
-
-        def initialize(ui)
-          @ui = ui
-          @column_widths = []
-
-          yield self
-        end
-
-        # Defines a column. If a collection is given, it is mapped to an array
-        # of strings and the longest string is used as the left justify width
-        # for that column when rows are printed.
-        def column(collection = [])
-          @column_widths << (collection.map(&:to_s).map(&:size).max || 0)
-        end
-
-        # Print a row.
-        def print_row(*cells)
-          row = ""
-          cells.each_with_index do |cell_data, i|
-            row << cell_data.to_s.ljust(@column_widths[i])
-            row << " "
-          end
-          ui.msg(row.strip)
-        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.
+#
+
+module ChefDK
+  module Policyfile
+    module Reports
+
+      # Defines a table with a flexible number of columns and prints rows in
+      # the table. Columns are defined ahead of time, by calling the #column
+      # method, individual rows are printed by calling #print_row with the data
+      # for each cell.
+      class TablePrinter
+
+        attr_reader :ui
+
+        def initialize(ui)
+          @ui = ui
+          @column_widths = []
+
+          yield self
+        end
+
+        # Defines a column. If a collection is given, it is mapped to an array
+        # of strings and the longest string is used as the left justify width
+        # for that column when rows are printed.
+        def column(collection = [])
+          @column_widths << (collection.map(&:to_s).map(&:size).max || 0)
+        end
+
+        # Print a row.
+        def print_row(*cells)
+          row = ""
+          cells.each_with_index do |cell_data, i|
+            row << cell_data.to_s.ljust(@column_widths[i])
+            row << " "
+          end
+          ui.msg(row.strip)
+        end
+
+      end
+    end
+  end
+end

data/lib/chef-dk/policyfile/reports/upload.rb

@@ -1,70 +1,70 @@
-#
-# 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/policyfile/reports/table_printer"
-
-module ChefDK
-  module Policyfile
-    module Reports
-      class Upload
-
-        attr_reader :reused_cbs
-        attr_reader :uploaded_cbs
-        attr_reader :ui
-
-        def initialize(reused_cbs: [], uploaded_cbs: [], ui: nil)
-          @reused_cbs = reused_cbs
-          @uploaded_cbs = uploaded_cbs
-          @ui = ui
-
-          @justify_name_width = nil
-          @justify_version_width = nil
-        end
-
-        def show
-          reused_cbs.each do |cb_with_lock|
-            lock = cb_with_lock.lock
-            table.print_row("Using", lock.name, lock.version, "(#{lock.identifier[0, 8]})")
-          end
-
-          uploaded_cbs.each do |cb_with_lock|
-            lock = cb_with_lock.lock
-            table.print_row("Uploaded", lock.name, lock.version, "(#{lock.identifier[0, 8]})")
-          end
-        end
-
-        def table
-          @table ||= TablePrinter.new(ui) do |t|
-            t.column(%w{ Using Uploaded })
-            t.column(cookbook_names)
-            t.column(cookbook_version_numbers)
-            t.column
-          end
-        end
-
-        def cookbook_names
-          (reused_cbs + uploaded_cbs).map { |e| e.lock.name }
-        end
-
-        def cookbook_version_numbers
-          (reused_cbs + uploaded_cbs).map { |e| e.lock.version }
-        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/policyfile/reports/table_printer"
+
+module ChefDK
+  module Policyfile
+    module Reports
+      class Upload
+
+        attr_reader :reused_cbs
+        attr_reader :uploaded_cbs
+        attr_reader :ui
+
+        def initialize(reused_cbs: [], uploaded_cbs: [], ui: nil)
+          @reused_cbs = reused_cbs
+          @uploaded_cbs = uploaded_cbs
+          @ui = ui
+
+          @justify_name_width = nil
+          @justify_version_width = nil
+        end
+
+        def show
+          reused_cbs.each do |cb_with_lock|
+            lock = cb_with_lock.lock
+            table.print_row("Using", lock.name, lock.version, "(#{lock.identifier[0, 8]})")
+          end
+
+          uploaded_cbs.each do |cb_with_lock|
+            lock = cb_with_lock.lock
+            table.print_row("Uploaded", lock.name, lock.version, "(#{lock.identifier[0, 8]})")
+          end
+        end
+
+        def table
+          @table ||= TablePrinter.new(ui) do |t|
+            t.column(%w{ Using Uploaded })
+            t.column(cookbook_names)
+            t.column(cookbook_version_numbers)
+            t.column
+          end
+        end
+
+        def cookbook_names
+          (reused_cbs + uploaded_cbs).map { |e| e.lock.name }
+        end
+
+        def cookbook_version_numbers
+          (reused_cbs + uploaded_cbs).map { |e| e.lock.version }
+        end
+
+      end
+    end
+  end
+end