toolrack 0.1.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de65ce9c244ee6178fcd96d2e1073dbd9067c7a1f9906e89de614e8a58c329f
-  data.tar.gz: f9943c8203a7cc47c0ab05557ed3c8ad327336288b439d736fc15f7b78deee51
+  metadata.gz: 2b8060cf4deb99cad679a22d0e9d4fd85969e0f332361a3d1bd89c52fda8166f
+  data.tar.gz: 5af17bbfb37aa09f5df3c9c8f02f916357b281a262316a6d3a67a0c0ccc9c613
 SHA512:
-  metadata.gz: 03d12fe2c6e1da0c3581ab424a4145f88aad0f0afbca472f5f1c1e2257b93438fba2cfb6591a33eb730751977257adc74b01acd875ce4b54fa8ce46cb08297fe
-  data.tar.gz: 6d089a8429ce18c130fee89b5524a202f6860402b68d6111a1aca80240cf8ecaec38663af2f22a30c42784984c2995c54613d121ff11fcd5eaac27f45d593f82
+  metadata.gz: 7fb7969942992c8163decf1d8a98200b7b719f3c6e5c1eda86ad833047b15e185fe9793ecd2876dca56921f9c80760efa08e75ba99e73e8a4af478d9365834f7
+  data.tar.gz: e081ff9358e5e9dabe48f6b41106cb0308f538c20b08753275b90ed54088b0463fe641cf5613ce23858374e6b36c2430329f2477260dc2f69493f1592dd9ed06

data/.gitignore

@@ -6,3 +6,9 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
+*.log
+tags
+Gemfile.lock
+test.ssh
+test.ssh.pub

data/README.md

@@ -43,9 +43,10 @@ class EditController
 end
 ```
 
-Currently it has only 2 modules:
+Currently it has 3 modules:
 * Condition Utilities
   * is_empty?(obj) - I find rather effort intensive to call if not (obj.nil? or obj.empty?) for items that I want to check for validity before process. Hence this method shall test for .nil?. If the object also respond to :empty? it shall be called again. For example integer type does not support .empty?
+  * not_empty?(obj) - Reverse of the is\_empty?(obj) above
 
 * Exception Utilities
   * raise_if_empty(obj, message, error) - Extension from the is_empty?() above, usually if it is empty, an exception shall be raised. It is just combined the conditions with raise of exception. 
@@ -55,6 +56,12 @@ Currently it has only 2 modules:
   * raise_if_false(obj, message, error) - As the name implied
   * raise_if_true(obj, message, error) -  As the name implied
 
+* Process Utilities
+  * exec(command, options = { ), &block) - Passing in the command into the method and result is returned to caller. If options is not given shall go to basic execution which is the backtick (\`). If block empty, result of the command is returned to caller. If block is given, result (true or false of the execution of command and any result from STDOUT is call to block provider(e.g. block.call($?, result)
+
+# Note on Process Utilities
+
+The command is passed as it is to the operating system which includes fatal operation such as "rm -rf". Library at current stage made no filtering on system harmful command hence the caller of the library has to take extra precaution on what command is being passed into the library
 
  
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+require 'devops_helper'
+
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"

data/lib/toolrack.rb

@@ -1,11 +1,22 @@
 require "toolrack/version"
 
+require 'tlogger'
+require 'singleton'
+
+require 'fileutils'
+
+require_relative 'toolrack/global'
 require_relative 'toolrack/exception_utils'
 require_relative 'toolrack/condition_utils'
+require_relative 'toolrack/process_utils'
+require_relative 'toolrack/runtime_utils'
 
 module Antrapol
-  module MyToolRack
+  module ToolRack
     class Error < StandardError; end
     # Your code goes here...
+ 
   end
 end
+
+

data/lib/toolrack/condition_utils.rb

@@ -1,19 +1,29 @@
 
 
 module Antrapol
-  module MyToolRack
+  module ToolRack
     module ConditionUtils
 
       def is_empty?(obj)
-        if obj.nil?
+        if not defined?(obj)
+          true
+        elsif obj.nil?
           true
         elsif obj.respond_to?(:empty?)
-          obj.empty?
+          if obj.respond_to?(:strip)
+            obj.strip.empty?
+          else
+            obj.empty?
+          end
         else
           false
         end
       end # is_empty?
 
+      def not_empty?(obj)
+        !is_empty?(obj)
+      end # not empty
+
     end # ConditionUtils
   end # MyToolRack
 end # Antrapol

data/lib/toolrack/exception_utils.rb

@@ -1,41 +1,44 @@
 
-require_relative 'conditions_utils'
+require_relative 'condition_utils'
 
 module Antrapol
-  module MyToolRack
+  module ToolRack
     module ExceptionUtils
-      include Antrapol::MyToolRack::ConditionUtils
+      include Antrapol::ToolRack::ConditionUtils
 
       # raise_if_empty
       # Raise the given (or default if not given) exception if the val given is empty
       # val - variable/object that shall be tested for emptiness
       # message - message to be thrown if it is true
       # error - exception object to be thrown
-      def raise_if_empty(val, message, error = Antrapol::MyToolRack::Error)
+      def raise_if_empty(val, message, error = Antrapol::ToolRack::Error)
         raise_error(message,error) if is_empty?(val)
       end # raise_if_empty
+      alias_method :raise_if_empty?, :raise_if_empty
 
       # 
       # raise_if_false
       #
-      def raise_if_false(bool, message, error = Antrapol::MyToolRack::Error)
+      def raise_if_false(bool, message, error = Antrapol::ToolRack::Error)
         if not bool
           raise_error(message,error)
         end 
       end # raise_if_false
+      alias_method :raise_if_false?, :raise_if_false
 
       #
       # raise_if_true
       #
-      def raise_if_true(bool, message, error = Antrapol::MyToolRack::Error)
+      def raise_if_true(bool, message, error = Antrapol::ToolRack::Error)
         raise_if_false(!bool, message, error)
       end # raise_if_true
+      alias_method :raise_if_true?, :raise_if_true
 
       protected
-      def raise_error(message, error = Antrapol::MyToolRack::Error)
+      def raise_error(message, error = Antrapol::ToolRack::Error)
         if error.nil?
           if @default_exception.nil?
-            raise Antrapol::MyToolRack::Error, message
+            raise Antrapol::ToolRack::Error, message
           else
             raise @default_exception, message
           end
@@ -45,5 +48,5 @@ module Antrapol
       end # raise_error
       
     end # ExceptionUtils
-  end # MyToolRack
+  end # ToolRack
 end # Antrapol

data/lib/toolrack/global.rb

@@ -0,0 +1,35 @@
+
+require 'singleton'
+require_relative 'condition_utils'
+
+module Antrapol
+  module ToolRack
+ 
+    class Logger
+      include Singleton
+      include Antrapol::ToolRack::ConditionUtils
+
+      attr_reader :glogger
+      def initialize
+        # boolean
+        loggerDebug = ENV['TOOLRACK_DEBUG']
+        logFile = ENV['TOOLRACK_LOGFILE'] || File.join(Dir.home, 'antrapol_logs','toolrack.log')
+        maxLogNo = ENV['TOOLRACK_MAX_LOGFILE'] || 10
+        logFileSize = ENV['TOOLRACK_MAX_LOGFILE_SIZE'] || 10*1024*1024
+
+        logFileDir = File.dirname(logFile)
+        if not File.exist?(logFileDir)
+          FileUtils.mkdir_p(logFileDir)
+        end
+        
+        if not_empty?(loggerDebug) and (loggerDebug.downcase == 'true')
+          @glogger = Tlogger.new(STDOUT)
+        else
+          @glogger = Tlogger.new(logFile,maxLogNo,logFileSize)
+        end
+      end
+    end
+  
+  end
+end
+

data/lib/toolrack/process_utils.rb

@@ -0,0 +1,151 @@
+
+require_relative 'global'
+require_relative 'runtime_utils'
+
+if Antrapol::ToolRack::RuntimeUtils.on_windows?
+  # pty causing "function 'openpty' not found in msvcrt.dll" in some
+  # windows platform. Due to patches?
+  Antrapol::ToolRack::Logger.instance.glogger.debug "On Windows. Not going to load gem 'pty'"
+else
+  require 'pty'
+end
+require 'expect'
+require 'io/console'
+require 'tlogger'
+require 'open3'
+
+
+
+module Antrapol
+  module ToolRack
+    module ProcessUtils
+
+      def exec(cmd, opts = { }, &block)
+        type = opts[:exec_type]
+        if not type.nil?
+          instance(type, cmd, opts, &block)
+        else
+          instance(:basic, cmd, opts, &block)
+        end
+      end
+
+      def instance(type, cmd, opts = { }, &block)
+        case type
+        when :basic
+          Antrapol::ToolRack::Logger.instance.glogger.debug "Basic execution"
+          basic_exec(cmd, &block)
+        when :system
+          Antrapol::ToolRack::Logger.instance.glogger.debug "System execution"
+          system_exec(cmd, opts, &block)
+        when :popen3
+          Antrapol::ToolRack::Logger.instance.glogger.debug "Popen3 execution"
+          popen3_exec(cmd, opts, &block)
+        else
+          Antrapol::ToolRack::Logger.instance.glogger.debug "Basic (fallback) execution"
+          # basic
+          basic_exec(cmd, &block) 
+        end
+      end
+
+      private
+      # backtick
+      # backtick will only return at the end of the process.
+      # If in the event there is a prompt to user, this should nto be used.
+      def basic_exec(cmd, &block)
+        Antrapol::ToolRack::Logger.instance.glogger.debug "Basic shell exec command : #{cmd}"
+        res = `#{cmd}`
+        if block
+          block.call($?, res)
+        else
+          res
+        end
+      end # basic_shell_exec
+
+      # system
+      # System call link the stdout and stdin to the calling process and idea 
+      # to call mild interactive process
+      def system_exec(cmd, opts = { }, &block)
+        Antrapol::ToolRack::Logger.instance.glogger.debug "System exec command : #{cmd}"
+        system(cmd)
+        $.
+      end # system_exec
+
+      #def popen_exec(cmd, opts = { }, &block)
+      #  puts "Cmd : #{cmd}"
+      #  IO.popen(cmd, "r+") do |io|
+      #    puts io.gets
+      #    puts io.gets
+      #    puts io.gets
+      #  end
+      #end
+
+      def popen3_exec(cmd, opts = { }, &block)
+        Antrapol::ToolRack::Logger.instance.glogger.debug "Popen3 exec command : #{cmd}"
+  			stdout, stderr, status = Open3.capture3(cmd)
+        block.call(:popen_exec, { output: stdout, error: stderr, status: status })
+      end
+
+      def pty_exec(cmd, opts = { }, &block)
+        
+        Antrapol::ToolRack::Logger.instance.glogger.debug "PTY exec command : #{cmd}"
+
+        # pty seems error running on windows + jruby
+        if Antrapol::ToolRack::RuntimeUtils.on_windows?
+          raise Exception, "You're running on Windows. There have been report that error \"function 'openpty' not found in msvcrt.dll\". Probably due to patches. For now pty_exec() shall be halted"
+        end
+
+        logger = opts[:logger] || Tlogger.new(STDOUT)
+        expect = opts[:expect] || { }
+        bufSize = opts[:intBufSize] || 1024000
+
+        if bufSize != nil and bufSize.to_i > 0
+        else
+          bufSize = 1024000
+        end
+
+        logger.debug "Command : #{cmd}"
+        PTY.spawn(cmd[0], *(cmd[1..-1])) do |pout,pin,pid| #, 'env TERM=ansi') do |stdout, stdin, pid|
+
+          pin.sync = true
+
+          begin
+            loop do
+              dat = []
+              loop do
+                d = pout.sysread(bufSize)
+                dat << d
+                break if d.length < bufSize
+              end
+              #dat = dat.join("\r\n")
+
+              if block
+                block.call(:inspect, { data: dat, output: pout, input: pin })
+              end
+
+            end
+          rescue EOFError => ex
+            logger.error "EOF : #{ex}"
+            #clog "EOF reached. Waiting to kill process.", :debug, :os_cmd
+            Process.wait(pid)
+            #clog "Processed killed.", :debug, :os_cmd
+          rescue Exception => ex
+            logger.error ex.message
+            logger.error ex.backtrace.join("\n")
+            #clog ex.message, :error, :os_cmd
+            #clog ex.backtrace.join("\n"), :error, :os_cmd
+          end
+
+        end
+        # end PTY.spawn() method
+
+        $?.exitstatus
+
+      end # pty_exec
+
+    end # module ProcessUtils
+
+    class ProcessUtilsEngine
+      extend ProcessUtils
+    end
+  end # module ToolRack
+end # module Antrapol

data/lib/toolrack/runtime_utils.rb

@@ -0,0 +1,29 @@
+
+
+module Antrapol
+  module ToolRack
+    module RuntimeUtils
+
+      def RuntimeUtils.on_windows?
+        (RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/) != nil
+      end
+
+      def RuntimeUtils.on_mac?
+        (RbConfig::CONFIG['host_os'] =~ /darwin|mac/) != nil
+      end
+
+      def RuntimeUtils.on_linux?
+        (RbConfig::CONFIG['host_os'] =~ /linux/) != nil
+      end
+
+      def RuntimeUtils.on_ruby?
+        not on_jruby? 
+      end
+
+      def RuntimeUtils.on_jruby?
+        (RUBY_PLATFORM =~ /java/) != nil
+      end
+
+    end # RuntimeUtils
+  end # ToolRack
+end #Antrapol

data/lib/toolrack/utils.rb

@@ -0,0 +1,23 @@
+
+
+
+module Antrapol
+  module Utils
+
+    def set_session_exception(exp)
+      if not exp.nil?
+        @sExp = exp
+      end
+    end
+
+    def session_exception
+      if not @sExp.nil?
+        @sExcp
+      else
+        Antrapol::ToolRack::Error
+      end
+    end
+    alias_method :session_exception, :s_exp
+
+  end
+end

data/lib/toolrack/version.rb

@@ -1,6 +1,6 @@
 module Antrapol
-  module MyToolRack
-    VERSION = "0.1.0"
+  module ToolRack
+    VERSION = "0.5.3"
   end
 end
 

data/process_test/backtick_test.rb

@@ -0,0 +1,2 @@
+
+`ssh-keygen -t ed25519 -a 188 -o -f test.ssh -C chrisliaw@antrapol.com`

data/process_test/pty_test.rb

@@ -0,0 +1,74 @@
+
+
+
+require 'pty'
+require 'expect'
+
+#m, s = PTY.open
+#r, w = IO.pipe
+#
+#pid = spawn("/usr/bin/openvpn --config /home/chris/.openvpn_cli/sg2-ovpn-tcp.ovpn", in: r, out: s)
+#r.close
+#s.close
+#
+#
+#ret = begin
+#        p m.gets
+#      rescue Errno::EIO
+#        nil
+#      end
+#
+
+
+##PTY.spawn("/usr/bin/sudo /usr/bin/openvpn --config /home/chris/.openvpn_cli/sg2-ovpn-tcp.ovpn") do |read, write, pid|
+#PTY.spawn("/usr/bin/openvpn --config /home/chris/.openvpn_cli/sg2-ovpn-tcp.ovpn") do |read, write, pid|
+#  #read.expect(/\[sudo\] password for chris:/) { |m|
+#  #  p m
+#  #  puts "expect"
+#  #  write.printf("chr1st0pher1120\n")
+#  #}
+#  #read.expect(/Username:/) { |msg| 
+#  #  puts "-- #{msg}"
+#  #  write.printf("purevpn0s2643230\r\n") 
+#  #}
+#
+#  #read.expect(/no echo\)/) { |msg|
+#  #  puts "++ #{msg}"
+#  #  write.printf("\t@ntr@p0l.c0m\r\n")
+#  #}
+#
+#  loop do
+#    read.expect(/\n/) { |l| 
+#      p l
+#      @ln = l 
+#    }
+#    break if @ln.nil?
+#  end
+#end
+
+read, write, pid = PTY.spawn("/usr/bin/openvpn --config /home/chris/.openvpn_cli/sg2-ovpn-tcp.ovpn")
+
+puts "PID : #{pid}"
+
+trap "SIGINT" do
+  read.close
+  write.close
+  begin
+    puts "Killing process"
+    Process.kill("HUP",pid)
+    puts "Kill done. Start waiting"
+    Process.wait(pid)
+    STDERR.puts "Cleanup Done!"
+  rescue PTY::ChildExited
+  end
+end
+
+loop do
+  read.expect(/\n/) do |l|
+    puts l
+    @ln = l
+  end
+  break if @ln.nil?
+end
+
+

data/process_test/shell_test.rb

@@ -0,0 +1,14 @@
+
+
+require 'shell'
+
+Shell.def_system_command(:sshKeygen,'/usr/bin/ssh-keygen')
+s = Shell.new
+
+th = Thread.new($stdout) do |out|
+  
+  p sshKeygen("-t","ed25519","-a","188","-o","-f","test.ssh","-C","chrisliaw@antrapol.com")
+
+end
+
+

data/process_test/system_test.rb

@@ -0,0 +1,3 @@
+
+
+system("ssh-keygen -t ed25519 -a 188 -o -f test.ssh -C chrisliaw@antrapol.com")

data/toolrack.gemspec

@@ -2,19 +2,19 @@ require_relative 'lib/toolrack/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "toolrack"
-  spec.version       = Antrapol::MyToolRack::VERSION
+  spec.version       = Antrapol::ToolRack::VERSION
   spec.authors       = ["Chris"]
   spec.email         = ["chrisliaw@antrapol.com"]
 
   spec.summary       = %q{Collection of simple utilities but I find it increase clarity}
   spec.description   = %q{Just collections of utilities}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/chrisliaw/toolrack"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
   #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  #spec.metadata["homepage_uri"] = spec.homepage
-  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chrisliaw/toolrack"
   #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
@@ -25,4 +25,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_dependency "tlogger", "~> 0.21"
+
+  spec.add_development_dependency "devops_helper", "~> 0.1.0"
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: toolrack
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Chris
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-13 00:00:00.000000000 Z
-dependencies: []
+date: 2021-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tlogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: devops_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Just collections of utilities
 email:
 - chrisliaw@antrapol.com
@@ -28,12 +56,22 @@ files:
 - lib/toolrack.rb
 - lib/toolrack/condition_utils.rb
 - lib/toolrack/exception_utils.rb
+- lib/toolrack/global.rb
+- lib/toolrack/process_utils.rb
+- lib/toolrack/runtime_utils.rb
+- lib/toolrack/utils.rb
 - lib/toolrack/version.rb
+- process_test/backtick_test.rb
+- process_test/pty_test.rb
+- process_test/shell_test.rb
+- process_test/system_test.rb
 - toolrack.gemspec
-homepage: ''
+homepage: https://github.com/chrisliaw/toolrack
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/chrisliaw/toolrack
+  source_code_uri: https://github.com/chrisliaw/toolrack
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Collection of simple utilities but I find it increase clarity
 test_files: []