raykit 0.0.304 → 0.0.305

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af677bf68d15ed6aeabaf70b1523e4e350a127d9b836d5a183702584045fa65b
-  data.tar.gz: 2690c79f04897a80b5c5f9d300eb8c41df3d57b7b7f25547910f9eeea340bad1
+  metadata.gz: 7ce7014fb0f09e6200f197f0af6d67c51dbce58df476d440d8cb1dc39a99f44d
+  data.tar.gz: ae8b9b47b88762e6778d594bb34a1d6da36f20e5c69f2dbd3ee7fc9c861d09f0
 SHA512:
-  metadata.gz: 9844953716e273bd5593c8aea8e4085e2ddf7279bf47e8fc51b37a128b654ab92f901ae98c665f337def725a2cddadefe151bf260d33e1251fff8da38dbc7173
-  data.tar.gz: 8e5b9e5be341b7bedc27f022afe5cd687276d424c0f1cffe8945e7f174908b6e8f74e466c7a460cc60442d373b7107d1adc865a81e15d9921cfdd04d62fc7098
+  metadata.gz: 073f890fd9f91ddccf1c3a264865f2b5359b6f315f9434823d6683c5b3d99e0dc4b56dffa1d9e2a7c2cee41a4fa74892c0321318ff466f7237e42c8ddb09c0db
+  data.tar.gz: 6631387820d5366183c50a0f8f0b6fb31eccff7b9c778dab3ea0e89c13b59c66c6ec6c31c86dc4bbc82fc8352ba318444776192905f9bb1b37052c68e36b8b1f

data/bin/raykit

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
-require_relative '../lib/raykit.rb'
+# frozen_string_literal: true
+
+require_relative '../lib/raykit'
 console = Raykit::Console.new
-console.run
+console.run

data/lib/raykit/command.rb

@@ -1,265 +1,262 @@
-require 'open3'
-require 'timeout'
-require 'json'
-require 'yaml'
-require 'logger'
-require 'securerandom'
+# frozen_string_literal: true
 
-BUFFER_SIZE=1024 if(!defined?(BUFFER_SIZE))
-module Raykit
-    # Functionality to support executing and logging system commands
-    class Command
-        @@commands=Array.new
-        # The timeout in seconds, defaults to 0 if not specified
-        attr_accessor :timeout
-        # The working directory, defaults the current directory if not specified
-        attr_accessor :directory
-        # The start time
-        attr_accessor :start_time
-        # The execution time in seconds
-        attr_accessor :elapsed
-        attr_accessor :command,:output,:error,:exitstatus
-        attr_accessor :user,:machine
-        attr_accessor :logging_enabled
-        attr_accessor :success_log_level
+require "open3"
+require "timeout"
+require "json"
+require "yaml"
+require "logger"
+require "securerandom"
 
-        def init_defaults 
-            @timeout=0
-            @directory = Dir.pwd
-            @output = ''
-            @error = ''
-            @exitstatus = 0
-            @user = Environment.user
-            @machine=Environment.machine
-            @logging_enabled = true
-        end
+BUFFER_SIZE = 1024 unless defined?(BUFFER_SIZE)
 
-        def initialize(command,timeout=0,success_log_level=Logger::DEBUG,logging_enabled=true)
-            @@commands=Array.new
-            init_defaults
-            @success_log_level=success_log_level
-            @logging_enabled=logging_enabled
-            @command=command
-            @timeout=timeout
-            if(@command.length > 0)
-                run
-            end
-            self
-        end
+module Raykit
+  # Functionality to support executing and logging system commands
+  class Command
+    @@commands = []
+    # The timeout in seconds, defaults to 0 if not specified
+    attr_accessor :timeout
+    # The working directory, defaults the current directory if not specified
+    attr_accessor :directory
+    # The start time
+    attr_accessor :start_time
+    # The execution time in seconds
+    attr_accessor :elapsed
+    attr_accessor :command, :output, :error, :exitstatus, :user, :machine, :logging_enabled, :success_log_level
 
-        def run() 
-            #puts '---running---'
-            @start_time = Time.now
-            timer = Timer.new
-            if(@timeout == 0)
-                @output,@error,process_status = Open3.capture3(@command) 
-                @exitstatus=process_status.exitstatus
-            else
-                Open3.popen3(@command, :chdir=>@directory) { |stdin,stdout,stderr,thread|
-                    tick=2
-                    pid = thread.pid
-                    start = Time.now
-                    elapsed = Time.now-start
-                    while ((elapsed) < @timeout) and thread.alive?
-                        Kernel.select([stdout,stderr], nil, nil, tick)
-                        begin
-                            @output << stdout.read_nonblock(BUFFER_SIZE)
-                            @error << stderr.read_nonblock(BUFFER_SIZE)
-                        rescue IO::WaitReadable
-                        rescue EOFError
-                            @exitstatus=thread.value.exitstatus
-                            break
-                        end
-                        elapsed = Time.now-start
-                    end
-                    if thread.alive?
-                        if(Gem.win_platform?)
-                            `taskkill /f /pid #{pid}`
-                        else
-                            Process.kill("TERM", pid)
-                        end
-                        @exitstatus=5
-                        @error="timed out"
-                    else
-                        @exitstatus=thread.value.exitstatus
-                    end
-                  }
-            end
-            @elapsed = timer.elapsed
-            if @logging_enabled
-                log
-                if @exitstatus != 0 
-                    to_log_event.to_seq
-                else
-                    #puts '---logging---'
-                    if !@success_log_level.nil?
-                        e = to_log_event
-                        e["Level"] = "Verbose" if @success_log_level == "Verbose"
-                        e["Level"]= "Debug" if @success_log_level == Logger::DEBUG
-                        e["Level"] = "Information" if @success_log_level == Logger::INFO
-                        e["Level"] = "Warning" if @elapsed > 60*2
-                        e.to_seq
-                    end
-                end
-            end
-        end
+    def init_defaults
+      @timeout = 0
+      @directory = Dir.pwd
+      @output = ""
+      @error = ""
+      @exitstatus = 0
+      @user = Environment.user
+      @machine = Environment.machine
+      @logging_enabled = true
+    end
 
-        def to_log_event
-            secrets=Secrets.new()
-            msg =secrets.hide(@command)
-            level="Verbose"
-            level="Warning" if @exitstatus != 0
-            output=@output
-            error=@error
-            output = @output[-1000..-1] if(@output.length > 1200)
-            error = @error[-1000..-1] if(@error.length > 1200)
-            Raykit::LogEvent.new(level,msg,{
-                "SourceContext"=>"Raykit::Command",
-                "Category"=>"Command",
-                "Timeout"=>@timeout,
-                "Directory"=>@directory,
-                "Output"=>output,
-                "Error"=>error,
-                "ExitStatus"=>@exitstatus,
-                "Elapsed"=>elapsed_str,
-                "ElapsedSeconds"=>@elapsed
-            })
-        end
+    def initialize(command, timeout = 0, success_log_level = Logger::DEBUG, logging_enabled = true)
+      @@commands = []
+      init_defaults
+      @success_log_level = success_log_level
+      @logging_enabled = logging_enabled
+      @command = command
+      @timeout = timeout
+      run if @command.length.positive?
+      self
+    end
 
-        def log
-            # --- Rolling File JSON -----
-            log = Logger.new("#{Raykit::Environment::log_dir}/Raykit.Commands.txt",'daily')
-            log.formatter = proc do |severity,datetime,progname,msg|
-                "#{msg}\n"
-            end
-            secrets=Secrets.new()
-            msg =secrets.hide(@command)#"?"# self.summary(false)
-            level="Verbose"
-            level="Warning" if @exitstatus != 0
-            event = Raykit::LogEvent.new(level,msg,{ 
-                "Timeout"=>@timeout,
-                "Directory"=>@directory,
-                "Output"=>@output,
-                "Error"=>@error,
-                "ExitStatus"=>@exitstatus,
-                "Elapsed"=>elapsed_str})
-            log.info event.to_json
-            # ---------------------------
+    def run
+      # puts '---running---'
+      @start_time = Time.now
+      timer = Timer.new
+      if @timeout.zero?
+        @output, @error, process_status = Open3.capture3(@command)
+        @exitstatus = process_status.exitstatus
+      else
+        Open3.popen3(@command, chdir: @directory) do |_stdin, stdout, stderr, thread|
+          tick = 2
+          pid = thread.pid
+          start = Time.now
+          elapsed = Time.now - start
+          while ((elapsed) < @timeout) && thread.alive?
+            Kernel.select([stdout, stderr], nil, nil, tick)
             begin
-                json=JSON.generate(to_hash)
-                log_filename = Environment.get_dev_dir('log') + '/Raykit.Command/' + SecureRandom.uuid + '.json'
-                log_dir = File.dirname(log_filename)
-                FileUtils.mkdir_p(log_dir) if(!Dir.exist?(log_dir))
-                File.open(log_filename, 'w') {|f| f.write(json) }
-                if(@exitstatus == 0)
-                    LOG.log('Raykit.Command',Logger::Severity::INFO,json)
-                else
-                    LOG.log('Raykit.Command',Logger::Severity::ERROR,json)
-                end
-            rescue JSON::GeneratorError => ge
-                puts to_hash.to_s
-                puts ge.to_s
-                json=JSON.generate(to_hash)
+              @output << stdout.read_nonblock(BUFFER_SIZE)
+              @error << stderr.read_nonblock(BUFFER_SIZE)
+            rescue IO::WaitReadable
+            rescue EOFError
+              @exitstatus = thread.value.exitstatus
+              break
             end
-        end
-
-        def elapsed_str()
-            if(elapsed < 1.0)
-                "%.0f" % (elapsed) + "s"
+            elapsed = Time.now - start
+          end
+          if thread.alive?
+            if Gem.win_platform?
+              `taskkill /f /pid #{pid}`
             else
-                "%.0f" % (elapsed) + "s"
+              Process.kill("TERM", pid)
             end
+            @exitstatus = 5
+            @error = "timed out"
+          else
+            @exitstatus = thread.value.exitstatus
+          end
         end
-
-        def summary(show_directory=false)
-            checkmark="\u2713"
-            #warning="\u26A0"
-            error="\u0058"
-            symbol=Rainbow(checkmark.encode('utf-8')).green
-            symbol=Rainbow(error.encode('utf-8')).red if(@exitstatus!=0)
-            if(show_directory)
-                puts symbol + "  " + elapsed_str.rjust(4) + " " + Rainbow(SECRETS.hide(@command)).yellow + " (#{@directory})"
-            else
-                puts symbol + "  " + elapsed_str.rjust(4) + " " + Rainbow(SECRETS.hide(@command)).yellow# + " (#{@directory})"
-            end
-            #puts symbol + "  " + elapsed_str.rjust(4) + " " + Rainbow(SECRETS.hide(@command)).yellow# + " (#{@directory})"
+      end
+      @elapsed = timer.elapsed
+      if @logging_enabled
+        log
+        if @exitstatus != 0
+          to_log_event.to_seq
+        else
+          # puts '---logging---'
+          unless @success_log_level.nil?
+            e = to_log_event
+            e["Level"] = "Verbose" if @success_log_level == "Verbose"
+            e["Level"] = "Debug" if @success_log_level == Logger::DEBUG
+            e["Level"] = "Information" if @success_log_level == Logger::INFO
+            e["Level"] = "Warning" if @elapsed > 60 * 2
+            e.to_seq
+          end
         end
+      end
+    end
 
-        def details
-            #summary
-            puts @output
-            puts @error
-            puts 
+    def to_log_event
+      secrets = Secrets.new
+      msg = secrets.hide(@command)
+      level = "Verbose"
+      level = "Warning" if @exitstatus != 0
+      output = @output
+      error = @error
+      output = @output[-1000..-1] if @output.length > 1200
+      error = @error[-1000..-1] if @error.length > 1200
+      Raykit::LogEvent.new(level, msg, {
+        "SourceContext" => "Raykit::Command",
+        "Category" => "Command",
+        "Timeout" => @timeout,
+        "Directory" => @directory,
+        "Output" => output,
+        "Error" => error,
+        "ExitStatus" => @exitstatus,
+        "Elapsed" => elapsed_str,
+        "ElapsedSeconds" => @elapsed,
+      })
+    end
+
+    def log
+      # --- Rolling File JSON -----
+      log = Logger.new("#{Raykit::Environment.log_dir}/Raykit.Commands.txt", "daily")
+      log.formatter = proc do |_severity, _datetime, _progname, msg|
+        "#{msg}\n"
+      end
+      secrets = Secrets.new
+      msg = secrets.hide(@command) # "?"# self.summary(false)
+      level = "Verbose"
+      level = "Warning" if @exitstatus != 0
+      event = Raykit::LogEvent.new(level, msg, {
+        "Timeout" => @timeout,
+        "Directory" => @directory,
+        "Output" => @output,
+        "Error" => @error,
+        "ExitStatus" => @exitstatus,
+        "Elapsed" => elapsed_str,
+      })
+      log.info event.to_json
+      # ---------------------------
+      begin
+        json = JSON.generate(to_hash)
+        log_filename = "#{Environment.get_dev_dir("log")}/Raykit.Command/#{SecureRandom.uuid}.json"
+        log_dir = File.dirname(log_filename)
+        FileUtils.mkdir_p(log_dir) unless Dir.exist?(log_dir)
+        File.open(log_filename, "w") { |f| f.write(json) }
+        if @exitstatus.zero?
+          LOG.log("Raykit.Command", Logger::Severity::INFO, json)
+        else
+          LOG.log("Raykit.Command", Logger::Severity::ERROR, json)
         end
+      rescue JSON::GeneratorError => e
+        puts to_hash.to_s
+        puts e.to_s
+        json = JSON.generate(to_hash)
+      end
+    end
 
-        def save()
-            filename = Environment.get_dev_dir('log') + '/Commands/' + SecureRandom.uuid
-            log_dir=File.dirname(filename)
-            FileUtils.mkdir_p(log_dir) if(!Dir.exist?(log_dir))
+    def elapsed_str
+      if elapsed < 1.0
+      end
+      "#{format("%.0f", elapsed)}s"
+    end
 
-            File.open(filename,'w'){|f|
-                f.write(JSON.pretty_generate(self.to_hash))
-            }
-            self
-        end
+    def summary(show_directory = false)
+      checkmark = "\u2713"
+      # warning="\u26A0"
+      error = "\u0058"
+      symbol = Rainbow(checkmark.encode("utf-8")).green
+      symbol = Rainbow(error.encode("utf-8")).red if @exitstatus != 0
+      if show_directory
+        puts "#{symbol}  #{elapsed_str.rjust(4)} #{Rainbow(SECRETS.hide(@command)).yellow} (#{@directory})"
+      else
+        puts "#{symbol}  #{elapsed_str.rjust(4)} #{Rainbow(SECRETS.hide(@command)).yellow}" # + " (#{@directory})"
+      end
+      # puts symbol + "  " + elapsed_str.rjust(4) + " " + Rainbow(SECRETS.hide(@command)).yellow# + " (#{@directory})"
+    end
 
-        def to_hash()
-            hash = Hash.new
-            hash[:command] = @command
-            hash[:directory] = @directory
-            hash[:timeout] = @timeout
-            hash[:start_time] = @start_time
-            hash[:elapsed] = @elapsed
-            hash[:output] = @output.force_encoding("ISO-8859-1").encode("UTF-8")
-            hash[:error] = @error.force_encoding("ISO-8859-1").encode("UTF-8")
-            hash[:exitstatus] = @exitstatus
-            hash[:user] = @user
-            hash[:machine] = @machine
-            hash[:context] = "Raykit.Command"
-            hash
-        end
+    def details
+      # summary
+      puts @output
+      puts @error
+      puts
+    end
 
-        def from_hash(hash)
-            @command = hash["command"]
-            @directory=hash["directory"]
-            @timeout=hash["timeout"]
-            @start_time=hash["start_time"]
-            @elapsed=hash["elapsed"]
-            @output=hash["output"]
-            @error=hash["error"]
-            @exitstatus=hash["exitstatus"]
-            @user=hash["user"] if(hash.include?("user"))
-            @machine=hash["machine"] if(hash.include?("machine"))
-        end
+    def save
+      filename = "#{Environment.get_dev_dir("log")}/Commands/#{SecureRandom.uuid}"
+      log_dir = File.dirname(filename)
+      FileUtils.mkdir_p(log_dir) unless Dir.exist?(log_dir)
 
-        def self.parse(json)
-            cmd=Command.new('')
-            cmd.from_hash(JSON.parse(json))
-            cmd
-        end
+      File.open(filename, "w") do |f|
+        f.write(JSON.pretty_generate(to_hash))
+      end
+      self
+    end
 
-        def self.parse_yaml_commands(yaml)
-            #commands=Array.new()
-            data = YAML.load(yaml)
-            commands = get_script_commands(data)
+    def to_hash
+      hash = {}
+      hash[:command] = @command
+      hash[:directory] = @directory
+      hash[:timeout] = @timeout
+      hash[:start_time] = @start_time
+      hash[:elapsed] = @elapsed
+      hash[:output] = @output.force_encoding("ISO-8859-1").encode("UTF-8")
+      hash[:error] = @error.force_encoding("ISO-8859-1").encode("UTF-8")
+      hash[:exitstatus] = @exitstatus
+      hash[:user] = @user
+      hash[:machine] = @machine
+      hash[:context] = "Raykit.Command"
+      hash
+    end
+
+    def from_hash(hash)
+      @command = hash["command"]
+      @directory = hash["directory"]
+      @timeout = hash["timeout"]
+      @start_time = hash["start_time"]
+      @elapsed = hash["elapsed"]
+      @output = hash["output"]
+      @error = hash["error"]
+      @exitstatus = hash["exitstatus"]
+      @user = hash["user"] if hash.include?("user")
+      @machine = hash["machine"] if hash.include?("machine")
+    end
+
+    def self.parse(json)
+      cmd = Command.new("")
+      cmd.from_hash(JSON.parse(json))
+      cmd
+    end
+
+    def self.parse_yaml_commands(yaml)
+      # commands=Array.new()
+      data = YAML.safe_load(yaml)
+      commands = get_script_commands(data)
+    end
+
+    def self.get_script_commands(hash)
+      commands = []
+      if hash.key?("script")
+        hash["script"].each do |cmd|
+          commands << cmd
         end
+      end
+      hash.each do |_k, v|
+        next unless v.is_a?(Hash)
 
-        def self.get_script_commands(hash)
-            commands=Array.new
-            if(hash.key?('script'))
-                hash['script'].each{|cmd|
-                    commands << cmd
-                }
-            end
-            hash.each{|k,v|
-                if(v.is_a?(Hash))
-                    subcommands=get_script_commands(v)
-                    subcommands.each{|c|
-                        commands << c
-                    }
-                end
-            }
-            commands
+        subcommands = get_script_commands(v)
+        subcommands.each do |c|
+          commands << c
         end
+      end
+      commands
     end
-end
+  end
+end