serialkiller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42b24d89567ed6c0261c138b259a99ce87b6bbc8
+  data.tar.gz: 21b1089a70ea52cbb18d7ba4a34bbc0fe2f379c2
+SHA512:
+  metadata.gz: 4139376e90d1cced209c8f05137fb1db5d1efec246791f58128e2d68b9b13c6cbf958b48f59d3125e4ac36e7cec14868781583cae140db308769e2ed54b97344
+  data.tar.gz: f78a14175c90fd86e3633aba279ee08289974cbe997031701ce7133156ad8dd90a2eefd569bf0e6eeddd059ebebb9b46b351029197eacf251b1bb4a26d702887

data/bin/serial

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+require 'serial/cli'
+require 'benchmark'
+
+begin
+  ENV['THOR_DEBUG'] = '1'
+  etime = Benchmark.realtime { SerialKiller::CLI.start(ARGV) }
+  $stderr.puts "Completed in #{etime}s"
+rescue Thor::UndefinedCommandError, Thor::UnknownArgumentError, Thor::AmbiguousCommandError, Thor::InvocationError => e
+  $stderr.puts(e.message)
+  exit(64)
+rescue Thor::Error => e
+  $stderr.puts(e.message)
+  exit(1)
+end

data/lib/serial.rb

@@ -0,0 +1,43 @@
+require 'logger'
+
+require 'ruby_expect'
+require 'active_support/all'
+
+require 'serial/devices'
+
+module SerialKiller
+  extend self
+
+  def connect(device: nil, host: nil, port: nil, offset: nil, timeout: nil, retries: nil, verbose: nil, keyfile: nil, username: '', password: '')
+    options = { offset: offset, keyfile: keyfile, verbose: verbose, timeout: timeout, retries: retries }
+    options[:username] = username unless username.empty?
+    options[:password] = password unless password.empty?
+
+    case device
+    when 'sentry'
+      sentry_connect(host, port, **options)
+    else
+      raise "#{device} is not supported"
+    end
+  end
+
+  private
+
+  def connect_device(host, port, offset: nil, keyfile: nil, verbose: nil, timeout: nil, retries: nil)
+    logger = Logger.new(STDOUT)
+    logger.level = Logger::DEBUG
+    exp = RubyExpect::Expect.spawn("/usr/bin/ssh root@#{host} -i #{keyfile} -p #{offset + port}", logger: verbose ? logger : nil)
+    exp.timeout = timeout
+
+    attempts = 0
+    exp.procedure do
+      exp.send ''
+      while attempts < retries
+        sleep(1)
+        yield exp
+        sleep(5)
+        attempts += 1
+      end
+    end
+  end
+end

data/lib/serial/cli.rb

@@ -0,0 +1,20 @@
+require 'thor'
+require 'serial'
+
+class SerialKiller::CLI < Thor
+  desc 'connect', 'Connect to a device'
+  method_option :device, type: :string, required: true, banner: 'DEVICE', desc: 'Type of device to connect to', enum: ['sentry'], aliases: '-d'
+  method_option :host, type: :string, required: true, banner: 'HOST', desc: 'Serial console server host to connect to', aliases: '-h'
+  method_option :port, type: :numeric, required: true, banner: 'PORT', desc: 'Serial console server port to connect to', aliases: '-p'
+  method_option :username, type: :string, default: '', banner: 'USERNAME', desc: 'Username for login', aliases: '-U'
+  method_option :password, type: :string, default: '', banner: 'PASSWORD', desc: 'Password for login', aliases: '-P'
+  method_option :offset, type: :numeric, default: 3000, banner: 'OFFSET', desc: 'Port offset on serial console server', aliases: '-o'
+  method_option :keyfile, type: :string, default: '/etc/conserver/.ssh/id_rsa', banner: 'KEYFILE', desc: 'Path to ssh keyfile', aliases: '-k'
+  method_option :timeout, type: :numeric, default: 30, banner: 'TIMEOUT', desc: 'Time to wait before giving up', aliases: '-t'
+  method_option :retries, type: :numeric, default: 5, banner: 'RETRIES', desc: 'Number of times to attempt to connect', aliases: '-r'
+  method_option :verbose, type: :boolean, default: false, desc: 'Run with verbose debug output', aliases: '-v'
+  def connect
+    opts = options.deep_symbolize_keys
+    SerialKiller.connect(**opts)
+  end
+end

data/lib/serial/devices.rb

@@ -0,0 +1 @@
+require 'serial/devices/sentry'

data/lib/serial/devices/sentry.rb

@@ -0,0 +1,62 @@
+
+
+def sentry_extract(exp, username, password)
+  exp.send username
+  exp.expect /Password:/ do
+    send password
+  end
+  exp.expect /Switched CDU:/ do
+    send 'show system'
+    sleep(5)
+  end
+
+  exp.expect /NIC S\/N:\s+(.*)$/ do
+    puts "NIC Serial: #{exp.last_match.captures.first.strip}"
+  end
+
+  exp.expect /Switched CDU:/ do
+    send 'show network'
+    sleep(5)
+  end
+
+  exp.expect /IPv4 Address:\s+(.*)\s+Subnet Mask:.*$/ do
+    puts "DHCP IP: #{exp.last_match.captures.first.strip}"
+  end
+
+  exp.expect /More \(Y\/es N\/o\):/ do
+    send 'Y'
+    sleep(5)
+  end
+
+  exp.expect /IPv4 Address:\s+(.*)\s+Subnet Mask:.*$/ do
+    puts "Static IP: #{exp.last_match.captures.first.strip}"
+  end
+
+  exp.expect /More \(Y\/es N\/o\):/ do
+    send 'Y'
+  end
+
+  exp.expect /Switched CDU:/ do
+    send 'logout'
+    sleep(5)
+    exit
+  end
+end
+
+def sentry_connect(host, port, username: 'admn', password: 'admn', **kwargs)
+  connect_device(host, port, **kwargs) do |exp|
+    exp.procedure.any do
+      exp.expect /^\s+$/ do
+        exp.send ''
+      end
+
+      exp.expect /Sentry Switched CDU/ do
+        exp.send ''
+      end
+
+      exp.expect /Username:/ do
+        sentry_extract(exp, username, password)
+      end
+    end
+  end
+end

data/lib/serial/version.rb

@@ -0,0 +1,3 @@
+module SerialKiller
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: serialkiller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dale Hamel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: ruby_expect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: Write expectations for network devices to interact with their serial
+  consoles
+email: dale.hamel@srvthe.net
+executables:
+- serial
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/serial
+- lib/serial.rb
+- lib/serial/cli.rb
+- lib/serial/devices.rb
+- lib/serial/devices/sentry.rb
+- lib/serial/version.rb
+homepage: http://rubygems.org/gems/serialkiller
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Automates serial console interactions using expectations
+test_files: []