foreman_netbox 1.0.2

data/README.md

@@ -0,0 +1,50 @@
+# ForemanNetbox
+
+[<img src="https://opensourcelogos.aws.dmtech.cloud/dmTECH_opensource_logo.svg" height="21" width="130">](https://www.dmtech.de/)
+
+This is a plugin for Foreman that introduces integration with [NetBox](https://netbox.readthedocs.io)
+
+## Installation
+
+See [How_to_Install_a_Plugin](https://theforeman.org/manuals/2.3/index.html#6.1InstallaPlugin)
+for how to install Foreman plugins.
+
+The gem name is "foreman_netbox".
+
+
+
+## Integration tests
+
+The easiest way to start Netbox is to use [netbox-docker](https://github.com/netbox-community/netbox-docker). To run integration tests provide `FOREMAN_NETBOX_URL` and `FOREMAN_NETBOX_TOKEN` variables, eg.
+
+```
+$ FOREMAN_NETBOX_URL=http://0.0.0.0:8000 FOREMAN_NETBOX_TOKEN=0123456789abcdef0123456789abcdef01234567 bundle exec rake test:foreman_netbox
+```
+
+After installation of the plugin you can find these settings as well under Administer/Settings/Netbox tab.
+
+You will find there as well a Netbox Orchestration Switch.
+
+If the switch is enabled every change of a Foreman Hostobject will be synced with your netbox instance.
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+Copyright (c) 2019 dmTECH GmbH, [dmtech.de](https://www.dmtech.de/)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/Rakefile

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# !/usr/bin/env rake
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanNetbox'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue StandardError
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
+end

data/app/contracts/foreman_netbox/device_contract.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+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)
+
+      required(:device).filled(:hash) do
+        required(:name).filled(:string)
+        optional(:serial).maybe(:string)
+        optional(:tags).array(:string)
+      end
+
+      required(:device_type).filled(:hash) do
+        required(:model).filled(:string)
+        required(:slug).filled(:string)
+        optional(:tags).array(:string)
+      end
+
+      required(:device_role).filled(:hash) do
+        required(:name).filled(:string)
+        required(:slug).filled(:string)
+        optional(:color).maybe(:string)
+      end
+
+      required(:manufacturer).filled(:hash) do
+        required(:name).filled(:string)
+        required(:slug).filled(:string)
+      end
+
+      required(:site).filled(:hash) do
+        required(:name).filled(:string)
+        required(:slug).filled(:string)
+        optional(:tags).array(:string)
+      end
+    end
+    # rubocop:enable Metrics/BlockLength
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module Params
+    class TenantParams < Dry::Schema::Params
+      define do
+        required(:name).filled(:string)
+        required(:slug).filled(:string)
+        optional(:tags).array(:string)
+      end
+    end
+  end
+end

data/app/contracts/foreman_netbox/virtual_machine_contract.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+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)
+
+      required(:virtual_machine).filled(:hash) do
+        required(:name).filled(:string)
+        optional(:vcpus).maybe(:integer)
+        optional(:memory).maybe(:integer)
+        optional(:disk).maybe(:integer)
+        optional(:tags).array(:string)
+      end
+
+      required(:cluster).filled(:hash) do
+        required(:name).filled(:string)
+        optional(:tags).array(:string)
+      end
+
+      required(:cluster_type).filled(:hash) do
+        required(:name).filled(:string)
+        required(:slug).filled(:string)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module Concerns
+    module Facts
+      def facts
+        context.host.facts.symbolize_keys
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module Concerns
+    module PrimaryIps
+      def primary_ip4
+        return if context.host.ip.blank?
+
+        ip_addresses_map[IPAddr.new(context.host.ip).to_i]
+      end
+
+      def primary_ip6
+        return if context.host.ip6.blank?
+
+        ip_addresses_map[IPAddr.new(context.host.ip6).to_i]
+      end
+
+      def ip_addresses_map
+        @ip_addresses_map ||= context.ip_addresses.each_with_object({}) do |ip, hash|
+          hash[ip.address.to_i] = ip.id
+        end
+      end
+    end
+  end
+end

data/app/interactors/foreman_netbox/delete_host/delete_device.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module DeleteHost
+    class DeleteDevice
+      include ::Interactor
+
+      around do |interactor|
+        interactor.call unless context.host.compute?
+      end
+
+      def call
+        ForemanNetbox::API.client.dcim.devices.find_by(name: context.host.name)&.delete
+      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
+    end
+  end
+end

data/app/interactors/foreman_netbox/delete_host/delete_virtual_machine.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module DeleteHost
+    class DeleteVirtualMachine
+      include ::Interactor
+
+      around do |interactor|
+        interactor.call if context.host.compute?
+      end
+
+      def call
+        ForemanNetbox::API.client.virtualization.virtual_machines.find_by(name: context.host.name)&.delete
+      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
+    end
+  end
+end

data/app/interactors/foreman_netbox/delete_host/organizer.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module DeleteHost
+    class Organizer
+      include ::Interactor::Organizer
+
+      organize DeleteHost::DeleteVirtualMachine,
+               DeleteHost::DeleteDevice
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    class Organizer
+      include ::Interactor::Organizer
+
+      before do
+        context.netbox_params = context.host.netbox_facet.netbox_params
+        context.raw_data = {}
+      end
+
+      organize SyncHost::SyncVirtualMachine::Organizer,
+               SyncHost::SyncDevice::Organizer
+
+      def call
+        super
+
+        update_status
+      rescue Interactor::Failure => e
+        update_status
+        raise e
+      end
+
+      private
+
+      delegate :host, :error, to: :context
+      delegate :netbox_facet, to: :host
+
+      def update_status
+        netbox_facet.update(synchronized_at: Time.zone.now, synchronization_error: error, raw_data: context.raw_data)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncDevice
+      class Create
+        include ::Interactor
+
+        around do |interactor|
+          interactor.call unless context.device
+        end
+
+        def call
+          context.device = ForemanNetbox::API.client::DCIM::Device.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
+
+        private
+
+        delegate :netbox_params, :device_type, :device_role, :site, to: :context
+        delegate :tenant, to: :context, allow_nil: true
+
+        def params
+          netbox_params.fetch(:device).merge(
+            device_type: device_type.id,
+            device_role: device_role.id,
+            site: site.id,
+            tenant: tenant&.id
+          ).compact
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncDevice
+      class Find
+        include ::Interactor
+
+        def call
+          # rubocop:disable Rails/DynamicFindBy
+          context.device = find_by_serial || find_by_mac || find_by_name
+          # rubocop:enable Rails/DynamicFindBy
+        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
+
+        delegate :host, :netbox_params, to: :context
+        delegate :mac, to: :host, allow_nil: true
+
+        def find_by_serial
+          serial = netbox_params.dig(:device, :serial)
+
+          ForemanNetbox::API.client.dcim.devices.filter(serial: serial).first if serial
+        end
+
+        def find_by_mac
+          ForemanNetbox::API.client.dcim.devices.filter(mac_address: mac).first if mac
+        end
+
+        def find_by_name
+          name = netbox_params.dig(:device, :name)
+
+          ForemanNetbox::API.client.dcim.devices.find_by(name: name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module ForemanNetbox
+  module SyncHost
+    module SyncDevice
+      class Organizer
+        include ::Interactor::Organizer
+
+        around do |interactor|
+          interactor.call unless context.host.compute?
+        end
+
+        after do
+          context.raw_data[:device] = context.device.raw_data!
+        end
+
+        organize SyncDevice::Validate,
+                 SyncHost::SyncTenant::Organizer,
+                 SyncDevice::SyncSite::Organizer,
+                 SyncDevice::SyncDeviceRole::Organizer,
+                 SyncDevice::SyncDeviceType::Organizer,
+                 SyncDevice::Find,
+                 SyncDevice::Create,
+                 SyncDevice::SyncInterfaces::Organizer,
+                 SyncDevice::Update,
+                 SyncDevice::SaveNetboxUrl
+      end
+    end
+  end
+end