chef-dk 0.2.0

data/lib/chef-dk/command/shell_init.rb

@@ -0,0 +1,80 @@
+#
+# 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/command/base'
+require 'mixlib/shellout'
+
+module ChefDK
+  module Command
+    class ShellInit < ChefDK::Command::Base
+
+      SUPPORTED_SHELLS = %w[ bash zsh sh ].map(&:freeze).freeze
+
+      banner(<<-HELP)
+Usage: chef shell-init
+
+`chef shell-init` modifies your shell environment to make ChefDK your default
+ruby.
+
+  To enable for just the current shell session:
+
+    eval "$(chef shell-init SHELL_NAME)"
+
+  To permanently enable:
+
+    echo 'eval "$(chef shell-init SHELL_NAME)"' >> ~/.YOUR_SHELL_RC_FILE
+
+OPTIONS:
+
+HELP
+
+      option :omnibus_dir,
+        :long         => "--omnibus-dir OMNIBUS_DIR",
+        :description  => "Alternate path to omnibus install (used for testing)"
+
+      def omnibus_root
+        config[:omnibus_dir] || super
+      end
+
+      def run(argv)
+        # Currently we don't have any shell-specific features, so we ignore the
+        # shell name. We'll need it if we add completion.
+        remaining_args = parse_options(argv)
+        shell_name = remaining_args.first
+        if shell_name.nil?
+          err("Please specify what shell you are using\n")
+          err(opt_parser.to_s)
+          return 1
+        elsif !SUPPORTED_SHELLS.include?(shell_name)
+          err("Shell `#{shell_name}' is not currently supported")
+          err("Supported shells are: #{SUPPORTED_SHELLS.join(' ')}")
+          return 1
+        end
+
+        env = omnibus_env.dup
+        path = env.delete("PATH")
+        msg("export PATH=#{path}")
+        env.each do |var_name, value|
+          msg("export #{var_name}=#{value}")
+        end
+        0
+      end
+    end
+  end
+end
+
+

data/lib/chef-dk/command/verify.rb

@@ -0,0 +1,226 @@
+#
+# 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/command/base'
+require 'chef-dk/exceptions'
+require 'chef-dk/component_test'
+
+module ChefDK
+  module Command
+    class Verify < ChefDK::Command::Base
+
+
+      banner "Usage: chef verify [component, ...] [options]"
+
+      option :omnibus_dir,
+        :long         => "--omnibus-dir OMNIBUS_DIR",
+        :description  => "Alternate path to omnibus install (used for testing)"
+
+      option :unit,
+        :long         => "--unit",
+        :description  => "Run bundled app unit tests (only smoke tests run by default)"
+
+      option :integration,
+        :long         => "--integration",
+        :description  => "Run integration tests. Possibly dangerous, for development systems only"
+
+      option :verbose,
+        :long         => "--verbose",
+        :description  => "Display all test output, not just failing tests"
+
+      class << self
+        def add_component(name, _delete_me=nil)
+          component = ComponentTest.new(name)
+          yield component if block_given? #delete this conditional
+          component_map[name] = component
+        end
+
+        def component(name)
+          component_map[name]
+        end
+
+        def components
+          component_map.values
+        end
+
+        def component_map
+          @component_map ||= {}
+        end
+      end
+
+      def components
+        self.class.components
+      end
+
+      #
+      # Components included in Chef Development kit:
+      # :base_dir => Relative path of the component w.r.t. omnibus_apps_dir
+      # :test_cmd => Test command to be launched for the component
+      #
+      add_component "berkshelf" do |c|
+        c.base_dir = "berkshelf"
+        # For berks the real command to run is "bundle exec thor spec:ci"
+        # We can't run it right now since graphviz specs are included in the
+        # test suite by default. We will be able to switch to that command when/if
+        # Graphviz is added to omnibus.
+        c.unit_test { sh("bundle exec rspec --color --format progress spec/unit --tag ~graphviz") }
+        c.integration_test { sh("bundle exec cucumber --color --format progress --tags ~@no_run --tags ~@spawn --tags ~@graphviz --strict") }
+
+        c.smoke_test do
+          tmpdir do |cwd|
+            FileUtils.touch(File.join(cwd,"Berksfile"))
+            sh("berks install", cwd: cwd)
+          end
+        end
+      end
+
+      add_component "test-kitchen" do |c|
+        c.base_dir = "test-kitchen"
+        c.unit_test { sh("bundle exec rake unit") }
+        c.integration_test { sh("bundle exec rake features") }
+        c.smoke_test { run_in_tmpdir("kitchen init") }
+      end
+
+      add_component "chef-client" do |c|
+        c.base_dir = "chef"
+        c.unit_test { sh("bundle exec rspec -fp spec/unit") }
+        c.integration_test { sh("bundle exec rspec -fp spec/integration spec/functional") }
+
+        c.smoke_test do
+          tmpdir do |cwd|
+            FileUtils.touch(File.join(cwd, "apply.rb"))
+            sh("chef-apply apply.rb", cwd: cwd)
+          end
+        end
+      end
+
+      add_component "chef-dk" do |c|
+        c.base_dir = "chef-dk"
+        c.unit_test { sh("bundle exec rspec") }
+        c.smoke_test { run_in_tmpdir("chef generate cookbook example") }
+      end
+
+      attr_reader :verification_threads
+      attr_reader :verification_results
+      attr_reader :verification_status
+
+      def initialize
+        super
+        @verification_threads = [ ]
+        @verification_results = [ ]
+        @verification_status = 0
+      end
+
+      def run(params = [ ])
+        @components_filter = parse_options(params)
+
+        validate_components!
+        invoke_tests
+        wait_for_tests
+        report_results
+
+        verification_status
+      end
+
+      def omnibus_root
+        config[:omnibus_dir] || super
+      end
+
+      def validate_components!
+        components.each do |component|
+          component.omnibus_root = omnibus_root
+          component.assert_present!
+        end
+      end
+
+      def components_to_test
+        if @components_filter.empty?
+          components
+        else
+          components.select do |component|
+            @components_filter.include?(component.name.to_s)
+          end
+        end
+      end
+
+      def invoke_tests
+        components_to_test.each do |component|
+          # Run the component specs in parallel
+          verification_threads << Thread.new do
+
+            results = []
+
+            results << component.run_smoke_test
+
+            if config[:unit]
+              results << component.run_unit_test
+            end
+
+            if config[:integration]
+              results << component.run_integration_test
+            end
+
+            if results.any? {|r| r.exitstatus != 0 }
+              component_status = 1
+              @verification_status = 1
+            else
+              component_status = 0
+            end
+
+            {
+              :component => component,
+              :results => results,
+              :component_status => component_status
+            }
+          end
+
+          msg("Running verification for component '#{component.name}'")
+        end
+      end
+
+      def wait_for_tests
+        while !verification_threads.empty?
+          verification_threads.each do |t|
+            if t.join(1)
+              verification_threads.delete t
+              verification_results << t.value
+              t.value[:results].each do |result|
+                if config[:verbose] || t.value[:component_status] != 0
+                  msg("")
+                  msg(result.stdout)
+                  msg(result.stderr) if result.stderr
+                end
+              end
+            else
+              $stdout.write "."
+            end
+          end
+        end
+      end
+
+      def report_results
+        msg("")
+        msg("---------------------------------------------")
+        verification_results.each do |result|
+          message = result[:component_status] == 0 ? "succeeded" : "failed"
+          msg("Verification of component '#{result[:component].name}' #{message}.")
+        end
+      end
+
+    end
+  end
+end

data/lib/chef-dk/commands_map.rb

@@ -0,0 +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
+
+

data/lib/chef-dk/component_test.rb

@@ -0,0 +1,142 @@
+#
+# 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'
+
+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
+    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
+
+    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)
+      end
+    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
+      File.join(omnibus_apps_dir, base_dir)
+    end
+
+    def base_dir
+      @base_dir or raise "`base_dir` must be defined for component `#{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
+