foreman_resource_quota 0.3.0 → 0.4.0

data/app/assets/javascripts/foreman_resource_quota/locale/zh_TW/foreman_resource_quota.js

@@ -0,0 +1,214 @@
+ locales['foreman_resource_quota'] = locales['foreman_resource_quota'] || {}; locales['foreman_resource_quota']['zh_TW'] = {
+  "domain": "foreman_resource_quota",
+  "locale_data": {
+    "foreman_resource_quota": {
+      "": {
+        "Project-Id-Version": "foreman_resource_quota 0.3.1",
+        "Report-Msgid-Bugs-To": "",
+        "PO-Revision-Date": "2025-01-07 14:34+0000",
+        "Last-Translator": "Bryan Kearney <bryan.kearney@gmail.com>, 2025",
+        "Language-Team": "Chinese (Taiwan) (https://app.transifex.com/foreman/teams/114/zh_TW/)",
+        "MIME-Version": "1.0",
+        "Content-Type": "text/plain; charset=UTF-8",
+        "Content-Transfer-Encoding": "8bit",
+        "Language": "zh_TW",
+        "Plural-Forms": "nplurals=1; plural=0;",
+        "lang": "zh_TW",
+        "domain": "foreman_resource_quota",
+        "plural_forms": "nplurals=1; plural=0;"
+      },
+      " ${response.response.data.error.full_messages}": [
+        ""
+      ],
+      "${label}": [
+        ""
+      ],
+      "${label} *": [
+        ""
+      ],
+      "${selectedUnit.symbol}": [
+        ""
+      ],
+      "Actions": [
+        "動作"
+      ],
+      "Apply": [
+        "套用"
+      ],
+      "CPU cores": [
+        ""
+      ],
+      "Click on \\\\\\\"Fetch quota utilization\\\\\\\": ": [
+        ""
+      ],
+      "Consumed resources": [
+        ""
+      ],
+      "Create a Resource Quota": [
+        ""
+      ],
+      "Create resource quota": [
+        ""
+      ],
+      "Define a Resource Quota here and apply it to users to guarantee a fair share of your resources.": [
+        ""
+      ],
+      "Define the Resource Quota this host counts to.": [
+        ""
+      ],
+      "Delete %s?": [
+        "刪除 %s？"
+      ],
+      "Delete a Resource Quota": [
+        ""
+      ],
+      "Description": [
+        "描述"
+      ],
+      "Description of the Resource Quota": [
+        ""
+      ],
+      "Disk space (GB)": [
+        ""
+      ],
+      "Edit": [
+        "編輯"
+      ],
+      "Edit Resource Quota %s": [
+        ""
+      ],
+      "Edit: ${quotaProperties[RESOURCE_IDENTIFIER_NAME]}": [
+        ""
+      ],
+      "Fetch quota utilization": [
+        ""
+      ],
+      "Foreman Plug-in to manage resource usage among users.": [
+        ""
+      ],
+      "Global Resource Quota no action": [
+        ""
+      ],
+      "It is optional for a user to assign a quota when creating new hosts": [
+        ""
+      ],
+      "List all Resource Quotas": [
+        ""
+      ],
+      "Make the assignment of a Resource Quota, during the host creation process, optional for\\n                        everyone. If this is true, user-specific \\\"optional assignment\\\" configurations are neglected.": [
+        ""
+      ],
+      "Maximum disk space in GiB": [
+        ""
+      ],
+      "Maximum memory in MiB": [
+        ""
+      ],
+      "Maximum number of CPU cores": [
+        ""
+      ],
+      "Memory (MB)": [
+        ""
+      ],
+      "Name": [
+        "名稱"
+      ],
+      "Name of the Resource Quota": [
+        ""
+      ],
+      "New Resource Quota": [
+        ""
+      ],
+      "New quota - no consumption to display.": [
+        ""
+      ],
+      "No consumption to display.": [
+        ""
+      ],
+      "No floating point for smallest unit (${units[0].symbol}).": [
+        ""
+      ],
+      "None provided": [
+        ""
+      ],
+      "Optional Assignment": [
+        ""
+      ],
+      "Properties": [
+        ""
+      ],
+      "Quota Limit": [
+        ""
+      ],
+      "Quotas from user groups": [
+        ""
+      ],
+      "Resource Quota": [
+        ""
+      ],
+      "Resource Quota ID.\\n                         This field is required if the setting `resource_quota_optional_assignment` is set to false.": [
+        ""
+      ],
+      "Resource Quota IDs to be associated with this user group. ": [
+        ""
+      ],
+      "Resource Quota IDs to be associated with this user. ": [
+        ""
+      ],
+      "Resource Quota optional assignment": [
+        ""
+      ],
+      "Resource Quotas": [
+        ""
+      ],
+      "Resource Quotas help admins to manage resources including CPUs, memory, and disk space among users or user groups.": [
+        ""
+      ],
+      "Resource Quota|Name": [
+        ""
+      ],
+      "Show Resource Quota": [
+        ""
+      ],
+      "Show hosts of a Resource Quota": [
+        ""
+      ],
+      "Show resources could not be determined when calculating utilization": [
+        ""
+      ],
+      "Show used resources of assigned hosts": [
+        ""
+      ],
+      "Show usergroups of a Resource Quota": [
+        ""
+      ],
+      "Show users of a Resource Quota": [
+        ""
+      ],
+      "Take no action when a Resource Quota is exceeded.": [
+        ""
+      ],
+      "The total amount of ${resourceTitle} for this quota.": [
+        ""
+      ],
+      "This can take some time since the resources of every host, assigned to this quota, must be requested.": [
+        ""
+      ],
+      "This group has no quotas": [
+        ""
+      ],
+      "Total ${resourceTitle} currently in use by all hosts assigned to this quota.": [
+        ""
+      ],
+      "Update a Resource Quota": [
+        ""
+      ],
+      "Value must be a natural number.": [
+        ""
+      ],
+      "When set to \\\"true\\\", it is optional for a user to assign a quota when creating new hosts.\\n                                   The default value is \\\"false\\\".": [
+        ""
+      ]
+    }
+  }
+};

data/app/controllers/foreman_resource_quota/api/v2/resource_quotas_controller.rb

@@ -11,19 +11,23 @@ module ForemanResourceQuota
           resource_id 'resource_quota'
           api_version 'v2'
           api_base_url '/foreman_resource_quota/api'
+          # resource quota are not bound to org/loc - so we remove the parameters from api here
+          # loc/org are inherited from the ::Api::V2::BaseController in Foreman
+          param :location_id, Integer, show: false
+          param :organization_id, Integer, show: false
         end
 
         before_action :find_resource, only: %i[show update destroy]
         before_action :custom_find_resource, only: %i[utilization missing_hosts hosts users usergroups]
 
-        api :GET, '/resource_quotas', N_('List all resource quotas')
+        api :GET, '/resource_quotas', N_('List all Resource Quotas')
         param_group :search_and_pagination, ::Api::V2::BaseController
         add_scoped_search_description_for(ForemanResourceQuota::ResourceQuota)
         def index
           @resource_quotas = resource_scope_for_index
         end
 
-        api :GET, '/resource_quotas/:id/', N_('Show resource quota')
+        api :GET, '/resource_quotas/:id/', N_('Show Resource Quota')
         param :id, :identifier, required: true
         def show
         end
@@ -39,23 +43,22 @@ module ForemanResourceQuota
           N_('Show resources could not be determined when calculating utilization')
         param :id, :identifier, required: true
         def missing_hosts
-          @resource_quota.determine_utilization
           process_response @resource_quota
         end
 
-        api :GET, '/resource_quotas/:id/hosts', N_('Show hosts of a resource quota')
+        api :GET, '/resource_quotas/:id/hosts', N_('Show hosts of a Resource Quota')
         param :id, :identifier, required: true
         def hosts
           process_response @resource_quota.hosts
         end
 
-        api :GET, '/resource_quotas/:id/users', N_('Show users of a resource quota')
+        api :GET, '/resource_quotas/:id/users', N_('Show users of a Resource Quota')
         param :id, :identifier, required: true
         def users
           process_response @resource_quota.users
         end
 
-        api :GET, '/resource_quotas/:id/usergroups', N_('Show usergroups of a resource quota')
+        api :GET, '/resource_quotas/:id/usergroups', N_('Show usergroups of a Resource Quota')
         param :id, :identifier, required: true
         def usergroups
           process_response @resource_quota.usergroups
@@ -63,25 +66,29 @@ module ForemanResourceQuota
 
         def_param_group :resource_quota do
           param :resource_quota, Hash, required: true, action_aware: true do
-            param :name, String, required: true
+            param :name, String, required: true, desc: N_('Name of the Resource Quota')
+            param :description, String, required: false, desc: N_('Description of the Resource Quota')
+            param :cpu_cores, Integer, required: false, desc: N_('Maximum number of CPU cores')
+            param :memory_mb, Integer, required: false, desc: N_('Maximum memory in MiB')
+            param :disk_gb, Integer, required: false, desc: N_('Maximum disk space in GiB')
           end
         end
 
-        api :POST, '/resource_quotas/', N_('Create a resource quota')
+        api :POST, '/resource_quotas/', N_('Create a Resource Quota')
         param_group :resource_quota, as: :create
         def create
           @resource_quota = ForemanResourceQuota::ResourceQuota.new(resource_quota_params)
           process_response @resource_quota.save
         end
 
-        api :PUT, '/resource_quotas/:id/', N_('Update a resource quota')
+        api :PUT, '/resource_quotas/:id/', N_('Update a Resource Quota')
         param :id, :identifier, required: true
         param_group :resource_quota
         def update
           process_response @resource_quota.update(resource_quota_params)
         end
 
-        api :DELETE, '/resource_quotas/:id/', N_('Delete a resource quota')
+        api :DELETE, '/resource_quotas/:id/', N_('Delete a Resource Quota')
         param :id, :identifier, required: true
         def destroy
           process_response @resource_quota.destroy

data/app/controllers/foreman_resource_quota/concerns/api/v2/hosts_controller_extensions.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module Concerns
+    module Api
+      module V2
+        module HostsControllerExtensions
+          extend ::Apipie::DSL::Concern
+          update_api(:create, :update) do
+            param :host, Hash do
+              param :resource_quota_id, :number, required: false,
+                desc: N_('Resource Quota ID.
+                         This field is required if the setting `resource_quota_optional_assignment` is set to false.')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_resource_quota/concerns/api/v2/usergroups_controller_extensions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module Concerns
+    module Api
+      module V2
+        module UsergroupsControllerExtensions
+          extend ::Apipie::DSL::Concern
+          update_api(:create, :update) do
+            param :usergroup, Hash do
+              param :resource_quota_ids, Array, of: :number, required: false,
+                desc: N_('Resource Quota IDs to be associated with this user group. ')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/controllers/foreman_resource_quota/concerns/api/v2/users_controller_extensions.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module ForemanResourceQuota
+  module Concerns
+    module Api
+      module V2
+        module UsersControllerExtensions
+          extend ::Apipie::DSL::Concern
+          update_api(:create, :update) do
+            param :user, Hash do
+              param :resource_quota_ids, Array, of: :number, required: false,
+                desc: N_('Resource Quota IDs to be associated with this user. ')
+              param :resource_quota_is_optional, :bool,
+                desc: N_('When set to "true", it is optional for a user to assign a quota when creating new hosts.
+                                   The default value is "false".')
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/app/models/concerns/foreman_resource_quota/host_managed_extensions.rb

@@ -19,7 +19,7 @@ module ForemanResourceQuota
 
       # A host shall always have a .host_resources attribute
       before_validation :build_host_resources, unless: -> { host_resources.present? }
-      after_save :save_host_resources, if: -> { host_resources.changed? }
+      after_save :save_host_resources, if: -> { host_resources&.changed? }
     end
 
     def verify_resource_quota
@@ -28,15 +28,15 @@ module ForemanResourceQuota
     rescue ResourceQuotaException => e
       handle_error('resource_quota_id',
         e.bare_message,
-        format('An error occured while checking the resource quota capacity: %s', e))
+        format('An error occured while checking the Resource Quota capacity: %s', e))
     rescue Foreman::Exception => e
       handle_error(:base,
         e.bare_message,
-        format('An unexpected Foreman error occured while checking the resource quota capacity: %s', e))
+        format('An unexpected Foreman error occured while checking the Resource Quota capacity: %s', e))
     rescue StandardError => e
       handle_error(:base,
         e.message,
-        format('An unknown error occured while checking the resource quota capacity: %s', e))
+        format('An unknown error occured while checking the Resource Quota capacity: %s', e))
     end
 
     def resource_quota_id
@@ -124,8 +124,8 @@ module ForemanResourceQuota
     end
 
     def formulate_quota_inconsistency_error(quota_name)
-      N_("An error occured adapting the resource quota utilization of '#{quota_name}' " \
-         "while processing host '#{name}'. The resource quota utilization values might be inconsistent.")
+      N_("An error occured adapting the Resource Quota utilization of '#{quota_name}' " \
+         "while processing host '#{name}'. The Resource Quota utilization values might be inconsistent.")
     end
 
     def early_return?(quota)
@@ -139,7 +139,9 @@ module ForemanResourceQuota
     end
 
     def quota_assigment_optional?
-      owner.resource_quota_is_optional || Setting[:resource_quota_optional_assignment]
+      return true if Setting[:resource_quota_optional_assignment]
+      return true if owner.respond_to?(:resource_quota_is_optional) && owner.resource_quota_is_optional
+      false
     end
 
     def save_host_resources

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

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

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

@@ -5,7 +5,7 @@
   <%= webpacked_plugins_css_for :foreman_resource_quota %>
 <% end %>
 
-<% title _('Resource quotas') %>
+<% title _('Resource Quotas') %>
 
 <%= title_actions react_component('CreateResourceQuotaModal') %>
 

data/config/initializers/inflections.rb

@@ -2,6 +2,7 @@
 
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.irregular 'resource_quota', 'resource_quotas'
+  inflect.irregular 'ResourceQuota', 'ResourceQuotas'
   inflect.irregular 'host_resources', 'hosts_resources'
   inflect.irregular 'HostResources', 'HostsResources'
 end

data/lib/foreman_resource_quota/engine.rb

@@ -40,12 +40,19 @@ module ForemanResourceQuota
       ::User.include ForemanResourceQuota::UserExtensions
       ::Usergroup.include ForemanResourceQuota::UsergroupExtensions
       ::Host::Managed.include ForemanResourceQuota::HostManagedExtensions
+
+      # Api controller extensions
+      ::Api::V2::HostsController.include ForemanResourceQuota::Concerns::Api::V2::HostsControllerExtensions
+      ::Api::V2::UsersController.include ForemanResourceQuota::Concerns::Api::V2::UsersControllerExtensions
+      ::Api::V2::UsergroupsController.include ForemanResourceQuota::Concerns::Api::V2::UsergroupsControllerExtensions
     rescue StandardError => e
       Rails.logger.warn "ForemanResourceQuota: skipping engine hook (#{e})"
     end
 
     # Register ForemanTasks-based recurring logic/scheduled tasks
-    initializer 'foreman_resource_quota.register_scheduled_tasks', before: :finisher_hook do |_app|
+    initializer 'foreman_resource_quota.register_scheduled_tasks',
+      before: :finisher_hook,
+      after: :build_middleware_stack do |_app| # ForemanTasks::Task becomes only available after this hook
       action_paths = [ForemanResourceQuota::Engine.root.join('lib/foreman_resource_quota/async')]
       ::ForemanTasks.dynflow.config.eager_load_paths.concat(action_paths)
 

data/lib/foreman_resource_quota/register.rb

@@ -7,6 +7,8 @@ Foreman::Plugin.register :foreman_resource_quota do
   apipie_documented_controllers ["#{ForemanResourceQuota::Engine.root}" \
                                  '/app/controllers/foreman_resource_quot/api/v2/*.rb']
 
+  register_gettext
+
   # Add permissions
   security_block :foreman_resource_quota do
     permission :view_resource_quotas,
@@ -93,13 +95,13 @@ Foreman::Plugin.register :foreman_resource_quota do
         type: :boolean,
         default: false,
         full_name: N_('Resource Quota optional assignment'),
-        description: N_('Make the assignment of a Resource quota, during the host creation process, optional for
+        description: N_('Make the assignment of a Resource Quota, during the host creation process, optional for
                         everyone. If this is true, user-specific "optional assignment" configurations are neglected.')
       setting 'resource_quota_global_no_action',
         type: :boolean,
         default: true,
         full_name: N_('Global Resource Quota no action'),
-        description: N_('Take no action when a resource quota is exceeded.')
+        description: N_('Take no action when a Resource Quota is exceeded.')
       # Future: Overwrite quota-specific "out of resource"-action and take no ..
     end
   end

data/lib/foreman_resource_quota/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ForemanResourceQuota
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/lib/tasks/foreman_resource_quota_tasks.rake

@@ -16,10 +16,10 @@ end
 namespace :test do
   desc 'Test ForemanResourceQuota'
   Rake::TestTask.new(:foreman_resource_quota) do |t|
-    test_dir = File.expand_path('../../test', __dir__)
-    t.libs << 'test'
-    t.libs << test_dir
+    test_dir = File.join(__dir__, '..', '..', 'test')
+    t.libs << ['test', test_dir]
     t.pattern = "#{test_dir}/**/*_test.rb"
+    t.test_files = [Rails.root.join('test/unit/foreman/access_permissions_test.rb')]
     t.verbose = true
     t.warning = false
   end

data/locale/Makefile

@@ -6,14 +6,15 @@
 # make tx-update - download and merge translations from Transifex
 # make clean - clean everything
 #
-DOMAIN = foreman_resource_quota
-VERSION = $(shell ruby -e 'require "rubygems";spec = Gem::Specification::load(Dir.glob("../*.gemspec")[0]);puts spec.version')
+DOMAIN = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).name')
+VERSION = $(shell ruby -rrubygems -e 'puts Gem::Specification::load(Dir.glob("../*.gemspec")[0]).version')
 POTFILE = $(DOMAIN).pot
 MOFILE = $(DOMAIN).mo
 POFILES = $(shell find . -name '$(DOMAIN).po')
 MOFILES = $(patsubst %.po,%.mo,$(POFILES))
 POXFILES = $(patsubst %.po,%.pox,$(POFILES))
 EDITFILES = $(patsubst %.po,%.edit.po,$(POFILES))
+JSFILES = $(shell find ../app/assets/javascripts/*/locale -name '$(DOMAIN).js')
 
 %.mo: %.po
 	mkdir -p $(shell dirname $@)/LC_MESSAGES
@@ -30,9 +31,16 @@ all-mo: $(MOFILES)
 	cat $@
 	! grep -q msgid $@
 
-%.edit.po:
+%.edit.po: %.po.time_stamp
 	touch $@
 
+# gettext will trash the .edit.po file if the time stamp doesn't exist or is older than the po file
+%.po.time_stamp: %.po
+	touch --reference $< $@
+
+# Prevent make from treating this as an intermediate file to be cleaned up
+.PRECIOUS: %.po.time_stamp
+
 check: $(POXFILES)
 
 # Unify duplicate translations
@@ -42,18 +50,23 @@ uniq-po:
 	done
 
 tx-pull: $(EDITFILES)
-	tx pull -f
+	# Initialize new languages
+	cd .. && tx pull -f --all --minimum-perc 50
+	# Force update all existing languages
+	cd .. && tx pull -f --minimum-perc 0
 	for f in $(EDITFILES) ; do \
 		sed -i 's/^\("Project-Id-Version: \).*$$/\1$(DOMAIN) $(VERSION)\\n"/' $$f; \
 	done
 
 tx-update: tx-pull
 	@echo
-	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation, then make -C locale mo-files to finish
+	@echo Run rake plugin:gettext[$(DOMAIN)] from the Foreman installation
+	@echo then run rake plugin:po_to_json[$(DOMAIN)] from the Foreman installation
+	@echo then run make -C locale mo-files to finish
 	@echo
 
 mo-files: $(MOFILES)
-	git add $(POFILES) $(POTFILE) ../locale/*/LC_MESSAGES
+	git add $(POFILES) $(POTFILE) $(JSFILES) ../locale/*/LC_MESSAGES
 	git commit -m "i18n - pulling from tx"
 	@echo
 	@echo Changes commited!