CmdShellMgr 0.1.0 → 0.1.1.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03d4beae9d674c2f4a07c93a0b9f4f6b9e1b8003
-  data.tar.gz: c8955d835377718c027cf0d2df704390b0e2745c
+  metadata.gz: 06827d8b27d4b42c6c7f3ba6c2e80c8fc19f97f7
+  data.tar.gz: 2b9c414164c1844591aaa04e32caa06020d1782a
 SHA512:
-  metadata.gz: 7e312ed2a190d226f6edf9a4281de0c5fc7ca83bd2ddd1c458a147d45d8a2e936c349d0f0805c1593796508fa07087290caf91e59d48e6b74177d04b01cfc128
-  data.tar.gz: ab3d365c21060e292bfe1d23c25bc2f1bfe98cd5fdad26e3320269fceefb99a183f2e713447b22becbced0c2efe21004f7bdd3650d13fec93127b9ae1fbc7ecc
+  metadata.gz: 9bac7be8a9c16f967e4164a074958a08b4016dfd36ea81d6d34b69a7c8138ccba05349b793089d45f09a68c9f4bcb8c57dedf4d03da883a9c3f3bda478ff208e
+  data.tar.gz: c54d3a48252ccd8f4651f620e4114496c7683e59d8cba15ef1c6d65dd4464c21ea5de2e8ffd7a270a81958313321321ab5daa2a930101fe962efd7eb6f54f24a

data/README.md

@@ -1,13 +1,15 @@
 # CmdShellMgr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/CmdShellMgr`. To experiment with that code, run `bin/console` for an interactive prompt.
+CmdShellMgr provides a DSL, domain specific language, container to manage
+commands.  Commands are managed by defining, executing, and accessing
+their results from a preferred framework, test script, or utility.
 
-TODO: Delete this and the text above, and describe your gem
+## Use Case
+Test automation frameworks, with CmdShellMgr, can easily be extended to
+execute external commands and manage those results.  
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
 gem 'CmdShellMgr'
 ```
@@ -22,7 +24,44 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
+
+## Examples (ScoutUI YAML)
+
+page:
+  name: Run ls 
+  action: loadcommand
+  command: 
+     - echo "Hello World"
+     - java -jar Tools.jar <.......>
+  id: DO Linux ls
+---
+page:
+  name: run ls
+  action: execute(DO Linux ls)
+---
+page:
+  name: Run a BASH Script
+  action: loadcommand
+  command: /tmp/abc.sh
+  id: CREATE_Foo
+  
+---
+  
+page:
+  name: do something
+  action: execute(CREATE_Foo)
+  parms:
+    - abc
+    - 123
+    - EFG
+    - ${userid}
+    
+---
+page:
+  name: blah
+  action: type(#username, getResult(CREATE_Foo))
+---
 
 ## Development
 

data/lib/CmdShellMgr/Command/command.rb

@@ -0,0 +1,51 @@
+
+
+module CmdShellMgr
+
+
+  class Command
+
+    attr_accessor :debug
+    attr_accessor :cmd
+    attr_accessor :results
+    attr_accessor :exitStatus
+
+    def initialize(_c=nil)
+      @debug=true
+      @exitStatus=nil
+      @results=nil
+      @cmd=_c
+    end
+
+
+    def execute(opts=nil)
+      @results=nil
+
+#      if @cmd.match(/.*\.(sh|ksh|csh)\s*$/i)
+#        puts " execute script  #{@cmd} #{opts.to_s}" if @debug
+#        @results = %x[ #{@cmd} #{opts.to_s} ]
+#      else
+        @results = %x[ #{@cmd} #{opts.to_s} ]
+#      end
+      @exitStatus = $?.exitstatus
+
+      if @debug
+        puts __FILE__ + (__LINE__).to_s + " results => #{@results}"
+        puts __FILE__ + (__LINE__).to_s + " exist   => #{@exitStatus}"
+      end
+
+      @exitStatus
+    end
+
+    def exitStatus
+      @exitStatus
+    end
+
+    def results
+      @results
+    end
+
+  end
+
+
+end

data/lib/CmdShellMgr/Command/commands.rb

@@ -0,0 +1,102 @@
+
+
+
+module CmdShellMgr
+
+
+  class Commands
+
+    attr_reader :debug
+    attr_accessor :queue
+
+
+    def initialize()
+      @debug=false
+      @queue=[]
+    end
+
+    def count
+      length
+    end
+    def size
+      length
+    end
+    def length
+      @queue.length
+    end
+
+    def add(_id, _cmd)
+
+      if _cmd.is_a?(String)
+        @queue << { :id => _id, :cmd => CmdShellMgr::Command.new(_cmd) }
+      else
+        @queue << { :id => _id, :cmd => _cmd }
+      end
+
+      @queue.last()
+    end
+
+    def _execute(cmd)
+      rc=0
+      if cmd.is_a?(Hash) && cmd.has_key?(:cmd) && cmd.has_key?(:id)
+        rc += cmd[:cmd].execute().to_i
+      end
+
+      rc
+    end
+
+
+
+    def execute(id=nil)
+
+      exitStatus=0
+      rc=nil
+
+      if id.nil?
+        @queue.each do |_cmd|
+
+          puts __FILE__ + (__LINE__).to_s + " execute command #{_cmd[:id]}" if @debug
+          rc=_cmd[:cmd].execute()
+        end
+      else
+        hits = @queue.select { |cmd| cmd[:id]==id }
+        hits.each do |h|
+          puts __FILE__ + (__LINE__).to_s + " #{h}" if @debug
+          _execute(h)
+        end
+      end
+
+      rc
+    end
+
+    def exitStatus(_id)
+      puts __FILE__ + (__LINE__).to_s + " results(#{_id})" if @debug
+      rc=""
+      hits = @queue.select { |cmd| cmd[:id]==_id }
+      hits.each do |h|
+
+        puts __FILE__ + (__LINE__).to_s + " results : #{h[:cmd].exitStatus}" if @debug
+        rc << h[:cmd].exitStatus.to_s
+      end
+
+      rc
+    end
+
+    def results(_id)
+      puts __FILE__ + (__LINE__).to_s + " results(#{_id})" if @debug
+      rc=""
+      hits = @queue.select { |cmd| cmd[:id]==_id }
+      hits.each do |h|
+
+        puts __FILE__ + (__LINE__).to_s + " results : #{h[:cmd].results}" if @debug
+        rc << h[:cmd].results.to_s
+      end
+
+      rc
+    end
+
+  end
+
+
+end
+

data/lib/CmdShellMgr/DSL/dsl.rb

@@ -0,0 +1,143 @@
+require 'singleton'
+
+module CmdShellMgr
+
+
+  class DSL
+    include Singleton
+
+    DSL_LIST=[
+      { id: 'add', regex: Regexp.new(/^\s*(add|command)\s*\(\s*(?<id>.*)?,\s*(?<cmd>.*)\s*\)\s*$/i)},
+      { id: 'execute', regex: Regexp.new(/^\s*execute\s*\(\s*(?<id>.*)?\)\s*$/i) },
+      { id: 'getResult', regex: Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*$/i) },
+      { id: 'matches', regex: Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.matches\s*\(\s*\/(?<regex>.*)?\/\s*\)$/i) },
+      { id: 'capture', regex: Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.capture\s*\(\s*\/(?<regex>.*)?\/\s*\)$/i) },
+      { id: 'status', regex: Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.exitStatus\s*$/i) }
+    ]
+
+    attr_accessor :queue
+    attr_accessor :debug
+
+    def validCmd?(_cmd)
+      DSL_LIST.each do |c|
+        _r = c[:regex]
+        if _cmd.match(_r)
+          return c
+        end
+      end
+
+      nil
+    end
+
+    def initialize()
+      @debug=false
+      @queue = CmdShellMgr::Commands.new()
+    end
+
+    def count
+      @queue.length
+    end
+
+    def cmd(opts)
+
+      rc=nil
+      cmdObj=nil
+      _cmd=nil
+
+
+      if opts.has_key?(:cmd)
+        _cmd=opts[:cmd]
+      else
+        return false
+      end
+
+      puts "CMD => #{_cmd}" if @debug
+
+      begin
+        cmdReg     = Regexp.new(/^\s*(add|command)\s*\(\s*(?<id>.*)?,\s*(?<cmd>.*)\s*\)\s*$/i)
+        executeIdReg = Regexp.new(/^\s*execute\s*\(\s*(?<id>.*)?\)\s*$/i)
+        getResultsReg = Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*$/i)
+        getResultsMatchesReg = Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.matches\s*\(\s*\/(?<regex>.*)?\/\s*\)$/i)
+        getResultsCaptureReg = Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.capture\s*\(\s*\/(?<regex>.*)?\/\s*\)$/i)
+        getResultsStatusReg  = Regexp.new(/^\s*getResult[s]*\s*\(\s*(?<id>.*)?\)\s*\.exitStatus\s*$/i)
+
+        cmdObj = _cmd.match(cmdReg)
+
+        if cmdObj
+
+          puts __FILE__ + (__LINE__).to_s + " cmdObj => #{cmdObj.class}"  if @debug  # MatchData
+
+          cmd = CmdShellMgr::Command.new(cmdObj[:cmd]);
+          puts __FILE__ + (__LINE__).to_s + " cmd ==> #{cmd}" if @debug
+
+          rc=@queue.add(cmdObj[:id], cmd)
+
+        elsif _cmd.match(executeIdReg)
+
+          cmdObj = _cmd.match(executeIdReg)
+          puts __FILE__ + (__LINE__).to_s + " exe => #{cmdObj[:id]}" if @debug
+
+          rc=@queue.execute(cmdObj[:id])
+
+          puts __FILE__ + (__LINE__).to_s + " executeResults => #{rc}"
+
+        elsif _cmd.match(getResultsStatusReg)
+          cmdObj=_cmd.match(getResultsStatusReg)
+          rc = @queue.exitStatus(cmdObj[:id])
+          puts __FILE__ + (__LINE__).to_s + " exitStatus(#{_cmd}) : #{rc}"  if @debug
+
+
+        elsif _cmd.match(getResultsMatchesReg)
+          cmdObj = _cmd.match(getResultsMatchesReg)
+          _result = @queue.results(cmdObj[:id])
+          regex = cmdObj[:regex]
+
+          rc=false
+
+          if _result.is_a?(String)
+            m=_result.match(/#{regex.to_s}/m)
+            rc = m.is_a?(MatchData) && m.size > 0
+          end
+
+
+        elsif _cmd.match(getResultsCaptureReg)
+          cmdObj = _cmd.match(getResultsCaptureReg)
+          _result=@queue.results(cmdObj[:id])
+          regex = cmdObj[:regex]
+          puts __FILE__ + (__LINE__).to_s + "RESULTS.Capture => #{_result.class} with #{regex}" if @debug
+
+          m=nil
+          if _result.is_a?(String)
+            m = _result.match(/#{regex.to_s}/m)
+
+            puts __FILE__ + (__LINE__).to_s + " m => #{m.class}" if @debug
+
+            if m.is_a?(MatchData) && m.size > 0
+              puts __FILE__ + (__LINE__).to_s + " ====> #{m[1]}"  if @debug
+              rc=m[1]
+            end
+
+          end
+
+        elsif _cmd.match(getResultsReg)
+
+          cmdObj=_cmd.match(getResultsReg)
+          rc=@queue.results(cmdObj[:id])
+          puts __FILE__ + (__LINE__).to_s + "RESULTS => #{rc}" if @debug
+
+        else
+          puts __FILE__ + (__LINE__).to_s + " Unknown command: #{_cmd}"
+        end
+
+      rescue RegexpError => ex
+        puts __FILE__ + (__LINE__).to_s + "  #{ex.class} : #{_cmd}"
+      end
+
+      rc
+    end
+
+
+  end
+
+
+end

data/lib/CmdShellMgr/version.rb

@@ -1,3 +1,3 @@
 module CmdShellMgr
-  VERSION = "0.1.0"
+  VERSION = "0.1.1.0.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: CmdShellMgr
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1.0.pre
 platform: ruby
 authors:
 - Kim, Peter
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,9 @@ files:
 - bin/console
 - bin/setup
 - lib/CmdShellMgr.rb
+- lib/CmdShellMgr/Command/command.rb
+- lib/CmdShellMgr/Command/commands.rb
+- lib/CmdShellMgr/DSL/dsl.rb
 - lib/CmdShellMgr/version.rb
 homepage: https://github.com/h20draoon
 licenses:
@@ -89,9 +92,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.2