blackstack-nodes 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37a97d12519b7be33c7f4a15c489043f4925c8a694c1ca5fcaa8766b64dee102
-  data.tar.gz: 65616d5b4e683929d19f55fefa8e6a79d383bc7b267beb9ba433bb0685d4c3b0
+  metadata.gz: 7dfff9ef5d2e94244befce50fd7dff63ff570be36b54da12e550ef100841c2de
+  data.tar.gz: fa9f19672395322af75efafc19d09add8ddc86e510125f4f37433ef7c9c1bd29
 SHA512:
-  metadata.gz: 9bb62ee361b49ca1962ab1e793d68767c8f48c5a36d590dcb65809dd14cde861e5cfb042b64634b0479bf53b9ae22bdba619b4c61818caf5d8fc21dd325a920d
-  data.tar.gz: b6e79a137d5a38d2af61980f1e76ee6b3a14e800353d759115bfa2801bcfbf5a15a204f28bb8ae119b641a304021334e092ba35fcbcdf26c808167571585a562
+  metadata.gz: 18abefb039af30eddfca6d081b563b053205e35ee209adb26b1c5e85c3bad8b9ba44198f62552bcc15a76aa5e53d571096881571451d04c4861df60bfbaf1f92
+  data.tar.gz: '08df674fc7bcc63bbf792a53d57473bffdd12cc5b72a716ca9b2782e58317e940070b05df16400588d5ab2199827038a0aaa63aa3b3902a15be86abbbfae7257'

data/lib/blackstack-nodes.rb

@@ -1,178 +1,189 @@
-require 'net/ssh'
-require 'simple_cloud_logging'
-# 
-module BlackStack
-  # 
-  module Infrastructure
-    # this module has attributes an methods used by both classes Node and Node.
-    module NodeModule
-      # :name is this is just a descriptive name for the node. It is not the host name, nor the domain, nor any ip. 
-      attr_accessor :name, :net_remote_ip, :ssh_username, :ssh_password, :ssh_port, :ssh_private_key_file
-      # non-database attributes, used for ssh connection and logging
-      attr_accessor :ssh, :logger
-
-      def self.descriptor_errors(h)
-        errors = []
-
-        # validate: the parameter h is a hash
-        errors << "The parameter h is not a hash" unless h.is_a?(Hash)
-
-        # validate: the parameter h has a key :name
-        errors << "The parameter h does not have a key :name" unless h.has_key?(:name)
-
-        # validate: the parameter h[:name] is a string
-        errors << "The parameter h[:name] is not a string" unless h[:name].is_a?(String)
-
-        # validate: the paramerer h has a key :net_remote_ip
-        errors << "The parameter h does not have a key :net_remote_ip" unless h.has_key?(:net_remote_ip)
-
-        # validate: the paramerer h has a key :ssh_username
-        errors << "The parameter h does not have a key :ssh_username" unless h.has_key?(:ssh_username)
-
-        # validate: the parameter h[:ssh_username] is a string
-        errors << "The parameter h[:ssh_username] is not a string" unless h[:ssh_username].is_a?(String)
-
-        # if the parameter h has a key :ssh_private_key_file
-        if h.has_key?(:ssh_private_key_file) && !h[:ssh_private_key_file].nil?
-          # validate: the parameter h[:ssh_private_key_file] is a string
-          errors << "The parameter h[:ssh_private_key_file] is not a string" unless h[:ssh_private_key_file].is_a?(String)
-
-          # validate: the parameter h[:ssh_private_key_file] is a string
-          errors << "The parameter h[:ssh_private_key_file] is not a string" unless h[:ssh_private_key_file].is_a?(String)
-        else
-          # validate: the parameter h has a key :ssh_password
-          errors << "The parameter h does not have a key :ssh_password nor :ssh_private_key_file" unless h.has_key?(:ssh_password)
-
-          # validate: the parameter h[:ssh_password] is a string
-          errors << "The parameter h[:ssh_password] is not a string" unless h[:ssh_password].is_a?(String)
-        end
-
-        # return
-        errors
-      end # def self.descriptor_errors(h)
-
-      def initialize(h, i_logger=nil)
-        errors = BlackStack::Infrastructure::NodeModule.descriptor_errors(h)
-        # raise an exception if any error happneed
-        raise "The node descriptor is not valid: #{errors.uniq.join(".\n")}" if errors.length > 0
-        # map attributes
-        self.name = h[:name]
-        self.net_remote_ip = h[:net_remote_ip]
-        self.ssh_username = h[:ssh_username]
-        self.ssh_password = h[:ssh_password] 
-        self.ssh_port = h[:ssh_port]
-        self.ssh_private_key_file = h[:ssh_private_key_file]
-
-        # create a logger
-        self.logger = !i_logger.nil? ? i_logger : BlackStack::BaseLogger.new(nil)
-      end # def self.create(h)
-
-      def to_hash
-        {
-          :name => self.name,
-          :net_remote_ip => self.net_remote_ip,
-          :ssh_username => self.ssh_username,
-          :ssh_password => self.ssh_password, 
-          :ssh_port => self.ssh_port,
-          :ssh_private_key_file => self.ssh_private_key_file,
-        }
-      end # def to_hash
-
-      # return true if the node is all set to connect using ssh user and password.
-      def using_password?
-        !self.net_remote_ip.nil? && !self.ssh_username.nil? && !self.ssh_password.nil?
-      end
-
-      # return true if the node is all set to connect using a private key file.
-      def using_private_key_file?
-        !self.net_remote_ip.nil? && !self.ssh_username.nil? && !self.ssh_private_key_file.nil?
-      end
-
-      def connect
-        # connect
-        if self.using_password?
-          self.ssh = Net::SSH.start(self.net_remote_ip, self.ssh_username, :password => self.ssh_password, :port => self.ssh_port)
-        elsif self.using_private_key_file?
-          self.ssh = Net::SSH.start(self.net_remote_ip, self.ssh_username, :keys => self.ssh_private_key_file, :port => self.ssh_port)
-        else
-          raise "No ssh credentials available"
-        end
-        self.ssh
-      end # def connect
-
-      def disconnect
-        self.ssh.close
-      end
-
-      def exec(command, sudo=true)
-        s = nil
-        command = command.gsub(/'/, "\\\\'")
-        if sudo
-          if self.using_password?
-            s = self.ssh.exec!("echo '#{self.ssh_password.gsub(/'/, "\\\\'")}' | sudo -S su root -c '#{command}'")
-          elsif self.using_private_key_file?
-            s = self.ssh.exec!("sudo -S su root -c '#{command}'")
-          end
-        else
-          s = self.ssh.exec!(command)
-        end
-        s
-      end # def exec
-
-      def reboot()
-        tries = 0
-        max_tries = 20
-        success = false
-
-        host = self
-
-        logger.logs 'reboot... '
-        #stdout = host.reboot
-        begin
-          stdout = self.exec("reboot")
-        rescue
-        end
-        logger.done #logf("done (#{stdout})")
-
-        while tries < max_tries && !success
-            begin
-                tries += 1
-
-                delay = 10
-                logger.logs "wait #{delay.to_s} seconds... "
-                sleep(delay)
-                logger.done
-
-                logger.logs "connecting (try #{tries.to_s})... "
-                host.connect
-                logger.done
-
-                success = true
-            rescue => e
-                logger.logf e.to_s #error e
-            end
-        end # while 
-        raise 'reboot failed' if !success
-      end # def reboot
-
-
-    end # module NodeModule
-
-    # TODO: declare these classes (stub and skeleton) using blackstack-rpc
-    #
-    # Node Stub
-    # This class represents a node, without using connection to the database.
-    # Use this class at the client side.
-    class Node
-      include NodeModule
-    end # class Node
-=begin
-    # Node Skeleton
-    # This class represents a node, with connection to the database.
-    # Use this class at the server side.
-    class Node < Sequel::Model(:node)
-      include NodeModule
-    end
-=end
-  end # module Infrastructure
+require 'net/ssh'
+require 'shellwords'
+require 'simple_cloud_logging'
+# 
+module BlackStack
+  # 
+  module Infrastructure
+    # this module has attributes an methods used by both classes Node and Node.
+    module NodeModule
+      # :name is this is just a descriptive name for the node. It is not the host name, nor the domain, nor any ip. 
+      attr_accessor :name, :net_remote_ip, :ssh_username, :ssh_password, :ssh_port, :ssh_private_key_file
+      # non-database attributes, used for ssh connection and logging
+      attr_accessor :ssh, :logger
+
+      def self.descriptor_errors(h)
+        errors = []
+
+        # validate: the parameter h is a hash
+        errors << "The parameter h is not a hash" unless h.is_a?(Hash)
+
+        # validate: the parameter h has a key :name
+        errors << "The parameter h does not have a key :name" unless h.has_key?(:name)
+
+        # validate: the parameter h[:name] is a string
+        errors << "The parameter h[:name] is not a string" unless h[:name].is_a?(String)
+
+        # validate: the paramerer h has a key :net_remote_ip
+        errors << "The parameter h does not have a key :net_remote_ip" unless h.has_key?(:net_remote_ip)
+
+        # validate: the paramerer h has a key :ssh_username
+        errors << "The parameter h does not have a key :ssh_username" unless h.has_key?(:ssh_username)
+
+        # validate: the parameter h[:ssh_username] is a string
+        errors << "The parameter h[:ssh_username] is not a string" unless h[:ssh_username].is_a?(String)
+
+        # if the parameter h has a key :ssh_private_key_file
+        if h.has_key?(:ssh_private_key_file) && !h[:ssh_private_key_file].nil?
+          # validate: the parameter h[:ssh_private_key_file] is a string
+          errors << "The parameter h[:ssh_private_key_file] is not a string" unless h[:ssh_private_key_file].is_a?(String)
+
+          # validate: the parameter h[:ssh_private_key_file] is a string
+          errors << "The parameter h[:ssh_private_key_file] is not a string" unless h[:ssh_private_key_file].is_a?(String)
+        else
+          # validate: the parameter h has a key :ssh_password
+          errors << "The parameter h does not have a key :ssh_password nor :ssh_private_key_file" unless h.has_key?(:ssh_password)
+
+          # validate: the parameter h[:ssh_password] is a string
+          errors << "The parameter h[:ssh_password] is not a string" unless h[:ssh_password].is_a?(String)
+        end
+
+        # return
+        errors
+      end # def self.descriptor_errors(h)
+
+      def initialize(h, i_logger=nil)
+        errors = BlackStack::Infrastructure::NodeModule.descriptor_errors(h)
+        # raise an exception if any error happneed
+        raise "The node descriptor is not valid: #{errors.uniq.join(".\n")}" if errors.length > 0
+        # map attributes
+        self.name = h[:name]
+        self.net_remote_ip = h[:net_remote_ip]
+        self.ssh_username = h[:ssh_username]
+        self.ssh_password = h[:ssh_password] 
+        self.ssh_port = h[:ssh_port]
+        self.ssh_private_key_file = h[:ssh_private_key_file]
+
+        # create a logger
+        self.logger = !i_logger.nil? ? i_logger : BlackStack::BaseLogger.new(nil)
+      end # def self.create(h)
+
+      def to_hash
+        {
+          :name => self.name,
+          :net_remote_ip => self.net_remote_ip,
+          :ssh_username => self.ssh_username,
+          :ssh_password => self.ssh_password, 
+          :ssh_port => self.ssh_port,
+          :ssh_private_key_file => self.ssh_private_key_file,
+        }
+      end # def to_hash
+
+      # return true if the node is all set to connect using ssh user and password.
+      def using_password?
+        !self.net_remote_ip.nil? && !self.ssh_username.nil? && !self.ssh_password.nil?
+      end
+
+      # return true if the node is all set to connect using a private key file.
+      def using_private_key_file?
+        !self.net_remote_ip.nil? && !self.ssh_username.nil? && !self.ssh_private_key_file.nil?
+      end
+
+      def connect
+        # connect
+        if self.using_password?
+          self.ssh = Net::SSH.start(self.net_remote_ip, self.ssh_username, :password => self.ssh_password, :port => self.ssh_port)
+        elsif self.using_private_key_file?
+          self.ssh = Net::SSH.start(self.net_remote_ip, self.ssh_username, :keys => self.ssh_private_key_file, :port => self.ssh_port)
+        else
+          raise "No ssh credentials available"
+        end
+        self.ssh
+      end # def connect
+
+      def disconnect
+        self.ssh.close
+      end
+
+      def exec(command, sudo=true)
+        code = nil
+        if sudo
+          if self.using_password?
+            code = "echo '#{self.ssh_password}' | sudo -S su root -c '#{command}'"
+          elsif self.using_private_key_file?
+            code = "sudo -S su root -c '#{command}'"
+          end
+        else
+          code = command
+        end
+#puts
+#puts
+#puts code
+#puts
+#puts
+        s = self.ssh.exec!(code)
+#puts
+#puts
+#puts s
+#puts
+#puts
+        s
+      end # def exec
+
+      def reboot()
+        tries = 0
+        max_tries = 20
+        success = false
+
+        host = self
+
+        logger.logs 'reboot... '
+        #stdout = host.reboot
+        begin
+          stdout = self.exec("reboot")
+        rescue
+        end
+        logger.done #logf("done (#{stdout})")
+
+        while tries < max_tries && !success
+            begin
+                tries += 1
+
+                delay = 10
+                logger.logs "wait #{delay.to_s} seconds... "
+                sleep(delay)
+                logger.done
+
+                logger.logs "connecting (try #{tries.to_s})... "
+                host.connect
+                logger.done
+
+                success = true
+            rescue => e
+                logger.logf e.to_s #error e
+            end
+        end # while 
+        raise 'reboot failed' if !success
+      end # def reboot
+
+
+    end # module NodeModule
+
+    # TODO: declare these classes (stub and skeleton) using blackstack-rpc
+    #
+    # Node Stub
+    # This class represents a node, without using connection to the database.
+    # Use this class at the client side.
+    class Node
+      include NodeModule
+    end # class Node
+=begin
+    # Node Skeleton
+    # This class represents a node, with connection to the database.
+    # Use this class at the server side.
+    class Node < Sequel::Model(:node)
+      include NodeModule
+    end
+=end
+  end # module Infrastructure
 end # module BlackStack

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blackstack-nodes
 version: !ruby/object:Gem::Version
-  version: 1.2.7
+  version: 1.2.8
 platform: ruby
 authors:
 - Leandro Daniel Sardi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-09 00:00:00.000000000 Z
+date: 2022-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -66,7 +66,7 @@ homepage: https://github.com/leandrosardi/blackstack-nodes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.7
-signing_key: 
+signing_key:
 specification_version: 4
 summary: BlackStack Nodes is a simple library to managing a computer remotely via
   SSH, and perform some common operations.