From a36a9a2c15be7db9f77dc1ef2be09652b6954ec3 Mon Sep 17 00:00:00 2001 From: elijah Date: Wed, 14 Nov 2012 14:28:09 -0800 Subject: more improvements to logging --- lib/leap_cli/commands/node.rb | 15 +++++---- lib/leap_cli/log.rb | 2 +- lib/leap_cli/util.rb | 78 +++++++++++++++++++++++++------------------ 3 files changed, 56 insertions(+), 39 deletions(-) diff --git a/lib/leap_cli/commands/node.rb b/lib/leap_cli/commands/node.rb index 61e463b..2b36f58 100644 --- a/lib/leap_cli/commands/node.rb +++ b/lib/leap_cli/commands/node.rb @@ -87,17 +87,20 @@ module LeapCli; module Commands # see `man sshd` for the format of known_hosts # def save_public_host_key(node) - log("Fetching public SSH host key for #{node.name}") + log :fetching, "public SSH host key for #{node.name}" public_key = get_public_key_for_ip(node.ip_address, node.ssh.port) pub_key_path = Path.named_path([:node_ssh_pub_key, node.name]) if Path.exists?(pub_key_path) if public_key == SshKey.load_from_file(pub_key_path) - log("Public SSH host key for #{node.name} has not changed") + log :trusted, "- Public SSH host key for #{node.name} matches previously saved key", :indent => 1 else - bail!("WARNING: The public SSH host key we just fetched for #{node.name} doesn't match what we have saved previously. Remove the file #{pub_key_path} if you really want to change it.") + bail! do + log 0, :error, "The public SSH host key we just fetched for #{node.name} doesn't match what we have saved previously.", :indent => 1 + log 0, "Remove the file #{pub_key_path} if you really want to change it.", :indent => 2 + end end elsif public_key.in_known_hosts?(node.name, node.ip_address, node.domain.name) - log("Public SSH host key for #{node.name} is trusted (key found in your ~/.ssh/known_hosts)") + log :trusted, "- Public SSH host key for #{node.name} is trusted (key found in your ~/.ssh/known_hosts)" else puts say("This is the SSH host key you got back from node \"#{node.name}\"") @@ -108,7 +111,7 @@ module LeapCli; module Commands bail! else puts - write_file!([:node_ssh_pub_key, node.name], public_key.to_s) + write_file! [:node_ssh_pub_key, node.name], public_key.to_s end end end @@ -123,7 +126,7 @@ module LeapCli; module Commands end def ping_node(node) - log("Pinging #{node.name}") + log :pinging, node.name assert_run!("ping -W 1 -c 1 #{node.ip_address}", "Could not ping #{node.name} (address #{node.ip_address}). Try again, we only send a single ping.") end diff --git a/lib/leap_cli/log.rb b/lib/leap_cli/log.rb index 18a246f..aa9fd16 100644 --- a/lib/leap_cli/log.rb +++ b/lib/leap_cli/log.rb @@ -57,7 +57,7 @@ def log(*args) when :run then Paint['run', :magenta] when :failed then Paint['FAILED', :red, :bold] when :ran then Paint['ran', :green, :bold] - else "" + else Paint[title.to_s, :cyan, :bold] end print "#{prefix} " if FILE_TITLES.include?(title) && message =~ /^\// diff --git a/lib/leap_cli/util.rb b/lib/leap_cli/util.rb index 8e7b752..20036b2 100644 --- a/lib/leap_cli/util.rb +++ b/lib/leap_cli/util.rb @@ -16,18 +16,19 @@ module LeapCli 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) + def bail!(message=nil) + if block_given? + yield + elsif message + puts message + end puts("Bailing out.") raise SystemExit.new - #ENV['GLI_DEBUG'] = "false" - #exit_now!(message) end # @@ -41,15 +42,19 @@ module LeapCli # # bails out with message if assertion is false. # - def assert!(boolean, message) - bail!(message) unless boolean + def assert!(boolean, message=nil, &block) + if !boolean + bail!(message, &block) + end 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 + assert! `which #{cmd_name}`.strip.any? do + log 0, :missing, "command '%s'" % cmd_name + end end # @@ -60,9 +65,11 @@ module LeapCli cmd = cmd + " 2>&1" output = `#{cmd}` unless $?.success? - log :run, cmd - log :failed, "(exit #{$?.exitstatus}) #{output}" - bail! + bail! do + log 0, :run, cmd + log 0, :failed, "(exit #{$?.exitstatus}) #{output}", :indent => 1 + log 0, message, :indent => 1 if message + end else log 2, :ran, cmd end @@ -76,9 +83,15 @@ module LeapCli File.exists?(file_path) ? 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." + bail! do + log 0, :error, "Sorry, we can't continue because these files already exist: #{file_list.join(', ')}." + log 0, options[:msg] if options[:msg] + end 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." + bail! do + log 0, :error, "Sorry, we can't continue because this file already exists: #{file_list.first}." + log 0, options[:msg] if options[:msg] + end end end @@ -89,7 +102,9 @@ module LeapCli rescue NoMethodError rescue NameError end - assert! value, " = Error: Nothing set for #{conf_path}" + assert! value do + log 0, :missing, "configuration value for #{conf_path}" + end end def assert_files_exist!(*files) @@ -99,9 +114,15 @@ module LeapCli !File.exists?(file_path) ? Path.relative_path(file_path) : nil }.compact if file_list.length > 1 - bail! "Sorry, you are missing these files: #{file_list.join(', ')}. #{options[:msg]}" + bail! do + log 0, :missing, "these files: #{file_list.join(', ')}" + log 0, options[:msg] if options[:msg] + end elsif file_list.length == 1 - bail! "Sorry, you are missing this file: #{file_list.join(', ')}. #{options[:msg]}" + bail! do + log 0, :missing, "file #{file_list.first}" + log 0, options[:msg] if options[:msg] + end end end @@ -123,16 +144,14 @@ module LeapCli # creates a directory if it doesn't already exist # def ensure_dir(dir) + dir = Path.named_path(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 - log :created, dir + assert_files_missing!(dir, :msg => "Cannot create directory #{dir}") + FileUtils.mkdir_p(dir) + unless dir =~ /\/$/ + dir = dir + '/' end + log :created, dir end end @@ -158,18 +177,13 @@ module LeapCli 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 + assert_files_exist!(filepath) + File.read(filepath) end def read_file(filepath) filepath = Path.named_path(filepath) - if !File.exists?(filepath) - nil - else + if file_exists?(filepath) File.read(filepath) end end -- cgit v1.2.3