chef-dk 0.2.1 → 0.3.0

data/lib/chef-dk/generator.rb

@@ -22,7 +22,22 @@ module ChefDK
     # This is here to hold attr_accessor data for Generator context variables
     class Context
       def self.add_attr(name)
-        attr_accessor(name)
+        @attributes ||= [ ]
+
+        if !@attributes.include?(name)
+          @attributes << name
+          attr_accessor(name)
+        end
+      end
+
+      def self.reset
+        return if @attributes.nil?
+
+        @attributes.each do |attr|
+          remove_method(attr)
+        end
+
+        @attributes = nil
       end
     end
 

data/lib/chef-dk/helpers.rb

@@ -85,7 +85,7 @@ module ChefDK
           {
             'PATH' => "#{omnibus_bin_dir}:#{user_bin_dir}:#{omnibus_embedded_bin_dir}:#{ENV['PATH']}",
             'GEM_ROOT' => Gem.default_dir.inspect,
-            'GEM_HOME' => Gem.paths.home,
+            'GEM_HOME' => Gem.user_dir,
             'GEM_PATH' => Gem.path.join(':'),
           }
         end

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

@@ -64,6 +64,10 @@ module ChefDK
         [:git, :github, :artifactserver].include?(source_type)
       end
 
+      def installed?
+        installer.installed?
+      end
+
       def ensure_cached
         unless installer.installed?
           installer.install

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

@@ -1,3 +1,19 @@
+#
+# 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/exceptions'
 
@@ -16,6 +32,10 @@ module ChefDK
     # Base class for CookbookLock implementations
     class CookbookLock
 
+      REQUIRED_LOCK_DATA_KEYS = %w{version identifier dotted_decimal_identifier cache_key source_options}
+      REQUIRED_LOCK_DATA_KEYS.each(&:freeze)
+      REQUIRED_LOCK_DATA_KEYS.freeze
+
       include Policyfile::StorageConfigDelegation
 
       # The cookbook name (without any version or other info suffixed)
@@ -49,6 +69,10 @@ module ChefDK
         @storage_config = storage_config
       end
 
+      def installed?
+        cookbook_location_spec.installed?
+      end
+
       def install_locked
         cookbook_location_spec.ensure_cached
       end
@@ -129,6 +153,36 @@ module ChefDK
       def chefignore
         @chefignore ||= Chef::Cookbook::Chefignore.new(File.join(cookbook_path, "chefignore"))
       end
+
+      private
+
+      def assert_required_keys_valid!(lock_data)
+        missing_keys = REQUIRED_LOCK_DATA_KEYS.reject {|key| lock_data.key?(key) }
+        unless missing_keys.empty?
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} missing required attributes `#{missing_keys.join("', `")}'"
+        end
+
+        version = lock_data["version"]
+        unless version.kind_of?(String)
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `version' attribute must be a string (got: #{version})"
+        end
+
+        identifier = lock_data["identifier"]
+        unless identifier.kind_of?(String)
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `identifier' attribute must be a string (got: #{identifier})"
+        end
+
+        cache_key = lock_data["cache_key"]
+        unless cache_key.kind_of?(String) || cache_key.nil?
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `cache_key' attribute must be a string (got: #{cache_key})"
+        end
+
+        source_options = lock_data["source_options"]
+        unless source_options.kind_of?(Hash)
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} `source_options' attribute must be a Hash (JSON object) (got: #{source_options})"
+        end
+      end
+
     end
 
     # CachedCookbook objects represent a cookbook that has been fetched from an
@@ -163,6 +217,8 @@ module ChefDK
       end
 
       def build_from_lock_data(lock_data)
+        assert_required_keys_valid!(lock_data)
+
         @version = lock_data["version"]
         @identifier = lock_data["identifier"]
         @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
@@ -255,6 +311,8 @@ module ChefDK
       end
 
       def build_from_lock_data(lock_data)
+        assert_required_keys_valid!(lock_data)
+
         @version = lock_data["version"]
         @identifier = lock_data["identifier"]
         @dotted_decimal_identifier = lock_data["dotted_decimal_identifier"]
@@ -300,6 +358,21 @@ module ChefDK
         @identifier_updated
       end
 
+      private
+
+      def assert_required_keys_valid!(lock_data)
+        super
+
+        source = lock_data["source"]
+        if source.nil?
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid. Lock data for a local cookbook must have a `source' attribute"
+        end
+
+        unless source.kind_of?(String)
+          raise InvalidLockfile, "Lockfile cookbook_lock for #{name} is invalid: `source' attribute must be a String (got: #{source.inspect})"
+        end
+      end
+
     end
   end
 end

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

@@ -0,0 +1,70 @@
+#
+# 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/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(["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(["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

@@ -0,0 +1,58 @@
+#
+# 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.
+#
+
+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

@@ -0,0 +1,70 @@
+#
+# 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/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

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

@@ -28,6 +28,12 @@ module ChefDK
 
       class Cookbook
 
+        VALID_STRING_FORMAT = /\A[^\s]+ \([^\s]+\)\Z/
+
+        def self.valid_str?(str)
+          !!(str =~ VALID_STRING_FORMAT)
+        end
+
         def self.parse(str)
           name, version_w_parens = str.split(' ')
           version = version_w_parens[/\(([^)]+)\)/, 1]
@@ -78,15 +84,13 @@ module ChefDK
       end
 
       def consume_lock_data(lock_data)
-        policyfile_dependencies_data = lock_data["Policyfile"] || []
-        policyfile_dependencies_data.each do |cookbook_name, constraint|
-          add_policyfile_dep(cookbook_name, constraint)
-        end
-        cookbook_dependencies_data = lock_data["dependencies"] || {}
-        cookbook_dependencies_data.each do |name_and_version, deps_list|
-          cookbook = Cookbook.parse(name_and_version)
-          add_cookbook_obj_dep(cookbook, deps_list)
+        unless lock_data.key?("Policyfile") and lock_data.key?("dependencies")
+          msg = %Q|lockfile solution_dependencies must be a Hash of the form `{"Policyfile": [], "dependencies": {} }' (got: #{lock_data.inspect})|
+          raise InvalidLockfile, msg
         end
+
+        set_policyfile_deps_from_lock_data(lock_data)
+        set_cookbook_deps_from_lock_data(lock_data)
       end
 
       def test_conflict!(cookbook_name, version)
@@ -198,6 +202,96 @@ module ChefDK
         @cookbook_dependencies[Cookbook.new(name, version)]
       end
 
+      def set_policyfile_deps_from_lock_data(lock_data)
+        policyfile_deps_data = lock_data["Policyfile"]
+
+        unless policyfile_deps_data.kind_of?(Array)
+          msg = "lockfile solution_dependencies Policyfile dependencies must be an array of cookbooks and constraints (got: #{policyfile_deps_data.inspect})"
+          raise InvalidLockfile, msg
+        end
+
+        policyfile_deps_data.each do |entry|
+          add_policyfile_dep_from_lock_data(entry)
+        end
+      end
+
+      def add_policyfile_dep_from_lock_data(entry)
+        unless entry.kind_of?(Array) and entry.size == 2
+          msg = %Q(lockfile solution_dependencies Policyfile dependencies entry must be like [ "$COOKBOOK_NAME", "$CONSTRAINT" ] (got: #{entry.inspect}))
+          raise InvalidLockfile, msg
+        end
+
+        cookbook_name, constraint = entry
+
+        unless cookbook_name.kind_of?(String) and !cookbook_name.empty?
+          msg = "lockfile solution_dependencies Policyfile dependencies entry. Cookbook name portion must be a string (got: #{entry.inspect})"
+          raise InvalidLockfile, msg
+        end
+
+        unless constraint.kind_of?(String) and !constraint.empty?
+          msg = "malformed lockfile solution_dependencies Policyfile dependencies entry. Version constraint portion must be a string (got: #{entry.inspect})"
+          raise InvalidLockfile, msg
+        end
+        add_policyfile_dep(cookbook_name, constraint)
+      rescue Semverse::InvalidConstraintFormat
+        msg = "malformed lockfile solution_dependencies Policyfile dependencies entry. Version constraint portion must be a valid version constraint (got: #{entry.inspect})"
+        raise InvalidLockfile, msg
+      end
+
+      def set_cookbook_deps_from_lock_data(lock_data)
+        cookbook_dependencies_data = lock_data["dependencies"]
+
+        unless cookbook_dependencies_data.kind_of?(Hash)
+          msg = "lockfile solution_dependencies dependencies entry must be a Hash (JSON object) of dependencies (got: #{cookbook_dependencies_data.inspect})"
+          raise InvalidLockfile, msg
+        end
+
+        cookbook_dependencies_data.each do |name_and_version, deps_list|
+          add_cookbook_dep_from_lock_data(name_and_version, deps_list)
+        end
+      end
+
+      def add_cookbook_dep_from_lock_data(name_and_version, deps_list)
+        unless name_and_version.kind_of?(String)
+          show = "#{name_and_version.inspect} => #{deps_list.inspect}"
+          msg = %Q(lockfile cookbook_dependencies entries must be of the form "$COOKBOOK_NAME ($VERSION)" => [ $dependency, ...] (got: #{show}) )
+          raise InvalidLockfile, msg
+        end
+
+        unless Cookbook.valid_str?(name_and_version)
+          msg = %Q(lockfile cookbook_dependencies entry keys must be of the form "$COOKBOOK_NAME ($VERSION)" (got: #{name_and_version.inspect}) )
+          raise InvalidLockfile, msg
+        end
+
+        unless deps_list.kind_of?(Array)
+          msg = %Q(lockfile cookbook_dependencies entry values must be an Array like [ [ "$COOKBOOK_NAME", "$CONSTRAINT" ], ... ] (got: #{deps_list.inspect}) )
+          raise InvalidLockfile, msg
+        end
+
+        deps_list.each do |entry|
+
+          unless entry.kind_of?(Array) and entry.size == 2
+            msg = %Q(lockfile solution_dependencies dependencies entry must be like [ "$COOKBOOK_NAME", "$CONSTRAINT" ] (got: #{entry.inspect}))
+            raise InvalidLockfile, msg
+          end
+
+          dep_name, constraint = entry
+
+          unless dep_name.kind_of?(String) and !dep_name.empty?
+            msg = "malformed lockfile solution_dependencies dependencies entry. Cookbook name portion must be a string (got: #{entry.inspect})"
+            raise InvalidLockfile, msg
+          end
+
+          unless constraint.kind_of?(String) and !constraint.empty?
+            msg = "malformed lockfile solution_dependencies dependencies entry. Version constraint portion must be a string (got: #{entry.inspect})"
+            raise InvalidLockfile, msg
+          end
+        end
+
+        cookbook = Cookbook.parse(name_and_version)
+        add_cookbook_obj_dep(cookbook, deps_list)
+      end
+
     end
 
   end