Skip to content

OCPBUGS-79069 - fix the since and sinceTime validation issue #345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
praveencodes wants to merge 5 commits into
base: master
Choose a base branch
from
Open

OCPBUGS-79069 - fix the since and sinceTime validation issue #345

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d780a66
fix the since and sinceTime validation
praveencodes Mar 25, 2026
05a4b4b
fix the validation error
praveencodes Apr 9, 2026
05e12a7
remove unnecessary descriptions
praveencodes Apr 9, 2026
d4fa624
remove the duration format
praveencodes May 6, 2026
4397399
Remove errValidationFailureHandled
praveencodes May 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions api/v1alpha1/mustgather_types.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ type MustGatherSpec struct {

// GatherSpec allows specifying the execution details for a must-gather run and the collection behavior.
// +kubebuilder:validation:XValidation:rule="!(has(self.since) && has(self.sinceTime))",message="only one of since or sinceTime may be specified"
// +kubebuilder:validation:XValidation:rule="!has(self.since) || !self.since.startsWith(\"-\")",message="since must be a non-negative duration string"
// +kubebuilder:validation:XValidation:rule="!has(self.since) || self.since.matches(r'^\\+?(([0-9]+(\\.[0-9]*)?|\\.[0-9]+)(ns|µs|us|ms|s|m|h))+$')",message="since may only use these duration suffixes: ns, us, µs, ms, s, m, h (e.g. 2h, 30m, 168h for one week)."
// +kubebuilder:validation:XValidation:rule="!has(self.sinceTime) || self.sinceTime.matches(r'^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$')",message="sinceTime must be in RFC3339 format."
type GatherSpec struct {
// +kubebuilder:validation:Optional
// Audit requests audit log collection via the default gather entrypoint.
Expand All @@ -90,18 +93,18 @@ type GatherSpec struct {
// +kubebuilder:validation:Items:MaxLength=256
Args []string `json:"args,omitempty"`

// Since only returns logs newer than a relative duration like "2h" or "30m".
// Since only returns logs newer than a relative duration (e.g. 2h, 30m, 168h for one week). Must be non-negative.
// Allowed units are ns, us, µs, ms, s, m, and h.
// This is passed to the must-gather script to filter log collection.
// Only one of since or sinceTime may be specified.
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Format=duration
Since *metav1.Duration `json:"since,omitempty"`

// SinceTime only returns logs after a specific date/time (RFC3339 format).
// SinceTime only returns logs after a specific instant. Use RFC3339 with uppercase T and Z or a zone offset
// (e.g. 2026-02-02T00:00:00Z). Must not be after the current time.
// This is passed to the must-gather script to filter log collection.
// Only one of since or sinceTime may be specified.
// +kubebuilder:validation:Optional
// +kubebuilder:validation:Format=date-time
SinceTime *metav1.Time `json:"sinceTime,omitempty"`
}

Expand Down
14 changes: 11 additions & 3 deletions bundle/manifests/tech-preview/operator.openshift.io_mustgathers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,15 @@ spec:
type: array
since:
description: |-
Since only returns logs newer than a relative duration like "2h" or "30m".
Since only returns logs newer than a relative duration (e.g. 2h, 30m, 168h for one week). Must be non-negative.
Allowed units are ns, us, µs, ms, s, m, and h.
This is passed to the must-gather script to filter log collection.
Only one of since or sinceTime may be specified.
format: duration
type: string
sinceTime:
description: |-
SinceTime only returns logs after a specific date/time (RFC3339 format).
SinceTime only returns logs after a specific instant. Use RFC3339 with uppercase T and Z or a zone offset
(e.g. 2026-02-02T00:00:00Z). Must not be after the current time.
This is passed to the must-gather script to filter log collection.
Only one of since or sinceTime may be specified.
format: date-time
Expand All @@ -84,6 +85,13 @@ spec:
x-kubernetes-validations:
- message: only one of since or sinceTime may be specified
rule: '!(has(self.since) && has(self.sinceTime))'
- message: since must be a non-negative duration string
rule: '!has(self.since) || !self.since.startsWith("-")'
- message: 'since may only use these duration suffixes: ns, us, µs,
ms, s, m, h (e.g. 2h, 30m, 168h for one week).'
rule: '!has(self.since) || self.since.matches(r''^\+?(([0-9]+(\.[0-9]*)?|\.[0-9]+)(ns|µs|us|ms|s|m|h))+$'')'
- message: sinceTime must be in RFC3339 format.
rule: "!has(self.sinceTime) || self.sinceTime.matches(r'^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}(\\.\\d+)?(Z|[+-]\\d{2}:\\d{2})$')"
imageStreamRef:
description: |-
ImageStreamRef specifies a custom image from the allowlist to be used for the
Expand Down
3 changes: 3 additions & 0 deletions controllers/mustgather/constant.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ const (
// ValidationImageStream represents the validation type for ImageStream
ValidationImageStream = "ImageStream"

// ValidationSinceTime represents validation of gatherSpec.sinceTime (e.g. must not be in the future)
ValidationSinceTime = "sinceTime"

// DefaultMustGatherImageEnv represents the environment variable for the default must-gather image
DefaultMustGatherImageEnv = "DEFAULT_MUST_GATHER_IMAGE"

Expand Down
9 changes: 9 additions & 0 deletions controllers/mustgather/mustgather_controller.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"fmt"
"os"
"slices"
"time"

"github.com/go-logr/logr"
imagev1 "github.com/openshift/api/image/v1"
Expand Down Expand Up @@ -397,6 +398,14 @@ func (r *MustGatherReconciler) getJobFromInstance(ctx context.Context, instance
return nil, err
}

if instance.Spec.GatherSpec != nil && instance.Spec.GatherSpec.SinceTime != nil && instance.Spec.GatherSpec.SinceTime.After(time.Now()) {
err := fmt.Errorf("gatherSpec.sinceTime must be at or before the current date and time")
if _, validationErr := r.setValidationFailureStatus(ctx, log, instance, ValidationSinceTime, err); validationErr != nil {
return nil, fmt.Errorf("failed to set validation failure status: %w, %w", err, validationErr)
}
return nil, err
Comment on lines +401 to +406

@coderabbitai coderabbitai Bot May 6, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Short-circuit handled sinceTime validation before generic error handling.

This branch updates status via setValidationFailureStatus, but then still returns a non-nil error. Downstream, Line 159 sends that error into ManageError, so the future-sinceTime case is not actually a clean validation short-circuit. Also, because this check runs after image/env resolution, unrelated prereq failures can mask the sinceTime validation entirely.

Please run this validation before getMustGatherImage / OPERATOR_IMAGE lookup, and return a handled signal that Reconcile can exit on without calling ManageError.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@controllers/mustgather/mustgather_controller.go` around lines 401 - 406, Run
the sinceTime validation (the block that calls setValidationFailureStatus with
ValidationSinceTime) before calling getMustGatherImage / reading OPERATOR_IMAGE
so it short-circuits early; after setting the validation failure status return a
handled reconcile result that does not propagate an error to ManageError (i.e.,
return the zero/handled ctrl.Result and nil error from Reconcile) so downstream
ManageError is not invoked. Ensure you update the control flow in Reconcile to
check the validation first and use the same setValidationFailureStatus call/site
as before.

}

return getJobTemplate(image, operatorImage, *instance, r.TrustedCAConfigMap), nil
}

Expand Down
42 changes: 42 additions & 0 deletions controllers/mustgather/mustgather_controller_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1588,6 +1588,48 @@ func generateFakeClient(objs ...runtime.Object) (client.Client, *runtime.Scheme)
return cl, s
}

func TestGetJobFromInstanceFutureSinceTimeSetsValidationStatus(t *testing.T) {
st := metav1.NewTime(time.Now().Add(48 * time.Hour))
mg := &mustgatherv1alpha1.MustGather{
ObjectMeta: metav1.ObjectMeta{
Name: "mg-future-sincetime",
Namespace: "openshift-must-gather-operator",
Finalizers: []string{mustGatherFinalizer},
},
Spec: mustgatherv1alpha1.MustGatherSpec{
GatherSpec: &mustgatherv1alpha1.GatherSpec{
SinceTime: &st,
},
},
}
t.Setenv("OPERATOR_IMAGE", "test-image")
t.Setenv("DEFAULT_MUST_GATHER_IMAGE", "test-must-gather-image")
cl, s := generateFakeClient(mg)
eventRec := record.NewFakeRecorder(10)
var cfg *rest.Config
r := MustGatherReconciler{
ReconcilerBase: util.NewReconcilerBase(cl, s, cfg, eventRec, nil),
DefaultMustGatherImage: "test-must-gather-image",
OperatorNamespace: "openshift-must-gather-operator",
}

_, err := r.getJobFromInstance(context.Background(), mg)
if err == nil {
t.Fatal("expected error")
}

updated := &mustgatherv1alpha1.MustGather{}
if err := cl.Get(context.Background(), types.NamespacedName{Name: mg.Name, Namespace: mg.Namespace}, updated); err != nil {
t.Fatal(err)
}
if updated.Status.Status != "Failed" {
t.Fatalf("expected status Failed, got %q", updated.Status.Status)
}
if !strings.Contains(updated.Status.Reason, ValidationSinceTime) {
t.Fatalf("expected reason to mention sinceTime, got %q", updated.Status.Reason)
}
}

// TestSFTPCredentialValidation tests the credential validation logic added in the controller
func TestSFTPCredentialValidation(t *testing.T) {
// Setup scheme
Expand Down
16 changes: 11 additions & 5 deletions deploy/crds/operator.openshift.io_mustgathers.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,28 @@ spec:
type: array
since:
description: |-
Since only returns logs newer than a relative duration like "2h" or "30m".
This is passed to the must-gather script to filter log collection.
Since only returns logs newer than a relative duration (e.g. 2h, 30m, 168h for one week). Must be non-negative.
Allowed units are ns, us, µs, ms, s, m, and h.
Only one of since or sinceTime may be specified.
format: duration
type: string
sinceTime:
description: |-
SinceTime only returns logs after a specific date/time (RFC3339 format).
This is passed to the must-gather script to filter log collection.
SinceTime only returns logs after a specific instant. Use RFC3339 with uppercase T and Z or a zone offset
(e.g. 2026-02-02T00:00:00Z). Must not be after the current time.
Only one of since or sinceTime may be specified.
format: date-time
type: string
type: object
x-kubernetes-validations:
- message: only one of since or sinceTime may be specified
rule: '!(has(self.since) && has(self.sinceTime))'
- message: since must be a non-negative duration string
rule: '!has(self.since) || !self.since.startsWith("-")'
- message: 'since may only use these duration suffixes: ns, us, µs,
ms, s, m, h (e.g. 2h, 30m, 168h for one week).'
rule: '!has(self.since) || self.since.matches(r''^\+?(([0-9]+(\.[0-9]*)?|\.[0-9]+)(ns|µs|us|ms|s|m|h))+$'')'
- message: sinceTime must be in RFC3339 format.
rule: '!has(self.sinceTime) || self.sinceTime.matches(r''^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[+-]\d{2}:\d{2})$'')'
imageStreamRef:
description: |-
ImageStreamRef specifies a custom image from the allowlist to be used for the
Expand Down