expectacle 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '029ac71fb1381c439677ac4c36009c7056be529b'
-  data.tar.gz: 23298b873bd9b727806fe09e3dcd8b20d598b5e8
+  metadata.gz: a27f91b34aba3a57cd043c6114aab2f7156ab77b
+  data.tar.gz: 8b10c0d7612d062d73a60bd1cfb5831f1d47cf7f
 SHA512:
-  metadata.gz: 11536ed5527986defcccf7b3017f4683ecde6a04c09271676403788a37226090c295d07576f3ed656f7e39a3965575b270dddf3d0a5b871ccd50e54120b70578
-  data.tar.gz: 4202028b4045286aa6a97521d8939adf8eb6c470178af86fc6b5b38908b8517bff1a3286846eb9fbb60b7f5bd19cfb426c88c5a598c07a204412c4d474acb01f
+  metadata.gz: e50f612f54dd268b7c1a029f9ee154ed93ac00e309ad837b958f9ab3443b526704cbbd8eac15cd5cc4d94db978a7cf6520f1349b7e1d7178877fcfb742029ff4
+  data.tar.gz: 3204c24a65f8af707e13c14744cf442c94b8fddc9212308d82bf5f7e201d5fe9ae122180c0eba4458b20ba8043b5238471d7695ea6d332e7b9eb3172bf32b9b6

data/.rubocop.yml

@@ -4,6 +4,10 @@ Metrics/LineLength:
   Exclude:
     - 'spec/**/*_spec.rb'
 
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*_spec.rb'
+
 Style/BlockComments:
   Exclude:
     - 'spec/spec_helper.rb'

data/.rubocop_todo.yml

@@ -10,18 +10,13 @@
 Metrics/AbcSize:
   Max: 18
 
-# Offense count: 2
-# Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 140
-
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 12
+  Max: 15
 
 # Offense count: 1
 # Configuration parameters: AllowedVariables.
 Style/GlobalVars:
   Exclude:
-    - 'lib/expectacle/thrower_base.rb'
+    - 'lib/expectacle/thrower_base.rb' # $expect_verbose

data/Gemfile

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

data/README.md

@@ -211,10 +211,10 @@ 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
+## Default 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),
+When use `ssh` (OpenSSH) command to spawn device, the user can set options for the command via `#{base_dir}/opts/ssh_opts.yml`.
+With options as list in [ssh_opts.yml](./vendor/opts/ssh_opts.yml),
 ```
 - '-o StrictHostKeyChecking=no'
 - '-o KexAlgorithms=+diffie-hellman-group1-sha1'
@@ -228,6 +228,30 @@ Host *
     Ciphers +aes128-cbc,3des-cbc,aes192-cbc,aes256-cbc
 ```
 
+## Use Local Serial Console
+
+Expectacle can handle `cu` (call up another system) command to operate via device local serial port.
+
+If you use Ubuntu, install `cu` at first.
+```
+sudo apt install cu
+```
+
+Set parameter `:protocol` to `cu`, and write `cu` command options as `:cu_opts`. Usually, one serial port correspond to one device. So host parameter `:cu_opts` is used as options to connect a host via serial port. For example:
+```
+- :hostname : 'l2sw1'
+  :type : 'c3750g'
+  :protocol : 'cu'
+  :cu_opts : '-l /dev/ttyUSB0 -s 9600'
+```
+File `#{base_dir}/opts/cu_opts.yml` has default options for `cu` command.
+
+At last, execute by `run_command` with `sudo`. Because it requires superuser permission to handle local device.
+```
+sudo -E bundle exec run_command -r -h l2switch.yml -c cisco_show_version.yml
+```
+**Notice** : Without `sudo -E` (`--preserve-env`) option, it do not preserve environment variables such as username/password and others you defined.
+
 ## TODO
 
 ### Sub prompt operation (interactive command)

data/Rakefile

@@ -1,12 +1,12 @@
 require 'bundler/gem_tasks'
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]
 
 begin
   require 'rspec/core/rake_task'
   RSpec::Core::RakeTask.new
 rescue LoadError
   task :spec do
-    $stderr.puts 'RSpec is disabled'
+    warn 'RSpec is disabled'
   end
 end
 
@@ -15,7 +15,7 @@ begin
   RuboCop::RakeTask.new
 rescue LoadError
   task :rubocop do
-    $stderr.puts 'RuboCop is disabled'
+    warn 'RuboCop is disabled'
   end
 end
 
@@ -27,6 +27,6 @@ begin
   end
 rescue LoadError
   task :yard do
-    $stderr.puts 'YARD is disabled'
+    warn 'YARD is disabled'
   end
 end

data/expectacle.gemspec

@@ -1,5 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'expectacle/version'
 

data/lib/expectacle/thrower.rb

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require 'expectacle/thrower_base'
+require 'expectacle/thrower_preview'
+require 'expectacle/thrower_utils'
 
 module Expectacle
+  # Maximum number to retly authentication
+  MAX_AUTH_COUNT = 10
+
   # Thrower logic(command list operation)
   class Thrower < ThrowerBase
     # Run(exec) commands for all hosts.
@@ -11,35 +15,29 @@ module Expectacle
     def run_command_for_all_hosts(hosts, commands)
       hosts.each do |each|
         @commands = commands.dup # Notice: @commands will be decremented.
+        @commands_len = @commands.length
+        @auth_count = 0
         @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|
-        @host_param = each
-        preview_command_for_host
-      end
-    end
-
     private
 
     def run_command_for_host
       ready_to_open_host_session do |spawn_cmd|
         open_interactive_process(spawn_cmd) do
+          before_run_command
           run_command
         end
       end
     end
 
-    def preview_command_for_host
-      ready_to_open_host_session do |spawn_cmd|
-        print YAML.dump(whole_previewed_parameters(spawn_cmd))
+    def before_run_command
+      return unless @local_serial
+      # for `cu` command
+      @reader.expect(/^Connected\./, 1) do
+        write_and_logging 'Send enter to connect serial', "\r\n", true
       end
     end
 
@@ -50,36 +48,11 @@ module Expectacle
       end
     end
 
-    def previewed_host_param
-      host_param = @host_param.dup
-      enable_mode = @enable_mode
-      @enable_mode = false
-      host_param[:username] = embed_user_name
-      host_param[:password] = embed_password
-      @enable_mode = true
-      host_param[:enable] = embed_password
-      @enable_mode = enable_mode
-      host_param
-    end
-
-    def previewed_commands
-      @commands.map { |cmd| embed_command(cmd) }
-    end
-
-    def whole_previewed_parameters(spawn_cmd)
-      {
-        spawn_cmd: spawn_cmd,
-        prompt: @prompt,
-        host: previewed_host_param,
-        commands: previewed_commands
-      }
-    end
-
     def exec_rest_commands
       if !@commands.empty?
         yield
       else
-        write_and_logging 'Send break: ', 'exit'
+        close_session
       end
     end
 
@@ -118,6 +91,7 @@ module Expectacle
     end
 
     def exec_each_prompt(prompt)
+      check_auth_count
       case prompt
       when /#{@prompt[:password]}/, /#{@prompt[:enable_password]}/
         write_and_logging 'Send password', embed_password, true

data/lib/expectacle/thrower_base.rb

@@ -2,16 +2,12 @@
 
 require 'pty'
 require 'expect'
-require 'yaml'
-require 'erb'
-require 'logger'
-require 'syslog/logger'
+require 'expectacle/thrower_base_io'
+require 'expectacle/thrower_base_params'
 
 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
 
@@ -58,31 +54,17 @@ module Expectacle
       File.join @base_dir, 'commands'
     end
 
-    private
-
-    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
+    # Path to span command options file directory.
+    # @return [String]
+    def opts_dir
+      File.join @base_dir, 'opts'
     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
+    private
 
     def ready_to_open_host_session
-      # prompt regexp of device
-      load_prompt_file
+      @local_serial = false # default for host
+      load_prompt_file # prompt regexp of device
       spawn_cmd = make_spawn_command
       if @prompt && spawn_cmd
         yield spawn_cmd
@@ -92,7 +74,7 @@ module Expectacle
     end
 
     def do_on_interactive_process
-      until @reader.eof?
+      until @reader.closed? || @reader.eof?
         @reader.expect(expect_regexp, @timeout) do |match|
           yield match
         end
@@ -111,93 +93,6 @@ module Expectacle
         @writer.sync = true
         yield
       end
-      @logger.info "End spawn: #{@host_param[:hostname]}"
-    end
-
-    def ssh_command
-      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', embed_ipaddr].join(' ')
-      when /^ssh$/i
-        ssh_command
-      else
-        @logger.error "Unknown protocol #{@host_param[:protocol]}"
-        nil
-      end
-    end
-
-    def load_yaml_file(file_type, file_name)
-      YAML.load_file file_name
-    rescue StandardError => error
-      @logger.error "Cannot load #{file_type}: #{file_name}"
-      raise error
-    end
-
-    def load_prompt_file
-      prompt_file = "#{prompts_dir}/#{@host_param[:type]}_prompt.yml"
-      @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]}
-        | #{@prompt[:username]}
-        | #{@prompt[:command1]} | #{@prompt[:command2]}
-        | #{@prompt[:sub1]} | #{@prompt[:sub2]}
-        | #{@prompt[:yn]}
-        )\s*$
-      /x
-    end
-
-    def write_and_logging(message, command, secret = false)
-      logging_message = secret ? message : message + command
-      @logger.info logging_message
-      @writer.puts command
-    end
-
-    def check_embed_envvar(command)
-      return unless command =~ /<%=\s*ENV\[[\'\"]?(.+)[\'\"]\]?\s*%>/
-      envvar_name = Regexp.last_match(1)
-      if !ENV.key?(envvar_name)
-        @logger.error "Variable name: #{envvar_name} is not found in ENV"
-      elsif ENV[envvar_name] =~ /^\s*$/
-        @logger.warn "Env var: #{envvar_name} exists, but null string"
-      end
-    end
-
-    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)
-      passwd_erb = ERB.new(base_str)
-      passwd_erb.result(binding)
-    end
-
-    def embed_command(command)
-      command_erb = ERB.new(command)
-      command_erb.result(binding)
-    end
-
-    def embed_user_name
-      check_embed_envvar(@host_param[:username])
-      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/thrower_base_io.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'logger'
+require 'syslog/logger'
+
+module Expectacle
+  # Basic state setup/management
+  class ThrowerBase
+    # @return [Logger] Logger instance.
+    attr_accessor :logger
+
+    private
+
+    def write_and_logging(message, command, secret = false)
+      logging_message = secret ? message : message + command
+      @logger.info logging_message
+      if @writer.closed?
+        @logger.error "Try to write #{command}, but writer closed"
+        @commands.clear
+      else
+        @writer.puts command
+      end
+    end
+
+    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 load_yaml_file(file_type, file_name)
+      YAML.load_file file_name
+    rescue StandardError => error
+      @logger.error "Cannot load #{file_type}: #{file_name}"
+      raise error
+    end
+
+    def load_prompt_file
+      prompt_file = "#{prompts_dir}/#{@host_param[:type]}_prompt.yml"
+      @prompt = load_yaml_file('prompt file', prompt_file)
+    end
+
+    def load_spawn_command_opts_file
+      opts_file = "#{opts_dir}/#{@host_param[:protocol]}_opts.yml"
+      if File.exist?(opts_file)
+        load_yaml_file("#{@host_param[:protocol]} opts file", opts_file)
+      else
+        @logger.warn "Opts file #{opts_file} not found."
+        []
+      end
+    end
+  end
+end

data/lib/expectacle/thrower_base_params.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module Expectacle
+  # Basic state setup/management
+  class ThrowerBase
+    private
+
+    def ssh_command
+      opts = load_spawn_command_opts_file
+      ['ssh', opts, "-l #{embed_user_name}", embed_ipaddr].join(' ')
+    end
+
+    def cu_command
+      @local_serial = true
+      opts = load_spawn_command_opts_file
+      ['cu', @host_param[:cu_opts], opts].join(' ')
+    end
+
+    def expect_regexp
+      /
+        ( #{@prompt[:password]} | #{@prompt[:enable_password]}
+        | #{@prompt[:username]}
+        | #{@prompt[:command1]} | #{@prompt[:command2]}
+        | #{@prompt[:sub1]} | #{@prompt[:sub2]}
+        | #{@prompt[:yn]}
+        )\s*$
+      /x
+    end
+
+    def make_spawn_command
+      case @host_param[:protocol]
+      when /^telnet$/i
+        ['telnet', embed_ipaddr].join(' ')
+      when /^ssh$/i
+        ssh_command
+      when /^cu$/i
+        cu_command
+      else
+        @logger.error "Unknown protocol #{@host_param[:protocol]}"
+        nil
+      end
+    end
+
+    def check_embed_envvar(command)
+      return unless command =~ /<%=\s*ENV\[[\'\"]?(.+)[\'\"]\]?\s*%>/
+      envvar_name = Regexp.last_match(1)
+      if !ENV.key?(envvar_name)
+        @logger.error "Variable name: #{envvar_name} is not found in ENV"
+      elsif ENV[envvar_name] =~ /^\s*$/
+        @logger.warn "Env var: #{envvar_name} exists, but null string"
+      end
+    end
+
+    def embed_var(param)
+      check_embed_envvar(param)
+      erb = ERB.new(param)
+      erb.result(binding)
+    end
+
+    def embed_password
+      @host_param[:enable] = '_NOT_DEFINED_' unless @host_param.key?(:enable)
+      base_str = @enable_mode ? @host_param[:enable] : @host_param[:password]
+      embed_var(base_str)
+    end
+
+    def embed_command(command)
+      embed_var(command)
+    end
+
+    def embed_user_name
+      embed_var(@host_param[:username])
+    end
+
+    def embed_ipaddr
+      embed_var(@host_param[:ipaddr])
+    end
+  end
+end

data/lib/expectacle/thrower_preview.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'expectacle/thrower_base'
+
+module Expectacle
+  # Thrower logic(command list operation)
+  class Thrower < ThrowerBase
+    # 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)
+      print YAML.dump(previewed_data(hosts, commands))
+    end
+
+    # Preview all parameters for all hosts (for testing)
+    # @param [Array<Hash>] hosts Host parameters (read from host list file).
+    # @param [Array<String>] commands Commands (read from command list file).
+    def previewed_data(hosts, commands)
+      @commands = commands
+      hosts.map do |each|
+        @host_param = each
+        preview_command_for_host
+      end
+    end
+
+    private
+
+    def preview_command_for_host
+      ready_to_open_host_session do |spawn_cmd|
+        whole_previewed_parameters(spawn_cmd)
+      end
+    end
+
+    def previewed_host_param
+      host_param = @host_param.dup
+      enable_mode = @enable_mode
+      @enable_mode = false
+      host_param[:username] = embed_user_name
+      host_param[:password] = embed_password
+      host_param[:ipaddr] = embed_ipaddr
+      @enable_mode = true
+      host_param[:enable] = embed_password
+      @enable_mode = enable_mode
+      host_param
+    end
+
+    def previewed_commands
+      @commands.map { |cmd| embed_command(cmd) }
+    end
+
+    def whole_previewed_parameters(spawn_cmd)
+      {
+        spawn_cmd: spawn_cmd,
+        prompt: @prompt,
+        host: previewed_host_param,
+        commands: previewed_commands
+      }
+    end
+  end
+end

data/lib/expectacle/thrower_utils.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'expectacle/thrower_base_io'
+
+module Expectacle
+  # Thrower logic(command list operation)
+  class Thrower < ThrowerBase
+    private
+
+    def check_auth_count
+      if @commands.length == @commands_len
+        @auth_count += 1
+      else
+        @auth_count = 0
+        @commands_len = @commands.length
+      end
+      return unless @auth_count > MAX_AUTH_COUNT
+      @logger.error "Close: Too many auth retries (#{@auth_count} times)"
+      @commands = []
+      close_session
+    end
+
+    def clear_auth_count
+      @auth_count = 0
+    end
+
+    def close_session
+      write_and_logging 'Send break: ', 'exit'
+      return unless @local_serial
+      @logger.info 'Close IO for spawn command'
+      @reader.close
+      @writer.close
+    end
+  end
+end

data/lib/expectacle/version.rb

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

data/vendor/commands/cisco_show_version.yml

@@ -0,0 +1,4 @@
+- 'term len 0'
+- 'conf term'
+- 'do show version | include IOS'
+- 'exit'

data/vendor/hosts/l2switch.yml

@@ -1,16 +1,17 @@
 - :hostname : 'l2sw1'
   :type : 'c3750g'
-  :ipaddr : '192.168.20.150'
-  :protocol : 'ssh'
+  :ipaddr : '192.168.255.1'
+  :protocol : 'cu'
+  :cu_opts : '-l /dev/ttyUSB0 -s 9600'
   :username : "<%= ENV['L2SW_USER'] %>"
   :password : "<%= ENV['L2SW_PASS'] %>"
   :enable : "<%= ENV['L2SW_PASS'] %>"
-  :tftp_server: '192.168.20.170'
+  :tftp_server: '192.168.2.16'
 - :hostname : 'l2sw2'
   :type : 'c3750g'
-  :ipaddr : '192.168.20.151'
+  :ipaddr : '192.168.255.2'
   :protocol : 'ssh'
   :username : "<%= ENV['L2SW_USER'] %>"
   :password : "<%= ENV['L2SW_PASS'] %>"
   :enable : "<%= ENV['L2SW_PASS'] %>"
-  :tftp_server: '192.168.20.170'
+  :tftp_server: '192.168.2.16'

data/vendor/opts/cu_opts.yml

@@ -0,0 +1,2 @@
+- '--parity=none'
+# - '--debug all'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expectacle
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - stereocat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-07 00:00:00.000000000 Z
+date: 2018-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -49,19 +49,25 @@ files:
 - lib/expectacle.rb
 - lib/expectacle/thrower.rb
 - lib/expectacle/thrower_base.rb
+- lib/expectacle/thrower_base_io.rb
+- lib/expectacle/thrower_base_params.rb
+- lib/expectacle/thrower_preview.rb
+- lib/expectacle/thrower_utils.rb
 - lib/expectacle/version.rb
 - vendor/commands/cisco_save_config_tftp.yml
 - vendor/commands/cisco_show_arp.yml
+- vendor/commands/cisco_show_version.yml
 - vendor/commands/pica8_ovs_info.yml
 - vendor/commands/ssg_get_arp.yml
 - vendor/commands/ssg_save_config_tftp.yml
 - vendor/hosts/fw.yml
 - vendor/hosts/l2switch.yml
 - vendor/hosts/ofswitch.yml
+- vendor/opts/cu_opts.yml
+- vendor/opts/ssh_opts.yml
 - 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