foreman_ovirt 0.2.0 → 2.0.0

data/README.md

@@ -0,0 +1,140 @@
+# ForemanOvirt
+
+#### Table of Contents
+
+1. [Overview](#overview)
+1. [Installation](#installation)
+1. [Usage](#usage)
+1. [Development](#development)
+    - [Dev prerequisites](#dev-prerequisites)
+    - [Dev server](#dev-server)
+1. [Contributing](#contributing)
+1. [Copyright](#copyright)
+    - [Plugin](#plugin)
+    - [The Foreman](#the-forman)
+
+## Overview
+
+[Foreman](http://theforeman.org/) plugin that adds [oVirt](https://www.ovirt.org) compute resource: managing virtual machines using the [fog-ovirt](https://github.com/fog/fog-ovirt) module.
+
+This plugin continues the oVirt support that was part of Foreman up to version 3.15 and is now maintained as a standalone plugin. It requires Foreman 3.16+.
+
+## Installation
+
+### From OS packages
+
+On Rocky/Alma/RedHat:
+
+```shell
+sudo dnf install rubygem-foreman_ovirt
+```
+
+On Debian/Ubuntu:
+
+```shell
+sudo apt-get install ruby-foreman-ovirt
+```
+
+## Usage
+
+Create a oVirt compute resource and set:
+
+* Provider: `oVirt`
+* URL: `https://ovirt.example.com/ovirt-engine/api`
+* Username: `admin@internal`
+
+Then click on "Load Datacenters" and add all necessary information to the form.
+
+## Development
+
+### Dev prerequisites
+
+See [Foreman dev setup](https://github.com/theforeman/foreman/blob/develop/developer_docs/foreman_dev_setup.asciidoc) and [foreman plugin development](https://github.com/theforeman/foreman/blob/develop/developer_docs/how_to_create_a_plugin.asciidoc) for details and a full explanation.
+
+* oVirt 4.5+ is required
+* NodeJS on the dev machine to run webpack-dev-server
+
+### Dev server
+
+NOTE: The following ignores all OS-dependant tasks and commands. Please see the official Foreman developer guide for an in-depth walkthrough.
+
+Fork and clone this plugin repository:
+
+```shell
+git clone https://github.com/YOUR_FORK/foreman_ovirt.git
+```
+
+Minimal steps to setup a Foreman dev instance:
+
+```shell
+git clone https://github.com/theforeman/foreman.git -b develop
+cd foreman
+cp config/settings.yaml.example config/settings.yaml
+cp config/database.yml.example config/database.yml
+```
+
+Edit `bundler.d/ovirt.rb` and add this content:
+
+```ruby
+gem 'fog-ovirt'
+gem 'foreman_ovirt', :path => '/path/to/foreman_ovirt'
+gem 'irb' # dev
+```
+
+In foreman directory, install dependencies:
+
+```shell
+bundle install --path vendor
+npm install
+```
+
+Run Foreman dev server:
+
+```shell
+BIND=0.0.0.0 bundle exec foreman start
+```
+
+Note that the bundled webpack server may consume HUGE amounts of RAM on startup.
+
+## Contributing
+
+Fork and send a Pull Request. Thanks!
+
+## Copyright
+
+### Plugin
+
+Copyright (c) 2025 markt.de GmbH & Co. KG
+
+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/>.
+
+The [LICENSE](LICENSE) file contains the full text of the GNU GPL v3 license, along with the text for all additional licenses referenced above.
+
+### The Foreman
+
+This plugin is based on code from Foreman 3.15.0.
+
+The Foreman repository/package is licensed under the GNU GPL v3 or newer, with some exceptions.
+
+Copyright (c) 2009-2020 to Ohad Levy, Paul Kelly and their respective owners.
+
+All copyright holders for the Foreman project are in the separate file called Contributors.
+
+Except where specified below, this program and entire repository 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 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 [GNU licenses](http://www.gnu.org/licenses/).
+
+All rights reserved.

data/Rakefile

@@ -1,53 +1,47 @@
-# encoding: utf-8
-
-require 'rubygems'
-require 'bundler'
+#!/usr/bin/env rake
 begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "foreman_ovirt"
-  gem.homepage = "http://github.com/oourfali/foreman_ovirt"
-  gem.license = "MIT"
-  gem.summary = %Q{Plugin engine for Foreman-Ovirt integration}
-  gem.description = %Q{Foreman oVirt plugin}
-  gem.email = "ovedo@redhat.com"
-  gem.authors = ["Oved Ourfali"]
-  # dependencies defined in Gemfile
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
 end
-#Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ForemanOvirt'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-# require 'rcov/rcovtask'
-# Rcov::RcovTask.new do |test|
-#   test.libs << 'test'
-#   test.pattern = 'test/**/test_*.rb'
-#   test.verbose = true
-#   test.rcov_opts << '--exclude "gems/*"'
-# end
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
-task :default => :test
+Bundler::GemHelper.install_tasks
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+require 'rake/testtask'
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "foreman_ovirt #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+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 LoadError
+  puts 'Rubocop not loaded.'
+end
+
+task :default do
+  Rake::Task['rubocop'].execute
 end

data/app/assets/javascripts/foreman_ovirt/display.js

@@ -0,0 +1,10 @@
+function toggle_keyboard_options() {
+    if ($('select.display_type').val().toLowerCase() === 'vnc') {
+        $('.keyboard_layout').parents('.form-group').css('display', '');
+    } else {
+        $('.keyboard_layout').parents('.form-group').css('display', 'none');
+    }
+}
+
+$(document).on('change', '.display_type', toggle_keyboard_options);
+$(document).ready(toggle_keyboard_options);

data/app/assets/javascripts/foreman_ovirt/host_edit.js

@@ -0,0 +1,61 @@
+$(document).ready(function() {
+  var ovirt = {
+    update_cluster_tab: function (compute_resource_id) {
+      if (compute_resource_id) {
+        $('#cluster-indicator').show();
+        $.get('/compute_resources/' + compute_resource_id + '/available_clusters', { 'format': 'json' }, function (data) {
+          var cluster_id = $('#host_compute_attributes_cluster_id');
+          helpers.update_select_options(cluster_id, data);
+          cluster_id.change();
+          $('#cluster-indicator').hide();
+        });
+      } else {
+        $('#cluster-indicator').hide();
+      }
+    },
+
+    update_template_tab: function (compute_resource_id, cluster_id) {
+      if (compute_resource_id && cluster_id) {
+        $('#template-indicator').show();
+        $.get('/compute_resources/' + compute_resource_id + '/available_images', { 'cluster_id': cluster_id, 'format': 'json' }, function (data) {
+          var template_id = $('#host_compute_attributes_template_id');
+          helpers.update_select_options(template_id, data);
+          $('#template-indicator').hide();
+        });
+      } else {
+        $('#template-indicator').hide();
+      }
+    }
+  };
+
+  $('#host_compute_resource_id').on('change', function () {
+    var selected = $(this).find('option:selected');
+    if (selected.data('provider') === 'Ovirt') {
+      ovirt.update_cluster_tab($(this).val());
+    }
+  });
+
+  $('#host_compute_attributes_cluster_id').on('change', function () {
+    var compute_resource_id = $('#host_compute_resource_id').val();
+    var selected = $('#host_compute_resource_id').find('option:selected');
+    if (selected.data('provider') === 'Ovirt') {
+      ovirt.update_template_tab(compute_resource_id, $(this).val());
+    }
+  });
+
+  if ($('#host_compute_resource_id').find('option:selected').data('provider') === 'Ovirt') {
+    ovirt.update_cluster_tab($('#host_compute_resource_id').val());
+  }
+
+  $('#host_interfaces_attributes').on('change', '.type', function() {
+    var root = $(this).parents('.fields');
+    // show the relevant network
+    var network = $(this).val();
+    if (network) {
+      // hide all other networks
+      root.find('.ovirt_network').hide();
+      // show the relevant network
+      root.find('.' + network.toLowerCase() + '_network').show();
+    }
+  });
+});

data/app/assets/javascripts/foreman_ovirt/nic_info.js

@@ -0,0 +1,3 @@
+providerSpecificNICInfo = function(form) {
+  return form.find('select.ovirt_name').val() + ' @ ' + form.find('select.ovirt_network :selected').text();
+}

data/app/assets/javascripts/foreman_ovirt/ovirt.js

@@ -0,0 +1,261 @@
+/* eslint-disable jquery/no-each */
+/* eslint-disable jquery/no-text */
+/* eslint-disable jquery/no-data */
+/* eslint-disable jquery/no-sizzle */
+/* eslint-disable jquery/no-hide */
+/* eslint-disable jquery/no-attr */
+/* eslint-disable jquery/no-ajax */
+/* eslint-disable jquery/no-trigger */
+/* eslint-disable jquery/no-val */
+/* eslint-disable jquery/no-prop */
+/* eslint-disable func-names */
+
+function templateSelected(item) {
+  const template = $(item).val();
+
+  if (template === null) {
+    return;
+  }
+
+  const url = $(item).attr('data-url');
+
+  tfm.tools.showSpinner();
+  $.ajax({
+    type: 'post',
+    url,
+    data: `template_id=${template}`,
+    success(result) {
+      // As Instance Type values will take precence over templates values,
+      // we don't update memory/cores values if  instance type is already selected
+      if (!$('#host_compute_attributes_instance_type').val()) {
+        updateCoresAndSockets(result);
+        setMemoryInputProps({ value: result.memory });
+        $('[id$=_ha]').prop('checked', result.ha);
+      }
+      $('#network_interfaces')
+        .children('.fields')
+        .remove();
+      $.each(result.interfaces, function() {
+        addNetworkInterface(this);
+      });
+      $('#storage_volumes .children_fields >.fields').remove();
+      $.each(result.volumes, function() {
+        // Change variable name because 'interface' is a reserved keyword.
+        // eslint-disable-next-line dot-notation
+        this.disk_interface = this['interface'];
+        addVolume(this);
+      });
+      const templateSelector = $('#host_compute_attributes_template');
+
+      if (templateSelector.siblings('.select2-container-disabled').length > 0) {
+        templateSelector.val(result.id);
+      }
+    },
+    complete() {
+      // eslint-disable-next-line no-undef
+      reloadOnAjaxComplete(item);
+    },
+  });
+}
+
+function instanceTypeSelected(item) {
+  const instanceType = $(item).val();
+
+  if (!item.disabled) {
+    const url = $(item).attr('data-url');
+
+    tfm.tools.showSpinner();
+    $.ajax({
+      type: 'post',
+      url,
+      data: `instance_type_id=${instanceType}`,
+      success(result) {
+        if (result.name != null) {
+          setMemoryInputProps({ value: result.memory });
+          updateCoresAndSockets(result);
+          $('[id$=_ha]').prop('checked', result.ha);
+        }
+        setMemoryInputProps({ disabled: result.name != null });
+        disableCoresAndSockets(result);
+        ['_ha'].forEach(name =>
+          $(`[id$=${name}]`).prop('readOnly', result.name != null)
+        );
+        const instanceTypeSelector = $(
+          '#host_compute_attributes_instance_type'
+        );
+
+        if (instanceTypeSelector.is(':disabled')) {
+          instanceTypeSelector.val(result.id).trigger('change');
+        }
+      },
+      complete() {
+        // eslint-disable-next-line no-undef
+        reloadOnAjaxComplete(item);
+      },
+    });
+  }
+}
+
+// fill in the template interfaces.
+function addNetworkInterface({ name, network }) {
+  const nestedFields = $('#network_interfaces .add_nested_fields');
+  // no network interfaces update when the network editing is not allowed by the compute resource
+
+  if (nestedFields.length > 0) {
+    // eslint-disable-next-line no-undef
+    const newId = add_child_node(nestedFields);
+
+    $(`[id$=${newId}_name]`).val(name);
+    $(`[id$=${newId}_network]`).val(network);
+  }
+}
+
+// fill in the template volumes.
+function addVolume({
+  size_gb: sizeGb,
+  storage_domain: storageDomain,
+  sparse,
+  bootable,
+  id,
+  disk_interface: diskInterface,
+  wipe_after_delete: wipeAfterDelete,
+}) {
+  // eslint-disable-next-line no-undef
+  const newId = add_child_node($('#storage_volumes .add_nested_fields'));
+
+  disableElement($(`[id$=${newId}_size_gb]`).val(sizeGb));
+  $(`[id$=${newId}_storage_domain]`).val(storageDomain);
+  disableElement($(`[id$=${newId}_interface]`).val(diskInterface));
+  disableElement($(`[id$=${newId}_bootable_true]`).attr('checked', bootable));
+  disableElement(
+    $(`[id$=${newId}_wipe_after_delete]`).prop('checked', wipeAfterDelete)
+  );
+  if (id) {
+    $(`[id$=${newId}_id]`).val(id);
+  }
+  $(`[id$=${newId}_storage_domain]`)
+    .next()
+    .hide();
+}
+
+function setMemoryInputProps(props) {
+  const newProps = { ...props };
+
+  if (newProps.value !== undefined && newProps.value !== null) {
+    newProps.value = parseInt(newProps.value, 10);
+  }
+
+  const memoryInputElement = getComponentByWrapperId('memory-input');
+  memoryInputElement.reactProps = {
+    ...memoryInputElement.reactProps,
+    ...newProps,
+  };
+}
+
+function updateCoresAndSockets(result) {
+  const coresInputElement = getComponentByWrapperId('cores-input');
+  coresInputElement.reactProps = {
+    ...coresInputElement.reactProps,
+    value: parseInt(result.cores, 10),
+  };
+  const socketInputElement = getComponentByWrapperId('sockets-input');
+  socketInputElement.reactProps = {
+    ...socketInputElement.reactProps,
+    value: parseInt(result.sockets, 10),
+  };
+}
+
+function disableCoresAndSockets(result) {
+  const coresInputElement = getComponentByWrapperId('cores-input');
+  coresInputElement.reactProps = {
+    ...coresInputElement.reactProps,
+    disabled: result.name != null,
+  };
+  const socketInputElement = getComponentByWrapperId('sockets-input');
+  socketInputElement.reactProps = {
+    ...socketInputElement.reactProps,
+    disabled: result.name != null,
+  };
+}
+
+function getComponentByWrapperId(wrapperId) {
+  return document
+    .getElementById(wrapperId)
+    .getElementsByTagName('foreman-react-component')[0];
+}
+
+function disableElement(element) {
+  element
+    .clone()
+    .attr('type', 'hidden')
+    .appendTo(element);
+  element.attr('disabled', 'disabled');
+}
+
+function bootableRadio(item) {
+  const disabled = $('[id$=_bootable_true]:disabled:checked:visible');
+
+  $('[id$=_bootable_true]').prop('checked', false);
+  if (disabled.length > 0) {
+    disabled.prop('checked', true);
+  } else {
+    $(item).prop('checked', true);
+  }
+}
+function clusterSelected(item) {
+  const cluster = $(item).val();
+  const url = $(item).data('url');
+
+  tfm.tools.showSpinner();
+  $.ajax({
+    type: 'post',
+    url,
+    data: `cluster_id=${cluster}`,
+    success(result) {
+      const networkOptions = $('select[id$=_network]').empty();
+
+      $.each(result, function() {
+        networkOptions.append(
+          $('<option />')
+            .val(this.id)
+            .text(this.name)
+        );
+      });
+    },
+    complete() {
+      // eslint-disable-next-line no-undef
+      reloadOnAjaxComplete(item);
+    },
+  });
+}
+
+function vnicSelected(item) {
+  const selectedVnicProfile = $(item).val();
+  if (selectedVnicProfile) {
+    const itemId = $(item).attr('id');
+    const nicId = itemId.match(/[a-z_]*_([0-9]+)[a-z_]*_vnic_profile/)[1];
+    const idNetwork = `id$=_${nicId}_network`;
+
+    const vnicOptions = JSON.parse(
+      $('select[id$=_vnic_profile]')[1].getAttribute('data-profiles')
+    );
+    const networkOptions = JSON.parse(
+      $('select[id$=_vnic_profile]')[1].getAttribute('data-networks')
+    );
+
+    const vnicNetwork = vnicOptions.filter(
+      vnicOption => vnicOption.id === selectedVnicProfile
+    )[0].network;
+    const networkObj = networkOptions.filter(
+      network => network.id === vnicNetwork.id
+    )[0];
+    const networkSelect = $(`select[${idNetwork}]`);
+    networkSelect.empty();
+    networkSelect.append(
+      $('<option />')
+        .val(networkObj.id)
+        .text(networkObj.name)
+    );
+    networkSelect.val(networkObj.id).trigger('change');
+  }
+}

data/app/controllers/concerns/foreman_ovirt/compute_resources_vms_controller.rb

@@ -0,0 +1,29 @@
+module ForemanOvirt
+  module ComputeResourcesVmsController
+    extend ActiveSupport::Concern
+
+    included do
+      prepend Overrides
+    end
+
+    module Overrides
+      def index
+        load_vms
+        @authorizer = Authorizer.new(User.current, collection: [@compute_resource])
+
+        respond_to do |format|
+          format.html
+          format.json do
+            if @compute_resource.supports_vms_pagination?
+              # XXX: Foreman Core uses ".json", but this results in a "partial missing" error.
+              render partial: "compute_resources_vms/index/#{@compute_resource.provider.downcase}_json"
+            else
+              render json: _('JSON VM listing is not supported for this compute resource.'),
+                     status: :not_implemented
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/concerns/foreman_ovirt/parameters_extension.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module ForemanOvirt
+  module ParametersExtension
+    extend ActiveSupport::Concern
+
+    # This block is executed when the module is included in the base class.
+    # It's responsible for setting up the method alias chain.
+    included do
+      # We need to modify class methods, so we operate on the singleton class.
+      class << self
+        # Create an alias for the original method.
+        alias_method :compute_resource_params_filter_without_ovirt, :compute_resource_params_filter
+        # Make the original method name point to our new implementation.
+        alias_method :compute_resource_params_filter, :compute_resource_params_filter_with_ovirt
+      end
+    end
+
+    module ClassMethods
+      # Our new implementation that extends the original functionality.
+      def compute_resource_params_filter_with_ovirt
+        # Call the original method via its new alias to get the base filter object.
+        compute_resource_params_filter_without_ovirt.tap do |filter|
+          # Now, add the oVirt specific parameters to the existing filter.
+          filter.permit :datacenter,
+                        :ovirt_quota,
+                        :keyboard_layout,
+                        :use_v4,
+                        :public_key,
+                        :uuid
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_ovirt/concerns/compute_resources_controller_extensions.rb

@@ -0,0 +1,60 @@
+module ForemanOvirt
+  module Concerns
+    module ComputeResourcesControllerExtensions
+      extend ActiveSupport::Concern
+
+      prepended do
+        before_action :change_datacenter_to_uuid, only: [:create, :update]
+        rescue_from ::ProxyAPI::Ovirt::Unauthorized, with: :render_ovirt_unauthorized_error
+      end
+
+      def available_clusters
+        organization = find_organization_by_id_or_name(params[:organization_id], params[:organization_name])
+        location = find_location_by_id_or_name(params[:location_id], params[:location_name])
+        proxy = find_resource(params[:id], [organization, location].compact, ::ProxyAPI::Ovirt)
+        render json: proxy.clusters
+      rescue Foreman::Exception => e
+        render_error e.message, status: :not_found
+      end
+
+      def available_vnic_profiles
+        organization = find_organization_by_id_or_name(params[:organization_id], params[:organization_name])
+        location = find_location_by_id_or_name(params[:location_id], params[:location_name])
+        proxy = find_resource(params[:id], [organization, location].compact, ::ProxyAPI::Ovirt)
+        render json: proxy.vnic_profiles(params[:network_id])
+      rescue Foreman::Exception => e
+        render_error e.message, status: :not_found
+      end
+
+      def action_permission
+        case params[:action]
+        when 'available_clusters', 'available_vnic_profiles'
+          :view
+        else
+          super
+        end
+      end
+
+      private
+
+      def change_datacenter_to_uuid
+        return unless params[:compute_resource] && params[:compute_resource][:provider] == 'Ovirt' && params[:compute_resource][:datacenter]
+        proxy = find_resource(params[:id]) if params[:id].present?
+        proxy ||= ::ProxyAPI::Ovirt.new(
+          url: params[:compute_resource][:url],
+          user: params[:compute_resource][:user],
+          password: params[:compute_resource][:password]
+        )
+        uuid = proxy.datacenter_uuid_by_name(params[:compute_resource][:datacenter])
+        params[:compute_resource][:datacenter] = uuid
+      rescue ::ProxyAPI::Ovirt::Unauthorized
+      rescue Foreman::Exception => e
+        render_error e.message, status: :not_found
+      end
+
+      def render_ovirt_unauthorized_error
+        render_error "401 Unauthorized", status: :unauthorized
+      end
+    end
+  end
+end