foreman_netbox 1.0.2

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/create_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class CreateDeviceInterfacesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::Create.call(
+      host: host, netbox_params: host.netbox_facet.netbox_params, device: device, interfaces: interfaces
+    )
+  end
+
+  let(:interfaces) { [OpenStruct.new(name: host.interfaces.second.netbox_name)] }
+  let(:device) { OpenStruct.new(id: 1) }
+  let(:host) do
+    FactoryBot.build_stubbed(
+      :host,
+      interfaces: [
+        FactoryBot.build_stubbed(:nic_base, mac: 'FE:13:C6:44:29:24', ip: '10.0.0.1', ip6: '1500:0:2d0:201::1'),
+        FactoryBot.build_stubbed(:nic_base, mac: 'FE:13:C6:44:29:22', ip: '10.0.0.2', ip6: '1500:0:2d0:201::2'),
+        FactoryBot.build_stubbed(:nic_base, identifier: nil, mac: nil)
+      ]
+    )
+  end
+
+  setup do
+    setup_default_netbox_settings
+  end
+
+  it 'creates missing interfaces' do
+    interfaces.expects(:reload).once.returns(true)
+
+    stub_post = stub_request(:post, "#{Setting[:netbox_url]}/api/dcim/interfaces/").with(
+      body: {
+        name: host.interfaces.first.netbox_name,
+        mac_address: host.interfaces.first.mac,
+        tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS,
+        type: ForemanNetbox::NetboxParameters::DEFAULT_INTERFACE_TYPE,
+        device: device.id
+      }.to_json
+    ).to_return(
+      status: 201, headers: { 'Content-Type': 'application/json' },
+      body: {
+        id: 1,
+        name: host.interfaces.first.netbox_name
+      }.to_json
+    )
+
+    subject
+    assert_requested(stub_post)
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/delete_test.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class DeleteDeviceInterfacesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::Delete.call(
+      host: host,
+      netbox_params: host.netbox_facet.netbox_params,
+      interfaces: interfaces
+    )
+  end
+
+  let(:interface_id) { 1 }
+  let(:interfaces) { ForemanNetbox::API.client::DCIM::Interfaces.new }
+  let(:host) do
+    FactoryBot.build_stubbed(:host, interfaces: [])
+  end
+
+  setup do
+    setup_default_netbox_settings
+    stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+      query: { limit: 50 }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: 1,
+        results: [{ id: interface_id, name: 'eth0' }]
+      }.to_json
+    )
+  end
+
+  it 'deletes interfaces that are not assigned to the host' do
+    stub_delete = stub_request(:delete, "#{Setting[:netbox_url]}/api/dcim/interfaces/#{interface_id}.json").to_return(
+      status: 200
+    )
+
+    subject
+    assert_requested(stub_delete)
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/find_test.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class FindDeviceInterfacesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::Find.call(
+      device: device
+    )
+  end
+
+  let(:device) { OpenStruct.new(id: 1) }
+
+  setup do
+    setup_default_netbox_settings
+  end
+
+  context 'when interfaces were found on Netbox' do
+    it 'assigns interfaces to context' do
+      stub_get = stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+        query: { limit: 50, device_id: device.id }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 1,
+          results: [
+            { id: 1 }
+          ]
+        }.to_json
+      )
+
+      assert_equal [1], subject.interfaces.map(&:id)
+      assert_requested(stub_get)
+    end
+  end
+
+  context 'when interfaces were not found on Netbox' do
+    it 'does not assign interfaces to context' do
+      stub_get = stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+        query: { limit: 50, device_id: device.id }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 0,
+          results: []
+        }.to_json
+      )
+
+      assert_equal [], subject.interfaces.map(&:id)
+      assert_requested(stub_get)
+    end
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/create_test.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class CreateDeviceIpAddressesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::SyncIpAddresses::Create.call(
+      host: host, interfaces: interfaces, netbox_params: host.netbox_facet.netbox_params
+    )
+  end
+
+  let(:interfaces) { [OpenStruct.new(id: 1, name: host.interfaces.first.netbox_name)] }
+  let(:subnet) { FactoryBot.build_stubbed(:subnet_ipv4) }
+  let(:subnet6) { FactoryBot.build_stubbed(:subnet_ipv6) }
+  let(:host) do
+    FactoryBot.build_stubbed(
+      :host,
+      interfaces: [
+        FactoryBot.build_stubbed(
+          :nic_base,
+          mac: 'FE:13:C6:44:29:24',
+          ip: '10.0.0.1',
+          ip6: '1500:0:2d0:201::1',
+          subnet: subnet,
+          subnet6: subnet6
+        )
+      ]
+    )
+  end
+
+  setup do
+    setup_default_netbox_settings
+    stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+      query: { limit: 50, interface_id: interfaces.first.id, address: host.interfaces.first.netbox_ip }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: 0,
+        results: []
+      }.to_json
+    )
+    stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+      query: { limit: 50, interface_id: interfaces.first.id, address: host.interfaces.first.netbox_ip6 }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: 1,
+        results: [{ id: 2 }]
+      }.to_json
+    )
+  end
+
+  it 'creates missing IP addresses in Netbox' do
+    stub_post_ip_address_v4 = stub_request(:post, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/").with(
+      body: {
+        address: host.interfaces.first.netbox_ip,
+        tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS,
+        interface: interfaces.first.id
+      }.to_json
+    ).to_return(
+      status: 201, headers: { 'Content-Type': 'application/json' },
+      body: { id: 1 }.to_json
+    )
+
+    stub_post_ip_address_v6 = stub_request(:post, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/").with(
+      body: {
+        address: host.interfaces.first.netbox_ip6,
+        tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS,
+        interface: interfaces.first.id
+      }.to_json
+    ).to_return(
+      status: 201, headers: { 'Content-Type': 'application/json' },
+      body: { id: 1 }.to_json
+    )
+
+    subject
+    assert_requested(stub_post_ip_address_v4)
+    assert_not_requested(stub_post_ip_address_v6)
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/delete_test.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class DeleteDeviceIpAddressesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::SyncIpAddresses::Delete.call(
+      host: host, interfaces: interfaces, ip_addresses: ip_addresses, netbox_params: host.netbox_facet.netbox_params
+    )
+  end
+
+  let(:interfaces) { ForemanNetbox::API.client.dcim.interfaces.filter(device_id: 1) }
+  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(device_id: 1) }
+  let(:host) do
+    FactoryBot.build_stubbed(
+      :host,
+      interfaces: [
+        FactoryBot.build_stubbed(
+          :nic_base,
+          ip: '10.0.0.1',
+          subnet: FactoryBot.build_stubbed(:subnet_ipv4)
+        )
+      ]
+    )
+  end
+
+  let(:interface_id) { 1 }
+  let(:ip_addresses_v4_id) { 1 }
+  let(:ip_addresses_v6_id) { 2 }
+  let(:ip_addresses_v4) { host.interfaces.first.netbox_ip }
+  let(:ip_addresses_v6) { '1500:0:2d0:201::1/32' }
+
+  setup do
+    setup_default_netbox_settings
+    stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+      query: { limit: 50, device_id: 1 }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: 1,
+        results: [
+          { id: interface_id, name: host.interfaces.first.netbox_name }
+        ]
+      }.to_json
+    )
+    stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+      query: { limit: 50, device_id: 1 }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: 2,
+        results: [
+          { id: ip_addresses_v4_id, address: ip_addresses_v4, interface: { id: interface_id } },
+          { id: ip_addresses_v6_id, address: ip_addresses_v6, interface: { id: interface_id } }
+        ]
+      }.to_json
+    )
+  end
+
+  it 'deletes from Netbox IP addresses that are not assigned to the host' do
+    stub_delete_ip_address_v4 = stub_request(:delete, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/#{ip_addresses_v4_id}.json").to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' }
+    )
+    stub_delete_ip_address_v6 = stub_request(:delete, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/#{ip_addresses_v6_id}.json").to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' }
+    )
+
+    subject
+    assert_not_requested(stub_delete_ip_address_v4)
+    assert_requested(stub_delete_ip_address_v6)
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/find_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class FindDeviceIpAddressesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::SyncIpAddresses::Find.call(
+      device: device
+    )
+  end
+
+  let(:device) { OpenStruct.new(id: 1) }
+
+  setup do
+    setup_default_netbox_settings
+  end
+
+  context 'when ip_addresses were found on Netbox' do
+    it 'assigns ip_addresses to context' do
+      stub_get = stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+        query: { limit: 50, device_id: device.id }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 1,
+          results: [{ id: 1 }]
+        }.to_json
+      )
+
+      assert_equal [1], subject.ip_addresses.map(&:id)
+      assert_requested(stub_get)
+    end
+  end
+
+  context 'when ip_addresses were not found on Netbox' do
+    it 'does not assign ip_addresses to context' do
+      stub_get = stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+        query: { limit: 50, device_id: device.id }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 0,
+          results: []
+        }.to_json
+      )
+
+      assert_equal [], subject.ip_addresses.map(&:id)
+      assert_requested(stub_get)
+    end
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/update_test.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class UpdateDeviceIpAddressesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::SyncIpAddresses::Update.call(
+      ip_addresses: ip_addresses,
+      netbox_params: host.netbox_facet.netbox_params
+    )
+  end
+
+  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(device_id: 1) }
+  let(:ip_addresses_data) do
+    [
+      { id: 1, address: host.netbox_facet.netbox_params[:ip_addresses].first[:address], tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS },
+      { id: 2, address: host.netbox_facet.netbox_params[:ip_addresses].second[:address], tags: [] }
+    ]
+  end
+  let(:host) do
+    FactoryBot.build_stubbed(
+      :host,
+      interfaces: [
+        FactoryBot.build_stubbed(
+          :nic_base,
+          identifier: 'eth0',
+          ip: '10.0.0.7',
+          ip6: '1600:0:2d0:202::17',
+          subnet: FactoryBot.build_stubbed(:subnet_ipv4, organizations: [], locations: []),
+          subnet6: FactoryBot.build_stubbed(:subnet_ipv6, organizations: [], locations: [])
+        )
+      ]
+    )
+  end
+
+  setup do
+    setup_default_netbox_settings
+    stub_request(:get, "#{Setting[:netbox_url]}/api/ipam/ip-addresses.json").with(
+      query: { limit: 50, device_id: 1 }
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: {
+        count: ip_addresses_data.count,
+        results: ip_addresses_data
+      }.to_json
+    )
+  end
+
+  test 'update ip addresses' do
+    stub_unexpected_patch = stub_request(:patch, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/#{ip_addresses_data.first[:id]}.json")
+    stub_expected_patch = stub_request(:patch, "#{Setting[:netbox_url]}/api/ipam/ip-addresses/#{ip_addresses_data.second[:id]}.json").with(
+      body: {
+        tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS
+      }.to_json
+    ).to_return(
+      status: 200, headers: { 'Content-Type': 'application/json' },
+      body: { id: 2 }.to_json
+    )
+
+    assert subject.success?
+    assert_not_requested stub_unexpected_patch
+    assert_requested stub_expected_patch
+  end
+end

data/test/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/update_test.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+class UpdateDeviceInterfacesTest < ActiveSupport::TestCase
+  subject do
+    ForemanNetbox::SyncHost::SyncDevice::SyncInterfaces::Update.call(
+      interfaces: interfaces,
+      host: host,
+      netbox_params: host.netbox_facet.netbox_params
+    )
+  end
+
+  let(:interfaces) { ForemanNetbox::API.client::DCIM::Interfaces.new }
+  let(:old_mac) { 'FE:13:C6:44:29:22' }
+  let(:host) do
+    FactoryBot.build_stubbed(
+      :host,
+      interfaces: [
+        FactoryBot.build_stubbed(
+          :nic_base,
+          identifier: 'eth1',
+          mac: old_mac
+        )
+      ]
+    )
+  end
+
+  setup do
+    setup_default_netbox_settings
+  end
+
+  context 'if the interface has been updated since the last synchronization' do
+    let(:new_mac) { 'FE:13:C6:44:29:24' }
+
+    it 'updats interface in Netbox' do
+      get_stub = stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+        query: { limit: 50 }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 1,
+          results: [
+            {
+              id: 1,
+              name: host.interfaces.first.netbox_name,
+              mac_address: new_mac,
+              tags: []
+            }
+          ]
+        }.to_json
+      )
+      stub_patch = stub_request(:patch, "#{Setting[:netbox_url]}/api/dcim/interfaces/1.json").with(
+        body: {
+          mac_address: host.interfaces.first.mac,
+          tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS
+        }.to_json
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: { id: 1 }.to_json
+      )
+
+      subject
+      assert_requested(get_stub)
+      assert_requested(stub_patch)
+    end
+  end
+
+  context 'if the host has not been updated since the last synchronization' do
+    it 'does not update interface on Netbox' do
+      get_stub = stub_request(:get, "#{Setting[:netbox_url]}/api/dcim/interfaces.json").with(
+        query: { limit: 50 }
+      ).to_return(
+        status: 200, headers: { 'Content-Type': 'application/json' },
+        body: {
+          count: 1,
+          results: [
+            {
+              id: 1,
+              name: host.interfaces.first.netbox_name,
+              mac_address: old_mac,
+              tags: ForemanNetbox::NetboxParameters::DEFAULT_TAGS
+            }
+          ]
+        }.to_json
+      )
+
+      subject
+      assert_requested(get_stub)
+    end
+  end
+end