foreman_netbox 1.2.0 → 2.0.0

data/lib/foreman_netbox/engine.rb

@@ -8,8 +8,6 @@ module ForemanNetbox
   class Engine < ::Rails::Engine
     engine_name 'foreman_netbox'
 
-    config.autoload_paths += Dir["#{config.root}/app/interactors"]
-
     # Add any db migrations
     initializer 'foreman_netbox.load_app_instance_data' do |app|
       ForemanNetbox::Engine.paths['db/migrate'].existent.each do |path|
@@ -17,51 +15,60 @@ module ForemanNetbox
       end
     end
 
-    initializer 'foreman_netbox.register_plugin', before: :finisher_hook do |_app|
-      Foreman::Plugin.register :foreman_netbox do
-        requires_foreman '>= 3.1'
+    # rubocop:disable Metrics/BlockLength
+    initializer 'foreman_netbox.register_plugin', before: :finisher_hook do |app|
+      app.reloader.to_prepare do
+        Foreman::Plugin.register :foreman_netbox do
+          requires_foreman '>= 3.13'
 
-        # Netbox Facet
-        register_facet(ForemanNetbox::NetboxFacet, :netbox_facet) do
-          set_dependent_action :destroy
-        end
+          # Netbox Facet
+          register_facet(ForemanNetbox::NetboxFacet, :netbox_facet) do
+            set_dependent_action :destroy
+          end
 
-        # extend host show page
-        extend_page('hosts/show') do |context|
-          context.add_pagelet :main_tabs,
-            name: N_('Netbox'),
-            partial: 'hosts/netbox_tab',
-            onlyif: proc { |host| host.netbox_facet.synchronized_at }
-        end
+          # extend host show page
+          extend_page('hosts/show') do |context|
+            context.add_pagelet :main_tabs,
+              name: N_('Netbox'),
+              partial: 'hosts/netbox_tab',
+              onlyif: proc { |host| host.netbox_facet.synchronized_at }
+          end
 
-        settings do
-          category(:netbox, N_('Netbox')) do
-            setting 'netbox_url',
-              type: :string,
-              default: '-',
-              full_name: N_('Netbox URL'),
-              description: N_('URL where Netbox is reachable')
-            setting 'netbox_api_token',
-              type: :string,
-              default: '-',
-              full_name: N_('Netbox API token'),
-              description: N_('API token to Netbox')
-            setting 'netbox_orchestration_enabled',
-              type: :boolean,
-              default: false,
-              full_name: N_('Netbox Orchestration'),
-              description: N_('Enable Netbox Orchestration')
-            setting 'netbox_skip_site_update',
-              type: :boolean,
-              default: false,
-              full_name: N_('Skip Site Update'),
-              description: N_('Skip updating Site attribute for Devices')
+          settings do
+            category(:netbox, N_('Netbox')) do
+              setting 'netbox_url',
+                type: :string,
+                default: '-',
+                full_name: N_('Netbox UI URL'),
+                description: N_('URL where Netbox UI is reachable')
+              setting 'netbox_api_url',
+                type: :string,
+                default: '-',
+                full_name: N_('Netbox API URL'),
+                description: N_('URL where Netbox API is reachable, in case it is different than Netbox UI')
+              setting 'netbox_api_token',
+                type: :string,
+                default: '-',
+                full_name: N_('Netbox API token'),
+                description: N_('API token to Netbox')
+              setting 'netbox_orchestration_enabled',
+                type: :boolean,
+                default: false,
+                full_name: N_('Netbox Orchestration'),
+                description: N_('Enable Netbox Orchestration')
+              setting 'netbox_skip_site_update',
+                type: :boolean,
+                default: false,
+                full_name: N_('Skip Site Update'),
+                description: N_('Skip updating Site attribute for Devices')
+            end
           end
-        end
 
-        logger :import, enabled: true
+          logger :import, enabled: true
+        end
       end
     end
+    # rubocop:enable Metrics/BlockLength
 
     config.to_prepare do
       ::Host::Managed.include(ForemanNetbox::HostExtensions)

data/lib/foreman_netbox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanNetbox
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

data/lib/tasks/foreman_netbox_tasks.rake

@@ -2,31 +2,6 @@
 
 require 'rake/testtask'
 
-namespace :foreman_netbox do
-  namespace :sync do
-    desc 'Example Task'
-    task full: :environment do
-      User.as_anonymous_admin do
-        Host::Managed.where(managed: true).each do |host|
-          unless host.netbox_facet.netbox_params_diff.empty?
-            puts "Nothing to push for #{host.name}"
-            next
-          end
-
-          puts "Pushing #{host.name} to Netbox"
-          result = host.push_to_netbox
-
-          if result.success?
-            puts "#{host.name} pushed"
-          else
-            puts "Failed to push #{host.name}: #{result.error}"
-          end
-        end
-      end
-    end
-  end
-end
-
 # Tests
 namespace :test do
   desc 'Test ForemanNetbox'
@@ -39,27 +14,4 @@ namespace :test do
   end
 end
 
-namespace :foreman_netbox do
-  task rubocop: :environment do
-    begin
-      require 'rubocop/rake_task'
-      RuboCop::RakeTask.new(:rubocop_foreman_netbox) do |task|
-        task.patterns = ["#{ForemanNetbox::Engine.root}/app/**/*.rb",
-                         "#{ForemanNetbox::Engine.root}/lib/**/*.rb",
-                         "#{ForemanNetbox::Engine.root}/test/**/*.rb"]
-      end
-    rescue StandardError
-      puts 'Rubocop not loaded.'
-    end
-
-    Rake::Task['rubocop_foreman_netbox'].invoke
-  end
-end
-
 Rake::Task[:test].enhance ['test:foreman_netbox']
-
-load 'tasks/jenkins.rake'
-
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:foreman_netbox', 'foreman_netbox:rubocop']
-end

data/test/fixtures/netbox_device_raw_data.json

@@ -327,4 +327,4 @@
     "created": "2020-07-13",
     "last_updated": "2020-07-14T12:02:37.622231Z"
   }
-}
+}

data/test/integration/foreman_netbox/sync_k8s_physical_host_test.rb

@@ -42,7 +42,7 @@ class SyncK8sPhysicalHostTest < ActiveSupport::TestCase
     end
   end
 
-  test 'sync host' do
+  test 'sync k8s host' do
     ForemanNetbox::NetboxFacet.any_instance.expects(:update).twice.returns(true)
 
     assert subject.success?

data/test/integration/foreman_netbox/sync_rhel_physical_host_test.rb

@@ -42,7 +42,7 @@ class SyncRhelPhysicalHostTest < ActiveSupport::TestCase
     end
   end
 
-  test 'sync host' do
+  test 'sync physical host' do
     ForemanNetbox::NetboxFacet.any_instance.expects(:update).twice.returns(true)
 
     assert subject.success?

data/test/integration/foreman_netbox/sync_rhel_virtual_host_test.rb

@@ -54,7 +54,7 @@ class SyncRhelVirtualHostTest < ActiveSupport::TestCase
     end
   end
 
-  test 'sync host' do
+  test 'sync virtual host' do
     ForemanNetbox::NetboxFacet.any_instance.expects(:update).twice.returns(true)
 
     assert subject.success?

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

@@ -27,7 +27,7 @@ class CreateDeviceTest < ActiveSupport::TestCase
   let(:site) { OpenStruct.new(id: 1) }
   let(:tenant) { OpenStruct.new(id: 1) }
   let(:netbox_device_params) { host.netbox_facet.netbox_params.fetch(:device) }
-  let(:tags) { [ForemanNetbox::API.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
+  let(:tags) { [ForemanNetbox::Api.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
 
   setup do
     setup_default_netbox_settings

data/test/interactors/foreman_netbox/sync_host/sync_device/save_netbox_url_test.rb

@@ -2,9 +2,9 @@
 
 require 'test_plugin_helper'
 
-class SaveNetboxUrlDeviceTest < ActiveSupport::TestCase
+class SaveNetboxURLDeviceTest < ActiveSupport::TestCase
   subject do
-    ForemanNetbox::SyncHost::SyncDevice::SaveNetboxUrl.call(host: host, device: device)
+    ForemanNetbox::SyncHost::SyncDevice::SaveNetboxURL.call(host: host, device: device)
   end
 
   let(:device) { OpenStruct.new(id: 1) }

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

@@ -14,7 +14,7 @@ class UpdateDeviceTypeTest < ActiveSupport::TestCase
 
   let(:host) { FactoryBot.build_stubbed(:host) }
   let(:device_type) do
-    ForemanNetbox::API.client::DCIM::DeviceType.new(id: 1).tap do |device|
+    ForemanNetbox::Api.client::DCIM::DeviceType.new(id: 1).tap do |device|
       device.instance_variable_set(
         :@data,
         { 'id' => 1, 'tags' => device_type_tags }

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

@@ -12,7 +12,7 @@ class DeleteDeviceInterfacesTest < ActiveSupport::TestCase
   end
 
   let(:interface_id) { 1 }
-  let(:interfaces) { ForemanNetbox::API.client::DCIM::Interfaces.new }
+  let(:interfaces) { ForemanNetbox::Api.client::DCIM::Interfaces.new }
   let(:host) do
     FactoryBot.build_stubbed(:host, interfaces: [])
   end

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

@@ -9,8 +9,8 @@ class DeleteDeviceIpAddressesTest < ActiveSupport::TestCase
     )
   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(: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,

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

@@ -11,7 +11,7 @@ class UpdateDeviceIpAddressesTest < ActiveSupport::TestCase
     )
   end
 
-  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(device_id: 1) }
+  let(:ip_addresses) { ForemanNetbox::Api.client.ipam.ip_addresses.filter(device_id: 1) }
   let(:tags_data) { default_tags.map { |t| { id: t.id, name: t.name, slug: t.slug } } }
   let(:ip_addresses_data) do
     [

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

@@ -12,8 +12,8 @@ class UpdateDeviceInterfacesTest < ActiveSupport::TestCase
     )
   end
 
-  let(:interfaces) { ForemanNetbox::API.client::DCIM::Interfaces.new }
-  let(:tags) { [ForemanNetbox::API.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
+  let(:interfaces) { ForemanNetbox::Api.client::DCIM::Interfaces.new }
+  let(:tags) { [ForemanNetbox::Api.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
   let(:old_mac) { 'FE:13:C6:44:29:22' }
   let(:host) do
     FactoryBot.build_stubbed(

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

@@ -10,9 +10,9 @@ class UpdateSiteTest < ActiveSupport::TestCase
   end
 
   let(:host) { FactoryBot.build_stubbed(:host) }
-  # let(:tags) { [ForemanNetbox::API.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
+  # let(:tags) { [ForemanNetbox::Api.client::Extras::Tag.new(id: 1, name: 'foreman', slug: 'foreman')] }
   let(:site) do
-    ForemanNetbox::API.client::DCIM::Site.new(id: 1).tap do |site|
+    ForemanNetbox::Api.client::DCIM::Site.new(id: 1).tap do |site|
       site.instance_variable_set(
         :@data,
         { 'id' => 1, 'tags' => site_tags }

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

@@ -18,7 +18,7 @@ class UpdateDeviceTest < ActiveSupport::TestCase
   end
 
   let(:device) do
-    ForemanNetbox::API.client::DCIM::Device.new(id: 1).tap do |device|
+    ForemanNetbox::Api.client::DCIM::Device.new(id: 1).tap do |device|
       device.instance_variable_set(
         :@data,
         {
@@ -68,7 +68,7 @@ class UpdateDeviceTest < ActiveSupport::TestCase
     )
   end
   let(:serialnumber) { device_data[:serial] }
-  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(device_id: device.id) }
+  let(:ip_addresses) { ForemanNetbox::Api.client.ipam.ip_addresses.filter(device_id: device.id) }
   let(:host) do
     FactoryBot.build_stubbed(
       :host,

data/test/interactors/foreman_netbox/sync_host/sync_tenant/update_test.rb

@@ -10,7 +10,7 @@ class UpdateTenantTest < ActiveSupport::TestCase
   end
 
   let(:tenant) do
-    ForemanNetbox::API.client::Tenancy::Tenant.new(id: 1).tap do |tenant|
+    ForemanNetbox::Api.client::Tenancy::Tenant.new(id: 1).tap do |tenant|
       tenant.instance_variable_set(
         :@data,
         { 'id' => 1, 'tags' => tenant_tags }

data/test/interactors/foreman_netbox/sync_host/sync_virtual_machine/save_netbox_url_test.rb

@@ -2,9 +2,9 @@
 
 require 'test_plugin_helper'
 
-class SaveNetboxUrlVirtualMachineTest < ActiveSupport::TestCase
+class SaveNetboxURLVirtualMachineTest < ActiveSupport::TestCase
   subject do
-    ForemanNetbox::SyncHost::SyncVirtualMachine::SaveNetboxUrl.call(host: host, virtual_machine: virtual_machine)
+    ForemanNetbox::SyncHost::SyncVirtualMachine::SaveNetboxURL.call(host: host, virtual_machine: virtual_machine)
   end
 
   let(:virtual_machine) { OpenStruct.new(id: 1) }

data/test/interactors/foreman_netbox/sync_host/sync_virtual_machine/sync_cluster/update_test.rb

@@ -11,7 +11,7 @@ class UpdateClusterTest < ActiveSupport::TestCase
 
   let(:host) { FactoryBot.build_stubbed(:host).tap { |h| h.stubs(:compute?).returns(true) } }
   let(:cluster) do
-    ForemanNetbox::API.client::Virtualization::Cluster.new(id: 1).tap do |cluster|
+    ForemanNetbox::Api.client::Virtualization::Cluster.new(id: 1).tap do |cluster|
       cluster.instance_variable_set(
         :@data,
         { 'id' => 1, 'tags' => cluster_tags }

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

@@ -10,7 +10,7 @@ class DeleteVirtualMachineInterfacesTest < ActiveSupport::TestCase
   end
 
   let(:interface_id) { 1 }
-  let(:interfaces) { ForemanNetbox::API.client::Virtualization::Interfaces.new }
+  let(:interfaces) { ForemanNetbox::Api.client::Virtualization::Interfaces.new }
   let(:host) { FactoryBot.build_stubbed(:host, interfaces: []) }
 
   setup do

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

@@ -9,8 +9,8 @@ class DeleteVirtualMachineIpAddressesTest < ActiveSupport::TestCase
     )
   end
 
-  let(:interfaces) { ForemanNetbox::API.client.virtualization.interfaces.filter(virtual_machine_id: 1) }
-  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(virtual_machine_id: 1) }
+  let(:interfaces) { ForemanNetbox::Api.client.virtualization.interfaces.filter(virtual_machine_id: 1) }
+  let(:ip_addresses) { ForemanNetbox::Api.client.ipam.ip_addresses.filter(virtual_machine_id: 1) }
 
   let(:host) do
     FactoryBot.build_stubbed(

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

@@ -11,7 +11,7 @@ class UpdateVirtualMachineIpAddressesTest < ActiveSupport::TestCase
     )
   end
 
-  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(virtual_machine_id: 1) }
+  let(:ip_addresses) { ForemanNetbox::Api.client.ipam.ip_addresses.filter(virtual_machine_id: 1) }
   let(:ip_addresses_data) do
     [
       {

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

@@ -12,7 +12,7 @@ class UpdateVirtualMachineInterfacesTest < ActiveSupport::TestCase
     )
   end
 
-  let(:interfaces) { ForemanNetbox::API.client::Virtualization::Interfaces.new }
+  let(:interfaces) { ForemanNetbox::Api.client::Virtualization::Interfaces.new }
   let(:old_mac) { 'FE:13:C6:44:29:22' }
   let(:host) do
     FactoryBot.build_stubbed(

data/test/interactors/foreman_netbox/sync_host/sync_virtual_machine/update_test.rb

@@ -16,7 +16,7 @@ class UpdateVirtualMachineTest < ActiveSupport::TestCase
   end
 
   let(:virtual_machine) do
-    ForemanNetbox::API.client::Virtualization::VirtualMachine.new(id: 1).tap do |virtual_machine|
+    ForemanNetbox::Api.client::Virtualization::VirtualMachine.new(id: 1).tap do |virtual_machine|
       virtual_machine.instance_variable_set(
         :@data,
         {
@@ -64,7 +64,7 @@ class UpdateVirtualMachineTest < ActiveSupport::TestCase
       )
     )
   end
-  let(:ip_addresses) { ForemanNetbox::API.client.ipam.ip_addresses.filter(virtual_machine_id: virtual_machine.id) }
+  let(:ip_addresses) { ForemanNetbox::Api.client.ipam.ip_addresses.filter(virtual_machine_id: virtual_machine.id) }
   let(:host) do
     FactoryBot.build_stubbed(
       :host,

data/test/test_plugin_helper.rb

@@ -27,6 +27,6 @@ end
 
 def default_tags
   ForemanNetbox::SyncHost::SyncTags::Organizer::DEFAULT_TAGS.map.with_index(1) do |tag, id|
-    ForemanNetbox::API.client::Extras::Tag.new(id: id, name: tag[:name], slug: tag[:slug])
+    ForemanNetbox::Api.client::Extras::Tag.new(id: id, name: tag[:name], slug: tag[:slug])
   end
 end

data/test/unit/foreman_netbox/api_test.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+
+module ForemanNetbox
+  class ApiTest < ActiveSupport::TestCase
+    describe '.netbox_api_url' do
+      subject { described_class.netbox_api_url }
+
+      let(:netbox1_url) { 'https://netbox1.com' }
+      let(:netbox1_api_url) { "#{netbox1_url}/api" }
+      let(:netbox2_api_url) { 'https://netbox1.com/api' }
+
+      context 'when only the netbox_url setting is set' do
+        setup do
+          Setting[:netbox_url] = netbox1_url
+        end
+
+        it 'returns the URL to the Netbox API' do
+          assert_equal netbox1_api_url, subject
+        end
+      end
+
+      context 'when only the netbox_api_url setting is set' do
+        setup do
+          Setting[:netbox_api_url] = netbox2_api_url
+        end
+
+        it 'returns the URL to the Netbox API' do
+          assert_equal netbox2_api_url, subject
+        end
+      end
+
+      context 'when both netbox_url and netbox_api_url setting are set' do
+        setup do
+          Setting[:netbox_url] = netbox1_api_url
+          Setting[:netbox_api_url] = netbox2_api_url
+        end
+
+        it 'returns the URL to the Netbox API from netbox_api_url setting' do
+          assert_equal netbox2_api_url, subject
+        end
+      end
+
+      context 'when neither setting netbox_url nor netbox_api_url is set' do
+        it 'raises exception' do
+          assert_raises(Foreman::Exception) { subject }
+        end
+      end
+    end
+  end
+end