blackstack-deployer 1.2.14 → 1.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b1cb9fcf8b593e26d0af9259d1f0c89c3ef3488424453e5532c31688e99576b
-  data.tar.gz: c242909970936867f33ecad49d997a467fe8e04b0dd2903d0b90ecd29ab330ad
+  metadata.gz: 9e60ac86398b508a3c0262ee2a8d19d41e59994dbe293de5d155c68b0681d75a
+  data.tar.gz: 6054c1d54a2c3da6bea3b8e30ad1168c09450039918eeed55f1e1380deb7f01f
 SHA512:
-  metadata.gz: 2b91301e161fe11577b77a78ceccfe8e160355ddf0118e6200ecb3137c21c8aa29456cbbc1f2d78210ae64efbb55f780517cd10b2c6302ba9219dadc20b27dd6
-  data.tar.gz: bd821f6059852d9cc265250161a879d04f131b245244b46fc406bb357de49fb4bfd42e387ba8e0ca120ed354b559623713b1506584ff81d62b378aa539820410
+  metadata.gz: 441321acb984529b0d4fceb4b6b25cd6d7264731019d6076df6c8b5c65026345e9f7cab72c2b12df6843bedae5520b4b8dd6745d87e388057938a861a7ccd055
+  data.tar.gz: 5f487e1c15d30092ca92583eb98e0438334350cda2d719e77b18a03a416f7cfcb34fadd452de992c83b482f1c2b20c9c33cc1f9f0ea572825bf5f35348a1d1fd

data/lib/blackstack-deployer.rb

@@ -5,14 +5,25 @@ module BlackStack
   # Deployer is a library that can be used to deploy a cluster of nodes.
   module Deployer
     @@logger = BlackStack::BaseLogger.new(nil)
+    @@show_output = false
     @@nodes = []
     @@routines = []
 
+    # set show_output
+    def self.set_show_output(value)
+      @@show_output = value
+    end
+
     # set the logger
     def self.set_logger(i_logger)
       @@logger = i_logger
     end
 
+    # get show_output
+    def self.show_output
+      @@show_output
+    end
+
     # get the logger assigned to the module
     def self.logger
       @@logger
@@ -155,7 +166,7 @@ module BlackStack
       def run(node)
         ret = []
         self.commands.each do |c|
-          BlackStack::Deployer.logger.logs "Running command: #{c.command.to_s}... "
+          #BlackStack::Deployer.logger.logs "Running command: #{c.command.to_s}... "
           h = c.run(node)
           ret << h
 
@@ -163,10 +174,10 @@ module BlackStack
           #BlackStack::Deployer.logger.logf h.to_s
 
           if h[:errors].size == 0
-            BlackStack::Deployer.logger.done
+            #BlackStack::Deployer.logger.done
           else
-            BlackStack::Deployer.logger.logf('error: ' + h.to_s)
-            raise "Error running command: #{h.to_s}"
+            #BlackStack::Deployer.logger.logf('error: ' + h.to_s)
+            raise "Error running command:\n#{h[:errors].uniq.join("\n")}"
           end
         end
         ret
@@ -175,7 +186,7 @@ module BlackStack
 
     # define attributes and methods of a routine's command
     module CommandModule
-      attr_accessor :command, :matches, :nomatches, :sudo
+      attr_accessor :command, :matches, :nomatches, :sudo, :background
 
       def self.descriptor_errors(c)
         errors = []
@@ -200,8 +211,11 @@ module BlackStack
             # :reboot is a reserved word, so it is fine to call :reboot
           else
             # validate: existis a routine with a the value c[:command].to_s on its :name key
-            errors << "The routine with the name #{c[:command].to_s} does not exist" unless BlackStack::Deployer::routines.select { |r| r.name == c[:command].to_s }.size > 0
+            errors << "The routine with the name #{c[:command].to_s} does not exist" unless BlackStack::Deployer::deployment_routines.select { |r| r.name == c[:command].to_s }.size > 0
           end
+        else
+          # validate: each line of the :command value must finish with ;
+          errors << "Each line in the :command value must finish with `;`.\nCommand: #{c[:command]}.\nRefer https://github.com/leandrosardi/blackstack-deployer#67-running-commands-in-background for more details." unless c[:command].strip.split("\n").select { |l| l.strip[-1,1] != ';' }.size == 0
         end
 
         # if c[:matches] exists
@@ -229,6 +243,12 @@ module BlackStack
             end # each
           end # if c[:matches].is_a?(Array)
         end # if :matches exists
+
+        # if c[:background] exists, it must be a boolean
+        if c.has_key?(:background)
+          errors << "The value of the key :background is not a boolean" unless c[:background].is_a?(TrueClass) || c[:background].is_a?(FalseClass)
+        end
+
         # 
         errors.uniq
       end # def self.descriptor_error(h)
@@ -257,7 +277,12 @@ module BlackStack
               self.nomatches << BlackStack::Deployer::NoMatch.new(m)
             end
           end
-        end                                                                                                                       
+        end
+        if h.has_key?(:background)
+          self.background = h[:background]
+        else
+          self.background = false
+        end                                                                                                            
       end # def initialize(h)
 
       def to_hash
@@ -275,49 +300,78 @@ module BlackStack
         h
       end # def to_hash
 
+      # return the code to exectute the command, 
+      # after applying modifications requested by 
+      # some parameters like `:show_outut` or `:background`.
+      def code(node)
+          ret = self.command
+          # replacing parameters
+          ret.scan(/%[a-zA-Z0-9\_]+%/).each do |p|
+            if p == '%eth0_ip%' # reserved parameter
+              # TODO: move the method eth0_ip to the blackstack-nodes library
+              ret.gsub!(p, node.eth0_ip) 
+            elsif p == '%timestamp%' # reserved parameter
+              # TODO: move this to a timestamp function on blackstack-core
+              ret.gsub!(p, Time.now.to_s.gsub(/\D/, '')) 
+            else
+              if node.parameters.has_key?(p.gsub(/%/, '').to_sym)
+                ret.gsub!(p, node.parameters[p.gsub(/%/, '').to_sym].to_s)
+              else
+                raise "The parameter #{p} does not exist in the node descriptor #{node.parameters.to_s}"
+              end
+            end
+          end
+          # if the command is configured to run in background, and the flag show_ouput is off, then modify the ret to run in background
+          if self.background && !BlackStack::Deployer.show_output
+            lines = ret.strip.lines
+            total = lines.size
+            i = 0
+            lines.each { |l| 
+              i += 1
+              if i == total
+                l.gsub!(/;$/, ' > /dev/null 2>&1 &')
+              else
+                l.gsub!(/;$/, ' > /dev/null 2>&1;')
+              end
+            }
+            ret = lines.join("\n")
+          end
+          # return the code
+          ret
+      end
+
       def run(node)
+        l = BlackStack::Deployer.logger
         errors = []
-        code = self.command
         output = nil
+        s = self.code(node)
 
-        # if code is a symbol
-        if code.is_a?(Symbol)
+        # if self.command is a symbol
+        if self.command.is_a?(Symbol)
 
-          # if code is equel than :reboot
-          if code == :reboot
+          # if self.command is equel than :reboot
+          if self.command == :reboot
             # call the node reboot method
             node.reboot
           else
             # look for a routine with this name
-            r = BlackStack::Deployer.routines.select { |r| r.name == code.to_s }.first
+            r = BlackStack::Deployer.routines.select { |r| r.name == self.command.to_s }.first
             if !r.nil?
               r.run(node)
             else
-              raise "The routine #{code.to_s} does not exist"
+              raise "The routine #{self.command.to_s} does not exist"
             end
           end
 
-        # if code is a string
-        elsif code.is_a?(String)
-          # replacing parameters
-          code.scan(/%[a-zA-Z0-9\_]+%/).each do |p|
-            if p == '%eth0_ip%' # reserved parameter
-              # TODO: move the method eth0_ip to the blackstack-nodes library
-              code.gsub!(p, node.eth0_ip) 
-            elsif p == '%timestamp%' # reserved parameter
-              # TODO: move this to a timestamp function on blackstack-core
-              code.gsub!(p, Time.now.to_s.gsub(/\D/, '')) 
-            else
-              if node.parameters.has_key?(p.gsub(/%/, '').to_sym)
-                code.gsub!(p, node.parameters[p.gsub(/%/, '').to_sym].to_s)
-              else
-                raise "The parameter #{p} does not exist in the node descriptor #{node.parameters.to_s}"
-              end
-            end
-          end
+        # if self.command is a string
+        elsif self.command.is_a?(String)
 
           # running the command
-          output = node.exec(code, self.sudo)
+          l.logs "Show command output... " if BlackStack::Deployer.show_output
+          l.log "\n\nCommand:\n--------\n\n#{s} " if BlackStack::Deployer.show_output
+          output = node.exec(s, self.sudo)
+          l.log "\n\nOutput:\n-------\n\n#{output}" if BlackStack::Deployer.show_output
+          l.logf('done tracing.') if BlackStack::Deployer.show_output
 
           # validation: at least one of the matches should happen
           if self.matches.size > 0
@@ -339,7 +393,7 @@ module BlackStack
         # return a hash descriptor of the command result 
         {
           :command => self.command,
-          :code => code,
+          :code => s,
           :output => output,
           :errors => errors,
         }
@@ -514,19 +568,19 @@ module BlackStack
       raise "The routine #{routine_name} cannot be run on the node #{node_name}: #{errors.uniq.join(".\n")}" if errors.length > 0
         
       # connect the node
-      self.logger.logs "Connecting to node #{n.name}... "
+      #self.logger.logs "Connecting to node #{n.name}... "
       n.connect
-      self.logger.done
+      #self.logger.done
 
       # run the routine
-      self.logger.logs "Running routine #{r.name}... "
+      #self.logger.logs "Running routine #{r.name}... "
       r.run(n)
-      self.logger.done
+      #self.logger.done
         
       # disconnect the node
-      self.logger.logs "Disconnecting from node #{n.name}... "
+      #self.logger.logs "Disconnecting from node #{n.name}... "
       n.disconnect
-      self.logger.done
+      #self.logger.done
         
     end # def
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blackstack-deployer
 version: !ruby/object:Gem::Version
-  version: 1.2.14
+  version: 1.2.17
 platform: ruby
 authors:
 - Leandro Daniel Sardi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-30 00:00:00.000000000 Z
+date: 2022-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blackstack-nodes