pingable_ipam_plugin 0.0.2 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5167c6a2b4558580a184c8f21d89054329acb2d87ab6b803b50f2838cd6d0c3f
-  data.tar.gz: 23f4fb9c0b37e4e5e2879092a5b00197b05655c4afb1e2574288a86e1edaaaec
+  metadata.gz: afb4f76ebb1e0b6ba231a0a52e696e78728abd2eb38ef75946397fc3531e4114
+  data.tar.gz: 402d327725e8605041658ba455b869f38ab09edc327d359e81b89155850c4194
 SHA512:
-  metadata.gz: 35052c2ee42d1f1e6d729eb6c13a03b014852aa75e457794c349ec122493ff85e6f1443f2be593185a4c1547e7d4161052b5a0109528e86a76c18485afa04c84
-  data.tar.gz: 27fb31ea168284836131069b6385a481d1709d21792f5e52cf674561d25cc9cd7f661418c087ddd725574ef34961619785d8b0991f032deaa6cbd79a8c3ef869
+  metadata.gz: 5755029b6b0c67cd28260d1e05715ac34fd04317cff271d9db4067e4f5094159c515da6a9bda1664586b95ba4deca91809542a080551ad49d3d521ec5fde4170
+  data.tar.gz: 2a8ccfb8448d928be6bd31a20a3db1a531c3fbe32e8baeabacc266570fe026f98035fbbdba9984e5e000d736b09f923d8faff018edc02b56ddbd96baeb604c32

data/README.md

@@ -3,6 +3,9 @@
 This IPAM mode extends the defaul Random DB adding one extra step
 before suggesting IP: ping that address and if it is pingable it will not be suggested.
 
+To prevent human error when the host is created without assigned subnet the plugin adds
+a new validation rule: the subnet must be selected.
+
 ## Installation
 
 See [How_to_Install_a_Plugin](http://projects.theforeman.org/projects/foreman/wiki/How_to_Install_a_Plugin)

data/app/models/concerns/pingable_ipam_plugin/nic_extensions.rb

@@ -0,0 +1,9 @@
+module PingableIpamPlugin
+  module NicExtensions
+    extend ActiveSupport::Concern
+    included do
+      validates :subnet_id, :presence => true, :if => Proc.new { |nic| nic.host_managed? && nic.primary? }
+    end
+  end
+end
+

data/app/services/ipam/ping_random_db.rb

@@ -1,5 +1,6 @@
 require 'timeout'
 require 'socket'
+require 'resolv'
 
 module IPAM
   class PingRandomDb < Base
@@ -7,8 +8,8 @@ module IPAM
       @generator ||= Random.new(mac ? mac.delete(':').to_i(16) : Random.new_seed)
     end
 
-    def random_ip
-      IPAddr.new(generator.rand(subnet_range.first.to_i..subnet_range.last.to_i), subnet.family)
+    def random_ip(range)
+      IPAddr.new(generator.rand(range.first.to_i..range.last.to_i), subnet.family)
     end
 
     def tcp_pingable?(ip)
@@ -32,34 +33,20 @@ module IPAM
       # Whether or not Errno::ECONNREFUSED is considered a successful ping
       @service_check = true
       @timeout = 1
-      @exception = nil
       bool = false
-      tcp = nil
 
       begin
-        Timeout.timeout(@timeout) do
-          begin
-            tcp = TCPSocket.new(ip, port)
-          rescue Errno::ECONNREFUSED => err
-            if @service_check
-              bool = true
-            else
-              @exception = err
-            end
-          rescue Exception => err
-            @exception = err
-          else
-            bool = true
-          end
+        bool = Socket.tcp(ip, port, connect_timeout: @timeout) { true }
+      rescue Errno::ECONNREFUSED
+        if @service_check
+          bool = true
         end
-      rescue Timeout::Error => err
-        @exception = err
-      ensure
-        tcp.close if tcp
+      rescue Exception
+        bool = false
       end
 
       if bool
-        logger.info "Succesful telnet ping #{ip}, port #{port}"
+        logger.info "[IPAM] Succesful telnet ping #{ip}, port #{port}"
       end
 
       bool
@@ -77,34 +64,63 @@ module IPAM
         system("ping -c 2 -W 1 #{ip} > /dev/null")
       end
     rescue => err
-      logger.debug "Unable to icmp ping #{ip} because #{err.inspect}."
+      logger.warn "[IPAM] Unable to icmp ping #{ip} because #{err.inspect}."
       true
     end
 
+    def ns_resolvable? ip
+      begin
+        name = Resolv.getname ip
+        logger.warn "[IPAM] Found a DNS resolvable IP #{ip}, resolved name: #{name}."
+        true
+      rescue StandardError
+        false
+      end
+    end
+
     # Safety check not to spend much CPU time when there are no many free IPs left. This gives up
     # in about a second on Ryzen 1700 running with Ruby 2.4.
     MAX_ITERATIONS = 100_000
 
     def suggest_ip
       iterations = 0
+      # Remove IPs already excluded or known.
+      range = subnet_range.to_a - excluded_ips.to_a
+      range -= subnet.known_ips.to_a
+
+      unless range.empty?
+        logger.info "[IPAM] IP range from #{range.first.to_s} to #{range.last.to_s}"
+      end
+
       loop do
+        if range.empty?
+          errors.add(:subnet, _('no free IP could be found in our DB, enlarge subnet range'))
+          return nil
+        end
+
         # next random IP from the sequence generated by MAC seed
-        candidate = random_ip
+        candidate = random_ip(range)
         iterations += 1
         break if iterations >= MAX_ITERATIONS
         # try to match it
         ip = candidate.to_s
+        # Check again if something has been changed.
         if !excluded_ips.include?(ip) && !subnet.known_ips.include?(ip)
-          logger.debug "Searching for free IP - pinging #{ip}."
+          logger.info "[IPAM] Searching for free IP - resolving #{ip}"
           if tcp_pingable?(ip) || icmp_pingable?(ip)
-            logger.warn("Found a pingable IP (#{ip}) address which not marked as known. Skipping it...")
+            logger.warn("[IPAM] Found a pingable IP (#{ip}) address which not marked as known. Skipping it...")
           else
-            logger.debug("Found #{ip} in #{iterations} iterations")
-            return ip
+            unless ns_resolvable?(ip)
+              logger.info("[IPAM] Found #{ip} in #{iterations} iterations")
+              return ip
+            end
           end
         end
+
+        range -= [ip]
       end
-      logger.debug("Not suggesting IP Address for #{subnet} as no free IP found in reasonable time (#{iterations} iterations)")
+
+      logger.warn("[IPAM] Not suggesting IP Address for #{subnet} as no free IP found in reasonable time (#{iterations} iterations)")
       errors.add(:subnet, _('no random free IP could be found in our DB, enlarge subnet range'))
       nil
     end

data/lib/pingable_ipam_plugin/engine.rb

@@ -16,6 +16,7 @@ module PingableIpamPlugin
       begin
         ::IPAM.send(:include, PingableIpamPlugin::IpamExtensions)
         ::Subnet::Ipv4.singleton_class.send(:prepend, PingableIpamPlugin::Ipv4Extensions)
+        ::Nic::Base.send(:include, PingableIpamPlugin::NicExtensions)
       rescue => e
         Rails.logger.warn "PingableIpamPlugin: skipping engine hook (#{e})"
       end

data/lib/pingable_ipam_plugin/version.rb

@@ -1,3 +1,3 @@
 module PingableIpamPlugin
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.7'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pingable_ipam_plugin
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.7
 platform: ruby
 authors:
 - Pavel Parshin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-20 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -51,6 +51,7 @@ files:
 - Rakefile
 - app/models/concerns/pingable_ipam_plugin/ipam_extensions.rb
 - app/models/concerns/pingable_ipam_plugin/ipv4_extensions.rb
+- app/models/concerns/pingable_ipam_plugin/nic_extensions.rb
 - app/services/ipam/ping_random_db.rb
 - lib/pingable_ipam_plugin.rb
 - lib/pingable_ipam_plugin/engine.rb