chef-dk 0.12.0 → 0.13.21

data/lib/chef-dk/commands_map.rb

@@ -1,115 +1,115 @@
-#
-# 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
-
-  # CommandsMap maintains a mapping of subcommand names to the files where
-  # those commands are defined and the classes that implement the commands.
-  #
-  # In ruby it's more typical to handle this sort of thing using conventions
-  # and metaprogramming. We've implemented this approach in the past and
-  # decided against it here:
-  # 1. Performance. As the CLI suite grows, you have to load more and more
-  # code, including dependencies that are installed by rubygems, etc. This gets
-  # slow, and CLI apps need to be fast.
-  # 2. You can workaround the above by having a convention mapping filename to
-  # command name, but then you have to do a lot of work to list all of the
-  # commands, which is actually a common thing to do.
-  # 3. Other ways to mitigate the performance issue (loading deps lazily) have
-  # their own complications and tradeoffs and don't fully solve the problem.
-  # 4. It's not actually that much work to maintain the mapping.
-  #
-  # ## Adding new commands globally:
-  #
-  # A "singleton-ish" instance of this class is stored as ChefDK.commands_map.
-  # You can configure a multiple commands at once in a block using
-  # ChefDK.commands, like so:
-  #
-  #   ChefDK.commands do |c|
-  #     # assigns `chef my-command` to the class ChefDK::Command::MyCommand.
-  #     # The "require path" is inferred to be "chef-dk/command/my_command"
-  #     c.builtin("my-command", :MyCommand)
-  #
-  #     # Set the require path explicitly:
-  #     c.builtin("weird-command", :WeirdoClass, require_path: "chef-dk/command/this_is_cray")
-  #
-  #     # You can add a description that will show up in `chef -h` output (recommended):
-  #     c.builtin("documented-cmd", :DocumentedCmd, desc: "A short description")
-  #   end
-  #
-  class CommandsMap
-    NULL_ARG = Object.new
-
-    CommandSpec = Struct.new(:name, :constant_name, :require_path, :description)
-
-    class CommandSpec
-
-      def instantiate
-        require require_path
-        command_class = ChefDK::Command.const_get(constant_name)
-        command_class.new
-      end
-
-    end
-
-    attr_reader :command_specs
-
-    def initialize
-      @command_specs = {}
-    end
-
-    def builtin(name, constant_name, require_path: NULL_ARG, desc: "")
-      if null?(require_path)
-        snake_case_path = name.gsub("-", "_")
-        require_path = "chef-dk/command/#{snake_case_path}"
-      end
-      command_specs[name] = CommandSpec.new(name, constant_name, require_path, desc)
-    end
-
-    def instantiate(name)
-      spec_for(name).instantiate
-    end
-
-    def have_command?(name)
-      command_specs.key?(name)
-    end
-
-    def command_names
-      command_specs.keys
-    end
-
-    def spec_for(name)
-      command_specs[name]
-    end
-
-    private
-
-    def null?(argument)
-      argument.equal?(NULL_ARG)
-    end
-  end
-
-  def self.commands_map
-    @commands_map ||= CommandsMap.new
-  end
-
-  def self.commands
-    yield commands_map
-  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.
+#
+
+module ChefDK
+
+  # CommandsMap maintains a mapping of subcommand names to the files where
+  # those commands are defined and the classes that implement the commands.
+  #
+  # In ruby it's more typical to handle this sort of thing using conventions
+  # and metaprogramming. We've implemented this approach in the past and
+  # decided against it here:
+  # 1. Performance. As the CLI suite grows, you have to load more and more
+  # code, including dependencies that are installed by rubygems, etc. This gets
+  # slow, and CLI apps need to be fast.
+  # 2. You can workaround the above by having a convention mapping filename to
+  # command name, but then you have to do a lot of work to list all of the
+  # commands, which is actually a common thing to do.
+  # 3. Other ways to mitigate the performance issue (loading deps lazily) have
+  # their own complications and tradeoffs and don't fully solve the problem.
+  # 4. It's not actually that much work to maintain the mapping.
+  #
+  # ## Adding new commands globally:
+  #
+  # A "singleton-ish" instance of this class is stored as ChefDK.commands_map.
+  # You can configure a multiple commands at once in a block using
+  # ChefDK.commands, like so:
+  #
+  #   ChefDK.commands do |c|
+  #     # assigns `chef my-command` to the class ChefDK::Command::MyCommand.
+  #     # The "require path" is inferred to be "chef-dk/command/my_command"
+  #     c.builtin("my-command", :MyCommand)
+  #
+  #     # Set the require path explicitly:
+  #     c.builtin("weird-command", :WeirdoClass, require_path: "chef-dk/command/this_is_cray")
+  #
+  #     # You can add a description that will show up in `chef -h` output (recommended):
+  #     c.builtin("documented-cmd", :DocumentedCmd, desc: "A short description")
+  #   end
+  #
+  class CommandsMap
+    NULL_ARG = Object.new
+
+    CommandSpec = Struct.new(:name, :constant_name, :require_path, :description)
+
+    class CommandSpec
+
+      def instantiate
+        require require_path
+        command_class = ChefDK::Command.const_get(constant_name)
+        command_class.new
+      end
+
+    end
+
+    attr_reader :command_specs
+
+    def initialize
+      @command_specs = {}
+    end
+
+    def builtin(name, constant_name, require_path: NULL_ARG, desc: "")
+      if null?(require_path)
+        snake_case_path = name.gsub("-", "_")
+        require_path = "chef-dk/command/#{snake_case_path}"
+      end
+      command_specs[name] = CommandSpec.new(name, constant_name, require_path, desc)
+    end
+
+    def instantiate(name)
+      spec_for(name).instantiate
+    end
+
+    def have_command?(name)
+      command_specs.key?(name)
+    end
+
+    def command_names
+      command_specs.keys
+    end
+
+    def spec_for(name)
+      command_specs[name]
+    end
+
+    private
+
+    def null?(argument)
+      argument.equal?(NULL_ARG)
+    end
+  end
+
+  def self.commands_map
+    @commands_map ||= CommandsMap.new
+  end
+
+  def self.commands
+    yield commands_map
+  end
+end
+
+

data/lib/chef-dk/component_test.rb

@@ -1,194 +1,198 @@
-#
-# 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'
-require 'chef-dk/helpers'
-
-# https://github.com/bundler/bundler/issues/4368
-# As of rubygems 2.6.2, Rubygems will call Bundler::SpecSet#size, which does
-# not exist as of Bundler 1.11.2.
-#
-# `#size` and `#length` should be synonyms in idiomatic ruby so we alias to
-# make bundler and rubygems play nicely.
-if Object.const_defined?(:Bundler) &&
-    Bundler.const_defined?(:SpecSet) &&
-    Bundler::SpecSet.instance_methods.include?(:length) &&
-    !Bundler::SpecSet.instance_methods.include?(:size)
-
-  module Bundler
-    class SpecSet
-
-      alias_method :size, :length
-
-    end
-  end
-
-end
-
-module ChefDK
-  class ComponentTest
-
-    class NullTestResult
-      def exitstatus
-        0
-      end
-
-      def stdout
-        ""
-      end
-
-      def stderr
-        ""
-      end
-    end
-
-    DEFAULT_TEST = lambda { |context| NullTestResult.new }
-
-    include Helpers
-
-    attr_accessor :base_dir
-
-    attr_writer :omnibus_root
-
-    attr_reader :name
-
-    def initialize(name)
-      @name = name
-      @unit_test = DEFAULT_TEST
-      @integration_test = DEFAULT_TEST
-      @smoke_test = DEFAULT_TEST
-      @base_dir = nil
-      @gem_name_for_base_dir = nil
-    end
-
-    def unit_test(&test_block)
-      @unit_test = test_block
-    end
-
-    def run_unit_test
-      instance_eval(&@unit_test)
-    end
-
-    def integration_test(&test_block)
-      @integration_test = test_block
-    end
-
-    def run_integration_test
-      instance_eval(&@integration_test)
-    end
-
-    def smoke_test(&test_block)
-      @smoke_test = test_block
-    end
-
-    def run_smoke_test
-      instance_eval(&@smoke_test)
-    end
-
-    def sh(command, options={})
-      combined_opts = default_command_options.merge(options)
-
-      # Env is a hash, so it needs to be merged separately
-      if options.key?(:env)
-        combined_opts[:env] = default_command_options[:env].merge(options[:env])
-      end
-      system_command(command, combined_opts)
-    end
-
-    # Just like #sh but raises an error if the the command returns an
-    # unexpected exit code.
-    #
-    # Most verification steps just run a single command, then
-    # ChefDK::Command::Verify#invoke_tests handles the results by inspecting
-    # the return value of the test block. For tests that run a lot of commands,
-    # this is inconvenient so you can use #sh! instead.
-    def sh!(*args)
-      sh(*args).tap { |result| result.error! }
-    end
-
-    def run_in_tmpdir(command, options={})
-      tmpdir do |dir|
-        options[:cwd] = dir
-        sh(command, options)
-      end
-    end
-
-    def tmpdir
-      Dir.mktmpdir do |tmpdir|
-        yield tmpdir
-      end
-    end
-
-    def assert_present!
-      unless File.exists?( component_path )
-        raise MissingComponentError.new(name, "Could not find #{component_path}")
-      end
-    rescue Gem::LoadError => e
-      raise MissingComponentError.new(name, e)
-    end
-
-    def default_command_options
-      {
-        :cwd => component_path,
-        :env => {
-          # Add the embedded/bin to the PATH so that bundle executable can
-          # be found while running the tests.
-          path_variable_key => omnibus_path
-        },
-        :timeout => 3600
-      }
-    end
-
-    def component_path
-      if base_dir
-        File.join(omnibus_apps_dir, base_dir)
-      elsif gem_base_dir
-        gem_base_dir
-      else
-        raise "`base_dir` or `gem_base_dir` must be defined for component `#{name}`"
-      end
-    end
-
-    def gem_base_dir
-      return nil if @gem_name_for_base_dir.nil?
-      # There is no way to say "give me the latest prerelease OR normal version of this gem.
-      # So we first ask if there is a normal version, and if there is not, we ask if there
-      # is a prerelease version.  ">= 0.a" is how we ask for a prerelease version, because a
-      # prerelease version is defined as "any version with a letter in it."
-      gem = Gem::Specification.find_by_name(@gem_name_for_base_dir)
-      gem ||= Gem::Specification.find_by_name(@gem_name_for_base_dir, '>= 0.a')
-      gem.gem_dir
-    end
-
-    def gem_base_dir=(gem_name)
-      @gem_name_for_base_dir = gem_name
-    end
-
-    def omnibus_root
-      @omnibus_root or raise "`omnibus_root` must be set before running tests"
-    end
-
-    def omnibus_path
-      [omnibus_bin_dir, omnibus_embedded_bin_dir, ENV['PATH']].join(File::PATH_SEPARATOR)
-    end
-
-    def path_variable_key
-      ENV.keys.grep(/\Apath\Z/i).first
-    end
-
-  end
-end
+#
+# 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'
+require 'chef-dk/helpers'
+
+# https://github.com/bundler/bundler/issues/4368
+# As of rubygems 2.6.2, Rubygems will call Bundler::SpecSet#size, which does
+# not exist as of Bundler 1.11.2.
+#
+# `#size` and `#length` should be synonyms in idiomatic ruby so we alias to
+# make bundler and rubygems play nicely.
+if Object.const_defined?(:Bundler) &&
+    Bundler.const_defined?(:SpecSet) &&
+    Bundler::SpecSet.instance_methods.include?(:length) &&
+    !Bundler::SpecSet.instance_methods.include?(:size)
+
+  module Bundler
+    class SpecSet
+
+      alias_method :size, :length
+
+    end
+  end
+
+end
+
+module ChefDK
+  class ComponentTest
+
+    class NullTestResult
+      def exitstatus
+        0
+      end
+
+      def stdout
+        ""
+      end
+
+      def stderr
+        ""
+      end
+    end
+
+    DEFAULT_TEST = lambda { |context| NullTestResult.new }
+
+    include Helpers
+
+    attr_accessor :base_dir
+
+    attr_writer :omnibus_root
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+      @unit_test = DEFAULT_TEST
+      @integration_test = DEFAULT_TEST
+      @smoke_test = DEFAULT_TEST
+      @base_dir = nil
+      @gem_name_for_base_dir = nil
+    end
+
+    def unit_test(&test_block)
+      @unit_test = test_block
+    end
+
+    def run_unit_test
+      instance_eval(&@unit_test)
+    end
+
+    def integration_test(&test_block)
+      @integration_test = test_block
+    end
+
+    def run_integration_test
+      instance_eval(&@integration_test)
+    end
+
+    def smoke_test(&test_block)
+      @smoke_test = test_block
+    end
+
+    def run_smoke_test
+      instance_eval(&@smoke_test)
+    end
+
+    def bin(binary)
+      File.join(omnibus_embedded_bin_dir, binary)
+    end
+
+    def sh(command, options={})
+      combined_opts = default_command_options.merge(options)
+
+      # Env is a hash, so it needs to be merged separately
+      if options.key?(:env)
+        combined_opts[:env] = default_command_options[:env].merge(options[:env])
+      end
+      system_command(command, combined_opts)
+    end
+
+    # Just like #sh but raises an error if the the command returns an
+    # unexpected exit code.
+    #
+    # Most verification steps just run a single command, then
+    # ChefDK::Command::Verify#invoke_tests handles the results by inspecting
+    # the return value of the test block. For tests that run a lot of commands,
+    # this is inconvenient so you can use #sh! instead.
+    def sh!(*args)
+      sh(*args).tap { |result| result.error! }
+    end
+
+    def run_in_tmpdir(command, options={})
+      tmpdir do |dir|
+        options[:cwd] = dir
+        sh(command, options)
+      end
+    end
+
+    def tmpdir
+      Dir.mktmpdir do |tmpdir|
+        yield tmpdir
+      end
+    end
+
+    def assert_present!
+      unless File.exists?( component_path )
+        raise MissingComponentError.new(name, "Could not find #{component_path}")
+      end
+    rescue Gem::LoadError => e
+      raise MissingComponentError.new(name, e)
+    end
+
+    def default_command_options
+      {
+        :cwd => component_path,
+        :env => {
+          # Add the embedded/bin to the PATH so that bundle executable can
+          # be found while running the tests.
+          path_variable_key => omnibus_path
+        },
+        :timeout => 3600
+      }
+    end
+
+    def component_path
+      if base_dir
+        File.join(omnibus_apps_dir, base_dir)
+      elsif gem_base_dir
+        gem_base_dir
+      else
+        raise "`base_dir` or `gem_base_dir` must be defined for component `#{name}`"
+      end
+    end
+
+    def gem_base_dir
+      return nil if @gem_name_for_base_dir.nil?
+      # There is no way to say "give me the latest prerelease OR normal version of this gem.
+      # So we first ask if there is a normal version, and if there is not, we ask if there
+      # is a prerelease version.  ">= 0.a" is how we ask for a prerelease version, because a
+      # prerelease version is defined as "any version with a letter in it."
+      gem = Gem::Specification.find_by_name(@gem_name_for_base_dir)
+      gem ||= Gem::Specification.find_by_name(@gem_name_for_base_dir, '>= 0.a')
+      gem.gem_dir
+    end
+
+    def gem_base_dir=(gem_name)
+      @gem_name_for_base_dir = gem_name
+    end
+
+    def omnibus_root
+      @omnibus_root or raise "`omnibus_root` must be set before running tests"
+    end
+
+    def omnibus_path
+      [omnibus_bin_dir, omnibus_embedded_bin_dir, ENV['PATH']].join(File::PATH_SEPARATOR)
+    end
+
+    def path_variable_key
+      ENV.keys.grep(/\Apath\Z/i).first
+    end
+
+  end
+end