foreman_resource_quota 0.1.0

data/app/services/foreman_resource_quota/resource_origin.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  class ResourceOrigin
+    RESOURCE_FUNCTION_MAP = {
+      cpu_cores: :extract_cpu_cores,
+      memory_mb: :extract_memory_mb,
+      disk_gb: :extract_disk_gb,
+    }.freeze
+
+    def collect_resources!(resources_sum, missing_hosts_resources, host_objects)
+      return if missing_hosts_resources.empty?
+
+      relevant_hosts = load_hosts_eagerly(missing_hosts_resources, host_objects, host_attribute_eager_name)
+      host_values = collect_attribute_from_hosts(relevant_hosts, host_attribute_name)
+      sum_resources_and_delete_missing_hosts!(resources_sum, missing_hosts_resources, host_values)
+    end
+
+    def host_attribute_eager_name
+      raise NotImplementedError
+    end
+
+    def host_attribute_name
+      raise NotImplementedError
+    end
+
+    def extract_cpu_cores(param)
+      raise NotImplementedError
+    end
+
+    def extract_memory_mb(param)
+      raise NotImplementedError
+    end
+
+    def extract_disk_gb(param)
+      raise NotImplementedError
+    end
+
+    private
+
+    def load_hosts_eagerly(missing_hosts_resources, host_objects, eager_attribute)
+      relevant_hosts = Host::Managed.where(name: missing_hosts_resources.keys).includes(eager_attribute)
+      relevant_hosts = relevant_hosts.compact
+      if relevant_hosts.size < missing_hosts_resources.size # Add non-eagerly loaded host objects
+        relevant_hosts_names = relevant_hosts.map(&:name)
+        (missing_hosts_resources.keys - relevant_hosts_names).each do |missing_host_name|
+          relevant_hosts << host_objects[missing_host_name]
+        end
+      end
+      relevant_hosts
+    rescue ActiveRecord::AssociationNotFoundError
+      # the eager_attribute could not be loaded
+      host_objects.values
+    end
+
+    def collect_attribute_from_hosts(host_list, attribute_name)
+      host_values = {}
+      host_list.each do |host|
+        attribute_value = host.send(attribute_name)
+        host_values[host.name] = attribute_value if attribute_value.present?
+      rescue StandardError
+        # skip hosts whose attribute couldn't be collected. They will be kept in the list
+        # of missing host resources
+      end
+      host_values
+    end
+
+    def sum_resources_and_delete_missing_hosts!(resources_sum, missing_hosts_resources, host_values)
+      host_values.each do |host_name, attribute_content|
+        missing_hosts_resources[host_name].reverse_each do |resource_name|
+          resource_value = process_resource(resource_name, attribute_content)
+          next unless resource_value
+          resources_sum[resource_name] += resource_value
+          missing_hosts_resources[host_name].delete(resource_name)
+        end
+        missing_hosts_resources.delete(host_name) if missing_hosts_resources[host_name].empty?
+      end
+    end
+
+    def process_resource(resource_name, attribute_content)
+      resource_value = method(RESOURCE_FUNCTION_MAP[resource_name]).call(attribute_content)
+      return nil unless resource_value
+      resource_value
+    end
+
+    # Extract encapsulated volumes attributes
+    #   The structure of data encapslated in :volumes_attributes is inconsistent. For example,
+    #   in an API call for host creation call this is an Array. But, through the UI this becomes a Hash.
+    # Parameters: A Hash containing :volumes_attributes.
+    # Returns: An Array of volume data (expecting an Array of Hashes)
+    def extract_volumes(param)
+      volumes = param[:volumes_attributes]
+      volumes = volumes.values if volumes.is_a?(Hash) # If it's a Hash, extract values
+      volumes
+    end
+  end
+end

data/app/services/foreman_resource_quota/resource_origins/compute_attributes_origin.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module ResourceOrigins
+    class ComputeAttributesOrigin < ResourceOrigin
+      def host_attribute_eager_name
+        :compute_attributes
+      end
+
+      def host_attribute_name
+        :compute_attributes
+      end
+
+      def extract_cpu_cores(param)
+        return nil unless param.key?(:cpus)
+        param[:cpus].to_i
+      rescue StandardError
+        nil
+      end
+
+      def extract_memory_mb(param)
+        case determine_memory_key(param)
+        when :memory
+          param[:memory].to_i / ResourceQuotaHelper::FACTOR_B_TO_MB
+        when :memory_mb
+          param[:memory_mb].to_i
+        end
+      rescue StandardError
+        nil
+      end
+
+      def extract_disk_gb(param)
+        return nil unless param.key?(:volumes_attributes)
+        extract_volumes(param).sum do |disk|
+          # key can be capactiy or size_gb
+          return nil unless disk.key?(:capacity) || disk.key?(:size_gb)
+          (disk[:size_gb] || disk[:capacity]).to_i
+        end
+      rescue StandardError
+        nil
+      end
+
+      private
+
+      def determine_memory_key(param)
+        return :memory if param.key?(:memory)
+        return :memory_mb if param.key?(:memory_mb)
+        nil
+      end
+
+      def parse_storage_string(storage_str)
+        return nil unless storage_str.is_a? String
+        case storage_str[-1].upcase
+        when 'G'
+          storage_str.to_i
+        when 'T'
+          storage_str[0..-2].to_i * ResourceQuotaHelper::FACTOR_B_TO_MB
+        when 'M'
+          (storage_str[0..-2].to_f / ResourceQuotaHelper::FACTOR_B_TO_MB).ceil
+        end
+      end
+    end
+  end
+end

data/app/services/foreman_resource_quota/resource_origins/compute_resource_origin.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module ResourceOrigins
+    class ComputeResourceOrigin < ResourceOrigin
+      def extract_cpu_cores(param)
+        param.cpus
+      rescue StandardError
+        nil
+      end
+
+      def extract_memory_mb(param)
+        param.memory.to_i / ResourceQuotaHelper::FACTOR_B_TO_MB
+      rescue StandardError
+        nil
+      end
+
+      def extract_disk_gb(_)
+        # FIXME: no disk given in VM (compare fog extensions)
+        nil
+      end
+
+      def collect_resources!(resources_sum, missing_hosts_resources, _host_objects)
+        compute_resource_to_hosts = group_hosts_by_compute_resource(missing_hosts_resources.keys)
+
+        compute_resource_to_hosts.each do |compute_resource_id, hosts|
+          next if compute_resource_id == :nil_compute_resource
+
+          host_vms, vm_id_attr = filter_vms_by_hosts(hosts, compute_resource_id)
+          next if host_vms.empty?
+
+          hosts.each do |host|
+            vm = host_vms.find { |obj| obj.send(vm_id_attr) == host.uuid }
+            next unless vm
+            process_host_vm!(resources_sum, missing_hosts_resources, host.name, vm)
+          end
+        end
+      end
+
+      # Groups hosts with the same compute resource.
+      # Parameters: An array of host names.
+      # Returns: A hash where keys represent compute resource IDs and values are the list of host objects.
+      def group_hosts_by_compute_resource(host_names)
+        Host::Managed.where(name: host_names).includes(:compute_resource).group_by do |host|
+          host.compute_resource&.id || :nil_compute_resource
+        end
+      end
+
+      # Filters VMs of a compute resource, given a list of hosts.
+      # Parameters:
+      #   - hosts: An array of host objects.
+      #   - compute_resource_id: ID of the compute resource.
+      # Returns:
+      #   - filtered_vms: An array of filtered virtual machine objects.
+      #   - id_attr: Attribute used for identifying virtual machines (either :vmid or :id).
+      def filter_vms_by_hosts(hosts, compute_resource_id)
+        host_uuids = hosts.map(&:uuid)
+        vms = ComputeResource.find_by(id: compute_resource_id).vms.all
+        id_attr = vms[0].respond_to?(:vmid) ? :vmid : :id
+        filtered_vms = vms.select { |obj| host_uuids.include?(obj.send(id_attr)) } # reduce from all vms
+        [filtered_vms, id_attr]
+      end
+
+      # Processes a host's virtual machines and updates resource allocation.
+      # Parameters:
+      #   - resources_sum: Hash containing total resources sum.
+      #   - missing_hosts_resources: Hash containing missing resources per host.
+      #   - host_name: Name of the host.
+      #   - vm: Compute resource VM object of given host.
+      # Returns: None.
+      def process_host_vm!(resources_sum, missing_hosts_resources, host_name, host_vm)
+        missing_hosts_resources[host_name].reverse_each do |resource_name|
+          resource_value = process_resource(resource_name, host_vm)
+          next unless resource_value
+          resources_sum[resource_name] += resource_value
+          missing_hosts_resources[host_name].delete(resource_name)
+        end
+        missing_hosts_resources.delete(host_name) if missing_hosts_resources[host_name].empty?
+      end
+    end
+  end
+end

data/app/services/foreman_resource_quota/resource_origins/facts_origin.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module ResourceOrigins
+    class FactsOrigin < ResourceOrigin
+      FACTS_KEYS_CPU_CORES = [
+        'ansible_processor_cores',
+        'facter_processors::cores',
+        'proc_cpuinfo::common::cpu_cores',
+        'processors::cores',
+      ].freeze
+
+      FACTS_KEYS_MEMORY_B = [
+        'facter_memory::system::total_bytes',
+        'memory::system::total_bytes',
+        'memory::memtotal',
+      ].freeze
+
+      FACTS_REGEX_DISK_B = [
+        /^disks::(\w+)::size_bytes$/,
+        /^facter_disks::(\w+)::size_bytes$/,
+      ].freeze
+
+      def host_attribute_eager_name
+        :fact_values
+      end
+
+      def host_attribute_name
+        :facts
+      end
+
+      def extract_cpu_cores(param)
+        common_keys = param.keys & FACTS_KEYS_CPU_CORES
+        return param[common_keys.first].to_i if common_keys.any?
+        nil
+      rescue StandardError
+        nil
+      end
+
+      def extract_memory_mb(param)
+        common_keys = param.keys & FACTS_KEYS_MEMORY_B
+        return (param[common_keys.first].to_i / ResourceQuotaHelper::FACTOR_B_TO_MB).to_i if common_keys.any?
+        nil
+      rescue StandardError
+        nil
+      end
+
+      def extract_disk_gb(param)
+        total_gb = nil
+
+        FACTS_REGEX_DISK_B.each do |regex|
+          relevant_keys = param.keys.grep(regex)
+          next unless relevant_keys.any?
+
+          total_gb = sum_disk_space(param, relevant_keys)
+        end
+
+        total_gb&.to_i
+      rescue StandardError
+        nil
+      end
+
+      def sum_disk_space(facts, keys)
+        keys.map { |key| facts[key].to_i }.sum / ResourceQuotaHelper::FACTOR_B_TO_GB unless keys.empty?
+      end
+    end
+  end
+end

data/app/services/foreman_resource_quota/resource_origins/vm_attributes_origin.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module ResourceOrigins
+    class VMAttributesOrigin < ResourceOrigin
+      def host_attribute_eager_name
+        :compute_resource
+      end
+
+      def host_attribute_name
+        :vm_compute_attributes
+      end
+
+      def extract_cpu_cores(param)
+        return nil unless param.key?(:cpus)
+        param[:cpus]
+      rescue StandardError
+        nil
+      end
+
+      def extract_memory_mb(param)
+        return nil unless param.key?(:memory_mb)
+        param[:memory_mb]
+      rescue StandardError
+        nil
+      end
+
+      def extract_disk_gb(param)
+        return nil unless param.key?(:volumes_attributes)
+        extract_volumes(param).sum do |disk|
+          # key can be capactiy or size_gb
+          return nil unless disk.key?(:capacity) || disk.key?(:size_gb)
+          (disk[:size_gb] || disk[:capacity]).to_i
+        end
+      rescue StandardError
+        nil
+      end
+    end
+  end
+end

data/app/views/foreman_resource_quota/api/v2/hosts/resource_quota.json.rabl

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+attribute :resource_quota_id, :resource_quota_name

data/app/views/foreman_resource_quota/api/v2/resource_quotas/base.json.rabl

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+attributes :name, :id, :description, :cpu_cores, :memory_mb, :disk_gb, :number_of_hosts, :number_of_users,
+  :number_of_usergroups

data/app/views/foreman_resource_quota/api/v2/resource_quotas/create.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+extends 'api/v2/resource_quotas/show'

data/app/views/foreman_resource_quota/api/v2/resource_quotas/hosts.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+child :hosts do
+  extends 'api/v2/hosts/base'
+end

data/app/views/foreman_resource_quota/api/v2/resource_quotas/index.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+collection @resource_quotas
+
+extends 'api/v2/resource_quotas/main'

data/app/views/foreman_resource_quota/api/v2/resource_quotas/main.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+extends 'api/v2/resource_quotas/base'
+
+attributes :created_at, :updated_at

data/app/views/foreman_resource_quota/api/v2/resource_quotas/show.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+extends 'api/v2/resource_quotas/main'

data/app/views/foreman_resource_quota/api/v2/resource_quotas/update.json.rabl

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+extends 'api/v2/resource_quotas/show'

data/app/views/foreman_resource_quota/api/v2/resource_quotas/usergroups.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+child :usergroups do
+  extends 'api/v2/usergroups/base'
+end

data/app/views/foreman_resource_quota/api/v2/resource_quotas/users.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+child :users do
+  extends 'api/v2/users/base'
+end

data/app/views/foreman_resource_quota/api/v2/resource_quotas/utilization.json.rabl

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+object @resource_quota
+
+extends 'api/v2/resource_quotas/main'
+
+attributes :utilization

data/app/views/foreman_resource_quota/api/v2/usergroups/resource_quota.json.rabl

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+attribute :resource_quota_ids, :resource_quota_names

data/app/views/foreman_resource_quota/api/v2/users/resource_quota.json.rabl

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+attribute :resource_quota_ids, :resource_quota_names

data/app/views/foreman_resource_quota/resource_quotas/_form.html.erb

@@ -0,0 +1,21 @@
+<%
+  if @resource_quota.new_record?
+    react_data = {
+      "isNewQuota": true,
+    }
+  else
+    react_data = {
+      "isNewQuota": false,
+      "initialProperties": {
+        "id": @resource_quota.id,
+        "name": @resource_quota.name,
+        "description": @resource_quota.description,
+        "cpu_cores": @resource_quota.cpu_cores,
+        "memory_mb": @resource_quota.memory_mb,
+        "disk_gb": @resource_quota.disk_gb,
+      },
+    }
+  end
+%>
+
+<%=  react_component('ResourceQuotaForm', react_data) %>

data/app/views/foreman_resource_quota/resource_quotas/edit.html.erb

@@ -0,0 +1,12 @@
+<% title(_('Edit Resource Quota %s') % @resource_quota) %>
+<%= breadcrumbs(resource_url: api_resource_quotas_path,
+                switcher_item_url: edit_resource_quota_path(':id')) %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_resource_quota %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_resource_quota %>
+<% end %>
+
+<%= render :partial => 'form' %>

data/app/views/foreman_resource_quota/resource_quotas/index.html.erb

@@ -0,0 +1,55 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_resource_quota %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_resource_quota %>
+<% end %>
+
+<% title _('Resource quotas') %>
+
+<%= title_actions react_component('CreateResourceQuotaModal') %>
+
+<table class="<%= table_css_classes 'table-bordered table-striped' %>">
+  <thead>
+    <tr>
+      <th><%= sort :name, :as => s_('Resource Quota|Name') %></th>
+      <th class="col-md-6"><%= _('Description') %></th>
+      <th class="col-md-1"><%= _('CPU cores') %></th>
+      <th class="col-md-1"><%= _('Memory (MB)') %></th>
+      <th class="col-md-1"><%= _('Disk space (GB)') %></th>
+      <th><%= _('Actions') %></th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @resource_quotas.each do |quota|
+         react_data = {
+           "isNewQuota": false,
+           "initialProperties": {
+             "id": quota.id,
+             "name": quota.name,
+             "description": quota.description,
+             "cpu_cores": quota.cpu_cores,
+             "memory_mb": quota.memory_mb,
+             "disk_gb": quota.disk_gb,
+           },
+         }
+    %>
+      <tr>
+        <td class="ellipsis">
+          <%= react_component('UpdateResourceQuotaModal', react_data) %>
+        </td>
+        <td><%= h(quota.description) %></td>
+        <td><%= h(quota.cpu_cores) %></td>
+        <td><%= h(quota.memory_mb) %></td>
+        <td><%= h(quota.disk_gb) %></td>
+        <td>
+          <%= action_buttons(
+                display_delete_if_authorized(hash_for_foreman_resource_quota_resource_quota_path(id: quota), data: { confirm: _("Delete %s?") % quota.name})
+              ) %>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>
+
+<%= will_paginate_with_info @resource_quotas %>

data/app/views/foreman_resource_quota/resource_quotas/new.html.erb

@@ -0,0 +1,10 @@
+<% title _('New Resource Quota') %>
+
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_resource_quota %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_resource_quota %>
+<% end %>
+
+<%= render :partial => 'form' %>

data/app/views/foreman_resource_quota/resource_quotas/welcome.html.erb

@@ -0,0 +1,10 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :foreman_resource_quota %>
+<% end %>
+<% content_for(:stylesheets) do %>
+  <%= webpacked_plugins_css_for :foreman_resource_quota %>
+<% end %>
+
+<% content_for(:title, _("Resource Quotas")) %>
+
+<%= react_component('ResourceQuotaEmptyState') %>

data/app/views/hosts/_form_quota_fields.html.erb

@@ -0,0 +1,4 @@
+<%
+  user_quotas = User.current&.admin? ? ForemanResourceQuota::ResourceQuota.all : User.current.resource_quotas
+%>
+<%= resource_quota_select form, user_quotas %>

data/app/views/users/_form_quota_tab.html.erb

@@ -0,0 +1,45 @@
+<% resource_type ||= pagelet.opts[:resource_type] %>
+<% if resource_type == :user %>
+  <% resource = @user %>
+<% elsif resource_type == :usergroup %>
+  <% resource = @usergroup %>
+<% end %>
+
+<% if resource_type == :user %>
+  <%= checkbox_f form, :"resource_quota_is_optional", :label => _("Optional Assignment"),
+    :label_help => _("It is optional for a user to assign a quota when creating new hosts") %>
+<% end %>
+
+<%= multiple_checkboxes(form, :resource_quotas, resource, ForemanResourceQuota::ResourceQuota, :label => _("Resource Quotas")) %>
+
+<% if resource_type == :user %>
+  <% usergroups = @user.cached_usergroups.includes(:resource_quotas).distinct %>
+  <% if usergroups.any? %>
+    <div class="form-group" id="inherited-quotas">
+      <label class="col-md-2 control-label" for="quotas"><%= _("Quotas from user groups") %></label>
+      <div class="col-md-5">
+        <div class="dropdown">
+          <button class="btn btn-default dropdown-toggle" type="button" id="usergroupsDropdownMenuBtn" data-toggle="dropdown">
+            <%= usergroups.first %>
+            <span class="caret"></span>
+          </button>
+          <ul class="dropdown-menu" quota="menu" aria-labelledby="usergroupsDropdownMenuBtn">
+            <% usergroups.each do |usergroup| %>
+                <li quota="presentation"><a quota="menuitem" tabindex="-1" data-id="<%=usergroup.id %>"><%= usergroup %></a></li>
+            <% end %>
+          </ul>
+        </div>
+        <ul class="list-group" id='quotas_tab'>
+          <% usergroups.each do |usergroup|  %>
+            <% unless usergroup.resource_quotas.map(&:name).any? %>
+                <li data-id="<%= usergroup.id %>" class="list-group-item"><%= _('This group has no quotas') %></li>
+            <%end %>
+            <% usergroup.resource_quotas.map(&:name).each do |quota_name| %>
+              <li data-id="<%= usergroup.id %>" class="list-group-item"><%= quota_name %></li>
+            <% end %>
+          <% end %>
+        </ul>
+      </div>
+    </div>
+  <% end  %>
+<% end %>

data/config/initializers/inflections.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+ActiveSupport::Inflector.inflections do |inflect|
+  inflect.irregular 'resource_quota', 'resource_quotas'
+end

data/config/routes.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# rubocop: disable Metrics/BlockLength
+Rails.application.routes.draw do
+  scope :foreman_resource_quota, path: 'foreman_resource_quota' do
+    resources :resource_quotas, except: %i[show], controller: 'foreman_resource_quota/resource_quotas' do
+      collection do
+        get 'auto_complete_search'
+      end
+    end
+  end
+
+  namespace :foreman_resource_quota do
+    resources :resource_quotas, except: %i[show] do
+      collection do
+        get 'help', action: :welcome
+        get 'auto_complete_search'
+      end
+    end
+
+    # API routes
+    namespace :api, defaults: { format: 'json' } do
+      scope '(:apiv)',
+        module: :v2,
+        defaults: { apiv: 'v2' },
+        apiv: /v1|v2/,
+        constraints: ApiConstraints.new(version: 2, default: true) do
+        resources :resource_quotas, except: %i[new edit] do
+          collection do
+            get 'auto_complete_search'
+          end
+          constraints(id: %r{[^/]+}) do
+            get 'utilization'
+            get 'hosts'
+            get 'users'
+            get 'usergroups'
+          end
+        end
+      end
+    end
+  end
+end
+# rubocop: enable Metrics/BlockLength