xlogin 0.3.7 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ea3547deaca69452375126dadf928ae75336be3
-  data.tar.gz: 8dc72eb01028ca3f85ba0a5eb7b7eb959f47388c
+  metadata.gz: 01f1dcfc4664204170ef0065396788768d5ac676
+  data.tar.gz: a4bf5740a6ca77b67a64497b7cded0942e689f9e
 SHA512:
-  metadata.gz: 858d6eb742ed5f93c43f2b886039f00ba136abf10f3d5ac06dce59a881338fccbae0a8b9371f1cfa5220c1cad6c5baeaa0dd7a9baab880e2379e13dbeeb02f46
-  data.tar.gz: 65e11182a15cec1c91f8f9181d239ba348acbfe54735cb12991f67385e7cb35d625feacf729650451a9e3e0719d8f81658ad386bd9f781fd6a929c06224adcb6
+  metadata.gz: e8bf704c7af2aef3f090951d94088d8ec49c985eff1226333be5d540a0171e1022efdb7cad142c5642d11024418c91d0e695f7c01d0dac4f388454433f550706
+  data.tar.gz: fc21595ec2a4acb907eb9f6dfd77154f3097b8afff7e7e21fd1548e8ca14d617e183a0bd7f56de3238006975f588f2f3a43ca2c4d62216c71c0d513ac233be68

data/.gitignore

@@ -56,5 +56,9 @@ build-iPhoneSimulator/
 # End of https://www.gitignore.io/api/ruby
 /lib/xlogin/.xloginrc
 /lib/xlogin/_xloginrc
-/lib/xlogin/firmware_templates/*
-!/lib/xlogin/firmware_templates/vyos.rb
+/lib/xlogin/templates/*
+!/lib/xlogin/templates/vyos.rb
+!/lib/xlogin/templates/junos.rb
+!/lib/xlogin/templates/ios.rb
+!/lib/xlogin/templates/iosxr.rb
+!/lib/xlogin/templates/sros.rb

data/bin/cmd_exec

@@ -46,7 +46,6 @@ module Xlogin
       opt.on('-H', 'Display hostnames for each response.')   { |v| options[:H] = v }
 
       opt.on('-f FILE',  'Read target hostnames from FILE.') { |v| options[:f] = v }
-      opt.on('-r FILE',  'Load extention library.')          { |v| options[:r] = v }
 
       opt.on('-x VALUE', 'Read commands from VALUE.')        { |v| options[:x] = v }
       opt.on('-c VALUE')                                     { |v| options[:c] = v }
@@ -74,9 +73,9 @@ module Xlogin
       usage if options[:x].nil? and options[:c].nil?
       usage if options[:f].nil? && args.empty?
 
-      if options[:r]
-        options[:r].split(':').each { |file| require file }
-      end
+      source_dirs  = [ENV['HOME'], Dir.pwd]
+      source_files = source_dirs.flat_map { |dir| [File.join(dir, '_xloginrc'), File.join(dir, '.xloginrc')] }
+      Xlogin.factory.source(*source_files)
 
       size     = (options[:p] || 1).to_i
       interval = (options[:i] || 0).to_i

data/bin/xlogin

@@ -12,7 +12,6 @@ module Xlogin
       opt = OptionParser.new
       opt.on('-e', '--enable', 'Try to gain enable priviledge.') { |v| options[:e] = v }
       opt.on('-l', '--log',    'Enable logging.')                { |v| options[:l] = v }
-      opt.on('-r FILE',        'Load extention library.')        { |v| options[:r] = v }
 
       opt.on(      '--list',   'List all devices.')              { |v| options[:list] = v }
 
@@ -34,9 +33,9 @@ module Xlogin
     def self.run(args = ARGV)
       options, args = getopts(args)
 
-      if options[:r]
-        options[:r].split(':').each { |file| require file }
-      end
+      source_dirs  = [ENV['HOME'], Dir.pwd]
+      source_files = source_dirs.flat_map { |dir| [File.join(dir, '_xloginrc'), File.join(dir, '.xloginrc')] }
+      Xlogin.factory.source(*source_files)
 
       if options[:list]
         puts Xlogin.factory.list.map { |e| "#{e[:name]}\t#{e[:type]}" }

data/lib/xlogin.rb

@@ -8,29 +8,24 @@ module Xlogin
 
   class GeneralError < StandardError; end
 
+  # default template directory
+  TEMPLATE_DIR = File.join(File.dirname(__FILE__), 'xlogin', 'templates')
+
   class << self
     def factory
+      @factory ||= configure_factory
+    end
+
+    def configure_factory(*template_dirs)
       unless @factory
         @factory = Xlogin::FirmwareFactory.instance
 
-        template_dir = File.join(File.dirname(__FILE__), 'xlogin', 'firmware_templates')
-
-        Dir.entries(template_dir).each do |file|
-          @factory.load_template_file(File.join(template_dir, file))
-        end
-
-        source_dirs  = [
-          ENV['HOME'],
-          ENV['XLOGIN_HOME'],
-          Dir.pwd
-        ]
-
-        source_dirs.compact.uniq.each do |dir|
-          @factory.source(File.join(dir, '.xloginrc'))
-          @factory.source(File.join(dir, '_xloginrc'))
+        template_dirs = [TEMPLATE_DIR, File.join(Dir.pwd, 'templates'), *template_dirs]
+        template_dirs.compact.uniq.each do |dir|
+          next unless FileTest.directory?(dir)
+          @factory.load_template_file(*Dir.glob(File.join(dir, '*.rb')))
         end
       end
-
       @factory
     end
 
@@ -41,11 +36,8 @@ module Xlogin
       factory.set_template(name, template)
     end
 
-    def alias(new_name, original_name)
-      template = factory.get_template(original_name)
-      raise Xlogin::GeneralError.new("'#{original_name}' not found") unless template
-
-      factory.set_template(new_name, template)
+    def alias(new_name, name)
+      factory.alias_template(new_name, name)
     end
 
     def get(hostname, args = {})
@@ -59,8 +51,4 @@ module Xlogin
     end
   end
 
-  # do not remove this line!
-  # initialize Xlogin systems and load related modules beforehand.
-  Xlogin.factory
-
 end

data/lib/xlogin/firmware_factory.rb

@@ -11,13 +11,17 @@ module Xlogin
     def initialize
       @database  = Hash.new
       @templates = Hash.new
+      @aliases   = Hash.new
     end
 
-    def load_template_file(file)
-      require file if file =~ /.rb$/
+    def load_template_file(*files)
+      files.each do |file|
+        require file if file =~ /.rb$/
+      end
     end
 
     def get_template(name)
+      name = @aliases[name] || name
       @templates[name.to_s.downcase]
     end
 
@@ -29,11 +33,15 @@ module Xlogin
       @templates.keys
     end
 
-    def source(db_file)
-      return unless File.exist?(db_file)
+    def alias_template(new_name, name)
+      @aliases[new_name.to_s.downcase] = name
+    end
 
-      content = IO.read(db_file)
-      instance_eval(content)
+    def source(*files)
+      files.compact.uniq.each do |file|
+        next unless File.exist?(file)
+        instance_eval(IO.read(file))
+      end
     end
 
     def get(name)
@@ -55,7 +63,10 @@ module Xlogin
       opts = args.reduce({}) { |a, (k, v)| a.merge(k.to_s.downcase.to_sym => v) }
       raise Xlogin::GeneralError.new("Host not found: #{args}") unless uri && type
 
-      session = get_template(type).dup.run(uri, opts)
+      template = get_template(type)
+      raise Xlogin::GeneralError.new("Template not defined: #{type}") unless template
+
+      session = template.dup.run(uri, opts)
       session.name = name if name
       session
     end
@@ -68,7 +79,7 @@ module Xlogin
     end
 
     def method_missing(name, *args, &block)
-      super unless caller_locations.first.label == "source"
+      super unless caller_locations.first.label =~ /source/ and args.size >= 2
 
       type = name.to_s.downcase
       name = args.shift

data/lib/xlogin/rake_task.rb

@@ -9,9 +9,18 @@ module Xlogin
     class << self
       include Rake::DSL
 
-      def bulk(names, **xlogin_opts, &block)
-        names = names.map(&:strip).grep(/^\s*[^#]/)
+      def mutex
+        @mutex ||= Mutex.new
+      end
+
+      def source(file, &block)
+        Xlogin.factory.source(file)
+        hostnames = Xlogin.factory.list.map { |e| e[:name] }
+        bulk(hostnames, &block)
+      end
 
+      def bulk(names, &block)
+        names = names.map(&:strip).grep(/^\s*[^#]/)
         namecount = names.uniq.inject({}) { |a, e| a.merge(e => names.count(e)) }
         duplicate = namecount.keys.select { |name| namecount[name] > 1 }
         raise Xlogin::GeneralError.new("Duplicate hosts found - #{duplicate.join(', ')}") unless duplicate.empty?
@@ -21,15 +30,11 @@ module Xlogin
 
           names.each do |name|
             desc "#{description} (#{name})"
-            RakeTask.new(name, **xlogin_opts, &block)
+            RakeTask.new(name, &block)
           end
         end
       end
 
-      def mutex
-        @mutex ||= Mutex.new
-      end
-
       def current_namespace
         path = Rake.application.current_scope.path
 
@@ -46,23 +51,24 @@ module Xlogin
 
 
     attr_reader   :name
+    attr_accessor :xlogin_opts
     attr_accessor :fail_on_error
     attr_accessor :silent
     attr_accessor :lockfile
     attr_accessor :logfile
     attr_accessor :uncomment
 
-    def initialize(name, **xlogin_opts)
+    def initialize(name)
       @name          = name
+      @xlogin_opts   = Xlogin.factory.get(name) || {}
+      @session       = nil
+      @taskrunner    = nil
+
       @fail_on_error = true
       @silent        = Rake.application.options.silent
       @lockfile      = nil
       @logfile       = nil
       @uncomment     = false
-      @xlogin_opts   = xlogin_opts
-
-      @session       = nil
-      @taskrunner    = nil
 
       yield(self) if block_given?
       define
@@ -86,9 +92,7 @@ module Xlogin
     private
     def define
       RakeTask.current_namespace do
-        description = Rake.application.last_description || "Run '#{RakeTask.current_namespace}'"
-
-        desc description
+        desc Rake.application.last_description || "Run '#{RakeTask.current_namespace}'"
         Rake.application.last_description = nil if uncomment
 
         if lockfile
@@ -108,24 +112,29 @@ module Xlogin
     end
 
     def run_task
-      loggers = []
+      raise Xlogin::GeneralError.new("missing xlogin_opts to connect to #{name}") unless @xlogin_opts[:type] && @xlogin_opts[:uri]
+
+      loggers = [@xlogin_opts[:log]].flatten.compact
       loggers << $stdout unless silent || Rake.application.options.always_multitask
 
       if logfile
         mkdir_p(File.dirname(logfile), verbose: Rake.application.options.trace)
-        loggers << logfile if logfile
+        loggers << logfile
       end
 
       @xlogin_opts[:log] = loggers unless loggers.empty?
 
       begin
-        @session = Xlogin.get(name, @xlogin_opts.dup)
-        @session.extend(SessionExt)
+        @session = Xlogin.factory.build(@xlogin_opts)
+        if @session && @taskrunner
+          @session.extend(SessionExt)
 
-        method_proc = method(:safe_puts)
-        @session.define_singleton_method(:safe_puts) { |*args| method_proc.call(*args) }
+          # pass RakeTask#safe_puts method to the session instance.
+          method_proc = method(:safe_puts)
+          @session.define_singleton_method(:safe_puts) { |*args| method_proc.call(*args) }
 
-        @taskrunner.call(@session) if @taskrunner && @session
+          @taskrunner.call(@session) if @taskrunner && @session
+        end
       rescue => e
         raise e if fail_on_error
         safe_puts(e, io: $stderr, force: true)
@@ -160,14 +169,9 @@ module Xlogin
           cmd(my_command)
         else
           cmd(my_command)
-          # retry thid command
           readline(command)
         end
       end
-
-      def sync(&block)
-        RakeTask.mutex.synchronize(&block) if block
-      end
     end
 
   end

data/lib/xlogin/session.rb

@@ -20,6 +20,25 @@ module Xlogin
       @logger   = update_logger
     end
 
+    def thread_safe(timeout: @timeout, maximum_retry: 1)
+      @safe_session = self
+      @safe_session_mutex ||= Mutex.new
+
+      Timeout.timeout(timeout) do
+        @safe_session_mutex.synchronize do
+          retry_count = 0
+          begin
+            @safe_session ||= Xlogin.get(@host, @opts)
+            yield @safe_session
+          rescue Errno::ECONNRESET => e
+            raise e unless (retry_count += 1) < maximum_retry
+            @safe_session = nil
+            retry
+          end
+        end
+      end
+    end
+
     def enable_log(out = $stdout)
       enabled = @loglist.include?(out)
       unless enabled

data/lib/xlogin/templates/ios.rb

@@ -0,0 +1,36 @@
+Xlogin.configure :ios do |os|
+  os.timeout(300)
+  os.prompt(/[>$#]/)
+  os.prompt(/yes \/ no: /) do
+    puts opts[:force] ? 'y' : 'n'
+  end
+
+  os.bind(:login) do |password|
+    waitfor(/Password: /) && puts(password)
+    waitfor
+  end
+
+  os.bind(:enable) do |password|
+    puts('enable')
+    waitfor(/Password: /) && puts(password)
+    waitfor
+  end
+
+  os.bind(:config) do
+    begin
+      cmd('terminal length 0')
+      resp = cmd('show run')
+      resp.lines[4..-2].join.to_s
+    ensure
+      cmd('exit')
+    end
+  end
+
+  os.bind(:save) do
+    begin
+      cmd('write memory')
+    ensure
+      cmd('exit')
+    end
+  end
+end

data/lib/xlogin/templates/iosxr.rb

@@ -0,0 +1,22 @@
+Xlogin.configure :iosxr do |os|
+  os.timeout(300)
+  os.prompt(/#\z/)
+
+  os.bind(:login) do |*args|
+    username, password = *args
+    waitfor(/Username: /) && puts(username)
+    waitfor(/Password: /) && puts(password)
+    waitfor
+  end
+
+  os.bind(:config) do
+    begin
+      cmd('terminal width 0')
+      cmd('terminal length 0')
+      resp = cmd('show run')
+      resp.lines[3..-3].join.to_s
+    ensure
+      cmd('exit')
+    end
+  end
+end

data/lib/xlogin/templates/junos.rb

@@ -0,0 +1,19 @@
+Xlogin.configure :junos do |os|
+  os.timeout(300)
+  os.prompt(/[>#] \z/)
+
+  os.bind(:login) do |*args|
+    username, password = *args
+    waitfor(/login:\s/)  && puts(username)
+    waitfor(/Password:/) && puts(password)
+    waitfor
+  end
+
+  os.bind(:config) do
+    begin
+      cmd('show configuration | no-more')
+    ensure
+      cmd('exit')
+    end
+  end
+end

data/lib/xlogin/templates/sros.rb

@@ -0,0 +1,30 @@
+Xlogin.configure :sros do |os|
+  os.timeout(300)
+  os.prompt(/[>$#] /)
+  os.prompt(/y\/n:/) do
+    puts opts[:force] ? 'y' : 'n'
+  end
+
+  os.bind(:login) do |*args|
+    username, password = *args
+    waitfor(/Login:\s?/)    && puts(username)
+    waitfor(/Password:\s?/) && puts(password)
+    waitfor
+  end
+
+  os.bind(:enable_admin) do |password|
+    puts('enable-admin')
+    waitfor(/Password:\s?/) && puts(password)
+    waitfor
+  end
+
+  os.bind(:config) do
+    begin
+      cmd('environment no more')
+      resp = cmd('admin display-config')
+      resp.lines[2..-2].join.to_s
+    ensure
+      cmd('logout')
+    end
+  end
+end

data/lib/xlogin/{firmware_templates → templates}/vyos.rb

@@ -24,5 +24,3 @@ Xlogin.configure :vyos do |os|
     end
   end
 end
-
-Xlogin.alias :edgeos, :vyos

data/lib/xlogin/version.rb

@@ -1,3 +1,3 @@
 module Xlogin
-  VERSION = "0.3.7"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlogin
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 0.4.1
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,17 +73,16 @@ files:
 - lib/xlogin/delegator.rb
 - lib/xlogin/firmware.rb
 - lib/xlogin/firmware_factory.rb
-- lib/xlogin/firmware_templates/vyos.rb
 - lib/xlogin/gateway.rb
 - lib/xlogin/rake_task.rb
-- lib/xlogin/rspec.rb
-- lib/xlogin/rspec/context.rb
-- lib/xlogin/rspec/resource.rb
-- lib/xlogin/scanner.rb
 - lib/xlogin/session.rb
 - lib/xlogin/ssh.rb
 - lib/xlogin/telnet.rb
-- lib/xlogin/thread_safe.rb
+- lib/xlogin/templates/ios.rb
+- lib/xlogin/templates/iosxr.rb
+- lib/xlogin/templates/junos.rb
+- lib/xlogin/templates/sros.rb
+- lib/xlogin/templates/vyos.rb
 - lib/xlogin/version.rb
 - xlogin.gemspec
 homepage: https://github.com/haccht/xlogin

data/lib/xlogin/rspec.rb

@@ -1,80 +0,0 @@
-require 'rspec'
-require 'stringio'
-
-require 'xlogin/rspec/context'
-require 'xlogin/rspec/resource'
-
-module Xlogin
-
-  module RSpecResourceHelper
-    def node(name)
-      Resources::NodeResource.new(name)
-    end
-
-    def command(str)
-      Resources::CommandResource.new(str)
-    end
-
-    def backend
-      unless @backend
-        context = Xlogin::Contexts.from_example(self)
-        @backend = context.session if context && context.respond_to?(:session)
-      end
-      @backend
-    end
-  end
-
-  module RSpecHelper
-    def current_context
-      @context
-    end
-
-    def method_missing(name, *args, &block)
-      if current_context.respond_to?(name)
-        current_context.send(name, *args, &block)
-      else
-        super(name, *args, &block)
-      end
-    end
-  end
-
-end
-
-
-include Xlogin::RSpecResourceHelper
-module RSpec
-  Matchers.define :match do |expected|
-    match do |actual|
-      response = actual.to_s.lines.slice(1..-1).join
-      expected =~ response
-    end
-
-    failure_message do |actual|
-      message = StringIO.new
-      message.puts "Expect response to match #{expected.inspect}"
-      message.puts "Result:"
-      message.puts actual.to_s.lines.slice(1..-2).map { |line| " +#{line}" }
-      message.string
-    end
-
-    failure_message_when_negated do |actual|
-      message = StringIO.new
-      message.puts "Expect response not to match #{expected.inspect}"
-      message.puts "Result:"
-      message.puts actual.to_s.lines.slice(1..-2).map { |line| " +#{line}" }
-      message.string
-    end
-  end
-
-  configure do |config|
-    config.include Xlogin::RSpecHelper
-
-    config.before(:all) do
-      @context = Xlogin::Contexts.from_example(self.class)
-    end
-
-    config.before(:each) do
-      @context = Xlogin::Contexts.from_example(RSpec.current_example)
-    end
-  end
-end

data/lib/xlogin/rspec/context.rb

@@ -1,58 +0,0 @@
-module Xlogin
-  module Contexts
-
-    class << self
-      def from_example(example)
-        example_group = example.example_group
-
-        node_resource    = find_resource(Resources::NodeResource, example_group)
-        command_resource = find_resource(Resources::CommandResource, example_group)
-
-        return nil if node_resource.nil? && command_resource.nil?
-        return NodeContext.new(node_resource.session) if command_resource.nil?
-
-        CommandContext.new(node_resource.session, command_resource.text)
-      end
-
-      def find_resource(klass, example_group)
-        arg = example_group.metadata[:description_args][0]
-        return arg if arg.is_a?(klass)
-
-        parent = example_group.parent_groups[1]
-        find_resource(klass, parent) if parent
-      end
-    end
-
-    class NodeContext
-      attr_reader :session
-
-      def initialize(session)
-        @session = session
-      end
-
-      def name
-        @session.name
-      end
-    end
-
-    class CommandContext
-      class << self
-        def response_cache
-          @cache ||= {}
-        end
-      end
-
-      attr_reader :session, :command
-
-      def initialize(session, command)
-        @session = session
-        @command = command 
-      end
-
-      def response
-        self.class.response_cache[[@session.name, @command]] ||= @session.cmd(@command)
-      end
-    end
-
-  end
-end

data/lib/xlogin/rspec/resource.rb

@@ -1,31 +0,0 @@
-module Xlogin
-  module Resources
-
-    class NodeResource
-      def initialize(name)
-        @name = name
-      end
-
-      def session
-        @session ||= Xlogin.get(@name)
-      end
-
-      def to_s
-        "Node '#{session.name}'"
-      end
-    end
-
-    class CommandResource
-      attr_reader :text
-
-      def initialize(text)
-        @text = text
-      end
-
-      def to_s
-        "with command '#{text}'"
-      end
-    end
-
-  end
-end

data/lib/xlogin/scanner.rb

@@ -1,88 +0,0 @@
-require 'xlogin'
-require 'xlogin/thread_safe'
-
-module Xlogin
-
-  class Scanner
-    class << self
-      def login_opts(**opts)
-        @login_opts = opts unless opts.empty?
-        @login_opts || {}
-      end
-    end
-
-    def initialize
-      @sessions = Hash.new
-      @scan_db  = Hash.new
-      @queries  = Array.new
-    end
-
-    def ids
-      @scan_db.keys
-    end
-
-    def sessions(&block)
-      hostnames = @queries.map { |_, hostname, _| hostname }.uniq
-      sessions  = hostnames.map { |hostname| session(hostname) }
-      sessions.each { |s| block.call(s) } if block
-      sessions
-    end
-
-    def define(id, &block)
-      type = ScanType.new
-      type.instance_eval(&block)
-
-      @scan_db[id] = type
-    end
-
-    def add(id, hostname, *args)
-      @queries << [id, hostname, *args]
-    end
-
-    def scan
-      data  = Hash.new
-      cache = Hash.new
-
-      threads = @queries.map do |req_key|
-        Thread.new do
-          id, hostname, *args = *req_key
-          type = @scan_db[id]
-
-          command = type.command.call(*args)
-          content = session(hostname).thread_safe { |s| s.cmd(command) }
-          matched = type.scanner.call(content)
-
-          cache[[hostname, command]] ||= content
-          data[req_key] = matched
-
-          yield(req_key, matched) if block_given?
-        end
-      end
-      threads.each { |th| th.join }
-
-      data
-    end
-
-    def close
-      sessions { |s| s.close }
-    end
-
-    private
-    def session(hostname)
-      @sessions[hostname] ||= Xlogin.get(hostname, **Xlogin::Scanner.login_opts)
-    end
-  end
-
-  class ScanType
-    def command(val = nil, &block)
-      return @command unless val || block
-      @command = (val) ? lambda { val } : block
-    end
-
-    def scanner(&block)
-      return @scanner unless block
-      @scanner = block
-    end
-  end
-
-end

data/lib/xlogin/thread_safe.rb

@@ -1,25 +0,0 @@
-require 'thread'
-require 'timeout'
-
-module Xlogin
-  module Session
-    def thread_safe(timeout: @timeout, maximum_retry: 1)
-      @safe_session = self
-      @safe_session_mutex ||= Mutex.new
-
-      Timeout.timeout(timeout) do
-        @safe_session_mutex.synchronize do
-          retry_count = 0
-          begin
-            @safe_session ||= Xlogin.get(@host, @opts)
-            yield @safe_session
-          rescue Errno::ECONNRESET => e
-            raise e unless (retry_count += 1) < maximum_retry
-            @safe_session = nil
-            retry
-          end
-        end
-      end
-    end
-  end
-end