foreman_netbox 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5c0bba2855f92b79b87545d69196dc2556311d59f7e2d90bfb1ea7acfe2a55f
-  data.tar.gz: 8847d6add790eedfcb2703a3db61acf2645eb1a60c37fd66e4614ac4bbb85917
+  metadata.gz: 4b8ad442bf38c2bf5ac0ed5b94580b108a16d267a2ae2a37f456a73ebb1f8cd6
+  data.tar.gz: e31f39d22ea73a0bda27093a4f8474740836899c4d0379cc8763a1b9ec766e24
 SHA512:
-  metadata.gz: cc82ec6557890e5457f9471e98560cbf9f12e4074752bbff7cc8e21f5cf8f34b0288150a1dedec75fd99c3d1b649ef943e74c6b633dd09548643d950dedcb75f
-  data.tar.gz: c7907c045cb7cc50ac25d098276c4666301aecf492802714297a08dfe12bf488f72c7a6bb7e5d1b31531b9d0025a9d979f282f7083d0ae04b3c2c50bc755ef77
+  metadata.gz: ab087e119d4a0fd10f4847a4e6aaa829e55e2b1036393058ccc90363a098ea12fa156fd7f62c1eba98d0e2a15e0f3fd0aeec77d65f4a78a515ff6b16b6739f13
+  data.tar.gz: 47561411ae532f4229a45ce71443f89fadc94aae271d25be9e201148500cfa7f013ff7e24c94c1134738e95f7a200ed204378a4dee65cd72e7694e64f81c5911

data/README.md

@@ -4,6 +4,14 @@
 
 This is a plugin for Foreman that introduces integration with [NetBox](https://netbox.readthedocs.io)
 
+## Compatibility
+
+| Netbox Version | Plugin Version |
+| -------------- | -------------- |
+| 2.8            | 1.0            |
+| 2.11           | 1.1            |
+| 3.3            | 1.2            |
+
 ## Installation
 
 See [How_to_Install_a_Plugin](https://theforeman.org/manuals/2.3/index.html#6.1InstallaPlugin)

data/app/contracts/foreman_netbox/device_contract.rb

@@ -4,9 +4,9 @@ module ForemanNetbox
   class DeviceContract < Dry::Validation::Contract
     # rubocop:disable Metrics/BlockLength
     params do
-      optional(:tenant).hash(ForemanNetbox::Params::TenantParams.new)
-      optional(:ip_addresses).array(ForemanNetbox::Params::IpAddressParams.new)
-      optional(:interfaces).array(ForemanNetbox::Params::InterfaceParams.new)
+      optional(:tenant).hash(ForemanNetbox::Params::TenantParams)
+      optional(:ip_addresses).array(ForemanNetbox::Params::IpAddressParams)
+      optional(:interfaces).array(ForemanNetbox::Params::InterfaceParams)
 
       required(:device).filled(:hash) do
         required(:name).filled(:string)

data/app/contracts/foreman_netbox/params/interface_params.rb

@@ -2,15 +2,13 @@
 
 module ForemanNetbox
   module Params
-    class InterfaceParams < Dry::Schema::Params
-      define do
-        required(:name).filled(:string)
-        required(:type).filled(:hash) do
-          required(:value).filled(:string)
-        end
-        optional(:mac_address).maybe(:string)
-        optional(:tags).array(:string)
+    InterfaceParams = Dry::Schema.Params do
+      required(:name).filled(:string)
+      required(:type).filled(:hash) do
+        required(:value).filled(:string)
       end
+      optional(:mac_address).maybe(:string)
+      optional(:tags).array(:string)
     end
   end
 end

data/app/contracts/foreman_netbox/params/ip_address_params.rb

@@ -2,14 +2,12 @@
 
 module ForemanNetbox
   module Params
-    class IpAddressParams < Dry::Schema::Params
-      define do
-        required(:address).filled(:string)
-        required(:interface).filled(:hash) do
-          required(:name).filled(:string)
-        end
-        optional(:tags).array(:string)
+    IpAddressParams = Dry::Schema.Params do
+      required(:address).filled(:string)
+      required(:interface).filled(:hash) do
+        required(:name).filled(:string)
       end
+      optional(:tags).array(:string)
     end
   end
 end

data/app/contracts/foreman_netbox/params/tenant_params.rb

@@ -2,12 +2,10 @@
 
 module ForemanNetbox
   module Params
-    class TenantParams < Dry::Schema::Params
-      define do
-        required(:name).filled(:string)
-        required(:slug).filled(:string)
-        optional(:tags).array(:string)
-      end
+    TenantParams = Dry::Schema.Params do
+      required(:name).filled(:string)
+      required(:slug).filled(:string)
+      optional(:tags).array(:string)
     end
   end
 end

data/app/contracts/foreman_netbox/virtual_machine_contract.rb

@@ -3,9 +3,9 @@
 module ForemanNetbox
   class VirtualMachineContract < Dry::Validation::Contract
     params do
-      optional(:tenant).hash(ForemanNetbox::Params::TenantParams.new)
-      optional(:ip_addresses).array(ForemanNetbox::Params::IpAddressParams.new)
-      optional(:interfaces).array(ForemanNetbox::Params::InterfaceParams.new)
+      optional(:tenant).hash(ForemanNetbox::Params::TenantParams)
+      optional(:ip_addresses).array(ForemanNetbox::Params::IpAddressParams)
+      optional(:interfaces).array(ForemanNetbox::Params::InterfaceParams)
 
       required(:virtual_machine).filled(:hash) do
         required(:name).filled(:string)

data/app/interactors/foreman_netbox/concerns/assign_tags.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module Concerns
+    module AssignTags
+      delegate :tags, to: :context
+
+      def assign_tags_to(object)
+        current_tag_ids = object.tags.pluck('id')
+
+        return if (default_tag_ids - current_tag_ids).empty?
+
+        object.tags = current_tag_ids | default_tag_ids
+      end
+
+      def default_tag_ids
+        tags.map(&:id)
+      end
+    end
+  end
+end

data/app/interactors/foreman_netbox/sync_host/sync_device/create.rb

@@ -5,6 +5,7 @@ module ForemanNetbox
     module SyncDevice
       class Create
         include ::Interactor
+        include ForemanNetbox::Concerns::AssignTags
 
         around do |interactor|
           interactor.call unless context.device
@@ -27,7 +28,8 @@ module ForemanNetbox
             device_type: device_type.id,
             device_role: device_role.id,
             site: site.id,
-            tenant: tenant&.id
+            tenant: tenant&.id,
+            tags: default_tag_ids
           ).compact
         end
       end

data/app/interactors/foreman_netbox/sync_host/sync_device/organizer.rb

@@ -15,6 +15,7 @@ module ForemanNetbox
         end
 
         organize SyncDevice::Validate,
+                 SyncHost::SyncTags::Organizer,
                  SyncHost::SyncTenant::Organizer,
                  SyncDevice::SyncSite::Organizer,
                  SyncDevice::SyncDeviceRole::Organizer,

data/app/interactors/foreman_netbox/sync_host/sync_device/save_netbox_url.rb

@@ -21,7 +21,7 @@ module ForemanNetbox
         delegate :url, to: :netbox_facet, prefix: true, allow_nil: true
 
         def netbox_device_url
-          "#{Setting::Netbox[:netbox_url]}/dcim/devices/#{device&.id}" if device&.id
+          "#{Setting[:netbox_url]}/dcim/devices/#{device&.id}" if device&.id
         end
       end
     end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_device_type/create.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncDeviceType
         class Create
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call unless context.device_type
@@ -24,7 +25,7 @@ module ForemanNetbox
 
           def params
             netbox_params.fetch(:device_type)
-                         .merge(manufacturer: manufacturer.id)
+                         .merge(manufacturer: manufacturer.id, tags: default_tag_ids)
                          .compact
           end
         end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_device_type/update.rb

@@ -6,14 +6,14 @@ module ForemanNetbox
       module SyncDeviceType
         class Update
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call if context.device_type
           end
 
           def call
-            new_tags = new_device_type_params.fetch(:tags, []) - device_type.tags
-            device_type.tags = (device_type.tags | new_tags) if new_tags.any?
+            assign_tags_to(device_type)
 
             device_type.save
           rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/create.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncInterfaces
         class Create
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           after do
             context.interfaces.reload
@@ -20,7 +21,8 @@ module ForemanNetbox
                              new_interface.except(:type)
                                           .merge(
                                             type: new_interface.dig(:type, :value),
-                                            device: device.id
+                                            device: device.id,
+                                            tags: default_tag_ids
                                           )
                            ).save
                          end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/create.rb

@@ -7,6 +7,7 @@ module ForemanNetbox
         module SyncIpAddresses
           class Create
             include ::Interactor
+            include ForemanNetbox::Concerns::AssignTags
 
             def call
               netbox_params.fetch(:ip_addresses, []).map do |ip_address|
@@ -21,7 +22,11 @@ module ForemanNetbox
                                               .zero?
 
                 ForemanNetbox::API.client::IPAM::IpAddress.new(
-                  ip_address.slice(:address, :tags).merge(interface: interface_id)
+                  ip_address.slice(:address)
+                            .merge(
+                              assigned_object_type: 'dcim.interface', assigned_object_id: interface_id,
+                              tags: default_tag_ids
+                            )
                 ).save
               end
             rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/delete.rb

@@ -25,7 +25,7 @@ module ForemanNetbox
                                                                .map { |i| i.fetch(:address) }
 
                 context.ip_addresses
-                       .select { |ip| ip['interface']['id'] == netbox_interface.id }
+                       .select { |ip| ip['assigned_object_type'] == 'dcim.interface' && ip['assigned_object_id'] == netbox_interface.id }
                        .reject { |ip| host_interface_ips.include?(ip['address']) }
                        .each(&:delete)
               end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/sync_ip_addresses/update.rb

@@ -7,12 +7,11 @@ module ForemanNetbox
         module SyncIpAddresses
           class Update
             include ::Interactor
+            include ForemanNetbox::Concerns::AssignTags
 
             def call
               context.ip_addresses.each do |ip_address|
-                new_tags = tags_map.fetch(ip_address[:address], []) - ip_address.tags
-
-                ip_address.tags = (ip_address.tags | new_tags) if new_tags.any?
+                assign_tags_to(ip_address)
 
                 ip_address.save
               end
@@ -20,17 +19,6 @@ module ForemanNetbox
               ::Foreman::Logging.logger('foreman_netbox/import').error("#{self.class} error #{e}: #{e.backtrace}")
               context.fail!(error: "#{self.class}: #{e}")
             end
-
-            private
-
-            delegate :netbox_params, to: :context
-
-            def tags_map
-              netbox_params.fetch(:ip_addresses, [])
-                           .each_with_object({}) do |item, memo|
-                             memo[item[:address]] = item.fetch(:tags, [])
-                           end
-            end
           end
         end
       end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_interfaces/update.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncInterfaces
         class Update
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           def call
             context.interfaces.each { |netbox_interface| update(netbox_interface) }
@@ -22,9 +23,7 @@ module ForemanNetbox
             return unless new_params
 
             netbox_interface.mac_address = new_params[:mac_address] if netbox_interface.mac_address != new_params[:mac_address]
-
-            new_tags = new_params.fetch(:tags, []) - netbox_interface.tags
-            netbox_interface.tags = (netbox_interface.tags | new_tags) if new_tags.any?
+            assign_tags_to(netbox_interface)
 
             netbox_interface.save
           rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_site/create.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncSite
         class Create
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call unless context.site
@@ -23,7 +24,9 @@ module ForemanNetbox
           delegate :netbox_params, to: :context
 
           def params
-            netbox_params.fetch(:site).compact
+            netbox_params.fetch(:site)
+                         .merge(tags: default_tag_ids)
+                         .compact
           end
         end
       end

data/app/interactors/foreman_netbox/sync_host/sync_device/sync_site/update.rb

@@ -6,14 +6,14 @@ module ForemanNetbox
       module SyncSite
         class Update
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call if context.site
           end
 
           def call
-            new_tags = new_site_params.fetch(:tags, []) - site.tags
-            site.tags = (site.tags | new_tags) if new_tags.any?
+            assign_tags_to(site)
 
             site.save
           rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
@@ -21,13 +21,7 @@ module ForemanNetbox
             context.fail!(error: "#{self.class}: #{e}")
           end
 
-          private
-
-          delegate :netbox_params, :site, to: :context
-
-          def new_site_params
-            netbox_params.fetch(:site, {})
-          end
+          delegate :site, to: :context
         end
       end
     end

data/app/interactors/foreman_netbox/sync_host/sync_device/update.rb

@@ -6,8 +6,9 @@ module ForemanNetbox
       class Update
         include ::Interactor
         include ForemanNetbox::Concerns::PrimaryIps
+        include ForemanNetbox::Concerns::AssignTags
 
-        ATTRIBUTES = %i[name device_role device_type primary_ip4 primary_ip6 site tenant serial tags].freeze
+        ATTRIBUTES = %i[name device_role device_type primary_ip4 primary_ip6 site tenant serial].freeze
 
         around do |interactor|
           interactor.call if context.device
@@ -19,6 +20,7 @@ module ForemanNetbox
 
         def call
           assign_new_attributes
+          assign_tags_to(device)
 
           device.save
         rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
@@ -60,6 +62,8 @@ module ForemanNetbox
         end
 
         def assign_site
+          return if device.site&.id && Setting[:netbox_skip_site_update]
+
           device.site = site&.id if device.site&.id != site&.id
         end
 
@@ -73,12 +77,6 @@ module ForemanNetbox
 
           device.serial = new_serial
         end
-
-        def assign_tags
-          new_tags = new_device_params.fetch(:tags, []) - device.tags
-
-          device.tags = (device.tags | new_tags) if new_tags.any?
-        end
       end
     end
   end

data/app/interactors/foreman_netbox/sync_host/sync_tags/create.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncTags
+      class Create
+        include ::Interactor
+
+        def call
+          context.tags.push(*new_tags)
+        end
+
+        private
+
+        def new_tags
+          SyncTags::Organizer::DEFAULT_TAGS
+            .reject { |params| existing_slugs.include?(params[:slug]) }
+            .map { |params| ForemanNetbox::API.client::Extras::Tag.new(params).save }
+        rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
+          ::Foreman::Logging.logger('foreman_netbox/import').error("#{self.class} error #{e}: #{e.backtrace}")
+          context.fail!(error: "#{self.class}: #{e}")
+        end
+
+        def existing_slugs
+          @existing_slugs ||= context.tags.pluck(:slug)
+        end
+      end
+    end
+  end
+end

data/app/interactors/foreman_netbox/sync_host/sync_tags/find.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncTags
+      class Find
+        include ::Interactor
+
+        def call
+          context.tags = slugs.map do |slug|
+            ForemanNetbox::API.client.extras.tags.find_by(slug: slug)
+          end.compact
+        rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
+          ::Foreman::Logging.logger('foreman_netbox/import').error("#{self.class} error #{e}: #{e.backtrace}")
+          context.fail!(error: "#{self.class}: #{e}")
+        end
+
+        private
+
+        def slugs
+          SyncTags::Organizer::DEFAULT_TAGS.pluck(:slug)
+        end
+      end
+    end
+  end
+end

data/app/interactors/foreman_netbox/sync_host/sync_tags/organizer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncTags
+      class Organizer
+        include ::Interactor::Organizer
+
+        DEFAULT_TAGS = [
+          { name: 'foreman', slug: 'foreman' }
+        ].freeze
+
+        after do
+          context.raw_data[:tags] = context.tags.map(&:raw_data!)
+        end
+
+        organize SyncTags::Find,
+                 SyncTags::Create
+      end
+    end
+  end
+end

data/app/interactors/foreman_netbox/sync_host/sync_tenant/create.rb

@@ -5,6 +5,7 @@ module ForemanNetbox
     module SyncTenant
       class Create
         include ::Interactor
+        include ForemanNetbox::Concerns::AssignTags
 
         around do |interactor|
           interactor.call unless context.tenant
@@ -22,7 +23,9 @@ module ForemanNetbox
         delegate :netbox_params, to: :context
 
         def params
-          netbox_params.fetch(:tenant).compact
+          netbox_params.fetch(:tenant)
+                       .merge(tags: default_tag_ids)
+                       .compact
         end
       end
     end

data/app/interactors/foreman_netbox/sync_host/sync_tenant/update.rb

@@ -5,14 +5,14 @@ module ForemanNetbox
     module SyncTenant
       class Update
         include ::Interactor
+        include ForemanNetbox::Concerns::AssignTags
 
         around do |interactor|
           interactor.call if context.tenant
         end
 
         def call
-          new_tags = new_tenant_params.fetch(:tags, []) - tenant.tags
-          tenant.tags = (tenant.tags | new_tags) if new_tags.any?
+          assign_tags_to(tenant)
 
           tenant.save
         rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
@@ -20,13 +20,7 @@ module ForemanNetbox
           context.fail!(error: "#{self.class}: #{e}")
         end
 
-        private
-
-        delegate :netbox_params, :tenant, to: :context
-
-        def new_tenant_params
-          netbox_params.fetch(:tenant, {})
-        end
+        delegate :tenant, to: :context
       end
     end
   end

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/create.rb

@@ -5,6 +5,7 @@ module ForemanNetbox
     module SyncVirtualMachine
       class Create
         include ::Interactor
+        include ForemanNetbox::Concerns::AssignTags
 
         around do |interactor|
           interactor.call unless context.virtual_machine
@@ -25,7 +26,8 @@ module ForemanNetbox
         def params
           netbox_params.fetch(:virtual_machine).merge(
             cluster: cluster.id,
-            tenant: tenant&.id
+            tenant: tenant&.id,
+            tags: default_tag_ids
           ).compact
         end
       end

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/organizer.rb

@@ -15,6 +15,7 @@ module ForemanNetbox
         end
 
         organize SyncVirtualMachine::Validate,
+                 SyncHost::SyncTags::Organizer,
                  SyncHost::SyncTenant::Organizer,
                  SyncVirtualMachine::SyncCluster::Organizer,
                  SyncVirtualMachine::Find,

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/save_netbox_url.rb

@@ -23,7 +23,7 @@ module ForemanNetbox
         def netbox_virtual_machine_url
           return unless context.virtual_machine&.id
 
-          "#{Setting::Netbox[:netbox_url]}/virtualization/virtual-machines/#{context.virtual_machine&.id}"
+          "#{Setting[:netbox_url]}/virtualization/virtual-machines/#{context.virtual_machine&.id}"
         end
       end
     end

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/sync_cluster/create.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncCluster
         class Create
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call unless context.cluster
@@ -25,7 +26,8 @@ module ForemanNetbox
 
           def params
             netbox_params.fetch(:cluster).merge(
-              type: cluster_type&.id
+              type: cluster_type&.id,
+              tags: default_tag_ids
             ).compact
           end
         end

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/sync_cluster/update.rb

@@ -6,14 +6,14 @@ module ForemanNetbox
       module SyncCluster
         class Update
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           around do |interactor|
             interactor.call if context.cluster
           end
 
           def call
-            new_tags = new_cluster_params.fetch(:tags, []) - cluster.tags
-            cluster.tags = (cluster.tags | new_tags) if new_tags.any?
+            assign_tags_to(cluster)
 
             cluster.save
           rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e
@@ -21,13 +21,7 @@ module ForemanNetbox
             context.fail!(error: "#{self.class}: #{e}")
           end
 
-          private
-
-          delegate :netbox_params, :cluster, to: :context
-
-          def new_cluster_params
-            netbox_params.fetch(:cluster, {})
-          end
+          delegate :cluster, to: :context
         end
       end
     end

data/app/interactors/foreman_netbox/sync_host/sync_virtual_machine/sync_interfaces/create.rb

@@ -6,6 +6,7 @@ module ForemanNetbox
       module SyncInterfaces
         class Create
           include ::Interactor
+          include ForemanNetbox::Concerns::AssignTags
 
           after do
             context.interfaces.reload
@@ -17,7 +18,11 @@ module ForemanNetbox
                          .reject { |i| interfaces.map(&:name).include?(i[:name]) }
                          .map do |new_interface|
                            ForemanNetbox::API.client::Virtualization::Interface.new(
-                             new_interface.except(:type).merge(virtual_machine: virtual_machine.id)
+                             new_interface.except(:type)
+                                          .merge(
+                                            virtual_machine: virtual_machine.id,
+                                            tags: default_tag_ids
+                                          )
                            ).save
                          end
           rescue NetboxClientRuby::LocalError, NetboxClientRuby::ClientError, NetboxClientRuby::RemoteError => e