Merge branch 'fix/gb/improve-timeout-inputs-help-sections' into 'master'

Improve help and validation sections of maximum build timeout inputs

Closes #49434

See merge request gitlab-org/gitlab-ce!23586

app/models/ci/runner.rb

@@ -114,7 +114,8 @@ module Ci
 
     cached_attr_reader :version, :revision, :platform, :architecture, :ip_address, :contacted_at
 
-    chronic_duration_attr :maximum_timeout_human_readable, :maximum_timeout
+    chronic_duration_attr :maximum_timeout_human_readable, :maximum_timeout,
+        error_message: 'Maximum job timeout has a value which could not be accepted'
 
     validates :maximum_timeout, allow_nil: true,
                                 numericality: { greater_than_or_equal_to: 600,

app/models/concerns/chronic_duration_attribute.rb

@@ -24,7 +24,7 @@ module ChronicDurationAttribute
         end
       end
 
-      validates virtual_attribute, allow_nil: true, duration: true
+      validates virtual_attribute, allow_nil: true, duration: { message: parameters[:error_message] }
     end
 
     alias_method :chronic_duration_attr, :chronic_duration_attr_writer

app/models/project.rb

@@ -384,7 +384,8 @@ class Project < ActiveRecord::Base
 
   enum auto_cancel_pending_pipelines: { disabled: 0, enabled: 1 }
 
-  chronic_duration_attr :build_timeout_human_readable, :build_timeout, default: 3600
+  chronic_duration_attr :build_timeout_human_readable, :build_timeout,
+    default: 3600, error_message: 'Maximum job timeout has a value which could not be accepted'
 
   validates :build_timeout, allow_nil: true,
                             numericality: { greater_than_or_equal_to: 10.minutes,

app/validators/duration_validator.rb

@@ -14,6 +14,10 @@ class DurationValidator < ActiveModel::EachValidator
   def validate_each(record, attribute, value)
     ChronicDuration.parse(value)
   rescue ChronicDuration::DurationParseError
-    record.errors.add(attribute, "is not a correct duration")
+    if options[:message]
+      record.errors.add(:base, options[:message])
+    else
+      record.errors.add(attribute, "is not a correct duration")
+    end
   end
 end

app/views/projects/settings/ci_cd/_form.html.haml

@@ -29,7 +29,7 @@
           = f.label :build_timeout_human_readable, _('Timeout'), class: 'label-bold'
           = f.text_field :build_timeout_human_readable, class: 'form-control'
           %p.form-text.text-muted
-            = _("Per job. If a job passes this threshold, it will be marked as failed")
+            = _('If any job surpasses this timeout threshold, it will be marked as failed. Human readable time input language is accepted like "1 hour". Values without specification represent seconds.')
             = link_to icon('question-circle'), help_page_path('user/project/pipelines/settings', anchor: 'timeout'), target: '_blank'
 
         %hr

app/views/shared/runners/_form.html.haml

@@ -45,7 +45,7 @@
       = _('Maximum job timeout')
     .col-sm-10
       = f.text_field :maximum_timeout_human_readable, class: 'form-control'
-      .form-text.text-muted= _('This timeout will take precedence when lower than Project-defined timeout')
+      .form-text.text-muted= _('This timeout will take precedence when lower than project-defined timeout and accepts a human readable time input language like "1 hour". Values without specification represent seconds.')
   .form-group.row
     = label_tag :tag_list, class: 'col-form-label col-sm-2' do
       = _('Tags')

changelogs/unreleased/fix-gb-improve-timeout-inputs-help-sections.yml

+---
+title: Improve help and validation sections of maximum build timeout inputs
+merge_request: 23586
+author:
+type: fixed

locale/gitlab.pot

@@ -3436,6 +3436,9 @@ msgstr ""
 msgid "Identities"
 msgstr ""
 
+msgid "If any job surpasses this timeout threshold, it will be marked as failed. Human readable time input language is accepted like \"1 hour\". Values without specification represent seconds."
+msgstr ""
+
 msgid "If disabled, the access level will depend on the user's permissions in the project."
 msgstr ""
 
@@ -4614,9 +4617,6 @@ msgstr ""
 msgid "People without permission will never get a notification and won't be able to comment."
 msgstr ""
 
-msgid "Per job. If a job passes this threshold, it will be marked as failed"
-msgstr ""
-
 msgid "Perform advanced options such as changing path, transferring, or removing the group."
 msgstr ""
 
@@ -6632,7 +6632,7 @@ msgstr ""
 msgid "This source diff could not be displayed because it is too large."
 msgstr ""
 
-msgid "This timeout will take precedence when lower than Project-defined timeout"
+msgid "This timeout will take precedence when lower than project-defined timeout and accepts a human readable time input language like \"1 hour\". Values without specification represent seconds."
 msgstr ""
 
 msgid "This user has no identities"

spec/models/concerns/chronic_duration_attribute_spec.rb

@@ -54,7 +54,8 @@ shared_examples 'ChronicDurationAttribute writer' do
       subject.send("#{virtual_field}=", '-10m')
 
       expect(subject.valid?).to be_falsey
-      expect(subject.errors&.messages).to include(virtual_field => ['is not a correct duration'])
+      expect(subject.errors&.messages)
+        .to include(base: ['Maximum job timeout has a value which could not be accepted'])
     end
   end