expectacle 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70d0dd97af8fb79becf1a01a31b11fc81ddc3c64
-  data.tar.gz: 20bf4dd2c8fca9af93f07bbf90b011481169b88b
+  metadata.gz: 2548d2071903bbd5b0f1c0ed3f0e46a928feb9d6
+  data.tar.gz: 0fd63708608402d9de553df1b36403dc9499cbb2
 SHA512:
-  metadata.gz: d2bb97f3b5bce0bcdf449b1ab9350cd403099e6d5e2de11356b05159ec872fcff2681142311e00830ceffb44b91ec59a396787f06728022cf3744fd906860e56
-  data.tar.gz: 94941d88e8c6ab26e3c940fd3af4ef5ecd112b710ebe117103f040f14d5476ccdd412520124d964a1aca1e2d7dbbda5c88ab88213b970875546ec5203140cf25
+  metadata.gz: 00791cb556c54d6b6d27081f1a9887ccc80469e1d4bcfa7a24d0df55de2d29e51af56a1956e512849470ab6c32f97b174922ad049acd9156ada255dae682bd95
+  data.tar.gz: 4c9679ba35e87619793823285ebf4c3d11eea1419122c595bbd107062601992ec487eb9581e0e433231d65c5a5fde136c502b06ff1eaca37244a07e72200310e

data/README.md

@@ -1,4 +1,5 @@
 # Expectacle
+[![Gem Version](https://badge.fury.io/rb/expectacle.svg)](https://badge.fury.io/rb/expectacle)
 
 Expectacle ("expect + spectacle") is a small wrapper of `pty`/`expect`.
 It can send commands (command-list) to hosts (including network devices etc)
@@ -26,32 +27,33 @@ Or install it yourself as:
 
 ## Usage
 
-### Utility Script
-See `bin/run_command` and `vendor` directory.
+### Send commands to hosts
+See [exe/run_command](./exe/run_command) and [vendor directory](./vendor).
 
-`run_command` can send commands to hosts.
+`run_command` can send commands to hosts with `-r`/`--run` option.
 
-    $ bundle exec ./bin/run_command l2switch.yml cisco_show_arp.yml
+    $ bundle exec run_command -r -h l2switch.yml -c cisco_show_arp.yml
 
-- `l2switch.yml` is host-list file.
+- See details of command line options with `--help` option.
+- [l2switch.yml](./vendor/hosts/l2switch.yml) is host-list file.
   It is a data definitions for each hosts to send commands.
   - At username and password (login/enable) parameter,
     you can write environment variables with ERB manner to avoid write raw login information.
-  - `bin/readne` is a small utility shell-script to set environment variable from CLI.
+  - [exe/readne](./exe/readne) is a small bash script to set environment variable in your shell.
 
 ```
-$ export L2SW_USER=`./bin/readne`
+$ export L2SW_USER=`./exe/readne`
 Input: (type username)
-$ export L2SW_PASS=`./bin/readne`
+$ export L2SW_PASS=`./exe/readne`
 Input: (type password)
 ```
 
 - `Expectacle::Thrower` read prompt-file by "type" parameter in host-list file.
   - In prompt-file, prompt regexps that used for interactive operation to host
     are defined. (These regexp are common information for some host-groups. (vendor, OS, ...))
-  - Prompt-file is searched by filename: `#{type}_prompt.yml`,
+  - Prompt-file is searched by filename: `#{type}_prompt.yml` from [prompts directory](./vendor/prompts).
     `type` parameter defined in host-list file.
-- `cisco_show_arp.yml` is command-list file.
+- [cisco_show_arp.yml](./vendor/commands/cisco_show_arp.yml) is command-list file.
   - it is a list of commands.
 - Each files are written by YAML.
 
@@ -95,7 +97,7 @@ stereocat@tftpserver:~/expectacle$ bundle exec run_command -p -h l2switch.yml -c
 ---
 (snip)
 ```
-**Notice** : Passwords were masked above example, but actually, raw password string are printed out.
+**Notice** : Passwords were masked above example, but actually, raw password strings are printed out.
 
 ### Use Syslog
 
@@ -104,6 +106,19 @@ So, log messages are printed out to syslog on localhost.
 
     $ bundle exec run_command -rs -h l2switch.yml -c cisco_show_arp.yml
 
+### Quiet mode
+
+With `-q`/`--quiet`, [run_command](./exe/run_command) stop printing out results
+received from a host to standard out. For example:
+
+    $ bundle exec run_command -rq -h l2switch.yml -c cisco_show_arp.yml
+
+the command prints only log message (without host output) to standard out.
+If you use options syslog(`-s`) and quiet(`-q`),
+there is nothing to be appeared in terminal (standard out).
+
+    $ bundle exec run_command -rqs -h l2switch.yml -c cisco_show_arp.yml
+
 ## Parameter Definitions
 
 ### Expectacle::Thrower
@@ -139,7 +154,7 @@ Host-list file is a list of host-parameters.
 It can use ERB to set values from environment variable in `:username`, `:password` and `:enable`.
 
 You can add other parameter(s) to refer in command-list files.
-See also: "Command list" section.
+See also: [Command list](#command-list-with-erb) section.
 
 ### Prompt parameter
 Prompt file is a table of prompt regexp of host group(type).
@@ -159,30 +174,31 @@ Command-list is a simple list of command-string.
 A command-string can contain host-parameter reference by ERB.
 
 For example, if you want to save configuration of a Cisco device to tftp server:
-- Add a parameter to tftp server info (IP address) in host-list file. (`vendor/hosts/l2switch.yml`)
+- Add a parameter to tftp server info (IP address) in [host-list file](vendor/hosts/l2switch.yml).
 ```YAML
 - :hostname : 'l2sw1'
   :type : 'c3750g'
-  :ipaddr : '192.168.0.1'
+  :ipaddr : '192.168.20.150'
   :protocol : 'ssh'
   :username : "<%= ENV['L2SW_USER'] %>"
   :password : "<%= ENV['L2SW_PASS'] %>"
   :enable : "<%= ENV['L2SW_PASS'] %>"
-  :tftp_server: '192.168.2.16'
+  :tftp_server: '192.168.20.170'
 - :hostname : 'l2sw2'
   :type : 'c3750g'
-  :ipaddr : '192.168.0.2'
+  :ipaddr : '192.168.20.151'
   :protocol : 'ssh'
   :username : "<%= ENV['L2SW_USER'] %>"
   :password : "<%= ENV['L2SW_PASS'] %>"
   :enable : "<%= ENV['L2SW_PASS'] %>"
-  :tftp_server: '192.168.2.16'
+  :tftp_server: '192.168.20.170'
 ```
 
-- Write command-list file using ERB.
+- Write [command-list file](vendor/commands/cisco_save_config_tftp.yml) using ERB.
   When send a command to host, ERB string was evaluated in `Expectacle::Thrower` bindings.
-  Then, it can refer host-parameter as `@host_param` hash. (`vendor/commands/cisco_save_config_tftp.yml`)
-  -  When exec below command-list, host configuration will be saved a file as `l2sw1.confg` on tftp server.
+  Then, it can refer host-parameter as `@host_param` hash.
+  - When exec below command-list, host configuration will be saved a file as `l2sw1.confg` on tftp server.
+  - See also: [parameter preview](#parameter-expansion-and-preview) section.
 
 ```YAML
 - "copy run start"
@@ -198,6 +214,11 @@ Now, Expectacle sends fixed command for sub-prompt.
 - Yex/No (`:yn`) : always sends "yes"
 - Sub prompt (`:sub1` and `:sub2`) : always sends Empty string (RETURN)
 
+### Error handling
+Expectacle does not have error message handling feature.
+If a host returns a error message when expectacle sent a command,
+then expectacle ignores it and continue sending rest commands (until command list is empty).
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/stereocat/expectacle>.

data/exe/run_command

@@ -8,13 +8,13 @@ require 'syslog/logger'
 
 option = {}
 opt = OptionParser.new
-opt.on('-h', '--hosts=FILE', 'Host list file') do |value|
+opt.on('-h', '--hosts=FILE', 'Set host-list file') do |value|
   option[:hosts] = value
 end
-opt.on('-c', '--commands=FILE', 'Command list file') do |value|
+opt.on('-c', '--commands=FILE', 'Set command-list file') do |value|
   option[:commands] = value
 end
-opt.on('-b', '--base-dir=DIR', 'Base directory path') do |value|
+opt.on('-b', '--base-dir=DIR', 'Set base directory path') do |value|
   option[:base_dir] = value
 end
 opt.on('-p', '--preview', 'Preview parameter') do |value|
@@ -23,24 +23,43 @@ end
 opt.on('-r', '--run', 'Run(exec) commands to each hosts') do |value|
   option[:run] = value
 end
-opt.on('-s', '--syslog', 'Use syslog logger (use localhost syslog)') do |value|
+opt.on('-s', '--syslog', 'Set syslog logger (localhost syslog)') do |value|
   option[:syslog] = value
 end
+opt.on('-t', '--timeout=SEC', 'Set seconds to timeout') do |value|
+  option[:timeout] = value
+end
+opt.on('-q', '--quiet', 'Stop printing results to standard out') do |value|
+  option[:quiet] = value
+end
+opt.on('-d', '--debug', 'Set logging level to DEBUG') do |value|
+  option[:debug] = value
+end
 opt.parse!(ARGV)
 
+# basic setting
+verbose = option.key?(:quiet) ? false : true
+timeout = option.key?(:timeout) ? option[:timeout] : 60
 base_dir = if option.key?(:base_dir)
              option[:base_dir]
            else
              file_dir = File.dirname(File.expand_path(__FILE__))
              File.expand_path('../vendor', file_dir)
            end
-thrower = Expectacle::Thrower.new(base_dir: base_dir)
 
+# create thrower
+thrower = Expectacle::Thrower.new(base_dir: base_dir,
+                                  verbose: verbose,
+                                  timeout: timeout)
+
+# setup logger options
 if option[:syslog]
   thrower.logger = Syslog::Logger.new 'Expectacle'
   thrower.setup_logger
 end
+thrower.logger.level = Logger::DEBUG if option.key?(:debug) && option[:debug]
 
+# run or preview
 hosts = YAML.load_file(File.join(thrower.hosts_dir, option[:hosts]))
 commands = YAML.load_file(File.join(thrower.commands_dir, option[:commands]))
 if option[:preview]

data/lib/expectacle/version.rb

@@ -1,4 +1,4 @@
 module Expectacle
   # Gem version
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.3'.freeze
 end

data/vendor/commands/cisco_show_arp.yml

@@ -1,4 +1,2 @@
 - 'show ip arp'
 - 'show mac address-table dynamic'
-
-

data/vendor/commands/ssg_get_arp.yml

@@ -1,4 +1,2 @@
 - 'get arp'
 - 'get mac-learn'
-
-

data/vendor/hosts/fw.yml

@@ -12,4 +12,3 @@
   :username : "<%= ENV['FW_USER'] %>"
   :password : "<%= ENV['FW_PASS'] %>"
   :tftp_server : '192.168.20.170'
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expectacle
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - stereocat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-30 00:00:00.000000000 Z
+date: 2016-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake