smart_proxy_dhcp_infoblox 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '09c889de302026a263c3bc24a811e4cf0d98457b'
-  data.tar.gz: 3ab6daa8940ee05581a913c02d455a579e246e47
+  metadata.gz: 27302f51a2acaa0673c4b5f53552866d24ebb739
+  data.tar.gz: a92c72fdaea22d0395ef95e7f24f514e28e09b9e
 SHA512:
-  metadata.gz: 24c3e8bdd8cb74ffe5cb06d5b592897b9311049746f284824ab68f7317f3a881ad5976b85e1d949b71d812a1bc1ae604c05268305b5eef73b960551b5a1642f5
-  data.tar.gz: 7a27741a156442a75b39d25662a92d48f28e062e8b9af51ac7240de9c59476bbb221edf6f0ad0727da3f3e7a248ab56dbefcbb653278a54435a8073c327c0bc1
+  metadata.gz: c9c5e1be7b5d16517e9cc1135c022622b3899372da1061448c8e9f69862160e5c4cc77d9352ef7685573028cad57772cdb9368e280dc43f7f761555a9b88d76e
+  data.tar.gz: 4bb48cb0751a23e604035432883ad1d5b4d32cb00996bcfdde389a9d0e9e008a4d93bcab97a53066fb2e60a0092e1dbca0e53b7a1fede206e8b9695d878051c4

data/README.md

@@ -1,5 +1,7 @@
 # SmartProxyDhcpInfoblox
 
+[![Build Status](https://travis-ci.org/theforeman/smart_proxy_dhcp_infoblox.svg?branch=master)](https://travis-ci.org/theforeman/smart_proxy_dhcp_infoblox)
+
 This plugin adds a new DHCP provider for managing records with infoblox servers
 
 ## Installation
@@ -26,7 +28,6 @@ Configuration options for this plugin are in `/etc/foreman-proxy/settings.d/dhcp
 * username: API Username
 * password: API Password
 * record_type: host / fixedaddress (see different record types chapter)
-* use_ranges: use infoblox ranges (true) or infoblox networks (false) to find the next free ip in your infoblox
 
 ## Different record types
 The main difference between host and fixedaddress is that a host record already includes the dns records. It's an infoblox object that includes dhcp/a record/ptr records. If you use the host objects there is no need to use a dns smart proxy. Everything gets handled inside the dhcp smart proxy. This does however limit functionality. You can't delete conflicting records or you can't change dns names using foreman gui. Beware when editing host objects manually in infoblox, once you delete a host in foreman all associated host objects get deleted.

data/config/dhcp_infoblox.yml.example

@@ -11,10 +11,5 @@
 # Record type to manage: can be "host" or "fixedaddress"
 #
 :record_type: 'host'
-#
-# Use  pre-definded ranges in networks to find available IP's
-#
-:use_ranges: false
-
 #:dns_view: 'non-default'
 #:network_view: 'another-non-default'

data/lib/smart_proxy_dhcp_infoblox/dhcp_infoblox_main.rb

@@ -7,15 +7,14 @@ module Proxy::DHCP::Infoblox
     include Proxy::Util
     include IpAddressArithmetic
 
-    attr_reader :connection, :crud, :restart_grid, :unused_ips, :network_view
+    attr_reader :connection, :crud, :restart_grid, :network_view
 
     def initialize(connection, crud, restart_grid, unused_ips, managed_subnets, network_view)
       @connection = connection
       @crud = crud
       @restart_grid = restart_grid
-      @unused_ips = unused_ips
       @network_view = network_view
-      super('infoblox', managed_subnets, nil)
+      super('infoblox', managed_subnets, nil, unused_ips)
     end
 
     def find_subnet(address);::Proxy::DHCP::Subnet.new(address, '255.255.255.0'); end
@@ -72,8 +71,21 @@ module Proxy::DHCP::Infoblox
       restart_grid.try_restart
     end
 
-    def unused_ip(subnet, _, from_ip_address, to_ip_address)
-      unused_ips.unused_ip(subnet, from_ip_address, to_ip_address)
+    require 'dhcp_common/subnet'
+    def get_subnet(subnet_address)
+      address, prefix_length = full_network_address(subnet_address).split("/")
+      netmask = cidr_to_ip_mask(prefix_length.to_i)
+    end
+
+    def find_ip_by_mac_address_and_range(subnet, mac_address, from_address, to_address)
+      r = crud.find_record_by_mac("#{subnet.network}/#{subnet.cidr}", mac_address)
+
+      if r && (IPAddr.new(from_address)..IPAddr.new(to_address)).cover?(IPAddr.new(r.ip))
+        logger.debug "Found an existing DHCP record #{r}, reusing..."
+        return r.ip
+      end
+
+      nil
     end
 
     def find_network(network_address)

data/lib/smart_proxy_dhcp_infoblox/dhcp_infoblox_plugin.rb

@@ -2,7 +2,7 @@ module Proxy::DHCP::Infoblox
   class Plugin < ::Proxy::Provider
     plugin :dhcp_infoblox, ::Proxy::DHCP::Infoblox::VERSION
 
-    default_settings :record_type => 'host', :range => false, :dns_view => "default", :network_view => "default"
+    default_settings :record_type => 'host', :dns_view => "default", :network_view => "default", :blacklist_duration_minutes => 30*60
     validate_presence :username, :password
 
     requires :dhcp, '>= 1.13'

data/lib/smart_proxy_dhcp_infoblox/dhcp_infoblox_version.rb

@@ -1,7 +1,7 @@
 module Proxy
   module DHCP
     module Infoblox
-      VERSION = '0.0.11'
+      VERSION = '0.0.12'
     end
   end
 end

data/lib/smart_proxy_dhcp_infoblox/plugin_configuration.rb

@@ -3,10 +3,10 @@ module Proxy::DHCP::Infoblox
     def load_classes
       require 'infoblox'
       require 'dhcp_common/dhcp_common'
+      require 'dhcp_common/free_ips'
       require 'smart_proxy_dhcp_infoblox/host_ipv4_address_crud'
       require 'smart_proxy_dhcp_infoblox/fixed_address_crud'
       require 'smart_proxy_dhcp_infoblox/grid_restart'
-      require 'smart_proxy_dhcp_infoblox/unused_ips'
       require 'smart_proxy_dhcp_infoblox/dhcp_infoblox_main'
     end
 
@@ -20,10 +20,8 @@ module Proxy::DHCP::Infoblox
                                 end)
 
 
-      c.dependency :unused_ips, (lambda do
-        ::Proxy::DHCP::Infoblox::UnusedIps.new(c.get_dependency(:connection), settings[:use_ranges],
-                                             settings[:network_view])
-      end)
+      c.singleton_dependency :unused_ips, lambda {::Proxy::DHCP::FreeIps.new(settings[:blacklist_duration_minutes]) }
+
       c.dependency :host_ipv4_crud, (lambda do
         ::Proxy::DHCP::Infoblox::HostIpv4AddressCRUD.new(c.get_dependency(:connection), settings[:dns_view])
       end)

data/test/integration_test.rb

@@ -0,0 +1,97 @@
+require "rack/test"
+require 'test_helper'
+require 'json'
+require 'dhcp_common/dhcp_common'
+require 'dhcp/dhcp'
+require 'dhcp/dependency_injection'
+require 'dhcp/dhcp_api'
+
+ENV['RACK_ENV'] = 'test'
+
+class IntegrationTest < ::Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    app = Proxy::DhcpApi.new
+    app.helpers.server = @server
+    app
+  end
+
+  def setup
+    @free_ips = ::Proxy::DHCP::FreeIps.new
+    @server = ::Proxy::DHCP::Infoblox::Provider.new(nil, Object.new, Object.new, @free_ips, [],
+                                                    "default")
+
+    @expected_reservation = {"name" => "testing-01", "ip" => "10.0.0.200", "mac" => "11:22:33:a9:61:09",
+                             "subnet" => "10.0.0.0/255.255.255.0", "hostname" => "testing-01"}
+  end
+
+
+  def test_get_subnets
+    @server.expects(:subnets).returns([])
+    get "/"
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_get_network
+    @server.expects(:all_hosts).with("10.0.0.0").returns([@expected_reservation])
+    @server.expects(:all_leases).with("10.0.0.0").returns([])
+
+    get "/10.0.0.0"
+
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_get_unused_ip
+    @server.expects(:get_subnet).with("10.0.0.0").returns(::Proxy::DHCP::Subnet.new("10.0.0.0", "255.255.255.0"))
+    @server.expects(:all_hosts).with("10.0.0.0").returns([@expected_reservation])
+    @server.expects(:all_leases).with("10.0.0.0").returns([])
+    @free_ips.expects(:find_free_ip).with("10.0.0.100", "10.0.0.200", [@expected_reservation]).returns("10.0.0.150")
+
+    get "/10.0.0.0/unused_ip?from=10.0.0.100&to=10.0.0.200"
+
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+    parsed_response = JSON.parse(last_response.body)
+    assert parsed_response.key?('ip')
+  end
+
+  def test_get_records_by_ip
+    @server.expects(:find_records_by_ip).with("10.0.0.0", "10.0.0.200").returns([@expected_reservation])
+    get "/10.0.0.0/ip/10.0.0.200"
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+    parsed_response = JSON.parse(last_response.body)
+    assert_equal 1, parsed_response.size
+    assert_equal @expected_reservation, parsed_response.first
+  end
+
+  def test_get_record_by_mac
+    @server.expects(:find_record_by_mac).with("10.0.0.0", "11:22:33:a9:61:09").returns(@expected_reservation)
+    get "/10.0.0.0/mac/11:22:33:a9:61:09"
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+    assert_equal @expected_reservation, JSON.parse(last_response.body)
+  end
+
+  def test_create_record
+    record = {
+        "hostname" => "test-02",
+        "ip"       => "10.0.0.250",
+        "mac"      => "10:10:10:10:10:10",
+        "network"  => "10.0.0.0",
+    }
+    @server.expects(:add_record).with(has_entries(record))
+    post "/10.0.0.0", record
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_delete_records_by_ip
+    @server.expects(:del_records_by_ip).with("10.0.0.0", "10.0.0.200")
+    delete "/10.0.0.0/ip/10.0.0.200"
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+
+  def test_delete_record_by_mac
+    @server.expects(:del_record_by_mac).with("10.0.0.0", "11:22:33:a9:61:09")
+    delete "/10.0.0.0/mac/11:22:33:a9:61:09"
+    assert last_response.ok?, "Last response was not ok: #{last_response.status} #{last_response.body}"
+  end
+end

data/test/plugin_configuration_test.rb

@@ -1,18 +1,18 @@
 require 'test_helper'
 require 'infoblox'
 require 'dhcp_common/dhcp_common'
+require 'dhcp_common/free_ips'
 require 'smart_proxy_dhcp_infoblox/plugin_configuration'
 require 'smart_proxy_dhcp_infoblox/record_type_validator'
 require 'smart_proxy_dhcp_infoblox/dhcp_infoblox_plugin'
 require 'smart_proxy_dhcp_infoblox/host_ipv4_address_crud'
 require 'smart_proxy_dhcp_infoblox/fixed_address_crud'
 require 'smart_proxy_dhcp_infoblox/grid_restart'
-require 'smart_proxy_dhcp_infoblox/unused_ips'
 require 'smart_proxy_dhcp_infoblox/dhcp_infoblox_main'
 
 class PluginDefaultConfigurationTest < Test::Unit::TestCase
   def test_default_settings
-    assert_equal({:record_type => 'host', :range => false, :dns_view => "default", :network_view => "default"},
+    assert_equal({:record_type => 'host', :blacklist_duration_minutes => 30*60, :dns_view => "default", :network_view => "default"},
                  Proxy::DHCP::Infoblox::Plugin.default_settings)
   end
 end
@@ -22,7 +22,7 @@ class InfobloxDhcpProductionWiringTest < Test::Unit::TestCase
     @network_view = "network_view"
     @dns_view = "dns_view"
     @settings = {:username => 'user', :password => 'password', :server => '127.0.0.1', :record_type => 'host',
-                 :use_ranges => true, :subnets => ['1.1.1.0/255.255.255.0'],
+                 :subnets => ['1.1.1.0/255.255.255.0'], :blacklist_duration_minutes => 300,
                  :dns_view => @dns_view, :network_view => @network_view}
     @container = ::Proxy::DependencyInjection::Container.new
     Proxy::DHCP::Infoblox::PluginConfiguration.new.load_dependency_injection_wirings(@container, @settings)
@@ -37,10 +37,9 @@ class InfobloxDhcpProductionWiringTest < Test::Unit::TestCase
   end
 
   def test_unused_ips_configuration
-    free_ips = @container.get_dependency(:unused_ips)
-    assert_not_nil free_ips.connection
-    assert free_ips.use_ranges
-    assert_equal @network_view, free_ips.network_view
+    unused_ips = @container.get_dependency(:unused_ips)
+    assert unused_ips
+    assert_equal 300, unused_ips.blacklist_interval
   end
 
   def test_host_ipv4_crud_configuration
@@ -64,7 +63,7 @@ class InfobloxDhcpProductionWiringTest < Test::Unit::TestCase
     provider = @container.get_dependency(:dhcp_provider)
     assert_not_nil provider.connection
     assert_not_nil provider.restart_grid
-    assert_not_nil provider.unused_ips
+    assert_not_nil provider.free_ips
     assert_equal @network_view, provider.network_view
     assert provider.managed_subnets.include?('1.1.1.0/255.255.255.0')
     assert provider.crud.instance_of?(::Proxy::DHCP::Infoblox::HostIpv4AddressCRUD)

data/test/unused_ip_test.rb

@@ -1,50 +1,58 @@
 require 'test_helper'
 require 'infoblox'
-require 'smart_proxy_dhcp_infoblox/unused_ips'
+require 'dhcp_common/free_ips'
+require 'smart_proxy_dhcp_infoblox/dhcp_infoblox_main'
+require 'ostruct'
 
 class UnusedIpTest < Test::Unit::TestCase
   def setup
     @connection = Object.new
+    @crud = Object.new
+    @restart_grid = Object.new
+    @managed_subnets = nil
     @network_view = "another"
-    @unused_ips = ::Proxy::DHCP::Infoblox::UnusedIps.new(@connection, false, @network_view)
+    @unused_ips = ::Proxy::DHCP::FreeIps.new
     @network = Infoblox::Network.new(:network => '1.1.1.0/24')
-    @range = Infoblox::Range.new(:start_addr => '1.1.1.0', :end_addr => '1.1.1.253')
+    @provider = Proxy::DHCP::Infoblox::Provider.new(@connection, @crud, @restart_grid,
+                                                    @unused_ips, @managed_subnets, @network_view)
   end
 
-  def test_excluded_ips
-    assert_equal ['192.168.42.254', '192.168.42.255'], @unused_ips.excluded_ips('192.168.42.0/24', '192.168.42.0', '192.168.42.253')
-  end
+  def test_unused_network_ip
+    expected_ip = '1.1.1.1'
+    @provider.expects(:get_subnet).with('1.1.0.0').returns(::Proxy::DHCP::Subnet.new('1.1.0.0', '255.255.0.0'))
+    @provider.expects(:all_hosts).with('1.1.0.0').returns([host = Object.new])
+    @provider.expects(:all_leases).with('1.1.0.0').returns([lease = Object.new])
+    @unused_ips.expects(:find_free_ip).with('1.1.0.1', '1.1.255.254', [host, lease]).returns(expected_ip)
 
-  def test_excluded_ips_is_empty_when_range_start_is_nil
-    assert @unused_ips.excluded_ips('192.168.42.0/24', nil, '192.168.42.253').empty?
-  end
+    ip = @provider.unused_ip('1.1.0.0', nil, nil, nil)
 
-  def test_excluded_ips_is_empty_when_range_end_is_nil
-    assert @unused_ips.excluded_ips('192.168.42.0/24', '192.168.42.250', nil).empty?
+    assert_equal expected_ip, ip
   end
 
-  def test_unused_network_ip
-    ::Infoblox::Network.expects(:find).with(@connection, 'network' => '1.1.1.0',
-                                            '_max_results' => 1, 'network_view' => @network_view).returns([@network])
-    @network.expects(:next_available_ip).with(1, ['1.1.1.254', '1.1.1.255']).returns(['1.1.1.1'])
-    assert_equal '1.1.1.1', @unused_ips.unused_network_ip('1.1.1.0', '1.1.1.0', '1.1.1.253')
-  end
+  def test_unused_network_ip_with_mac_address_present
+    expected_ip = '1.1.1.1'
+    mac_address = '00:01:02:03:04:05'
+    @provider.expects(:get_subnet).with('1.1.0.0').returns(subnet = ::Proxy::DHCP::Subnet.new('1.1.0.0', '255.255.0.0'))
+    @provider.expects(:find_ip_by_mac_address_and_range).with(subnet, mac_address, '1.1.0.1', '1.1.255.254').returns(expected_ip)
 
-  def test_unused_range_ip
-    ::Infoblox::Range.expects(:find).with(@connection, 'network' => '1.1.1.0', 'network_view' => @network_view).returns([@range])
-    @range.expects(:next_available_ip).with(1).returns(['1.1.1.1'])
-    assert_equal '1.1.1.1', @unused_ips.unused_range_ip('1.1.1.0', '1.1.1.0', '1.1.1.253')
-  end
+    ip = @provider.unused_ip('1.1.0.0', mac_address, nil, nil)
 
-  def test_unused_ip_uses_network_api_when_use_ranges_is_false
-    unused_ips = ::Proxy::DHCP::Infoblox::UnusedIps.new(@connection, false, @network_view)
-    unused_ips.expects(:unused_network_ip).with('1.1.1.0', '1.1.1.0', '1.1.1.253')
-    unused_ips.unused_ip('1.1.1.0', '1.1.1.0', '1.1.1.253')
+    assert_equal expected_ip, ip
   end
 
-  def test_unused_ip_uses_range_api_when_use_ranges_is_true
-    unused_ips = ::Proxy::DHCP::Infoblox::UnusedIps.new(@connection, true, @network_view)
-    unused_ips.expects(:unused_range_ip).with('1.1.1.0', '1.1.1.0', '1.1.1.253')
-    unused_ips.unused_ip('1.1.1.0', '1.1.1.0', '1.1.1.253')
+  def test_unused_network_ip_with_mac_address_present_with_address_outside_range
+    expected_ip = '1.1.1.1'
+    start_range = '1.1.10.1'
+    end_range = '1.1.100.1'
+    mac_address = '00:01:02:03:04:05'
+    @provider.expects(:get_subnet).with('1.1.0.0').returns(subnet = ::Proxy::DHCP::Subnet.new('1.1.0.0', '255.255.0.0'))
+    @crud.expects(:find_record_by_mac).with('1.1.0.0/16', mac_address).returns(OpenStruct.new(:ip => '10.0.0.1'))
+    @provider.expects(:all_hosts).with('1.1.0.0').returns([host = Object.new])
+    @provider.expects(:all_leases).with('1.1.0.0').returns([lease = Object.new])
+    @unused_ips.expects(:find_free_ip).with(start_range, end_range, [host, lease]).returns(expected_ip)
+
+    ip = @provider.unused_ip('1.1.0.0', mac_address, start_range, end_range)
+
+    assert_equal expected_ip, ip
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_proxy_dhcp_infoblox
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Klaas Demter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-19 00:00:00.000000000 Z
+date: 2018-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: infoblox
@@ -53,9 +53,9 @@ files:
 - lib/smart_proxy_dhcp_infoblox/network_address_range_regex_generator.rb
 - lib/smart_proxy_dhcp_infoblox/plugin_configuration.rb
 - lib/smart_proxy_dhcp_infoblox/record_type_validator.rb
-- lib/smart_proxy_dhcp_infoblox/unused_ips.rb
 - test/host_and_fixedaddress_crud_test.rb
 - test/infoblox_provider_test.rb
+- test/integration_test.rb
 - test/plugin_configuration_test.rb
 - test/record_type_validator_test.rb
 - test/regex_generator_test.rb
@@ -86,6 +86,7 @@ signing_key:
 specification_version: 4
 summary: Infoblox DHCP provider plugin for Foreman's smart proxy
 test_files:
+- test/integration_test.rb
 - test/infoblox_provider_test.rb
 - test/plugin_configuration_test.rb
 - test/regex_generator_test.rb

data/lib/smart_proxy_dhcp_infoblox/unused_ips.rb

@@ -1,50 +0,0 @@
-require 'ipaddr'
-require 'smart_proxy_dhcp_infoblox/ip_address_arithmetic'
-
-module Proxy::DHCP::Infoblox
-  class UnusedIps
-    include IpAddressArithmetic
-    attr_reader :connection, :use_ranges, :network_view
-
-    def initialize(connection, use_ranges, network_view)
-      @connection = connection
-      @use_ranges = use_ranges
-      @memoized_network = nil
-      @network_view = network_view
-    end
-
-    def unused_ip(network_address, from_ip_address, to_ip_address)
-      @use_ranges ? unused_range_ip(network_address, from_ip_address, to_ip_address) : unused_network_ip(network_address, from_ip_address, to_ip_address)
-    end
-
-    def unused_network_ip(network_address, from_ip_address, to_ip_address)
-      find_network(network_address).next_available_ip(1, excluded_ips(find_network(network_address).network, from_ip_address, to_ip_address)).first
-    end
-
-    def unused_range_ip(network_address, from_ip_address, to_ip_address)
-      find_range(network_address, from_ip_address, to_ip_address).next_available_ip(1).first
-    end
-
-    def excluded_ips(subnet_address, from, to)
-      return [] if from.nil? || to.nil?
-      (IPAddr.new(network_cidr_to_range(subnet_address).first)..IPAddr.new(network_cidr_to_range(subnet_address).last)).to_a.map(&:to_s) -
-          (IPAddr.new(from)..IPAddr.new(to)).to_a.map(&:to_s)
-    end
-
-    def find_range(network_address, from, to)
-      ranges = ::Infoblox::Range.find(@connection, 'network' => network_address, 'network_view' => network_view)
-      range = (from.nil? || to.nil?) ? ranges.first : ranges.find {|r| r.start_addr == from && r.end_addr == to}
-      raise "No Ranges found for #{network_address} network" if range.nil?
-      range
-    end
-
-    def find_network(network_address)
-      return @memoized_network if !@memoized_network.nil? && @memoized_address == network_address
-      @memoized_address = network_address
-      @memoized_network = ::Infoblox::Network.find(@connection, 'network' => network_address, 'network_view' => network_view,
-                                                   '_max_results' => 1).first
-      raise "Subnet #{network_address} not found" if @memoized_network.nil?
-      @memoized_network
-    end
-  end
-end