ccsh 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e18fe57923e83f6f801b3c17cffab2d0928df142
-  data.tar.gz: 8fa3fb86f5626fa09a4f657379626bcc1e4c4d72
+  metadata.gz: '0061963e9d2650efa04cdc165c330639b30198b7'
+  data.tar.gz: 370fe5f65c0948e3887ef91b6d654bb5a6513b89
 SHA512:
-  metadata.gz: a5b6525d2f5d690e88d2cb9322a42400d5909e625d797d24b7a7c64bf31607c7026bc34de478936bae625ec89dee37b936b8d1075e35b17ab21b5f8c9f72fede
-  data.tar.gz: f40ee7dcf33c3071a3ff83c5b105ac66ae3b07cfc2d79109aecc96d864331d4dd389daa932c74faecb90b5a21440989b603f6e004cb169c44b4c0a779c947b10
+  metadata.gz: f19431222c8aabc93a1742bc7e4e671177938c388283cabf7fe312878da30a13a1d78ed076b06065a3f5567f5c7feff55c21ad3bf4b25d74f6c5c5ca27ab3311
+  data.tar.gz: c39dfa8bf6dac2f3f4986e05c3efcf8932ec7e71aad20e9fc220fe6c88468e1fc7ccfa222bc41ed55a53caa8c28c20b9197ba045b11b3f361521632f4fa461c4

data/lib/ccsh.rb

@@ -9,20 +9,36 @@ module CCSH
     require 'ccsh/ssh.rb'
 
     def self.execute!
-        options = CCSH::Options.parse_options ARGV
+        begin
+            options = CCSH::Options.parse_options ARGV
 
-        ENV['CCSH_DEBUG']   = "true" if options[:debug]
-        ENV['CCSH_VERBOSE'] = "true" if options[:verbose]
+            ENV['CCSH_DEBUG']   = "true" if options[:debug]
+            ENV['CCSH_VERBOSE'] = "true" if options[:verbose]
 
-        raise "You must to specified a hostname or group" if options[:targets].empty?
+            raise "You must to specified a hostname or group" if options[:targets].empty?
 
-        filename = options[:hosts]
-        targets = options[:targets]
+            filename = options[:hosts]
+            targets = options[:targets]
 
-        self.start_cli CCSH::Hosts.new.parser!(filename).filter_by(targets)
+            hosts = CCSH::Hosts.new.parser!(filename).filter_by(targets)
+            self.start_cli(hosts, options)
+
+        rescue Exception => e
+            if not e.message == 'exit'
+                CCSH::Utils.debug "Backtrace:\n\t#{e.backtrace.join("\n\t")}\n\n"
+                CCSH::Utils.verbose "Backtrace:\n\t#{e.backtrace.join("\n\t")}\n\n"
+
+                puts "An error occur and system exit with the following message: "
+                puts "  #{e.message}"
+
+                exit!
+            end
+
+            exit
+        end
     end
 
-    def self.with_info
+    def self.with_info(options)
         cmd_start = Time.now
         cmd = yield
         cmd_end = Time.now
@@ -32,13 +48,32 @@ module CCSH
             'time' => cmd_end - cmd_start,
         }.inspect
 
-        puts ">>> #{cmd.hostname} #{info}"
+        prompt = ">>> #{cmd.hostname} #{info}"
+
+        puts prompt
         STDERR.puts cmd.stderr if cmd.stderr != nil && cmd.stderr != ''
         puts cmd.stdout if cmd.stdout != nil && cmd.stdout != ''
         puts
+
+        if options[:output] != nil
+            begin
+                file_handler = File.new(options[:output], "a+")
+
+                file_handler.write("#{prompt}\n")
+                file_handler.write("ERROR: #{cmd.stderr}") if cmd.stderr != nil && cmd.stderr != ''
+                file_handler.write("#{cmd.stdout}\n") if cmd.stdout != nil && cmd.stdout != ''
+            rescue Exception => e
+                puts "WARNING: An error occur when trying to write the output to file: #{options[:output]}. "
+                puts "WARNING: Thefore, the output is not being stored"
+                puts "WARNING: Error message: #{e.message}"
+            end
+        end
     end
 
-    def self.start_cli(hosts)
+
+    def self.start_cli(hosts, options)
+        CCSH::Utils.display_hosts(hosts) if options[:show_hosts]
+
         quit = false
         loop do
             begin
@@ -55,17 +90,26 @@ module CCSH
                     elsif command == 'reset'
                         CCSH::Utils.reset_console
                     else
-                        threads = []
-                        hosts.each do |host|
-                            threads << Thread.new do
+                        if ((options.max_threads == 0) || (options.max_threads > hosts.length))
+                            options.max_threads = hosts.length
+                        end
 
-                                with_info do
-                                    host.run command
+                        CCSH::Utils.debug "Using #{options.max_threads} maximum of threads"
+
+                        hosts.each_slice(options.max_threads) do |batch_hosts|
+                            threads = []
+
+                            batch_hosts.each do |host|
+                                threads << Thread.new do
+
+                                    info = with_info(options) do
+                                        host.run command
+                                    end
                                 end
                             end
-                        end
 
-                        threads.each(&:join)
+                            threads.each(&:join)
+                        end
                     end
                 end
             rescue Exception => exception

data/lib/ccsh/host.rb

@@ -1,5 +1,5 @@
 module CCSH
-    class Host        
+    class Host
         attr_accessor :name
         attr_accessor :port
         attr_accessor :user
@@ -22,7 +22,7 @@ module CCSH
         end
 
         def run(command)
-            CCSH::Utils.verbose("Running command '#{@command}' on #{@hostname}")
+            CCSH::Utils.debug("Running command '#{command}' on #{@hostname}")
             command = CCSH::SSH.start do |ssh|
                 ssh.user = @user
                 ssh.port = @port
@@ -42,4 +42,4 @@ module CCSH
             return @groups.include? target
         end
     end
-end
+end

data/lib/ccsh/options.rb

@@ -9,12 +9,15 @@ module CCSH
             # default values
             user_home = File.expand_path('~')
 
-            options.config  = "#{user_home}/.ccsh/config.yaml"
-            options.hosts   = "#{user_home}/.ccsh/hosts.yaml"
-            options.output  = ""
-            options.debug   = false
-            options.verbose = false
-            options.check   = false
+            options.config      = "#{user_home}/.ccsh/config.yaml"
+            options.hosts       = "#{user_home}/.ccsh/hosts.yaml"
+            options.output      = ""
+            options.debug       = false
+            options.verbose     = false
+            options.check       = false
+            options.output      = nil
+            options.show_hosts  = false
+            options.max_threads = 0
 
             # open parser
             opt_parser = OptionParser.new do |opts|
@@ -27,6 +30,7 @@ module CCSH
                 end
 
                 opts.on("-d", "--[no-]debug", "Run Debug mode") do |d|
+                    options.verbose = d
                     options.debug = d
                 end
 
@@ -38,10 +42,38 @@ module CCSH
                     options.check = k
                 end
 
+                opts.on("-o", "--output FILEPATH", "Write all the interaction into an output file") do |out|
+                    options.output = out
+                end
+
                 opts.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+                    options.show_hosts = v
                     options.verbose = v
                 end
 
+                opts.on("--show-hosts", "Output the filtered hosts") do |show_hosts|
+                    options.show_hosts = show_hosts
+                end
+
+                opts.on("-t", "--max-threads MAX_THREADS",
+                        "Define the maxinum number of threads (by default: the ammount of selected hosts)") do |max_threads|
+
+                    begin
+                        if not max_threads =~ /\d+/
+                            raise "The value '#{max_threads}' is not a valid value to max_threads options"
+                        end
+
+                        max_threads = max_threads.to_i
+                        if max_threads < 0
+                            raise "max_threads value should be a positive number instead of '#{max_threads}'"
+                        end
+
+                        options.max_threads = max_threads
+                    rescue Exception => e
+                        raise e.message
+                    end
+                end
+
                 opts.on("--version", "Display version") do |v|
                     build = "build #{CCSH::BUILD_NUMBER}" if CCSH::BUILD_NUMBER != nil
                     puts "CCSH version #{CCSH::VERSION} #{build}"

data/lib/ccsh/utils.rb

@@ -1,5 +1,9 @@
 module CCSH
     module Utils
+
+        ##
+        # Responsible to merge the defaults settings with the each hosts
+        # parameters.
         def self.merge_defaults(defaults)
             defaultsValues = {
                 'user'        => 'root',
@@ -22,6 +26,10 @@ module CCSH
             return defaultsValues
         end
 
+        ##
+        # Given an item, hash and wanted default return, return the
+        # item if exists on array object or return the default
+        # value if the key doesn't exist.
         def self.get_options(item, object, default)
             if object.key? item
                 return object[item]
@@ -30,18 +38,37 @@ module CCSH
             return default
         end
 
+        ##
+        # Pretty print the filtered hosts
+        def self.display_hosts(hosts)
+            puts "Selected Hosts (option: --show-hosts):"
+            hosts.each do |host|
+                puts "+ Server #{host.name}: #{host.user}@#{host.hostname} => Groups: #{host.groups}"
+            end
+
+            puts
+        end
+
+        ##
+        #
         def self.valid_ssh(options)
             return true
         end
 
+        ##
+        # Display a message, if debug mode is enabled
         def self.debug(msg)
-            puts "DEBUG", msg if ENV['CCSH_DEBUG'] == "true"
+            puts "[DEBUG] #{msg}" if ENV['CCSH_DEBUG'] == "true"
         end
 
+        ##
+        # Verbosely display a message, if verbose mode is enabled
         def self.verbose(msg)
             puts msg if ENV['CCSH_VERBOSE'] == "true"
         end
 
+        ##
+        # Handle terminal signals
         def self.handle_signals
             Signal.trap('INT') do
                 self.exit_console 0
@@ -52,6 +79,8 @@ module CCSH
             end
         end
 
+        ##
+        # Exit the console message
         def self.exit_console(code, msg = nil)
             puts msg if msg != nil
 
@@ -59,11 +88,15 @@ module CCSH
             exit code || 0
         end
 
+        ##
+        # clear the system console when run clear
         def self.clear_console
             printf "\e[H\e[2J"
         end
 
-        def self.clear_console
+        ##
+        # reset the console
+        def self.reset_console
             printf("\033c");
         end
     end

data/lib/ccsh/version.rb

@@ -1,7 +1,7 @@
 module CCSH
 
     # ccsh relased version
-    VERSION   = "0.0.3"
+    VERSION   = "0.0.4"
 
     # the git commit tag number that generate this build
     BUILD_NUMBER = "dev-#{VERSION}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccsh
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
-- Rafael Silva <raffs>
+- Rafael Silva - raffs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-03 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh