free-range 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8cef8634d2f2d3e9e90289e4098b5bac3341872844764b0db4bca9e0b3bdaf0e
-  data.tar.gz: ca753e285e70bce1f8ca7d947c56d76683901666c103765de05a6f58a36c879b
+  metadata.gz: a0252edadec09077b1c95f148f2e5dec18a0faf393f7c9b225fc0ca0962b06af
+  data.tar.gz: f45851705405c80dd7ec484c439711716146317e0b19efdba3e4d756f5fce2fa
 SHA512:
-  metadata.gz: ac8287096aa861556171e3b7ad393640ff4193e16de0d062666f0b576b80b6768aaa96fa47e511ab8b94ce4e0473cec28c7f402b89b5c76f691c72d62e017934
-  data.tar.gz: 9a2778e40dd3a4e189ebe32bd5e56b0676d08be1bb05f13f9c3b08378d9c9a65638b5f0742bff33991f2e2521dd4549a2b9f112a526226f71889c1fde8116616
+  metadata.gz: 76e14e7c6e5a94c2f4a88fe987477e8ca960aab236fb2d63b24e7655a694d5e0da57a0b08aee141c4f6b4ecd4e1ec2caf64d671703033ab626a725de30c4a9a5
+  data.tar.gz: 879632d0abb8539b61b99e49af8bf427b786163be9e669e0a5542f2286234666d9c183a360fe21cac97bc9debb1ad97e816b15f18bd1cb494adfb205252c43ad

data/lib/free-range.rb

@@ -3,7 +3,6 @@ require 'rmagick'
 require 'fileutils'
 
 module FreeRange
-
   # Перевірка наявності ImageMagick
   begin
     require 'rmagick'
@@ -13,6 +12,60 @@ module FreeRange
     exit 1
   end
 
+  # Клас для зберігання конфігураційних команд
+  class Config
+    attr_accessor :username, :password
+
+    # Ініціалізує об’єкт конфігурації
+    # @param login [Hash] Hash with target, username, and password
+    # @yield [self] Yields self for block-based configuration
+    def initialize(login)
+      @login = login
+      @username = nil
+      @password = nil
+      yield self if block_given?
+    end
+
+    # Повертає команду SSH
+    # @return [String] SSH command string
+    def ssh_command
+      "sshpass -p \"#{@login[:password]}\" ssh -C -x -4 -o StrictHostKeyChecking=no #{@login[:username]}@#{@login[:target]}"
+    end
+
+    # Повертає команду для отримання даних про передплатників
+    # @return [String] Subscribers command string
+    def subscribers_command
+      "ssh -C -x roffice /usr/local/share/noc/bin/radius-subscribers"
+    end
+
+    # Повертає команду для отримання списку інтерфейсів
+    # @return [String] Command to fetch interfaces
+    def command_interfaces
+      'show configuration interfaces | no-more | display set | match dynamic-profile | match "ranges ([0-9]+(-[0-9]+)?)"'
+    end
+
+    # Повертає команду для отримання діапазонів VLAN
+    # @param interface [String, nil] Interface name or nil for all interfaces
+    # @return [String] Command to fetch VLAN ranges
+    def command_ranges(interface = nil)
+      interface ? "show configuration interfaces #{interface} | no-more | display set | match dynamic-profile | match \"ranges ([0-9]+(-[0-9]+)?)\"" : 'show configuration interfaces | no-more | display set | match dynamic-profile | match "ranges ([0-9]+(-[0-9]+)?)"'
+    end
+
+    # Повертає команду для отримання демультиплексорних VLAN
+    # @param interface [String, nil] Interface name or nil for all interfaces
+    # @return [String] Command to fetch demux VLANs
+    def command_demux(interface = nil)
+      interface ? "show configuration interfaces #{interface} | display set | match unnumbered-address" : 'show configuration interfaces | display set | match unnumbered-address'
+    end
+
+    # Повертає команду для отримання інших VLAN
+    # @param interface [String, nil] Interface name or nil for all interfaces
+    # @return [String] Command to fetch other VLANs
+    def command_another(interface = nil)
+      interface ? "show configuration interfaces #{interface} | display set | match vlan-id" : 'show configuration interfaces | display set | match vlan-id'
+    end
+  end
+
   # Абстрактний клас для роботи з VLAN
   class VlanContainer
     def initialize
@@ -20,16 +73,20 @@ module FreeRange
     end
 
     # Додаємо VLAN до списку (віртуальний метод, може бути перевизначений)
+    # @param vlan [Integer] VLAN ID to add
+    # @return [void]
     def add_vlan(vlan)
       @vlans << vlan
     end
 
     # Повертаємо масив VLAN
+    # @return [Array<Integer>] Sorted array of unique VLAN IDs
     def vlans
       @vlans.uniq.sort
     end
 
     # Створюємо хеш діапазонів із VLAN
+    # @return [Hash{Integer => Integer}] Hash mapping range start to range end
     def ranges
       return {} if @vlans.empty?
 
@@ -59,16 +116,23 @@ module FreeRange
     end
 
     # Додаємо діапазон до списку VLAN-ів
+    # @param start [Integer] Start of VLAN range
+    # @param finish [Integer] End of VLAN range
+    # @return [void]
     def add_range(start, finish)
       (start..finish).each { |vlan| @vlans << vlan }
     end
 
     # Додаємо діапазон до списку "інших" VLAN-ів
+    # @param start [Integer] Start of another VLAN range
+    # @param finish [Integer] End of another VLAN range
+    # @return [void]
     def add_another_range(start, finish)
       (start..finish).each { |vlan| @another_in_ranges << vlan }
     end
 
     # Повертаємо масив "інших" VLAN-ів
+    # @return [Array<Integer>] Sorted array of unique "another" VLAN IDs
     def another_in_ranges
       @another_in_ranges.uniq.sort
     end
@@ -84,6 +148,9 @@ module FreeRange
 
   # Клас для виводу даних
   class Print
+    # Виводить хеш діапазонів VLAN у порядку зростання
+    # @param ranges [Ranges] Object containing VLAN ranges
+    # @return [void]
     def self.ranged(ranges)
       puts "\nСформований хеш діапазонів (в порядку зростання):"
       if ranges.ranges.empty?
@@ -95,6 +162,9 @@ module FreeRange
       end
     end
 
+    # Виводить зайняті VLAN-и в межах діапазонів у порядку зростання
+    # @param vlans [Vlans] Object containing VLANs
+    # @return [void]
     def self.vlans(vlans)
       puts "\nЗайняті VLAN-и в межах діапазонів (в порядку зростання):"
       if vlans.vlans.empty?
@@ -104,6 +174,9 @@ module FreeRange
       end
     end
 
+    # Виводить діапазони VLAN-ів у порядку зростання
+    # @param vlans [Vlans] Object containing VLANs
+    # @return [void]
     def self.vlan_ranges(vlans)
       puts "\nДіапазони VLAN-ів (в порядку зростання):"
       vlan_ranges = vlans.vlan_ranges
@@ -116,6 +189,13 @@ module FreeRange
       end
     end
 
+    # Виводить комбіновані діапазони VLAN зі статусами
+    # @param ranges [Ranges] Object containing VLAN ranges
+    # @param vlans [Vlans] Object containing VLANs
+    # @param use_color [Boolean] Enable colored output
+    # @param target [String] Target device hostname
+    # @param interface [String, nil] Interface name or nil
+    # @return [void]
     def self.combined_ranges(ranges, vlans, use_color, target, interface = nil)
       if ranges.ranges.empty?
         puts "Не знайдено діапазонів."
@@ -142,6 +222,13 @@ module FreeRange
       puts result.join(',')
     end
 
+    # Виводить таблицю розподілу VLAN
+    # @param ranges [Ranges] Object containing VLAN ranges
+    # @param vlans [Vlans] Object containing VLANs
+    # @param use_color [Boolean] Enable colored output
+    # @param target [String] Target device hostname
+    # @param interface [String, nil] Interface name or nil
+    # @return [void]
     def self.table(ranges, vlans, use_color, target, interface = nil)
       puts "VLAN Distribution for #{target}#{interface ? " (#{interface})" : ''}"
       all_vlans, status_counts = build_vlan_statuses(ranges, vlans)
@@ -191,6 +278,13 @@ module FreeRange
       puts summary_text
     end
 
+    # Зберігає таблицю розподілу VLAN як PNG-зображення
+    # @param ranges [Ranges] Object containing VLAN ranges
+    # @param vlans [Vlans] Object containing VLANs
+    # @param path [String] Directory path to save the PNG
+    # @param target [String] Target device hostname
+    # @param interface [String, nil] Interface name or nil
+    # @return [void]
     def self.table_png(ranges, vlans, path, target, interface = nil)
       all_vlans, status_counts = build_vlan_statuses(ranges, vlans)
       cell_width = 12
@@ -307,6 +401,10 @@ module FreeRange
 
     private
 
+    # Будує хеш статусів VLAN і підраховує кількість кожного статусу
+    # @param ranges [Ranges] Object containing VLAN ranges
+    # @param vlans [Vlans] Object containing VLANs
+    # @return [Array<Hash, Hash>] Hash of VLAN statuses and status counts
     def self.build_vlan_statuses(ranges, vlans)
       all_vlans = {}
       ranges.ranges.each do |start, finish|
@@ -321,6 +419,12 @@ module FreeRange
       [all_vlans, status_counts]
     end
 
+    # Форматує діапазон VLAN зі статусом для виводу
+    # @param start [Integer] Start of VLAN range
+    # @param finish [Integer] End of VLAN range
+    # @param status [String] VLAN status ('f', 'b', 'e', 'c', 'a', 'u')
+    # @param use_color [Boolean] Enable colored output
+    # @return [String] Formatted range string
     def self.format_range(start, finish, status, use_color)
       range_text = start == finish ? "#{start}" : "#{start}-#{finish}"
       range_text_with_status = "#{range_text}(#{status})"
@@ -339,6 +443,10 @@ module FreeRange
       end
     end
 
+    # Форматує символ для таблиці VLAN
+    # @param status [String] VLAN status ('f', 'b', 'e', 'c', 'a', 'u', or ' ')
+    # @param use_color [Boolean] Enable colored output
+    # @return [String] Formatted character for table display
     def self.format_table_char(status, use_color)
       if use_color
         case status
@@ -357,12 +465,14 @@ module FreeRange
   end
 
   # Метод для заповнення Ranges для одного інтерфейсу
-  def self.process_interface(ssh_command, interface, ranges)
-    command_ranges = interface ? "show configuration interfaces #{interface} | no-more | display set | match dynamic-profile | match \"ranges ([0-9]+(-[0-9]+)?)\"" : 'show configuration interfaces | no-more | display set | match dynamic-profile | match "ranges ([0-9]+(-[0-9]+)?)"'
-    command_demux = interface ? "show configuration interfaces #{interface} | display set | match unnumbered-address" : 'show configuration interfaces | display set | match unnumbered-address'
-    command_another = interface ? "show configuration interfaces #{interface} | display set | match vlan-id" : 'show configuration interfaces | display set | match vlan-id'
-
-    full_cmd = "#{ssh_command} '#{command_ranges}'"
+  # @param config [Config] Configuration object with commands
+  # @param interface [String, nil] Interface name or nil for all interfaces
+  # @param ranges [Ranges] Object to store VLAN ranges
+  # @param debug [Boolean] Enable debug output
+  # @return [void]
+  def self.process_interface(config, interface, ranges, debug = false)
+    full_cmd = "#{config.ssh_command} '#{config.command_ranges(interface)}'"
+    puts "[DEBUG] Executing command: #{full_cmd}" if debug
     result = `#{full_cmd}`.strip
     unless result.empty?
       result.each_line do |line|
@@ -374,7 +484,8 @@ module FreeRange
       end
     end
 
-    full_cmd = "#{ssh_command} '#{command_demux}'"
+    full_cmd = "#{config.ssh_command} '#{config.command_demux(interface)}'"
+    puts "[DEBUG] Executing command: #{full_cmd}" if debug
     result = `#{full_cmd}`.strip
     unless result.empty?
       result.each_line do |line|
@@ -388,7 +499,8 @@ module FreeRange
       end
     end
 
-    full_cmd = "#{ssh_command} '#{command_another}'"
+    full_cmd = "#{config.ssh_command} '#{config.command_another(interface)}'"
+    puts "[DEBUG] Executing command: #{full_cmd}" if debug
     result = `#{full_cmd}`.strip
     unless result.empty?
       result.each_line do |line|
@@ -404,10 +516,16 @@ module FreeRange
   end
 
   # Основна логіка виконання
+  # @return [void]
   def self.run
     options = {}
     OptionParser.new do |opts|
-      opts.banner = "Використання: free-range <IP-адреса або hostname> [опції]"
+      opts.banner = <<~BANNER
+        Використання: free-range <IP-адреса або hostname> [опції]
+
+        Аналізує розподіл VLAN на мережевих пристроях, генеруючи таблиці або PNG-зображення.
+      BANNER
+      opts.on("-h", "--help", "Показати цю довідку") { puts opts; exit 0 }
       opts.on("-u", "--username USERNAME", "Ім'я користувача для SSH") { |u| options[:username] = u }
       opts.on("-p", "--password PASSWORD", "Пароль для SSH") { |p| options[:password] = p }
       opts.on("-n", "--no-color", "Вимкнути кольоровий вивід") { options[:no_color] = true }
@@ -415,50 +533,72 @@ module FreeRange
       opts.on("-t", "--table", "Вивести діаграму розподілу VLAN-ів") { options[:table] = true }
       opts.on("-g", "--table-png PATH", "Зберегти діаграму розподілу VLAN-ів як PNG") { |path| options[:table_png] = path }
       opts.on("-i", "--interface INTERFACE", "Назва інтерфейсу або 'all'") { |i| options[:interface] = i }
+      opts.on("-c", "--config CONFIG_FILE", "Шлях до конфігураційного файлу") { |c| options[:config_file] = c }
     end.parse!
 
     if ARGV.empty?
       puts "Помилка: потрібно вказати IP-адресу або hostname роутера."
-      puts "Використання: free-range <IP-адреса або hostname> [-u|--username USERNAME] [-p|--password PASSWORD] [-n|--no-color] [-d|--debug] [-t|--table] [--table-png PATH] [-i|--interface INTERFACE]"
-      exit 1
-    end
-
-    username = options[:username] || ENV['WHOAMI']
-    password = options[:password] || ENV['WHATISMYPASSWD']
-    if username.nil? || password.nil?
-      puts "Помилка: необхідно вказати ім'я користувача та пароль."
-      puts "Використовуйте опції -u|--username і -p|--password або змінні оточення WHOAMI і WHATISMYPASSWD."
+      puts "Використовуйте: free-range --help для довідки."
       exit 1
     end
 
+    # Визначаємо змінні з опцій
     use_color = !options[:no_color] && ENV['TERM'] && ENV['TERM'] != 'dumb'
     debug = options[:debug]
     table_mode = options[:table]
     table_png_mode = options[:table_png]
     interface = options[:interface]
+    config_file = options[:config_file]
+
+    # Ініціалізуємо config з порожнім login
+    config = Config.new({ target: ARGV[0], username: nil, password: nil })
+
+    # Завантажуємо конфігураційний файл, якщо він вказаний
+    if config_file
+      begin
+        # Виконуємо конфігураційний файл у контексті існуючого об’єкта config
+        config.instance_eval(File.read(config_file), config_file)
+      rescue LoadError, Errno::ENOENT
+        puts "Помилка: неможливо завантажити конфігураційний файл '#{config_file}'."
+        exit 1
+      rescue ArgumentError => e
+        puts "Помилка в конфігураційному файлі '#{config_file}': #{e.message}"
+        exit 1
+      rescue StandardError => e
+        puts "Помилка в конфігураційному файлі '#{config_file}': #{e.message}"
+        exit 1
+      end
+    end
+
+    # Визначаємо username і password з пріоритетом: аргументи > config > ENV
+    username = options[:username] || config.username || ENV['WHOAMI']
+    password = options[:password] || config.password || ENV['WHATISMYPASSWD']
 
-#    # Перевірка формату інтерфейсу
-#    if interface && interface != "all" && interface !~ /^[a-z]+-\d+\/\d+\/\d+$/
-#      puts "Помилка: некоректна назва інтерфейсу. Використовуйте формат 'xe-0/0/2' або 'all'."
-#      exit 1
-#    end
+    if username.nil? || password.nil?
+      puts "Помилка: необхідно вказати ім'я користувача та пароль."
+      puts "Використовуйте опції -u/--username і -p/--password, конфігураційний файл або змінні оточення WHOAMI і WHATISMYPASSWD."
+      exit 1
+    end
 
     login = { target: ARGV[0], username: username, password: password }
     target = ARGV[0].split('.')[0]
     puts "Connecting to device: #{login[:target]}"
 
-    ssh_command = "sshpass -p \"#{login[:password]}\" ssh -C -x -4 -o StrictHostKeyChecking=no #{login[:username]}@#{login[:target]}"
-    subscribers_command = "ssh -C -x roffice /usr/local/share/noc/bin/radius-subscribers"
+    # Оновлюємо config з актуальними login даними
+    config = Config.new(login) { |c|
+      c.username = config.username if config.username
+      c.password = config.password if config.password
+    }
 
-    subscribers_result = `#{subscribers_command}`.strip
+    subscribers_result = `#{config.subscribers_command}`.strip
     if subscribers_result.empty?
       puts "Помилка: результат subscribers_command порожній. Перевір шлях або доступ."
       exit 1
     end
 
     if interface == "all"
-      command_interfaces = 'show configuration interfaces | no-more | display set | match dynamic-profile | match "ranges ([0-9]+(-[0-9]+)?)"'
-      full_cmd = "#{ssh_command} '#{command_interfaces}'"
+      full_cmd = "#{config.ssh_command} '#{config.command_interfaces}'"
+      puts "[DEBUG] Executing command: #{full_cmd}" if debug
       result = `#{full_cmd}`.strip
       if result.empty?
         puts "Помилка: результат команди порожній. Перевір підключення або команду."
@@ -481,7 +621,7 @@ module FreeRange
           end
         end
 
-        process_interface(ssh_command, intf, ranges)
+        process_interface(config, intf, ranges, debug)
         if debug
           puts "\nІнтерфейс: #{intf}"
           Print.ranged(ranges)
@@ -511,7 +651,7 @@ module FreeRange
         end
       end
 
-      process_interface(ssh_command, interface, ranges)
+      process_interface(config, interface, ranges, debug)
       if debug
         puts "\nІнтерфейс: #{interface}" if interface
         Print.ranged(ranges)