# # 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" require "chef-dk/ui" require "chef/util/path_helper" require "chef/mixin/shell_out" require "bundler" module ChefDK class CLI include Mixlib::CLI include ChefDK::Helpers include Chef::Mixin::ShellOut 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 sanity_check! 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 rescue OptionParser::InvalidOption => e err(e.message) show_help exit 1 end # If no subcommand is given, then this class is handling the CLI request. def handle_options parse_options(argv) if config[:version] show_version else show_help end exit 0 end def show_version msg("Chef Development Kit Version: #{ChefDK::VERSION}") ["chef-client", "delivery", "berks", "kitchen", "inspec"].each do |component| result = Bundler.with_clean_env { shell_out("#{component} --version") } if result.exitstatus != 0 msg("#{component} version: ERROR") else version = result.stdout.lines.first.scan(/(?:master\s)?[\d+\.\(\)]+\S+/).join("\s") msg("#{component} version: #{version}") end end end def show_help msg(banner) msg("\nAvailable Commands:") justify_length = subcommands.map(&:length).max + 2 subcommand_specs.each do |name, spec| next if spec.hidden 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) && (0..255).cover?(maybe_integer) maybe_integer else 0 end end # Find PATH or Path correctly if we are on Windows def path_key env.keys.grep(/\Apath\Z/i).first end # upcase drive letters for comparison since ruby has a String#capitalize function def drive_upcase(path) if Chef::Platform.windows? && path[0] =~ /^[A-Za-z]$/ && path[1, 2] == ":\\" path.capitalize else path end end def env ENV end # catch the cases where users setup only the embedded_bin_dir in their path, or # when they have the embedded_bin_dir before the omnibus_bin_dir -- both of which will # defeat appbundler and interact very badly with our intent. def sanity_check! # When installed outside of omnibus, trust the user to configure their PATH return true unless omnibus_install? paths = env[path_key].split(File::PATH_SEPARATOR) paths.map! { |p| drive_upcase(Chef::Util::PathHelper.cleanpath(p)) } embed_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_embedded_bin_dir))) bin_index = paths.index(drive_upcase(Chef::Util::PathHelper.cleanpath(omnibus_bin_dir))) if embed_index if bin_index if embed_index < bin_index err("WARN: #{omnibus_embedded_bin_dir} is before #{omnibus_bin_dir} in your #{path_key}, please reverse that order.") err("WARN: consider using the correct `chef shell-init ` command to setup your environment correctly.") end else err("WARN: only #{omnibus_embedded_bin_dir} is present in your path, you must add #{omnibus_bin_dir} before that directory.") err("WARN: consider using the correct `chef shell-init ` command to setup your environment correctly.") end end end end end