foreman_ovirt 2.0.2 → 2.0.4

data/config/routes.rb

@@ -1,9 +1,12 @@
+# frozen_string_literal: true
+
 Rails.application.routes.draw do
-  namespace :api, :defaults => { :format => 'json' } do
-    scope "(:apiv)", :module => :v2, :defaults => { :apiv => 'v2' }, :apiv => /v1|v2/, :constraints => ApiConstraints.new(:version => 2, :default => true) do
-      constraints(:id => /[^\/]+/) do
-        resources :compute_resources, :except => [:new, :edit] do
-          get :available_vnic_profiles, :on => :member
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)', module: :v2, defaults: { apiv: 'v2' }, apiv: /v1|v2/,
+          constraints: ApiConstraints.new(version: 2, default: true) do
+      constraints(id: %r{[^/]+}) do
+        resources :compute_resources, except: %i[new edit] do
+          get :available_vnic_profiles, on: :member
         end
       end
     end

data/db/migrate/20250810212811_update_legacy_ovirt_compute_resource_type.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 class UpdateLegacyOvirtComputeResourceType < ActiveRecord::Migration[7.0]
   # Temporary model definition to ensure the migration is self-contained
   # and independent of the application's model, which may change over time.
-  class ComputeResource < ActiveRecord::Base
+  class ComputeResource < ApplicationRecord
     self.table_name = :compute_resources
     # Disable STI to allow direct manipulation of the 'type' column.
     self.inheritance_column = :_type_disabled
@@ -9,13 +11,13 @@ class UpdateLegacyOvirtComputeResourceType < ActiveRecord::Migration[7.0]
 
   # Migrate the legacy class name to the new plugin class name.
   def up
-    say "Updating legacy oVirt compute resource types to ForemanOvirt::Ovirt"
+    say 'Updating legacy oVirt compute resource types to ForemanOvirt::Ovirt'
     ComputeResource.where(type: 'Foreman::Model::Ovirt').update_all(type: 'ForemanOvirt::Ovirt')
   end
 
   # Revert the class name back to the legacy value.
   def down
-    say "Reverting oVirt compute resource types back to legacy Foreman::Model::Ovirt"
+    say 'Reverting oVirt compute resource types back to legacy Foreman::Model::Ovirt'
     ComputeResource.where(type: 'ForemanOvirt::Ovirt').update_all(type: 'Foreman::Model::Ovirt')
   end
 end

data/lib/foreman_ovirt/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanOvirt
   class Engine < ::Rails::Engine
     engine_name 'foreman_ovirt'
@@ -8,7 +10,7 @@ module ForemanOvirt
       end
     end
 
-    initializer 'foreman_ovirt.register_plugin', :before => :finisher_hook do |app|
+    initializer 'foreman_ovirt.register_plugin', before: :finisher_hook do |app|
       app.reloader.to_prepare do
         Foreman::Plugin.register :foreman_ovirt do
           requires_foreman '>= 3.16'
@@ -17,10 +19,10 @@ module ForemanOvirt
 
           register_global_js_file 'global'
 
-          security_block :foreman_ovirt do
-            permission :view_compute_resources, { :'foreman_ovirt/compute_resources' =>
-              [:available_vnic_profiles] }
-          end
+          p = Foreman::AccessControl.permission(:view_compute_resources)
+          p.actions.concat(%w[foreman_ovirt/compute_resources/available_vnic_profiles
+                              api/v2/compute_resources/available_vnic_profiles])
+          p.actions.uniq!
         end
       end
     end
@@ -57,6 +59,7 @@ module ForemanOvirt
 
       ::ComputeResourcesVmsController.include ForemanOvirt::ComputeResourcesVmsController
       ::ComputeResourcesController.include ForemanOvirt::ParametersExtension
+      ::Api::V2::ComputeResourcesController.include ForemanOvirt::ApiComputeResourcesControllerExtension
     rescue StandardError => e
       Rails.logger.warn "ForemanOvirt: skipping engine hook (#{e})"
     end

data/lib/foreman_ovirt/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ForemanOvirt
-  VERSION = '2.0.2'.freeze
+  VERSION = '2.0.4'
 end

data/lib/foreman_ovirt.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'foreman_ovirt/engine'
 
 module ForemanOvirt

data/lib/tasks/foreman_ovirt_tasks.rake

@@ -1,30 +1,45 @@
-# Ensure the task is only defined when the main app is loaded.
-if defined?(Rails) && Rails.application
-  namespace :foreman_ovirt do
-    namespace :db do
-      desc "Prevents the destructive core oVirt data migration from being run by marking it as complete."
-      task :prevent_core_migration => :environment do
-        # The version of the Foreman core migration to skip.
-        version_to_skip = 20250414121956
-        migration_context = ActiveRecord::Base.connection.migration_context
+# frozen_string_literal: true
 
-        all_migrations = migration_context.migrations.map(&:version)
-        run_migrations = migration_context.get_all_versions
+namespace :foreman_ovirt do
+  namespace :db do
+    desc 'Prevents destructive core oVirt data migration by marking it as complete'
+    task prevent_core_migration: :environment do
+      # The version of the Foreman core migration to skip.
+      version_to_skip = 20250414121956 # rubocop:disable Style/NumericLiterals
+      migration_context = ActiveRecord::Base.connection.migration_context
 
-        # A migration needs to be run if it exists on disk but is not yet marked as run in the database.
-        if all_migrations.include?(version_to_skip) && !run_migrations.include?(version_to_skip)
-          Rails.logger.info "[foreman_ovirt] Marking core migration #{version_to_skip} (MigrateOvirtResources) as complete to prevent data loss."
-          ActiveRecord::SchemaMigration.create!(version: version_to_skip.to_s)
-          Rails.logger.info "[foreman_ovirt] Core migration successfully skipped."
-        else
-          Rails.logger.debug "[foreman_ovirt] Core migration #{version_to_skip} does not need to be skipped (already migrated or not found)."
-        end
+      all_migrations = migration_context.migrations.map(&:version)
+      run_migrations = migration_context.get_all_versions
+
+      # A migration needs to be run if:
+      # - it's not a fresh (empty) database
+      # - the migration exists on disk but is not yet marked as run in the database
+      if migration_context.current_version != 0 && all_migrations.include?(version_to_skip) &&
+         !run_migrations.include?(version_to_skip)
+        Rails.logger.info "[foreman_ovirt] Marking core migration #{version_to_skip} as complete to prevent data loss."
+        ActiveRecord::SchemaMigration.create!(version: version_to_skip.to_s)
+        Rails.logger.info '[foreman_ovirt] Core migration successfully skipped.'
+      else
+        Rails.logger.debug "[foreman_ovirt] Core migration #{version_to_skip} already migrated or not found."
       end
     end
   end
+end
 
-  # Enhance the core db:migrate task to run our prevention task first.
-  if Rake::Task.task_defined?('db:migrate')
-    Rake::Task['db:migrate'].enhance(['foreman_ovirt:db:prevent_core_migration'])
+# Enhance the core db:migrate task to run our prevention task first.
+Rake::Task['db:migrate'].enhance(['foreman_ovirt:db:prevent_core_migration']) if Rake::Task.task_defined?('db:migrate')
+
+# Tests
+namespace :test do
+  desc 'Test Foreman Ovirt'
+  Rake::TestTask.new(:foreman_ovirt) do |t|
+    test_dir = File.expand_path('../../test', __dir__)
+    t.libs << 'test'
+    t.libs << test_dir
+    t.pattern = "#{test_dir}/**/*_test.rb"
+    t.verbose = true
+    t.warning = false
   end
 end
+
+Rake::Task[:test].enhance ['test:foreman_ovirt'] if Rake::Task.task_defined?(:test)

data/locale/gemspec.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Matches foreman_ovirt.gemspec
-_('ForemanOvirt plugin adds oVirt compute resource to Foreman using fog-ovirt.')
+_('The Foreman oVirt plugin adds oVirt compute resource to Foreman using fog-ovirt.')

data/package.json

@@ -26,6 +26,7 @@
   },
   "devDependencies": {
     "@babel/core": "^7.7.0",
+    "@sheerun/mutationobserver-shim": "^0.3.3",
     "@theforeman/builder": ">= 15.0.1",
     "@theforeman/eslint-plugin-foreman": ">= 15.0.1",
     "@theforeman/find-foreman": ">= 15.0.1",

data/test/controllers/api/v2/compute_resources_controller_test.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'fog/ovirt/models/compute/quota'
+
+module Api
+  module V2
+    # rubocop:disable Metrics/ClassLength
+    class OvirtComputeResourcesControllerTest < ActionController::TestCase
+      # rubocop:enable Metrics/ClassLength
+      tests Api::V2::ComputeResourcesController
+
+      def setup
+        Fog.mock!
+      end
+
+      def teardown
+        Fog.unmock!
+      end
+
+      context 'ovirt available resources' do
+        setup do
+          @ovirt_object = Object.new
+          @ovirt_object.stubs(:name).returns('test_ovirt_object')
+          @ovirt_object.stubs(:id).returns('my11-test35-uuid99')
+
+          quota = Fog::Ovirt::Compute::Quota.new(id: '1', name: 'Default')
+          client_mock = mock.tap { |m| m.stubs(datacenters: [], quotas: [quota], servers: []) }
+          ForemanOvirt::Ovirt.any_instance.stubs(:client).returns(client_mock)
+
+          @ovirt_cr = FactoryBot.create(:ovirt_cr)
+        end
+
+        teardown do
+          if @response.present? && @response.code.to_i.between?(200, 299)
+            available_objects = ActiveSupport::JSON.decode(@response.body)
+            assert_not_empty available_objects
+          end
+        end
+
+        test 'should get available virtual machines' do
+          ForemanOvirt::Ovirt.any_instance.stubs(:available_virtual_machines).returns([@ovirt_object])
+          get :available_virtual_machines, params: { id: @ovirt_cr.to_param }
+        end
+
+        test 'should get available networks' do
+          ForemanOvirt::Ovirt.any_instance.stubs(:available_networks).returns([@ovirt_object])
+          get :available_networks, params: { id: @ovirt_cr.to_param, cluster_id: '123-456-789' }
+        end
+
+        test 'should get available clusters' do
+          ForemanOvirt::Ovirt.any_instance.stubs(:available_clusters).returns([@ovirt_object])
+          get :available_clusters, params: { id: @ovirt_cr.to_param }
+        end
+
+        test 'should get available storage domains' do
+          ForemanOvirt::Ovirt.any_instance.stubs(:available_storage_domains).returns([@ovirt_object])
+          get :available_storage_domains, params: { id: @ovirt_cr.to_param }
+        end
+      end
+
+      context 'ovirt datacenters' do
+        setup do
+          quota = Fog::Ovirt::Compute::Quota.new(id: '1', name: 'Default')
+          client_mock = mock.tap { |m| m.stubs(datacenters: [], quotas: [quota], servers: []) }
+          ForemanOvirt::Ovirt.any_instance.stubs(:client).returns(client_mock)
+        end
+
+        test 'should create with datacenter name' do
+          datacenter_uuid = Foreman.uuid
+          ForemanOvirt::Ovirt.any_instance.stubs(:get_datacenter_uuid).returns(datacenter_uuid)
+          ForemanOvirt::Ovirt.any_instance.stubs(:test_connection).returns(true)
+
+          attrs = { name: 'Ovirt-create-test', url: 'https://myovirt/api', provider: 'ovirt',
+                    datacenter: 'test', user: 'user@example.com', password: 'secret' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_response :created
+          assert_equal datacenter_uuid, ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+
+        test 'should create with datacenter uuid' do
+          datacenter_uuid = Foreman.uuid
+          # Implicitly tests that conversion is skipped
+          ForemanOvirt::Ovirt.any_instance.expects(:get_datacenter_uuid).never
+
+          attrs = { name: 'Ovirt-create-test', url: 'https://myovirt/api', provider: 'ovirt',
+                    datacenter: datacenter_uuid, user: 'user@example.com', password: 'secret' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_response :created
+          assert_equal datacenter_uuid, ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+
+        test 'should update with datacenter name' do
+          datacenter_uuid = Foreman.uuid
+          compute_resource = FactoryBot.create(:ovirt_cr)
+
+          ForemanOvirt::Ovirt.any_instance.stubs(:get_datacenter_uuid).returns(datacenter_uuid)
+          ForemanOvirt::Ovirt.any_instance.stubs(:test_connection).returns(true)
+
+          attrs = { datacenter: 'test' }
+          put :update, params: { id: compute_resource.id, compute_resource: attrs }
+
+          assert_response :ok
+          assert_equal datacenter_uuid, ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+
+        test 'should update with datacenter uuid' do
+          datacenter_uuid = Foreman.uuid
+          compute_resource = FactoryBot.create(:ovirt_cr)
+
+          # Implicitly tests that conversion is skipped
+          ForemanOvirt::Ovirt.any_instance.expects(:get_datacenter_uuid).never
+
+          attrs = { datacenter: datacenter_uuid }
+          put :update, params: { id: compute_resource.id, compute_resource: attrs }
+
+          assert_response :ok
+          assert_equal datacenter_uuid, ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+
+        test 'should handle datacenter conversion failure' do
+          exception_msg = 'Datacenter not found or Auth failed'
+          ForemanOvirt::Ovirt.any_instance.stubs(:test_connection).raises(Foreman::Exception.new(exception_msg))
+
+          attrs = { name: 'Ovirt-rescue-test', url: 'https://myovirt/api', provider: 'ovirt',
+                    datacenter: 'Failing-DC', user: 'user@example.com', password: 'secret' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_response :unprocessable_entity
+        end
+
+        test 'should skip conversion safely if datacenter is completely omitted or blank' do
+          ForemanOvirt::Ovirt.any_instance.expects(:get_datacenter_uuid).never
+          attrs = { name: 'Ovirt-omitted-test', url: 'https://myovirt/api', provider: 'ovirt',
+                    user: 'user@example.com', password: 'secret' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_response :created
+          assert_nil ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+
+        test 'should skip datacenter conversion if provider is not ovirt' do
+          ForemanOvirt::Ovirt.any_instance.expects(:get_datacenter_uuid).never
+
+          attrs = { name: 'Non-Ovirt-test', url: 'qemu:///system', provider: 'Libvirt', datacenter: 'leave-me-alone' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_equal 'leave-me-alone', @controller.params[:compute_resource][:datacenter]
+        end
+
+        test 'should handle provider name with different casing' do
+          datacenter_uuid = Foreman.uuid
+          ForemanOvirt::Ovirt.any_instance.stubs(:get_datacenter_uuid).returns(datacenter_uuid)
+          ForemanOvirt::Ovirt.any_instance.stubs(:test_connection).returns(true)
+
+          attrs = { name: 'Ovirt-uppercase-test', url: 'https://myovirt/api', provider: 'OVIRT',
+                    datacenter: 'test', user: 'user@example.com', password: 'secret' }
+          post :create, params: { compute_resource: attrs }
+
+          assert_response :created
+          assert_equal datacenter_uuid, ActiveSupport::JSON.decode(@response.body)['datacenter']
+        end
+      end
+
+      test 'should skip datacenter conversion on update if provider is not ovirt' do
+        compute_resource = FactoryBot.create(:vmware_cr)
+        ForemanOvirt::Ovirt.any_instance.expects(:get_datacenter_uuid).never
+
+        attrs = { datacenter: 'leave-me-alone' }
+        put :update, params: { id: compute_resource.id, compute_resource: attrs }
+
+        assert_equal 'leave-me-alone', @controller.params[:compute_resource][:datacenter]
+      end
+
+      context 'ovirt cache refreshing' do
+        test 'should fail if unsupported' do
+          ovirt_cr = FactoryBot.create(:ovirt_cr)
+          put :refresh_cache, params: { id: ovirt_cr.to_param }
+          assert_response :error
+        end
+      end
+    end
+  end
+end

data/test/controllers/hosts_controller_test.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'test_plugin_helper'
+require 'fog/ovirt/models/compute/quota'
+
+module ForemanOvirt
+  class HostsControllerTest < ActionController::TestCase
+    tests ::HostsController
+
+    setup do
+      User.current = users(:admin)
+    end
+
+    test '#host update preserves association despite quota validation' do
+      hostgroup = FactoryBot.create(:hostgroup, :with_subnet, :with_domain, :with_os)
+
+      compute_resource = FactoryBot.build(:ovirt_cr)
+      compute_resource.stubs(:update_public_key)
+
+      # Setup quota mock to test that quota validation doesn't interfere with host update
+      quota = Fog::Ovirt::Compute::Quota.new(id: '1', name: 'Default')
+      client_mock = mock.tap { |m| m.stubs(datacenters: [], quotas: [quota]) }
+      compute_resource.stubs(:client).returns(client_mock)
+      compute_resource.save!
+
+      compute_resource.update(locations: hostgroup.locations, organizations: hostgroup.organizations)
+      host = FactoryBot.create(:host, hostgroup: hostgroup, compute_resource: compute_resource)
+
+      # Simulate form submission without compute_resource_id to test preservation
+      host_attributes = host.attributes.except('id', 'created_at', 'updated_at', 'compute_resource_id')
+
+      put :update, params: { commit: 'Update', id: host.id, host: host_attributes }, session: set_session_user
+
+      assert_response :redirect
+      host.reload
+      assert_equal compute_resource.id, host.compute_resource_id,
+        'Host should remain associated with compute resource after update'
+    end
+
+    private
+
+    def set_session_user
+      { user: User.current.id }
+    end
+  end
+end

data/test/factories/foreman_ovirt_factories.rb

@@ -1,5 +1,30 @@
+# frozen_string_literal: true
+
 FactoryBot.define do
-  factory :host do
-    name 'foreman_ovirt'
+  # This file defines factories for the ForemanOvirt plugin.
+  # The factory for the oVirt compute resource.
+  factory :ovirt_cr,
+    class: 'ForemanOvirt::Ovirt', parent: :compute_resource do
+    name { 'oVirt' }
+    url do
+      'https://ovirt.example.com/ovirt-engine/api'
+    end
+    user do
+      'admin@internal'
+    end
+    password do
+      'secret'
+    end
+    uuid do
+      '56396f90-84c4-11e1-88f5-1231381c4021'
+    end
+    provider do
+      'Ovirt'
+    end
+
+    # This ensures the test doesn't actually try to talk to a real server
+    after(:build) do |cr|
+      cr.stubs(:update_public_key)
+    end
   end
 end