require 'digest/md5' module LeapCli module Util extend self ## ## QUITTING ## # # quit and print help # def help!(message=nil) ENV['GLI_DEBUG'] = "false" help_now!(message) #say("ERROR: " + message) end # # quit with a message that we are bailing out. # def bail!(message="") puts(message) puts("Bailing out.") raise SystemExit.new #ENV['GLI_DEBUG'] = "false" #exit_now!(message) end # # quit with no message # def quit!(message='') puts(message) raise SystemExit.new end # # bails out with message if assertion is false. # def assert!(boolean, message) bail!(message) unless boolean end # # assert that the command is available # def assert_bin!(cmd_name) assert! `which #{cmd_name}`.strip.any?, "Sorry, bailing out, the command '%s' is not installed." % cmd_name end # # assert that the command is run without an error. # if successful, return output. # def assert_run!(cmd, message=nil) cmd = cmd + " 2>&1" output = `#{cmd}` unless $?.success? log1(" * run: #{cmd}") log1(" * FAILED: (exit #{$?}) #{output}") else log2(" * run: #{cmd}") end return output end def assert_files_missing!(*files) options = files.last.is_a?(Hash) ? files.pop : {} file_list = files.collect { |file_path| file_path = Path.named_path(file_path) File.exists?(file_path) ? relative_path(file_path) : nil }.compact if file_list.length > 1 bail! "Sorry, we can't continue because these files already exist: #{file_list.join(', ')}. You are not supposed to remove these files. Do so only with caution." elsif file_list.length == 1 bail! "Sorry, we can't continue because this file already exists: #{file_list}. You are not supposed to remove this file. Do so only with caution." end end def assert_config!(conf_path) value = nil begin value = manager.instance_eval(conf_path) rescue NoMethodError rescue NameError end assert! value, "* Error: Nothing set for #{conf_path}" end def assert_files_exist!(*files) options = files.last.is_a?(Hash) ? files.pop : {} file_list = files.collect { |file_path| file_path = Path.named_path(file_path) !File.exists?(file_path) ? relative_path(file_path) : nil }.compact if file_list.length > 1 bail! "Sorry, you are missing these files: #{file_list.join(', ')}. #{options[:msg]}" elsif file_list.length == 1 bail! "Sorry, you are missing this file: #{file_list.join(', ')}. #{options[:msg]}" end end ## ## FILES AND DIRECTORIES ## def relative_path(path) path.sub(/^#{Regexp.escape(Path.provider)}\//,'') end def progress_created(path) progress 'created %s' % relative_path(path) end def progress_updated(path) progress 'updated %s' % relative_path(path) end def progress_nochange(path) progress2 'no change %s' % relative_path(path) end def progress_removed(path) progress 'removed %s' % relative_path(path) end # # creates a directory if it doesn't already exist # def ensure_dir(dir) unless File.directory?(dir) if File.exists?(dir) bail! 'Unable to create directory "%s", file already exists.' % dir else FileUtils.mkdir_p(dir) unless dir =~ /\/$/ dir = dir + '/' end progress_created dir end end end ## ## FILE READING, WRITING, DELETING, and MOVING ## # # All file read and write methods support using named paths in the place of an actual file path. # # To call using a named path, use a symbol in the place of filepath, like so: # # read_file(:known_hosts) # # In some cases, the named path will take an argument. In this case, set the filepath to be an array: # # write_file!([:user_ssh, 'bob'], ssh_key_str) # # To resolve a named path, use the shortcut helper 'path()' # # path([:user_ssh, 'bob']) ==> files/users/bob/bob_ssh_pub.key # def read_file!(filepath) filepath = Path.named_path(filepath) if !File.exists?(filepath) bail!("File '%s' does not exist." % filepath) else File.read(filepath) end end def read_file(filepath) filepath = Path.named_path(filepath) if !File.exists?(filepath) nil else File.read(filepath) end end def remove_file!(filepath) filepath = Path.named_path(filepath) if File.exists?(filepath) File.unlink(filepath) progress_removed(filepath) end end def write_file!(filepath, contents) filepath = Path.named_path(filepath) ensure_dir File.dirname(filepath) existed = File.exists?(filepath) if existed if file_content_equals?(filepath, contents) progress_nochange filepath return end end File.open(filepath, 'w') do |f| f.write contents end if existed progress_updated filepath else progress_created filepath end end def cmd_exists?(cmd) `which #{cmd}`.strip.chars.any? end # # compares md5 fingerprints to see if the contents of a file match the string we have in memory # def file_content_equals?(filepath, contents) filepath = Path.named_path(filepath) output = `md5sum '#{filepath}'`.strip if $?.to_i == 0 return output.split(" ").first == Digest::MD5.hexdigest(contents).to_s else return false end end ## ## PROCESSES ## # # run a long running block of code in a separate process and display marching ants as time goes by. # if the user hits ctrl-c, the program exits. # def long_running(&block) pid = fork if pid == nil yield exit! end Signal.trap("SIGINT") do Process.kill("KILL", pid) Process.wait(pid) bail! end while true sleep 0.2 STDOUT.print '.' STDOUT.flush break if Process.wait(pid, Process::WNOHANG) end STDOUT.puts end end end