expectacle 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d1decbec1db35ee28a8b21210f8f61c42cff269
-  data.tar.gz: 33563494544b430040b0c1488280f48474a48062
+  metadata.gz: 70d0dd97af8fb79becf1a01a31b11fc81ddc3c64
+  data.tar.gz: 20bf4dd2c8fca9af93f07bbf90b011481169b88b
 SHA512:
-  metadata.gz: fc8348cd4cf0fecc78dc5b72ad45169d144d01d1a5c467236cf661e3492c0a2782579b4e97be562ea4fe4a8db7dabfef314c47d65a14556f5635f1c686ddd4b7
-  data.tar.gz: e870762f009586844c50b4ea06e5a7bed8179a94d06800542a602599d90b80bf6e1a4e9f3ad4966797f61b241459dbfc29ac58941f8aa52cffbe1e2a327aeb8d
+  metadata.gz: d2bb97f3b5bce0bcdf449b1ab9350cd403099e6d5e2de11356b05159ec872fcff2681142311e00830ceffb44b91ec59a396787f06728022cf3744fd906860e56
+  data.tar.gz: 94941d88e8c6ab26e3c940fd3af4ef5ecd112b710ebe117103f040f14d5476ccdd412520124d964a1aca1e2d7dbbda5c88ab88213b970875546ec5203140cf25

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

@@ -9,4 +9,10 @@ group :test do
   gem 'simplecov'
 end
 
+group :development do
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'github-markup'
+end
+
 gem 'rubocop'

data/README.md

@@ -55,6 +55,55 @@ Input: (type password)
   - it is a list of commands.
 - Each files are written by YAML.
 
+### Parameter expansion and preview
+Expectacle has parameter expansion feature using ERB.
+In a command list file,
+you can write command strings including environment variable and parameters defined in host file.
+See [Parameter definitions](#parameter-definitions) section about details of parameter expansion feature.
+
+Thereby, there are some risks sending danger commands by using wrong parameter and command definitions.
+
+Then, you can preview expanded command strings to send a host and parameters before execute actually.
+For Example:
+```
+stereocat@tftpserver:~/expectacle$ bundle exec run_command -p -h l2switch.yml -c cisco_save_config_tftp.yml
+---
+:spawn_cmd: ssh -o StrictHostKeyChecking=no -o KexAlgorithms=+diffie-hellman-group1-sha1
+  -l cisco 192.168.20.150
+:prompt:
+  :password: "^Password\\s*:"
+  :username: "^Username\\s*:"
+  :sub1: "\\][:\\?]"
+  :sub2: "\\[confirm\\]"
+  :yn: "\\[yes\\/no\\]:"
+  :command1: "^[\\w\\-]+>"
+  :command2: "^[\\w\\-]+(:?\\(config\\))?\\#"
+  :enable_password: SAME_AS_LOGIN_PASSWORD
+  :enable_command: enable
+:host:
+  :hostname: l2sw1
+  :type: c3750g
+  :ipaddr: 192.168.20.150
+  :protocol: ssh
+  :username: cisco
+  :password: ********
+  :enable: ********
+  :tftp_server: 192.168.20.170
+:commands:
+- copy run start
+- copy run tftp://192.168.20.170/l2sw1.confg
+---
+(snip)
+```
+**Notice** : Passwords were masked above example, but actually, raw password string are printed out.
+
+### Use Syslog
+
+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
+
 ## Parameter Definitions
 
 ### Expectacle::Thrower
@@ -147,7 +196,7 @@ Feature for sub-prompt (interactive command) is not enough.
 Now, Expectacle sends fixed command for sub-prompt.
 (These actions were defined for cisco to execute above "copy run" example...)
 - Yex/No (`:yn`) : always sends "yes"
-- Sub prompt (`:sub1` and `:sub2`) : Empty string (RETURN)
+- Sub prompt (`:sub1` and `:sub2`) : always sends Empty string (RETURN)
 
 ## Contributing
 

data/Rakefile

@@ -18,3 +18,15 @@ rescue LoadError
     $stderr.puts 'RuboCop is disabled'
   end
 end
+
+begin
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  YARD::Rake::YardocTask.new do |task|
+    task.files = FileList['./lib/**/*.rb']
+  end
+rescue LoadError
+  task :yard do
+    $stderr.puts 'YARD is disabled'
+  end
+end

data/exe/run_command

@@ -4,6 +4,7 @@
 require 'expectacle'
 require 'optparse'
 require 'yaml'
+require 'syslog/logger'
 
 option = {}
 opt = OptionParser.new
@@ -22,16 +23,24 @@ 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|
+  option[:syslog] = value
+end
 opt.parse!(ARGV)
 
-file_dir = File.dirname(File.expand_path(__FILE__))
 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)
 
+if option[:syslog]
+  thrower.logger = Syslog::Logger.new 'Expectacle'
+  thrower.setup_logger
+end
+
 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/thrower.rb

@@ -5,14 +5,20 @@ require 'expectacle/thrower_base'
 module Expectacle
   # Thrower logic(command list operation)
   class Thrower < ThrowerBase
+    # Run(exec) commands for all hosts.
+    # @param [Array<Hash>] hosts Host parameters (read from host list file).
+    # @param [Array<String>] commands Commands (read from command list file).
     def run_command_for_all_hosts(hosts, commands)
-      @commands = commands
       hosts.each do |each|
+        @commands = commands.dup # Notice: @commands will be decremented.
         @host_param = each
         run_command_for_host
       end
     end
 
+    # Preview all parameters for all hosts.
+    # @param [Array<Hash>] hosts Host parameters (read from host list file).
+    # @param [Array<String>] commands Commands (read from command list file).
     def preview_parameter(hosts, commands)
       @commands = commands
       hosts.each do |each|
@@ -33,7 +39,7 @@ module Expectacle
 
     def preview_command_for_host
       ready_to_open_host_session do |spawn_cmd|
-        preview_command spawn_cmd
+        print YAML.dump(whole_previewed_parameters(spawn_cmd))
       end
     end
 
@@ -44,29 +50,29 @@ module Expectacle
       end
     end
 
-    def preview_host_param
+    def previewed_host_param
       host_param = @host_param.dup
       enable_mode = @enable_mode
       @enable_mode = false
-      host_param[:username] = embed_user_name(binding)
-      host_param[:password] = embed_password(binding)
+      host_param[:username] = embed_user_name
+      host_param[:password] = embed_password
       @enable_mode = true
-      host_param[:enable] = embed_password(binding)
+      host_param[:enable] = embed_password
       @enable_mode = enable_mode
       host_param
     end
 
-    def preview_commands
-      @commands.map { |cmd| embed_command(cmd, binding) }
+    def previewed_commands
+      @commands.map { |cmd| embed_command(cmd) }
     end
 
-    def preview_command(spawn_cmd)
-      data = {}
-      data[:spawn_cmd] = spawn_cmd
-      data[:prompt] = @prompt
-      data[:host] = preview_host_param
-      data[:commands] = preview_commands
-      print YAML.dump(data)
+    def whole_previewed_parameters(spawn_cmd)
+      {
+        spawn_cmd: spawn_cmd,
+        prompt: @prompt,
+        host: previewed_host_param,
+        commands: previewed_commands
+      }
     end
 
     def exec_rest_commands
@@ -81,7 +87,7 @@ module Expectacle
       exec_rest_commands do
         # Notice: @commands changed
         command = @commands.shift
-        write_and_logging 'Send command: ', embed_command(command, binding)
+        write_and_logging 'Send command: ', embed_command(command)
       end
     end
 
@@ -114,9 +120,9 @@ module Expectacle
     def exec_each_prompt(prompt)
       case prompt
       when /#{@prompt[:password]}/, /#{@prompt[:enable_password]}/
-        write_and_logging 'Send password', embed_password(binding), true
+        write_and_logging 'Send password', embed_password, true
       when /#{@prompt[:username]}/
-        write_and_logging 'Send username: ', embed_user_name(binding)
+        write_and_logging 'Send username: ', embed_user_name
       when /#{@prompt[:command2]}/, /#{@prompt[:command1]}/
         exec_by_mode(prompt)
       when /#{@prompt[:yn]}/, /#{@prompt[:sub1]}/, /#{@prompt[:sub2]}/

data/lib/expectacle/thrower_base.rb

@@ -9,11 +9,23 @@ require 'logger'
 module Expectacle
   # Basic state setup/management
   class ThrowerBase
+    # @return [Logger] Logger instance.
     attr_accessor :logger
+    # @return [String] Base directory path to find params/hosts/commands file.
     attr_reader :base_dir
 
+    # Constructor
+    # @param timeout [Integer] Seconds to timeout. (default: 60sec)
+    # @param verbose [Boolean] Flag to enable verbose output.
+    #   (default: `true`)
+    # @param base_dir [String] Base directory to find files.
+    #   (default: `Dir.pwd`)
+    # @param logger [IO] IO Object to logging. (default `$stdout`)
+    # @return [Expectacle::ThrowerBase]
     def initialize(timeout: 60, verbose: true,
                    base_dir: Dir.pwd, logger: $stdout)
+      # default
+      @host_param = {}
       # remote connection timeout (sec)
       @timeout = timeout
       # cli mode flag
@@ -23,23 +35,44 @@ module Expectacle
       # base dir
       @base_dir = File.expand_path(base_dir)
       # logger
-      setup_default_logger(logger)
+      @logger = Logger.new(logger)
+      setup_default_logger
     end
 
+    # Path to prompt file directory.
+    # @return [String]
     def prompts_dir
       File.join @base_dir, 'prompts'
     end
 
+    # Path to host list file directory.
+    # @return [String]
     def hosts_dir
       File.join @base_dir, 'hosts'
     end
 
+    # Path to command list file directory.
+    # @return [String]
     def commands_dir
       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
+    end
+
     def ready_to_open_host_session
       # prompt regexp of device
       load_prompt_file
@@ -78,7 +111,7 @@ module Expectacle
       ['ssh',
        '-o StrictHostKeyChecking=no',
        '-o KexAlgorithms=+diffie-hellman-group1-sha1', # for old cisco device
-       "-l #{embed_user_name(binding)}",
+       "-l #{embed_user_name}",
        @host_param[:ipaddr]].join(' ')
     end
 
@@ -106,16 +139,6 @@ module Expectacle
       @prompt = load_yaml_file('prompt file', prompt_file)
     end
 
-    def setup_default_logger(logger_io)
-      @logger = Logger.new(logger_io)
-      @logger.level = Logger::INFO
-      @logger.progname = 'Expectacle'
-      @logger.datetime_format = '%Y-%m-%d %H:%M:%D %Z'
-      @logger.formatter = proc do |severity, datetime, progname, msg|
-        "#{datetime} #{progname} [#{severity}] #{msg}\n"
-      end
-    end
-
     def expect_regexp
       /
         ( #{@prompt[:password]} | #{@prompt[:enable_password]}
@@ -143,7 +166,7 @@ module Expectacle
       end
     end
 
-    def embed_password(binding)
+    def embed_password
       @host_param[:enable] = '_NOT_DEFINED_' unless @host_param.key?(:enable)
       base_str = @enable_mode ? @host_param[:enable] : @host_param[:password]
       check_embed_envvar(base_str)
@@ -151,12 +174,12 @@ module Expectacle
       passwd_erb.result(binding)
     end
 
-    def embed_command(command, binding)
+    def embed_command(command)
       command_erb = ERB.new(command)
       command_erb.result(binding)
     end
 
-    def embed_user_name(binding)
+    def embed_user_name
       check_embed_envvar(@host_param[:username])
       uname_erb = ERB.new(@host_param[:username])
       uname_erb.result(binding)

data/lib/expectacle/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expectacle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - stereocat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-28 00:00:00.000000000 Z
+date: 2016-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -37,6 +37,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md