Throttling: apply changes requested in PR6952

  Update openqa.ini parameter description
  Fix the t/ui/10-tests_overview.t u.test for CI
  Move in a routine the format prechecks of the throttling parameter

Author: m-dati

etc/openqa/openqa.ini

@@ -369,12 +369,14 @@ concurrent = 0
 ## scheduled products without any jobs (e.g. due to errors) are not immediately
 ## cleaned up.
 #scheduled_product_min_storage_duration = 34
-## Job resources throttling configuration:
-## a string of comma-separated jobs resources, 
-## formatted like: "RES1:MAL1,RES2:MAL2,..."
-## where MAL# is a malus priority to multiply for RES value
-## PRIO1 = prio_base + int(RES1.val * MAL1)
-#prio_throttling_parameters
+## Throttling
+## A comma-separated list of test parameters eachone followed by a colon and a scaling factor,
+## to trigger throttling by priority of scheduled openQA job, for any matched job setting.
+## Example: 'prio_throttling_parameters = 'QEMURAM:.003,HDDSIZEGB:.05,RETRY:1'.
+## The scaling factor is a decimal value that the parameter's value is multiplied by and added to the job prio,
+## according to the formula: priority = '$base_prio + int($<value of parameter1> * $<prio_throttling_scale of parameter1>) + ...'.
+## Example: a parameter 'RETRY' = 1, 'prio_throttling_scale of retry' = 3, 'base prio' = 50, provides a job prio of '50 + 1*3=53'
+#prio_throttling_parameters =
 
 [archiving]
 ## Moves logs of jobs which are preserved during the cleanup because they are

lib/OpenQA/Schema/ResultSet/Jobs.pm

@@ -102,8 +102,7 @@ sub latest_jobs ($self, $until = undef) {
 }
 
 sub load_throttling_config ($config_string) {
-    # parse to hash "{ PAR1 => MAL1, PAR2 => MAL2, ...}"
-    # the prio_throttling_parameters configuration string; see openqa.ini
+    # convert in hash the prio_throttling_parameters string configured in openqa.ini
     return unless ($config_string && $config_string =~ /:/);
     $config_string =~ s/\s+//g;
     my %hash = map { my ($k, $v) = split /:/, $_, 2 } split /,/, $config_string;

lib/OpenQA/Setup.pm

@@ -61,6 +61,15 @@ sub _load_config ($app, $defaults, $mode_specific_defaults) {
     return $config;
 }
 
+sub validate_prio_throttling_format ($config) {
+    my $throttling = $config->{misc_limits}->{prio_throttling_parameters};
+    if ($throttling && length $throttling) {
+        $config->{misc_limits}->{prio_throttling_parameters} =~ s/\s+//g;
+        die("Wrong formatting for 'prio_throttling_parameters' in openqa.ini")
+          unless ($throttling =~ /^[A-Z_]+:\d+(?:,[A-Z_]+:\d+)*$/i);
+    }
+}
+
 sub read_config ($app) {
     my %defaults = (
         global => {
@@ -294,12 +303,9 @@ sub read_config ($app) {
     if (my $minion_fail_job_blocklist = $config->{influxdb}->{ignored_failed_minion_jobs}) {
         $config->{influxdb}->{ignored_failed_minion_jobs} = [split(/\s+/, $minion_fail_job_blocklist)];
     }
-    my $throttling = $config->{misc_limits}->{prio_throttling_parameters};
-    if ($throttling && length $throttling) {
-        $config->{misc_limits}->{prio_throttling_parameters} =~ s/\s+//g;
-        die("Wrong formatting for 'prio_throttling_parameters' in openqa.ini")
-          unless ($throttling =~ /^[A-Z_]+:\d+(?:,[A-Z_]+:\d+)*$/i);
-    }
+
+    validate_prio_throttling_format($config);
+
     my $results = delete $global_config->{parallel_children_collapsable_results};
     $global_config->{parallel_children_collapsable_results_sel}
       = ' .status' . join('', map { ":not(.result_$_)" } split(/\s+/, $results));