expectacle 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2548d2071903bbd5b0f1c0ed3f0e46a928feb9d6
-  data.tar.gz: 0fd63708608402d9de553df1b36403dc9499cbb2
+  metadata.gz: '029ac71fb1381c439677ac4c36009c7056be529b'
+  data.tar.gz: 23298b873bd9b727806fe09e3dcd8b20d598b5e8
 SHA512:
-  metadata.gz: 00791cb556c54d6b6d27081f1a9887ccc80469e1d4bcfa7a24d0df55de2d29e51af56a1956e512849470ab6c32f97b174922ad049acd9156ada255dae682bd95
-  data.tar.gz: 4c9679ba35e87619793823285ebf4c3d11eea1419122c595bbd107062601992ec487eb9581e0e433231d65c5a5fde136c502b06ff1eaca37244a07e72200310e
+  metadata.gz: 11536ed5527986defcccf7b3017f4683ecde6a04c09271676403788a37226090c295d07576f3ed656f7e39a3965575b270dddf3d0a5b871ccd50e54120b70578
+  data.tar.gz: 4202028b4045286aa6a97521d8939adf8eb6c470178af86fc6b5b38908b8517bff1a3286846eb9fbb60b7f5bd19cfb426c88c5a598c07a204412c4d474acb01f

data/.gitignore

@@ -1,3 +1,5 @@
+*~
+\#*
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -99,13 +99,19 @@ stereocat@tftpserver:~/expectacle$ bundle exec run_command -p -h l2switch.yml -c
 ```
 **Notice** : Passwords were masked above example, but actually, raw password strings are printed out.
 
-### Use Syslog
+### Change place of log message
+
+With `-l`/`--logfile`, [run_command](./exe/run_command) changes logging IO to file instead of standard-out (default).
+
+    $ bundle exec run_command -r -l foo.log -h l2switch.yml -c cisco_show_arp.yml
 
 With `-s`/`--syslog`, [run_command](./exe/run_command) changes logging instance to `syslog/logger`.
 So, log messages are printed out to syslog on localhost.
 
     $ bundle exec run_command -rs -h l2switch.yml -c cisco_show_arp.yml
 
+**Notice** : When specified `--logfile` and `--syslog` at the same time, `--syslog` is used to logging.
+
 ### Quiet mode
 
 With `-q`/`--quiet`, [run_command](./exe/run_command) stop printing out results
@@ -205,6 +211,23 @@ For example, if you want to save configuration of a Cisco device to tftp server:
 - "copy run tftp://<%= @host_param[:tftp_server] %>/<%= @host_param[:hostname] %>.confg"
 ```
 
+## SSH Options
+
+When use `ssh` (OpenSSH) command to spawn device, the user can set options for the command via `#{base_dir}/ssh_opts.yml`.
+With options as list in [ssh_opts.yml](./vendor/ssh_opts.yml),
+```
+- '-o StrictHostKeyChecking=no'
+- '-o KexAlgorithms=+diffie-hellman-group1-sha1'
+- '-o Ciphers=+aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc'
+```
+it works same as `~/.ssh/config` below.
+```
+Host *
+    StrictHostKeyChecking no
+    KexAlgorithms +diffie-hellman-group1-sha1
+    Ciphers +aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc
+```
+
 ## TODO
 
 ### Sub prompt operation (interactive command)

data/exe/run_command

@@ -4,7 +4,6 @@
 require 'expectacle'
 require 'optparse'
 require 'yaml'
-require 'syslog/logger'
 
 option = {}
 opt = OptionParser.new
@@ -26,6 +25,9 @@ end
 opt.on('-s', '--syslog', 'Set syslog logger (localhost syslog)') do |value|
   option[:syslog] = value
 end
+opt.on('-l', '--logfile=FILE', 'Set file to save log message') do |value|
+  option[:logfile] = value
+end
 opt.on('-t', '--timeout=SEC', 'Set seconds to timeout') do |value|
   option[:timeout] = value
 end
@@ -40,6 +42,13 @@ opt.parse!(ARGV)
 # basic setting
 verbose = option.key?(:quiet) ? false : true
 timeout = option.key?(:timeout) ? option[:timeout] : 60
+logger = if option.key?(:syslog)
+           :syslog
+         elsif option.key?(:logfile)
+           option[:logfile]
+         else
+           $stdout
+         end
 base_dir = if option.key?(:base_dir)
              option[:base_dir]
            else
@@ -50,13 +59,9 @@ base_dir = if option.key?(: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
+                                  timeout: timeout,
+                                  logger: logger)
+# setup logging level
 thrower.logger.level = Logger::DEBUG if option.key?(:debug) && option[:debug]
 
 # run or preview

data/lib/expectacle/thrower_base.rb

@@ -5,6 +5,7 @@ require 'expect'
 require 'yaml'
 require 'erb'
 require 'logger'
+require 'syslog/logger'
 
 module Expectacle
   # Basic state setup/management
@@ -20,7 +21,8 @@ module Expectacle
     #   (default: `true`)
     # @param base_dir [String] Base directory to find files.
     #   (default: `Dir.pwd`)
-    # @param logger [IO] IO Object to logging. (default `$stdout`)
+    # @param logger [IO,String,Symbol] IO Object (default `$stdout`),
+    #   File name, or :syslog to logging.
     # @return [Expectacle::ThrowerBase]
     def initialize(timeout: 60, verbose: true,
                    base_dir: Dir.pwd, logger: $stdout)
@@ -35,8 +37,7 @@ module Expectacle
       # base dir
       @base_dir = File.expand_path(base_dir)
       # logger
-      @logger = Logger.new(logger)
-      setup_default_logger
+      setup_default_logger(logger)
     end
 
     # Path to prompt file directory.
@@ -57,20 +58,26 @@ module Expectacle
       File.join @base_dir, 'commands'
     end
 
-    # Setup common settings of logger instance.
-    def setup_logger
-      @logger.level = Logger::INFO
-      @logger.formatter = proc do |severity, datetime, progname, msg|
-        "#{datetime} #{progname} [#{severity}] #{msg}\n"
-      end
-    end
-
     private
 
-    def setup_default_logger
-      @logger.progname = 'Expectacle'
-      @logger.datetime_format = '%Y-%m-%d %H:%M:%D %Z'
-      setup_logger
+    def default_io_logger(logger_io, progname)
+      logger = Logger.new(logger_io)
+      logger.progname = progname
+      logger.datetime_format = '%Y-%m-%d %H:%M:%D %Z'
+      logger
+    end
+
+    def setup_default_logger(logger)
+      progname = 'Expectacle'
+      @logger = if logger == :syslog
+                  Syslog::Logger.new(progname)
+                else
+                  default_io_logger(logger, progname)
+                end
+      @logger.level = Logger::INFO
+      @logger.formatter = proc do |severity, datetime, pname, msg|
+        "#{datetime} #{pname} [#{severity}] #{msg}\n"
+      end
     end
 
     def ready_to_open_host_session
@@ -108,17 +115,14 @@ module Expectacle
     end
 
     def ssh_command
-      ['ssh',
-       '-o StrictHostKeyChecking=no',
-       '-o KexAlgorithms=+diffie-hellman-group1-sha1', # for old cisco device
-       "-l #{embed_user_name}",
-       @host_param[:ipaddr]].join(' ')
+      opts = load_ssh_opts_file
+      ['ssh', opts, "-l #{embed_user_name}", embed_ipaddr].join(' ')
     end
 
     def make_spawn_command
       case @host_param[:protocol]
       when /^telnet$/i
-        ['telnet', @host_param[:ipaddr]].join(' ')
+        ['telnet', embed_ipaddr].join(' ')
       when /^ssh$/i
         ssh_command
       else
@@ -139,6 +143,11 @@ module Expectacle
       @prompt = load_yaml_file('prompt file', prompt_file)
     end
 
+    def load_ssh_opts_file
+      ssh_opts_file = "#{@base_dir}/ssh_opts.yml"
+      @ssh_opts = load_yaml_file('ssh opts file', ssh_opts_file)
+    end
+
     def expect_regexp
       /
         ( #{@prompt[:password]} | #{@prompt[:enable_password]}
@@ -184,5 +193,11 @@ module Expectacle
       uname_erb = ERB.new(@host_param[:username])
       uname_erb.result(binding)
     end
+
+    def embed_ipaddr
+      check_embed_envvar(@host_param[:ipaddr])
+      ipaddr_erb = ERB.new(@host_param[:ipaddr])
+      ipaddr_erb.result(binding)
+    end
   end
 end

data/lib/expectacle/version.rb

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

data/vendor/ssh_opts.yml

@@ -0,0 +1,3 @@
+- '-o StrictHostKeyChecking=no'
+- '-o KexAlgorithms=+diffie-hellman-group1-sha1'
+- '-o Ciphers=+aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expectacle
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - stereocat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -61,6 +61,7 @@ files:
 - vendor/prompts/c3750g_prompt.yml
 - vendor/prompts/pica8_prompt.yml
 - vendor/prompts/ssg_prompt.yml
+- vendor/ssh_opts.yml
 homepage: https://github.com/stereocat/expectacle
 licenses:
 - MIT
@@ -81,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2.1
 signing_key: 
 specification_version: 4
 summary: Simple expect wrapper to send commands to a devices.