chef-dk 0.2.0

data/Rakefile

@@ -0,0 +1,18 @@
+#
+# 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 "bundler/gem_tasks"

data/bin/chef

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+#
+# 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.
+#
+
+# Set a trap for ctrl-C right away so we don't surface interrupt exceptions inside of rubygems or whatever.
+Kernel.trap(:INT) { print("\n"); exit 1 }
+
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'chef-dk/cli'
+
+ChefDK::CLI.new(ARGV.clone).run

data/lib/chef-dk.rb

@@ -0,0 +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.
+#
+
+module ChefDK
+end

data/lib/chef-dk/builtin_commands.rb

@@ -0,0 +1,31 @@
+#
+# 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.
+#
+
+
+ChefDK.commands do |c|
+  c.builtin "exec", :Exec, require_path: "chef-dk/command/exec",
+    desc: "Runs the command in context of the embedded ruby"
+
+  c.builtin "gem", :GemForwarder, require_path: "chef-dk/command/gem",
+    desc: "Runs the `gem` command in context of the embedded ruby"
+
+  c.builtin "generate", :Generate, desc: "Generate a new app, cookbook, or component"
+
+  c.builtin "shell-init", :ShellInit, desc: "Initialize your shell to use ChefDK as your primary ruby"
+
+  c.builtin "verify", :Verify, desc: "Test the embedded ChefDK applications"
+end

data/lib/chef-dk/chef_runner.rb

@@ -0,0 +1,83 @@
+#
+# 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'
+
+module ChefDK
+  # An adapter to chef's APIs to kick off a chef-client run.
+  class ChefRunner
+
+    attr_reader :cookbook_path
+    attr_reader :run_list
+
+    def initialize(cookbook_path, run_list)
+      @cookbook_path = cookbook_path
+      @run_list = run_list
+      @formatter = nil
+      @ohai = nil
+    end
+
+    def converge
+      configure
+      Chef::Runner.new(run_context).converge
+    end
+
+    def run_context
+      @run_context ||= policy.setup_run_context
+    end
+
+    def policy
+      return @policy_builder if @policy_builder
+
+      @policy_builder = Chef::PolicyBuilder::ExpandNodeObject.new("chef-dk", ohai.data, {}, nil, formatter)
+      @policy_builder.load_node
+      @policy_builder.build_node
+      @policy_builder.node.run_list(*run_list)
+      @policy_builder.expand_run_list
+      @policy_builder
+    end
+
+    def formatter
+      @formatter ||= Chef::Formatters.new(:doc, stdout, stderr)
+    end
+
+    def configure
+      Chef::Config.solo = true
+      Chef::Config.cookbook_path = cookbook_path
+      Chef::Config.color = true
+      Chef::Config.diff_disabled = true
+    end
+
+    def ohai
+      return @ohai if @ohai
+
+      @ohai = Ohai::System.new
+      @ohai.all_plugins(["platform", "platform_version"])
+      @ohai
+    end
+
+    def stdout
+      $stdout
+    end
+
+    def stderr
+      $stderr
+    end
+
+  end
+end
+

data/lib/chef-dk/cli.rb

@@ -0,0 +1,135 @@
+#
+# 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 'mixlib/cli'
+require 'chef-dk/version'
+require 'chef-dk/commands_map'
+require 'chef-dk/builtin_commands'
+require 'chef-dk/helpers'
+
+module ChefDK
+  class CLI
+    include Mixlib::CLI
+    include ChefDK::Helpers
+
+    banner(<<-BANNER)
+Usage:
+    chef -h/--help
+    chef -v/--version
+    chef command [arguments...] [options...]
+BANNER
+
+    option :version,
+      :short        => "-v",
+      :long         => "--version",
+      :description  => "Show chef version",
+      :boolean      => true
+
+    option :help,
+      :short        => "-h",
+      :long         => "--help",
+      :description  => "Show this message",
+      :boolean      => true
+
+    attr_reader :argv
+
+    def initialize(argv)
+      @argv = argv
+      super() # mixlib-cli #initialize doesn't allow arguments
+    end
+
+    def run
+      subcommand_name, *subcommand_params = argv
+
+      #
+      # Runs the appropriate subcommand if the given parameters contain any
+      # subcommands.
+      #
+      if subcommand_name.nil? || option?(subcommand_name)
+        handle_options
+      elsif have_command?(subcommand_name)
+        subcommand = instantiate_subcommand(subcommand_name)
+        exit_code = subcommand.run_with_default_options(subcommand_params)
+        exit normalized_exit_code(exit_code)
+      else
+        err "Unknown command `#{subcommand_name}'."
+        show_help
+        exit 1
+      end
+    end
+
+    # If no subcommand is given, then this class is handling the CLI request.
+    def handle_options
+      parse_options(argv)
+      if config[:version]
+        msg("Chef Development Kit Version: #{ChefDK::VERSION}")
+      else
+        show_help
+      end
+      exit 0
+    end
+
+    def show_help
+      msg(banner)
+      msg("\nAvailable Commands:")
+
+      justify_length = subcommands.map(&:length).max + 2
+      subcommand_specs.each do |name, spec|
+        msg("    #{"#{name}".ljust(justify_length)}#{spec.description}")
+      end
+    end
+
+    def exit(n)
+      Kernel.exit(n)
+    end
+
+    def commands_map
+      ChefDK.commands_map
+    end
+
+    def have_command?(name)
+      commands_map.have_command?(name)
+    end
+
+    def subcommands
+      commands_map.command_names
+    end
+
+    def subcommand_specs
+      commands_map.command_specs
+    end
+
+    def option?(param)
+      param =~ /^-/
+    end
+
+    def instantiate_subcommand(name)
+      commands_map.instantiate(name)
+    end
+
+    private
+
+    def normalized_exit_code(maybe_integer)
+      if maybe_integer.kind_of?(Integer) and (0..255).include?(maybe_integer)
+        maybe_integer
+      else
+        0
+      end
+    end
+
+  end
+end

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

@@ -0,0 +1,71 @@
+#
+# 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 'mixlib/cli'
+require 'chef-dk/helpers'
+require 'chef-dk/version'
+
+module ChefDK
+  module Command
+    class Base
+      include Mixlib::CLI
+      include ChefDK::Helpers
+
+      option :help,
+        :short        => "-h",
+        :long         => "--help",
+        :description  => "Show this message",
+        :boolean      => true
+
+      option :version,
+        :short        => "-v",
+        :long         => "--version",
+        :description  => "Show chef version",
+        :boolean      => true
+
+      def initialize
+        super
+      end
+
+      #
+      # optparser overwrites -h / --help options with its own.
+      # In order to control this behavior, make sure the default options are
+      # handled here.
+      #
+      def run_with_default_options(params = [ ])
+        if needs_help?(params)
+          msg(opt_parser.to_s)
+          0
+        elsif needs_version?(params)
+          msg("Chef Development Kit Version: #{ChefDK::VERSION}")
+          0
+        else
+          run(params)
+        end
+      end
+
+      def needs_help?(params)
+        params.include?("-h") || params.include?("--help")
+      end
+
+      def needs_version?(params)
+        params.include?("-v") || params.include?("--version")
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+#
+# 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 Exec < ChefDK::Command::Base
+      banner "Usage: chef exec SYSTEM_COMMAND"
+
+      def run(params)
+        exec omnibus_env, *params
+        raise "Exec failed without an exception, your ruby is buggy"  # should never get here
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1,47 @@
+#
+# 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 'rubygems'
+require 'rubygems/gem_runner'
+require 'rubygems/exceptions'
+require 'pp'
+
+module ChefDK
+  module Command
+
+    # Forwards all commands to rubygems.
+    class GemForwarder < ChefDK::Command::Base
+      banner "Usage: chef gem GEM_COMMANDS_AND_OPTIONS"
+
+      def run(params)
+        retval = Gem::GemRunner.new.run( params.clone )
+        retval.nil? ? true : retval
+      rescue Gem::SystemExitException => e
+        exit( e.exit_code )
+      end
+
+      # Lazy solution: By automatically returning false, we force ChefDK::Base to
+      # call this class' run method, so that Gem::GemRunner can handle the -v flag
+      # appropriately (showing the gem version, or installing a specific version
+      # of a gem).
+      def needs_version?(params)
+        false
+      end
+    end
+  end
+end