module ChefCLI::Helpers
Public Instance Methods
# File lib/chef-cli/helpers.rb, line 37 def err(message) stderr.print("#{message}\n") end
Unix users do not want git on their path if they already have it installed. Because we put `embedded/bin` on the path we must move the git binaries somewhere else that we can append to the end of the path. This is only a temporary solution - see github.com/chef/chef-cli/issues/854 for a better proposed solution.
# File lib/chef-cli/helpers.rb, line 103 def git_bin_dir @git_bin_dir ||= File.expand_path(File.join(omnibus_root, "gitbin")) end
In our Windows ChefCLI
omnibus package we include Git For Windows, which has a bunch of helpful unix utilties (like ssh, scp, etc.) bundled with it
# File lib/chef-cli/helpers.rb, line 109 def git_windows_bin_dir @git_windows_bin_dir ||= File.expand_path(File.join(omnibus_root, "embedded", "git", "usr", "bin")) end
# File lib/chef-cli/helpers.rb, line 41 def msg(message) stdout.print("#{message}\n") end
# File lib/chef-cli/helpers.rb, line 67 def omnibus_bin_dir @omnibus_bin_dir ||= omnibus_expand_path(omnibus_root, "bin") end
# File lib/chef-cli/helpers.rb, line 71 def omnibus_embedded_bin_dir @omnibus_embedded_bin_dir ||= omnibus_expand_path(omnibus_root, "embedded", "bin") end
environment vars for omnibus
# File lib/chef-cli/helpers.rb, line 116 def omnibus_env @omnibus_env ||= begin user_bin_dir = File.expand_path(File.join(Gem.user_dir, "bin")) path = [ omnibus_bin_dir, user_bin_dir, omnibus_embedded_bin_dir, ENV["PATH"].split(File::PATH_SEPARATOR) ] path << git_bin_dir if Dir.exist?(git_bin_dir) path << git_windows_bin_dir if Dir.exist?(git_windows_bin_dir) { "PATH" => path.flatten.uniq.join(File::PATH_SEPARATOR), "GEM_ROOT" => Gem.default_dir, "GEM_HOME" => Gem.user_dir, "GEM_PATH" => Gem.path.join(File::PATH_SEPARATOR), } end end
# File lib/chef-cli/helpers.rb, line 132 def omnibus_expand_path(*paths) dir = File.expand_path(File.join(paths)) raise OmnibusInstallNotFound.new unless dir && File.directory?(dir) dir end
Locates the omnibus directories
# File lib/chef-cli/helpers.rb, line 56 def omnibus_install? # We also check if the location we're running from (omnibus_root is relative to currently-running ruby) # includes the version manifest that omnibus packages ship with. If it doesn't, then we're running locally # or out of a gem - so not as an 'omnibus install' File.exist?(expected_omnibus_root) && File.exist?(File.join(expected_omnibus_root, "version-manifest.json")) end
# File lib/chef-cli/helpers.rb, line 63 def omnibus_root @omnibus_root ||= omnibus_expand_path(expected_omnibus_root) end
# File lib/chef-cli/helpers.rb, line 75 def package_home @package_home ||= begin package_home_set = !([nil, ""].include? ENV["CHEF_WORKSTATION_HOME"]) if package_home_set ENV["CHEF_WORKSTATION_HOME"] else default_package_home end end end
# File lib/chef-cli/helpers.rb, line 49 def stderr $stderr end
# File lib/chef-cli/helpers.rb, line 45 def stdout $stdout end
Runs given commands using mixlib-shellout
# File lib/chef-cli/helpers.rb, line 31 def system_command(*command_args) cmd = Mixlib::ShellOut.new(*command_args) cmd.run_command cmd end
Returns the full path to the given command under usr_bin_prefix
# File lib/chef-cli/helpers.rb, line 94 def usr_bin_path(command) File.join(usr_bin_prefix, command) end
Returns the directory that contains our main symlinks. On Mac we place all of our symlinks under /usr/local/bin on other platforms they are under /usr/bin
# File lib/chef-cli/helpers.rb, line 89 def usr_bin_prefix @usr_bin_prefix ||= macos? ? "/usr/local/bin" : "/usr/bin" end
Private Instance Methods
# File lib/chef-cli/helpers.rb, line 145 def default_package_home if Chef::Platform.windows? File.join(ENV["LOCALAPPDATA"], ChefCLI::Dist::PRODUCT_PKG_HOME) else File.expand_path("~/.#{ChefCLI::Dist::PRODUCT_PKG_HOME}") end end
# File lib/chef-cli/helpers.rb, line 141 def expected_omnibus_root File.expand_path(File.join(Gem.ruby, "..", "..", "..")) end
@return [Boolean] Returns true if we are on macOS. Otherwise false
@api private
# File lib/chef-cli/helpers.rb, line 173 def macos? !!(RUBY_PLATFORM =~ /darwin/) end
@api private This method resets all the instance variables used. It should only be used for testing
# File lib/chef-cli/helpers.rb, line 163 def reset! instance_variables.each do |ivar| instance_variable_set(ivar, nil) end end
Open a file. By default, the mode is for read+write, and binary so that windows writes out what we tell it, as this is the most common case we have.
# File lib/chef-cli/helpers.rb, line 156 def with_file(path, mode = "wb+", &block) File.open(path, mode, &block) end