toolrack 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9695907a18e7af223dc46afdede9aadf6a63860cd85600eac575d1707f92122a
-  data.tar.gz: 33b7a5e328a97b336f75d74e87adfd11c9d2e4e4db65096db9657cbc8d438a3b
+  metadata.gz: 1376b2757fe58eb3b84626106d08631b990f5fcc3955101ea68d652a620be53f
+  data.tar.gz: 78aacec33c7f4e9d654c7d73c3a0c08ff5f90d94c0cabcfbe356558627cbd80c
 SHA512:
-  metadata.gz: ed2140ad2e0ddd44977b8375e02f4d81ce30e2c5c3c8ade312d0ebb24213373d38783a3f509994f23bb866977d74825e42f8ea585f78a1bd64afdb24d017294c
-  data.tar.gz: ec78c82697275f8ad85900892a017dfe0be6edbc5a19f761d382d53dcf372c9f3c68f7d7bb4678b7af02d25a77346f2ba082c6d099d002ac563c9173fb40d8d3
+  metadata.gz: 2728bd75dfd2ef4a93d4059756e97409248d0c0f54bb30a1edfd90178899fdac604c31769830c524000638834bc7da01e7708cca3248db68e929cf58a7bb7ee5
+  data.tar.gz: d7b825fed51fefeec270b998c5f6c4f3250d3a1df4579d51c89cef150f18d3428d6ebd39e9e837e8b44498c6bce884e8b82b8e2df9bda7fabcf954917c3b2d39

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

@@ -3,9 +3,12 @@ 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/process_utils'
 require_relative 'toolrack/runtime_utils'
 
 module Antrapol
@@ -13,32 +16,9 @@ module Antrapol
     class Error < StandardError; end
     # Your code goes here...
  
-    class GlobalConf
-      include Singleton
+  end
+end
 
-    end
+ToolRack = Antrapol::ToolRack
 
-    class Logger
-      include Singleton
-      include Antrapol::ToolRack::ConditionUtils
 
-      attr_reader :glogger
-      def initialize
-        # boolean
-        loggerDebug = ENV['TOOLRACK_DEBUG']
-        logFile = ENV['TOOLRACK_LOGFILE']
-        maxLogNo = ENV['TOOLRACK_MAX_LOGFILE'] || 10
-        logFileSize = ENV['TOOLRACK_MAX_LOGFILE_SIZE'] || 10*1024*1024
-        
-        if not is_empty?(loggerDebug) and loggerDebug
-          @glogger = Tlogger.new(STDOUT)
-        elsif not is_empty?(logFile)
-          @glogger = Tlogger.new(logFile,maxLogNo,logFileSize)
-        else
-          @glogger = Tlogger.new('toolrack.log',maxLogNo,logFileSize)
-        end
-      end
-    end
-  
-  end
-end

data/lib/toolrack/condition_utils.rb

@@ -5,10 +5,16 @@ module Antrapol
     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

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

@@ -1,21 +1,64 @@
 
-require 'pty'
+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)
+      def basic_exec(cmd, &block)
         Antrapol::ToolRack::Logger.instance.glogger.debug "Basic shell exec command : #{cmd}"
-        `#{cmd}`
+        res = `#{cmd}`
+        if block
+          block.call($?, res)
+        else
+          res
+        end
       end # basic_shell_exec
 
       # system
@@ -46,6 +89,11 @@ module Antrapol
         
         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

data/lib/toolrack/runtime_utils.rb

@@ -4,21 +4,26 @@ module Antrapol
   module ToolRack
     module RuntimeUtils
 
-      def detect_os
-        case RbConfig::CONFIG['host_os']
-        when /cygwin|mswin|mingw|bccwin|wince|emx/
-          :win
-        when /darwin|mac/
-          :mac
-        else
-          :linux
-        end
+      def RuntimeUtils.on_windows?
+        (RbConfig::CONFIG['host_os'] =~ /cygwin|mswin|mingw|bccwin|wince|emx/) != nil
       end
 
-      def detect_ruby
-        
+      def RuntimeUtils.on_mac?
+        (RbConfig::CONFIG['host_os'] =~ /darwin|mac/) != nil
       end
 
-    end
-  end
-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 ToolRack
-    VERSION = "0.3.0"
+    VERSION = "0.6.0"
   end
 end
 

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/toolrack.gemspec

@@ -27,4 +27,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "tlogger", "~> 0.21"
+
+  spec.add_development_dependency "devops_helper", "~> 0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: toolrack
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Chris
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-13 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tlogger
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !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
@@ -42,8 +56,10 @@ 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
@@ -55,7 +71,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/chrisliaw/toolrack
   source_code_uri: https://github.com/chrisliaw/toolrack
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -70,8 +86,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Collection of simple utilities but I find it increase clarity
 test_files: []