ccsh 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '0061963e9d2650efa04cdc165c330639b30198b7'
-  data.tar.gz: 370fe5f65c0948e3887ef91b6d654bb5a6513b89
+SHA256:
+  metadata.gz: 639d07e71db4651f24cde07acebee595da81371f9e1890260c66a8aac6d0f694
+  data.tar.gz: 583b234ae7902e7c30d701134778ace42b0adc4bbb4a61749bc64650fd8c76bc
 SHA512:
-  metadata.gz: f19431222c8aabc93a1742bc7e4e671177938c388283cabf7fe312878da30a13a1d78ed076b06065a3f5567f5c7feff55c21ad3bf4b25d74f6c5c5ca27ab3311
-  data.tar.gz: c39dfa8bf6dac2f3f4986e05c3efcf8932ec7e71aad20e9fc220fe6c88468e1fc7ccfa222bc41ed55a53caa8c28c20b9197ba045b11b3f361521632f4fa461c4
+  metadata.gz: f16c64f3e57d0504a848acac338edabd30fe2d82ec589e018d198f00e0eb31076781d8976806d15cd886a63e00417814ce40ddc4ea7ee331cbe15df39c0e66ea
+  data.tar.gz: 4ee0fc7b6466475e6c2d446026b079e2411c0a7d77e1b7e1508fbcc66e78d92a3dfda37abb735f8ea7329999e6daf93764ecba057bc4ce32b1e446d851c8d81d

data/lib/ccsh.rb

@@ -15,12 +15,36 @@ module CCSH
             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?
+            if options[:targets].empty?
+                error_msg = "You must specify a target hostname or group name."
+
+                puts error_msg
+                puts "Example:"
+                puts "    'ccsh databases' - select all servers from the database group"
+                puts "    'ccsh all'       - select all defined servers"
+                puts "Please run 'ccsh --help' for details"
+                puts ""
+
+                raise error_msg
+            end
 
             filename = options[:hosts]
             targets = options[:targets]
-
             hosts = CCSH::Hosts.new.parser!(filename).filter_by(targets)
+
+            # validate and display pretty message if no hosts was found to the
+            # given target.
+            if hosts.empty?
+                error_msg = "Could not found any hosts that matches the given target(s): '#{targets.join(', ')}'"
+                puts error_msg
+
+                puts "Here are some groups found on the file: '#{filename}'"
+                CCSH::Utils.show_groups(CCSH::Hosts.new.parser!(filename).filter_by('all'))
+
+                puts ""
+                raise error_msg
+            end
+
             self.start_cli(hosts, options)
 
         rescue Exception => e
@@ -28,8 +52,8 @@ module CCSH
                 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}"
+                STDERR.puts "An error occur and system exit with the following message: "
+                STDERR.puts "  #{e.message.gsub("\n", ' ').squeeze(' ')}"
 
                 exit!
             end
@@ -73,6 +97,7 @@ module CCSH
 
     def self.start_cli(hosts, options)
         CCSH::Utils.display_hosts(hosts) if options[:show_hosts]
+        CCSH::Utils.display_hosts_verbosity(hosts) if options[:verbose]
 
         quit = false
         loop do
@@ -100,8 +125,14 @@ module CCSH
                             threads = []
 
                             batch_hosts.each do |host|
-                                threads << Thread.new do
+                                if command =~ /^([ ]*)sudo/
+                                    if host.sudo_enabled != true
+                                        STDERR.puts "WARN: You cannot run sudo on the host #{host.hostname}, please enable sudo mode for this hosts"
+                                        next
+                                    end
+                                end
 
+                                threads << Thread.new do
                                     info = with_info(options) do
                                         host.run command
                                     end

data/lib/ccsh/host.rb

@@ -9,6 +9,8 @@ module CCSH
         attr_accessor :private_key
         attr_accessor :ssh_options
         attr_accessor :timeout
+        attr_accessor :sudo_enabled
+        attr_accessor :sudo_password
 
         def initialize
             @name = ''
@@ -19,10 +21,13 @@ module CCSH
             @password = nil
             @private_key = nil
             @ssh_options = []
+            @sudo_enabled = false
+            @sudo_password = @password
         end
 
         def run(command)
             CCSH::Utils.debug("Running command '#{command}' on #{@hostname}")
+
             command = CCSH::SSH.start do |ssh|
                 ssh.user = @user
                 ssh.port = @port
@@ -30,6 +35,8 @@ module CCSH
                 ssh.password = @password
                 ssh.private_key = @private_key
                 ssh.options = @ssh_options
+                ssh.enable_sudo = @sudo_enabled
+                ssh.sudo_password = @sudo_password
 
                 ssh.command = command
                 ssh.hostname = @hostname || @name

data/lib/ccsh/hosts.rb

@@ -36,6 +36,11 @@ module CCSH
                     host.private_key = CCSH::Utils.get_options('private_key', h, @defaults['private_key'])
                     host.ssh_options = CCSH::Utils.get_options('ssh_options', h, @defaults['ssh_options'])
                     host.timeout = CCSH::Utils.get_options('timeout', h, @defaults['timeout'])
+                    host.sudo_enabled = CCSH::Utils.get_options('sudo_enabled', h, @defaults['sudo_enabled'])
+                    host.sudo_password = CCSH::Utils.get_options('sudo_password', h, @defaults['sudo_password'])
+
+                    # define the password if the sudo_password is not set
+                    host.sudo_password = host.password if host.sudo_password == nil
 
                     host.groups = h['groups']
 
@@ -51,12 +56,12 @@ module CCSH
         end
 
         def filter_by(targets)
-            return @hosts if targets.include? 'all'
+            return @hosts if targets.include?('all')
 
             hosts = []
             @hosts.each do |host|
                 targets.each do |target|
-                    hosts << host if host.groups.include? target
+                    hosts << host if host.groups != nil && host.groups.include?(target)
                 end
             end
 

data/lib/ccsh/options.rb

@@ -75,8 +75,7 @@ module CCSH
                 end
 
                 opts.on("--version", "Display version") do |v|
-                    build = "build #{CCSH::BUILD_NUMBER}" if CCSH::BUILD_NUMBER != nil
-                    puts "CCSH version #{CCSH::VERSION} #{build}"
+                    puts "CCSH version #{CCSH::VERSION}"
                     exit
                 end
             end

data/lib/ccsh/ssh.rb

@@ -21,6 +21,8 @@ module CCSH
             attr_accessor :password
             attr_accessor :private_key
             attr_accessor :options
+            attr_accessor :enable_sudo
+            attr_accessor :sudo_password
 
             attr_accessor :stdout
             attr_accessor :stderr
@@ -33,6 +35,10 @@ module CCSH
                 @options  = []
                 @stdout = ''
                 @stderr = ''
+
+                @enable_sudo      = false
+                @sudo_user        = 'root'
+                @sudo_password    = nil
             end
 
             def execute!
@@ -48,12 +54,33 @@ module CCSH
 
                 Net::SSH.start(@hostname, @user, @options) do |ssh|
                     ssh.open_channel do |ch|
-                        ch.exec @command do |ch, success|
-                            raise "Could execute command #{command} on #{host}" unless success
-                        end
-
                         ch.on_data do |c, data|
-                            @stdout << data
+
+                            if data =~ /^\[sudo\] password for /
+
+                                if @enable_sudo
+                                    if @sudo_password != nil
+                                        ch.send_data "#{@sudo_password}\n"
+                                    else
+                                        msg = """The server #{@hostname} asked for user password
+                                            by the 'password' or 'sudo_password' option was not defined.
+                                        """.gsub("\n", ' ').squeeze(' ')
+
+                                        STDERR.puts "[WARN] #{msg}"
+                                        ch.send_data "\x03"
+                                    end
+                                else
+                                    msg = """The server #{@hostname} asked for user password
+                                        the sudo_enabled option was not allowed
+                                        skipping this hosts setup
+                                    """.gsub("\n", ' ').squeeze(' ')
+
+                                    STDERR.puts "[WARN] #{msg}"
+                                    ch.send_data "\x03"
+                                end
+                            else
+                                @stdout << data
+                            end
                         end
 
                         ch.on_extended_data do |c, type, data|
@@ -63,16 +90,27 @@ module CCSH
                         ch.on_request("exit-status") do |c,data|
                             @return_code = data.read_long
                         end
-                    
+
                         ch.on_request("exit-signal") do |c, data|
                             @return_signal = data.read_long
                         end
 
-                    end.wait    
+                        ch.request_pty do |ch, success|
+                            if success
+                                CCSH::Utils.debug("pty successfully obtained for #{@hostname}")
+                            else
+                                CCSH::Utils.debug("pty unsuccessfully obtained for #{@hostname}")
+                            end
+                        end
+
+                        ch.exec @command do |ch, success|
+                            raise "Could execute command #{command} on #{host}" unless success
+                        end
+                    end.wait
                 end
 
                 return self
             end
         end
     end
-end
+end

data/lib/ccsh/utils.rb

@@ -6,9 +6,11 @@ module CCSH
         # parameters.
         def self.merge_defaults(defaults)
             defaultsValues = {
-                'user'        => 'root',
-                'port'        => '22',
-                'private_key' => '~/.ssh/id_rsa',
+                'user'          => 'root',
+                'port'          => '22',
+                'sudo_enabled'  => false,
+                'sudo_password' => nil,
+                'private_key'   => '~/.ssh/id_rsa',
             }
             defaultsValues.merge!(defaults) if defaults != nil
 
@@ -45,12 +47,37 @@ module CCSH
             hosts.each do |host|
                 puts "+ Server #{host.name}: #{host.user}@#{host.hostname} => Groups: #{host.groups}"
             end
+            puts
+        end
 
+        ##
+        # Display host display_hosts_verbosity
+        def self.display_hosts_verbosity(hosts)
+            hosts.each do |host|
+                CCSH::Utils::verbose("sudo mode enable to host: #{host.hostname}") if host.sudo_enabled
+            end
             puts
         end
 
         ##
-        #
+        # Show at least 10 groups names
+        def self.show_groups(hosts)
+            hosts_groups = []
+            hosts.each do |host|
+                if host.groups != nil
+                    host.groups.each do |gname|
+                        hosts_groups.push(gname) unless hosts_groups.include?(gname)
+                    end
+                end
+            end
+
+            hosts_groups.slice(0, 10).each { |gname| puts "  - #{gname}" }
+            puts "Example: ccsh #{hosts_groups[0]}" unless hosts_groups[0] == nil
+            puts "Example: ccsh #{hosts_groups.slice(0,2).join(' ')}" unless hosts_groups.slice(0,2) == nil
+        end
+
+        ##
+        # validate the ssh connection before start the ccsh console
         def self.valid_ssh(options)
             return true
         end
@@ -64,7 +91,7 @@ module CCSH
         ##
         # Verbosely display a message, if verbose mode is enabled
         def self.verbose(msg)
-            puts msg if ENV['CCSH_VERBOSE'] == "true"
+            puts "[verbose] #{msg}" if ENV['CCSH_VERBOSE'] == "true"
         end
 
         ##

data/lib/ccsh/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ccsh
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Rafael Silva - raffs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -86,7 +86,7 @@ homepage: https://github.com/raffs/ccsh
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message: Thanks for installing CCSH!
 rdoc_options: []
 require_paths:
 - lib
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.5
 signing_key: 
 specification_version: 4
 summary: Interactive multiple client shell command