xlogin 0.7.16 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c724426e5a7a390655bde1100323aa82b3e7189e
-  data.tar.gz: 2e1f06d01d84439fdbce0acd48487d1ffb6fec6d
+  metadata.gz: 1d9a1b26c54a0a1729282e93dca1abcc8dfc1336
+  data.tar.gz: 41c331ddf6bf109f0ef85b79d79f0f841dbb787c
 SHA512:
-  metadata.gz: a878236af348f8b765472712079c09dc7847d6db5a0521c1913edd62fb4efd63cd24411386b320912c24ed504a56acf1b8a3267db8ba2c4ef2f63abf8869a234
-  data.tar.gz: 6d48c122220ce879f30933a866773b9d2bd0879059cca7ea0419f7cb9b6aef6a08d6680f0e5629f8a44689e1efd4c0e85d1e6199775379e340c44908f325e6b8
+  metadata.gz: 5c472d2e2fbe03a9b2bcfc088fe3a5143ac0fa20253c53c07dc84604ebd4fdbab787343bbd8e06e1f5eea259d1ff8894055e6a7f3dc0e7ecc855d472584c660c
+  data.tar.gz: b46d85dca28cf7643e2c85fb517bf4c86a5a58418b76f88b3011436e2b4bdb04f1a2b1221c55a83923b3a33dcedfcbde2bd5de3f4591725e66a8725dae803636

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    xlogin (0.8.0)
+      net-ssh
+      net-ssh-gateway
+      net-ssh-telnet
+      net-telnet
+      parallel
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    net-ssh (4.2.0)
+    net-ssh-gateway (2.0.0)
+      net-ssh (>= 4.0.0)
+    net-ssh-telnet (0.2.1)
+      net-ssh (>= 2.0.1)
+    net-telnet (0.1.1)
+    parallel (1.12.1)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.13)
+  rake (~> 10.0)
+  xlogin!
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -3,12 +3,12 @@ rancid clogin alternative.
 
 ## Usage
 
-ネットワークデバイスへのログインを自動化するツール群。  
-`~/.xlogin.d/`へファームウェア毎の仕様を記述することで対象機器を拡大可能。
+ネットワークデバイスへのログイン処理を自動化するツール群。  
+`~/.xlogin.d/`にファームウェア毎のログイン仕様(template)を記述することで自働化対象機器を任意に設定可能。
+templateの記述例は[lib/xlogin/templates](https://github.com/haccht/xlogin/tree/master/lib/xlogin/templates)を参照のこと。
 
-
-各個別装置毎のログインのための認証情報は`~/.xloginrc`へ記述しておく。  
-`.xloginrc`のフォーマットはDSL形式で下記の通り
+各個別装置毎のログインのための認証情報は`~/.xloginrc`へ記述する。  
+`.xloginrc`のフォーマットはDSL形式で下記の通り。
 
 ~~~
 #hosttype	hostname	telnet_uri_scheme	options
@@ -16,6 +16,18 @@ vyos	'vyos01',	'telnet://vagrant:vagrant@127.0.0.1:2200'
 vyos	'vyos02',	'telnet://vagrant:vagrant@127.0.0.1:2201'
 ~~~
 
+下記コマンドでvyos01へ自動ログインし、プロンプトをユーザに渡す。
+
+~~~sh
+xlogin vyos01
+~~~
+
+また下記コマンドでvyos01,vyos02へ同時に自動ログインし、コマンドを一括投入する。
+
+~~~sh
+xlogin 'vyos*' exec 'show configuration command | no-more; exit' -j 2
+~~~
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/xlogin/cli.rb

@@ -8,123 +8,110 @@ require 'stringio'
 module Xlogin
   class CLI
 
+    DEFAULT_INVENTORY_FILE = File.join(ENV['HOME'], '.xloginrc')
+    DEFAULT_TEMPLATE_DIR   = File.join(ENV['HOME'], '.xlogin.d')
+
     def self.run(args = ARGV)
       config = getopts(args)
       client = Xlogin::CLI.new
-
-      task = config.task.downcase.tr('-', '_')
-      Xlogin::CLI.usage("Task not defined - #{task}") unless client.respond_to?(task)
-      client.method(task).call(config)
+      client.method(config.taskname).call(config)
     end
 
     def self.getopts(args)
       config = OpenStruct.new(
-        task: 'tty',
-        hostlist:  [],
-        parallels: 1,
+        parallel:  1,
         inventory: nil,
         templates: [],
       )
 
       parser = OptionParser.new
-      parser.banner += ' HOST-PATTERN'
-
-      parser.on('-m TASK', '--task', String, 'Execute the TASK(default: tty).') { |v| config.task = v }
-      parser.on('-a ARGS', '--args', String, 'The ARGS to pass to the task.')   { |v| config.args = v }
-
-      parser.on('-i PATH',      '--inventory',    String, 'The PATH to the inventory file (default: $HOME/.xloginrc).') { |v| config.inventory = v }
-      parser.on('-t PATH',      '--template',     String, 'The PATH to the template file.')       { |v| config.templates << v }
-      parser.on('-T DIRECTORY', '--template-dir', String, 'The DIRECTORY to the template files.') { |v| config.templates += Dir.glob(File.join(v, '*.rb')) }
-      parser.on('-l [DIRECTORY]', '--log',        String, 'The DIRECTORY to the output log file (default: $PWD/log).') { |v| config.logdir = v || ENV['PWD'] }
-
-      parser.on('-p NUM', '--parallels',  Integer,   'The NUM of the threads. (default: 5).') { |v| config.parallels  = v }
-      parser.on('-e',     '--enable',     TrueClass, 'Try to gain enable priviledge.')        { |v| config.enable = v }
-      parser.on('-y',     '--assume-yes', TrueClass, 'Always answer "yes" if confirmed.')     { |v| config.assume_yes = v }
-      parser.on('-h',     '--help', 'Show this message.') { Xlogin::CLI.usage }
-
-      self.class.module_eval do
-        define_method(:usage) do |message = nil|
-          puts message if message
-          puts parser.to_s
-          exit 1
+      parser.banner  = "#{File.basename($0)} HOST [TASK ARGUMENTS] [Options]"
+      parser.version = Xlogin::VERSION
+
+      parser.on('-i PATH',        '--inventory',    String, 'The PATH to the inventory file(default: $HOME/.xloginrc).') { |v| config.inventory = v }
+      parser.on('-t PATH',        '--template',     String, 'The PATH to the template file.') { |v| config.templates << v }
+      parser.on('-T DIRECTORY',   '--template-dir', String, 'The DIRECTORY of the template files.') { |v| config.templates += Dir.glob(File.join(v, '*.rb')) }
+      parser.on('-L [DIRECTORY]', '--log-dir',      String, 'The DIRECTORY of the log files(default: $PWD).') { |v| config.logdir = v || '.' }
+
+      parser.on('-j NUM', '--jobs',       Integer,   'The NUM of jobs to execute in parallel(default: 1).') { |v| config.parallel = v }
+      parser.on('-e',     '--enable',     TrueClass, 'Try to gain enable priviledge.') { |v| config.enable = v }
+      parser.on('-y',     '--assume-yes', TrueClass, 'Automatically answer yes to prompts.') { |v| config.authorize = v }
+
+      begin
+        args = parser.parse!(args)
+        hostlist = args.shift
+        taskname = args.shift || 'tty'
+
+        Xlogin.configure do
+          config.inventory ||= DEFAULT_INVENTORY_FILE
+          if config.templates.empty?
+            generate_templates(DEFAULT_TEMPLATE_DIR) unless File.exist?(DEFAULT_TEMPLATE_DIR)
+            config.templates += Dir.glob(File.join(DEFAULT_TEMPLATE_DIR, '*.rb'))
+          end
+
+          authorize(config.authorize)
+          source(File.expand_path(config.inventory, ENV['PWD']))
+          load_templates(*config.templates.map { |file| File.expand_path(file, ENV['PWD']) })
         end
-      end
 
-      args = parser.parse(args)
-      Xlogin.configure do
-        template(*config.templates)
-        source(config.inventory)
-        authorize(config.assume_yes)
-      end
+        config.hostlist  = hostlist.to_s.split(',').flat_map { |pattern| Xlogin.factory.list(pattern) }
+        config.taskname  = taskname.to_s.downcase.tr('-', '_')
+        config.arguments = args
 
-      config.hostlist += args.flat_map do |target|
-        hostlist = Xlogin.factory.list(target)
-        hostlist.tap { |e| raise "Invalid inventory - #{target}" if e.empty? }
+        methods = Xlogin::CLI.instance_methods(false)
+        raise "No host found: `#{hostlist}`"   if config.hostlist.empty?
+        raise "No task defined: `#{taskname}`" if config.taskname.empty? || methods.find_index(config.taskname.to_sym).nil?
+      rescue => e
+        $stderr.puts e, '', parser
+        exit 1
       end
 
-      config.parallels = [config.parallels, config.hostlist.size].min
       config
     end
 
-    def tty(config)
-      config.hostlist = [config.hostlist.shift].compact
-      Xlogin::CLI.usage('Invalid inventory.') if config.hostlist.empty?
-
-      puts "Trying #{config.hostlist.first[:name]}..."
-      puts "Escape character is '^]'."
+    def list(config)
+      width = config.hostlist.map { |e| e[:name].length }.max
+      $stdout.puts config.hostlist.map { |e| "#{e[:name].to_s.ljust(width)} #{e[:type]}" }.sort
+    end
 
-      login(config) do |session|
-        session.interact!
-      end
+    def tty(config)
+      target = config.hostlist.sort_by { |e| e[:name] }.first
+      $stdout.puts "Trying #{target[:name]}...", "Escape character is '^]'."
+      config.hostlist = [target]
+      login(config) { |session| session.interact! }
     end
 
     def exec(config)
-      Xlogin::CLI.usage('Invalid inventory.') if config.hostlist.empty?
-
-      login(config) do |session|
-        command_lines = ['', *config.args.split(';')]
-        command_lines.each { |command| session.cmd(command) }
-      end
+      command_lines = ['', *config.arguments.flat_map { |e| e.split(';') }].map(&:strip)
+      login(config) { |session| command_lines.each { |command| session.cmd(command) } }
     end
 
     def load(config)
-      Xlogin::CLI.usage('Invalid inventory.') if config.hostlist.empty?
-
-      login(config) do |session|
-        command_lines = ['', *IO.readlines(config.args.to_s)]
-        command_lines.each { |command| session.cmd(command) }
-      end
-    end
-
-    def list(config)
-      config.hostlist += Xlogin.factory.list('all') if config.hostlist.empty?
-      width = config.hostlist.map { |e| e[:name].length }.max
-      puts config.hostlist.map { |e| "#{e[:name].to_s.ljust(width)} #{e[:type]}" }.sort
+      command_lines = ['', *config.arguments.flat_map { |e| IO.readlines(e) }].map(&:strip)
+      login(config) { |session| command_lines.each { |command| session.cmd(command) } }
     end
 
     private
     def login(config, &block)
-      buffer  = StringIO.new
-
-      Parallel.map(config.hostlist, in_thread: config.parallels) do |hostinfo|
+      Parallel.map(config.hostlist, in_threads: config.parallel) do |hostinfo|
         begin
+          buffer   = StringIO.new
           hostname = hostinfo[:name]
 
           loggers  = []
-          loggers << buffer  if config.parallels != 1
-          loggers << $stdout if config.parallels == 1
-          loggers << File.join(config.logdir, "#{hostname}.log") if config.logdir
+          loggers << ((config.parallel > 1)? buffer : $stdout)
+          loggers << File.expand_path(File.join(config.logdir, "#{hostname}.log"), ENV['PWD']) if config.logdir
 
           session = Xlogin.get(hostinfo.merge(log: loggers))
-          session.enable if session.config.enable && config.enable
+          session.enable if config.enable && hostinfo[:enable]
 
           block.call(session)
         rescue => e
-          lines = (config.parallels > 1)? ["\n#{hostname}\t| [Error] #{e}"] : ["\n[Error] #{e}"]
+          lines = (config.parallel > 1)? ["\n#{hostname}\t| [Error] #{e}"] : ["\n[Error] #{e}"]
           lines.each { |line| $stderr.print "#{line.chomp}\n" }
         end
 
-        if config.parallels > 1
+        if config.parallel > 1
           lines = buffer.string.lines.map { |line| "#{hostname}\t| " + line.gsub("\r", '') }
           lines.each { |line| $stdout.print "#{line.chomp}\n" }
         end

data/lib/xlogin/factory.rb

@@ -10,12 +10,11 @@ module Xlogin
     def initialize
       @database  = Hash.new
       @templates = Hash.new
-      @group     = nil
     end
 
     def source(*files)
       files.compact.each do |file|
-        file = File.expand_path(file)
+        raise SessionError.new("Inventory file not found: #{file}") unless File.exist?(file)
         instance_eval(IO.read(file)) if File.exist?(file)
       end
     end
@@ -29,19 +28,17 @@ module Xlogin
       @database[name]
     end
 
-    def list(name = nil)
-      keys = @database.keys
-      keys = keys.select { |key| key =~ /^#{name}(:|$)/ } unless name.nil? || name.to_s == 'all'
-      @database.values_at(*keys)
+    def list(pattern = nil)
+      key, val = pattern.to_s.split(':')
+      key, val = 'name', (key || '*') if val.nil?
+      @database.values.select { |info| File.fnmatch(val, info[key.to_sym]) }
     end
 
     def source_template(*files)
       files.compact.each do |file|
-        file = File.expand_path(file)
+        raise TemplateError.new("Template file not found: #{file}") unless File.exist?(file)
         name = File.basename(file, '.rb').scan(/\w+/).join('_')
-        next unless File.exist?(file)
-
-        set_template(name, IO.read(file))
+        set_template(name, IO.read(file)) if File.exist?(file)
       end
     end
 
@@ -59,13 +56,6 @@ module Xlogin
       @templates.keys
     end
 
-    def group(group_name)
-      current_group = @group
-      @group = [current_group, group_name.to_s].compact.join(':')
-      yield
-      @group = current_group
-    end
-
     def build(type:, uri:, **opts)
       template = get_template(type)
       template.build(uri, **opts)
@@ -82,7 +72,7 @@ module Xlogin
       super unless caller_locations.first.label == 'block in source' and args.size >= 2
 
       type = method_name.to_s.downcase
-      name = [@group, args.shift].compact.join(':')
+      name = args.shift
       uri  = args.shift
       opts = args.shift || {}
       set(type: type, name: name, uri: uri, **opts)

data/lib/xlogin/version.rb

@@ -1,3 +1,3 @@
 module Xlogin
-  VERSION = "0.7.16"
+  VERSION = "0.8.0"
 end

data/lib/xlogin.rb

@@ -6,10 +6,6 @@ require 'xlogin/version'
 
 module Xlogin
 
-  DEFAULT_INVENTORY_FILE = File.join(ENV['HOME'], '.xloginrc')
-  DEFAULT_TEMPLATE_DIR   = File.join(ENV['HOME'], '.xlogin.d')
-  BUILTIN_TEMPLATE_FILES = Dir.glob(File.join(File.dirname(__FILE__), 'xlogin', 'templates', '*.rb'))
-
   class SessionError       < StandardError; end
   class TemplateError      < StandardError; end
   class AuthorizationError < StandardError; end
@@ -45,29 +41,29 @@ module Xlogin
       @authorized == true
     end
 
+    def generate_templates(dir)
+      FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+      builtin_templates = Dir.glob(File.join(File.dirname(__FILE__), 'xlogin', 'templates', '*.rb'))
+      builtin_templates.each { |file| FileUtils.cp(file, DEFAULT_TEMPLATE_DIR) }
+    end
+
     private
-    def authorize(boolean = false, &block)
+    def authorize(boolean = true, &block)
       @authorized = boolean == true || (block && block.call == true)
     end
 
-    def source(source_file = nil)
-      factory.source(source_file || DEFAULT_INVENTORY_FILE)
+    def source(*source_files)
+      factory.source(*source_files)
     end
 
     def template(*template_dirs)
       files = template_dirs.flat_map { |dir| Dir.glob(File.join(dir, '*.rb')) }
-      load_template(*files)
+      load_templates(*files)
     end
     alias_method :template_dir, :template
 
-    def load_template(*template_files)
-      return factory.source_template(*template_files) unless template_files.empty?
-
-      unless Dir.exist?(DEFAULT_TEMPLATE_DIR)
-        FileUtils.mkdir_p(DEFAULT_TEMPLATE_DIR)
-        BUILTIN_TEMPLATE_FILES.each { |file| FileUtils.cp(file, DEFAULT_TEMPLATE_DIR) }
-      end
-      template_dir(DEFAULT_TEMPLATE_DIR)
+    def load_templates(*template_files)
+      factory.source_template(*template_files)
     end
 
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xlogin
 version: !ruby/object:Gem::Version
-  version: 0.7.16
+  version: 0.8.0
 platform: ruby
 authors:
 - haccht
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-15 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-telnet
@@ -121,6 +121,7 @@ files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile