mirror of
https://github.com/cozystack/cozystack.git
synced 2026-11-12 23:54:01 +09:00
fix(mariadb): fail backup and restore jobs whose operator Job failed (#5207)
<!-- Thank you for making a contribution! Here are some tips for you: - Use Conventional Commits for the PR title: `type(scope): description` - Types: feat, fix, docs, style, refactor, perf, test, build, ci, chore - Scopes are not an exhaustive list — pick the most specific scope for the change and extend the list when a genuinely new area appears. Examples: - System components: dashboard, platform, operator, cilium, kube-ovn, linstor, fluxcd, cluster-api - Managed apps: postgres, mariadb, redis, kafka, clickhouse, virtual-machine, kubernetes - Development and maintenance: api, hack, tests, ci, docs, maintenance - Breaking changes: append `!` after type/scope (`feat(api)!: ...`) or add a `BREAKING CHANGE:` footer - If it's a work in progress, consider creating this PR as a draft. - Don't hesistate to ask for opinion and review in the community chats, even if it's still a draft. - Add the label `kind/backport` if it's a bugfix that needs to be backported to a previous version. --> ## What this PR does When the Job behind a mariadb-operator `Backup` or `Restore` fails, the operator sets `Complete=True` with reason `JobFailed` (`SetCompleteWithJob` in mariadb-operator 25.10.2). The MariaDB driver read `Complete=True` alone as success, so a backup whose dump or upload failed ended `Succeeded` and produced a `Ready` Cozystack `Backup` pointing at an archive that does not exist, and a failed restore ended `Succeeded` too. A scheduled `Plan` kept producing such backups. The driver now treats `Complete=True` as success only with reason `JobComplete`, and fails the BackupJob or RestoreJob on `JobFailed` whatever the status, without creating a `Backup`. The failure message names the operator object and carries the Job's own `Failed` reason and message, since the operator's condition message is only `Failed` and the Job's pod, with its logs, is already deleted when the Job fails. A Job that is missing or cannot be read is named in the message instead. Any other `Complete` state keeps waiting under the existing deadline, as before; that includes `Complete=False` with reason `Failed`, which the operator sets with its own cause (`Error creating Job`, `Backup not complete`) for a failure outside the Job and then retries, and the deadline failure now carries that message. Regression tests drive the backup and restore reconcilers through every `Complete` status/reason combination, an absent `Complete` condition, and expired deadlines for an absent condition, an unknown reason and reason `Failed`. They assert the job phase and message as persisted in the API rather than on the in-memory object, a requeue while the run is in progress, and, for backups, that no `Backup` is created on failure. Separate tests cover the failure message for a Job that cannot be read and for a Job without a `Failed` condition. Backups that already exist are not touched. A `Ready` MariaDB `Backup` created by a failed run before this fix may have no archive of its own. Restoring from it can fail or select another dump from the shared prefix. ### Screenshots <!-- REQUIRED for UI changes: attach screenshots or screen recordings demonstrating the visual impact of your changes. PRs with UI changes without screenshots will not be merged. --> ### Downstream repositories <!-- Cozystack is upstream for repositories that are NOT kept in sync with it automatically, and nothing in CI compares the two sides, so a change here can break them silently. Which change forces what, and which file to touch, is the trigger map in docs/agents/contributing.md under "Downstream Repositories". Walk it before you tick anything. IF YOU ARE AN AI AGENT OR AN LLM, THIS IS PART OF THE TASK, NOT A FORM TO FILL IN: 1. Walk the trigger map against the actual diff of this PR, file by file. Do not decide from the PR title or from your memory of what you changed. 2. For every repository you tick, open the follow-up PR there and link it on the same line. A ticked box with no link claims work that does not exist, which is worse than an empty box. Search that repository for an open PR or issue covering it first, and link that instead of filing a duplicate. 3. When the follow-up is out of scope, or needs a decision that is not yours to make, open an issue in that repository instead, link that, and say so in the PR body. Do not push a speculative PR into another repository just to fill a line here. 4. Do not tick "No downstream repository is affected" to make the checklist go away. If you are unsure, leave every box empty and say so in the PR body, so a human decides. --> - [x] No downstream repository is affected by this change - [ ] [cozystack/website](https://github.com/cozystack/website) - follow-up: - [ ] [cozystack/terraform-provider-cozystack](https://github.com/cozystack/terraform-provider-cozystack) - follow-up: - [ ] [cozystack/ansible-cozystack](https://github.com/cozystack/ansible-cozystack) - follow-up: - [ ] [cozystack/ccp](https://github.com/cozystack/ccp) - follow-up: - [ ] [cozystack/talm](https://github.com/cozystack/talm) - follow-up: - [ ] [cozystack/cozyhr](https://github.com/cozystack/cozyhr) - follow-up: - [ ] [cozystack/cozy-proxy](https://github.com/cozystack/cozy-proxy) - follow-up: - [ ] [cozystack/cozystack-telemetry-server](https://github.com/cozystack/cozystack-telemetry-server) - follow-up: - [ ] [cozystack/external-apps-example](https://github.com/cozystack/external-apps-example) - follow-up: - [ ] [cozystack/examples](https://github.com/cozystack/examples) - follow-up: - [ ] [cozystack/community](https://github.com/cozystack/community) - follow-up: ### Release note <!-- Write a release note: - Explain what has changed internally and for users. - Start with the same `type(scope):` prefix as in the PR title - Follow the guidelines at https://github.com/kubernetes/community/blob/master/contributors/guide/release-notes.md. --> ```release-note fix(mariadb): a MariaDB BackupJob or RestoreJob whose operator Job failed now ends Failed instead of Succeeded, and a failed backup no longer creates a Ready Backup without an archive. Backups created by failed runs before this fix are not removed; restoring from one can fail or select another dump from the shared prefix. ``` <!-- This is an auto-generated comment: release notes by coderabbit.ai --> <!-- coderabbit-ai-generated:v1 --> ## Summary by CodeRabbit * **Bug Fixes** * Backup and restore operations now report failed jobs as failures, including details from the underlying job when available. * Operations are marked successful only when the job completes successfully. Other outcomes continue to be monitored until the existing deadline, after which failures include available condition details. * Failed backups no longer create backup artifacts. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
This commit is contained in:
3 files changed
+359
-39
No files matched your search
@@ -7,6 +7,7 @@ import (
|
||||
"fmt"
|
||||
"time"
|
||||
|
||||
batchv1 "k8s.io/api/batch/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
apimeta "k8s.io/apimachinery/pkg/api/meta"
|
||||
@@ -204,7 +205,10 @@ func (r *BackupJobReconciler) reconcileMariaDB(ctx context.Context, j *backupsv1
|
||||
cond := apimeta.FindStatusCondition(mdbBackup.Status.Conditions, mariadbtypes.ConditionTypeComplete)
|
||||
|
||||
switch {
|
||||
case cond != nil && cond.Status == metav1.ConditionTrue:
|
||||
case cond != nil && cond.Reason == mariadbtypes.ConditionReasonJobFailed:
|
||||
return r.markBackupJobFailed(ctx, j, mariadbJobFailedMessage(ctx, r.Client, "Backup", mdbBackup.Namespace, mdbBackup.Name, cond))
|
||||
|
||||
case cond != nil && cond.Status == metav1.ConditionTrue && cond.Reason == mariadbtypes.ConditionReasonJobComplete:
|
||||
// Backup completed successfully. Materialise the Cozystack artifact
|
||||
// and finalise the BackupJob. Idempotent: if the artifact already
|
||||
// exists (a previous reconcile created it and then raced on the
|
||||
@@ -231,34 +235,54 @@ func (r *BackupJobReconciler) reconcileMariaDB(ctx context.Context, j *backupsv1
|
||||
}
|
||||
return ctrl.Result{}, nil
|
||||
|
||||
case cond != nil && cond.Status == metav1.ConditionFalse && cond.Reason == mariadbtypes.ConditionReasonJobFailed:
|
||||
// Terminal failure. The operator marks Complete=False/JobFailed only
|
||||
// after the underlying Job exhausts its backoff budget, so we can
|
||||
// fail the BackupJob immediately rather than waiting for the
|
||||
// driver-side deadline.
|
||||
message := cond.Message
|
||||
if message == "" {
|
||||
message = "k8s.mariadb.com Backup terminal failure"
|
||||
}
|
||||
return r.markBackupJobFailed(ctx, j, message)
|
||||
|
||||
default:
|
||||
// Still running (Complete=False/JobRunning, Complete=False/JobNotComplete,
|
||||
// JobSuspended, or no Complete condition yet). Apply a wall-clock
|
||||
// deadline so a permanently-stuck Backup eventually fails the
|
||||
// BackupJob instead of pinning it Running forever.
|
||||
// JobSuspended, a reason this driver does not know, or no Complete
|
||||
// condition yet). Apply a wall-clock deadline so a permanently-stuck
|
||||
// Backup eventually fails the BackupJob instead of pinning it Running
|
||||
// forever.
|
||||
if mariadbBackupDeadlineExceeded(j.Status.StartedAt) {
|
||||
detail := "no Complete condition observed"
|
||||
if cond != nil {
|
||||
detail = fmt.Sprintf("Complete=%s/%s", cond.Status, cond.Reason)
|
||||
}
|
||||
return r.markBackupJobFailed(ctx, j, fmt.Sprintf(
|
||||
"k8s.mariadb.com Backup did not complete within %s (%s)", mariadbDefaultBackupDeadline, detail))
|
||||
"k8s.mariadb.com Backup did not complete within %s (%s)", mariadbDefaultBackupDeadline, mariadbCompleteDetail(cond)))
|
||||
}
|
||||
return ctrl.Result{RequeueAfter: mariadbPollInterval}, nil
|
||||
}
|
||||
}
|
||||
|
||||
// mariadbJobFailedMessage names the operator object whose Job failed and
|
||||
// carries that Job's own Failed condition, because the operator's condition
|
||||
// message is only "Failed". The operator names the Job after the object.
|
||||
func mariadbJobFailedMessage(ctx context.Context, c client.Reader, kind, namespace, name string, cond *metav1.Condition) string {
|
||||
message := fmt.Sprintf("k8s.mariadb.com/%s %s/%s failed (Complete=%s/%s)", kind, namespace, name, cond.Status, cond.Reason)
|
||||
job := &batchv1.Job{}
|
||||
if err := c.Get(ctx, types.NamespacedName{Namespace: namespace, Name: name}, job); err != nil {
|
||||
if apierrors.IsNotFound(err) {
|
||||
return fmt.Sprintf("%s; Job %s/%s not found", message, namespace, name)
|
||||
}
|
||||
return fmt.Sprintf("%s; reading Job %s/%s: %v", message, namespace, name, err)
|
||||
}
|
||||
for _, jc := range job.Status.Conditions {
|
||||
if jc.Type == batchv1.JobFailed && jc.Status == corev1.ConditionTrue {
|
||||
return fmt.Sprintf("%s; Job %s/%s: %s: %s", message, namespace, name, jc.Reason, jc.Message)
|
||||
}
|
||||
}
|
||||
return fmt.Sprintf("%s; Job %s/%s reports no Failed condition", message, namespace, name)
|
||||
}
|
||||
|
||||
// mariadbCompleteDetail describes the last Complete condition for a deadline
|
||||
// failure. The message matters for reason Failed, which the operator sets
|
||||
// with its own cause ("Error creating Job", "Backup not complete") rather
|
||||
// than from a Job.
|
||||
func mariadbCompleteDetail(cond *metav1.Condition) string {
|
||||
if cond == nil {
|
||||
return "no Complete condition observed"
|
||||
}
|
||||
if cond.Message == "" {
|
||||
return fmt.Sprintf("Complete=%s/%s", cond.Status, cond.Reason)
|
||||
}
|
||||
return fmt.Sprintf("Complete=%s/%s: %s", cond.Status, cond.Reason, cond.Message)
|
||||
}
|
||||
|
||||
// mariadbBackupDeadlineExceeded reports whether enough wall-clock time has
|
||||
// elapsed since the BackupJob started that we should give up on a stuck
|
||||
// operator Backup. Returns false when StartedAt is nil so the very first
|
||||
@@ -577,7 +601,10 @@ func (r *RestoreJobReconciler) reconcileMariaDBRestore(ctx context.Context, rest
|
||||
|
||||
cond := apimeta.FindStatusCondition(mdbRestore.Status.Conditions, mariadbtypes.ConditionTypeComplete)
|
||||
switch {
|
||||
case cond != nil && cond.Status == metav1.ConditionTrue:
|
||||
case cond != nil && cond.Reason == mariadbtypes.ConditionReasonJobFailed:
|
||||
return r.markRestoreJobFailed(ctx, restoreJob, mariadbJobFailedMessage(ctx, r.Client, "Restore", mdbRestore.Namespace, mdbRestore.Name, cond))
|
||||
|
||||
case cond != nil && cond.Status == metav1.ConditionTrue && cond.Reason == mariadbtypes.ConditionReasonJobComplete:
|
||||
now := metav1.Now()
|
||||
restoreJob.Status.CompletedAt = &now
|
||||
restoreJob.Status.Phase = backupsv1alpha1.RestoreJobPhaseSucceeded
|
||||
@@ -592,23 +619,12 @@ func (r *RestoreJobReconciler) reconcileMariaDBRestore(ctx context.Context, rest
|
||||
}
|
||||
return ctrl.Result{}, nil
|
||||
|
||||
case cond != nil && cond.Status == metav1.ConditionFalse && cond.Reason == mariadbtypes.ConditionReasonJobFailed:
|
||||
message := cond.Message
|
||||
if message == "" {
|
||||
message = fmt.Sprintf("k8s.mariadb.com/Restore %s/%s terminal failure", mdbRestore.Namespace, mdbRestore.Name)
|
||||
}
|
||||
return r.markRestoreJobFailed(ctx, restoreJob, message)
|
||||
|
||||
default:
|
||||
deadline := options.effectiveRestoreDeadline()
|
||||
if restoreJob.Status.StartedAt != nil && time.Since(restoreJob.Status.StartedAt.Time) > deadline {
|
||||
detail := "no Complete condition observed"
|
||||
if cond != nil {
|
||||
detail = fmt.Sprintf("Complete=%s/%s", cond.Status, cond.Reason)
|
||||
}
|
||||
return r.markRestoreJobFailed(ctx, restoreJob, fmt.Sprintf(
|
||||
"k8s.mariadb.com/Restore did not complete within %s (%s; override via spec.options.restoreTimeoutSeconds)",
|
||||
deadline, detail))
|
||||
deadline, mariadbCompleteDetail(cond)))
|
||||
}
|
||||
return ctrl.Result{RequeueAfter: mariadbPollInterval}, nil
|
||||
}
|
||||
|
||||
@@ -4,12 +4,15 @@ package backupcontroller
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"strings"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
batchv1 "k8s.io/api/batch/v1"
|
||||
corev1 "k8s.io/api/core/v1"
|
||||
apiequality "k8s.io/apimachinery/pkg/api/equality"
|
||||
apierrors "k8s.io/apimachinery/pkg/api/errors"
|
||||
apimeta "k8s.io/apimachinery/pkg/api/meta"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime"
|
||||
@@ -17,6 +20,7 @@ import (
|
||||
"k8s.io/client-go/tools/record"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client"
|
||||
clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
|
||||
"sigs.k8s.io/controller-runtime/pkg/client/interceptor"
|
||||
|
||||
strategyv1alpha1 "github.com/cozystack/cozystack/api/backups/strategy/v1alpha1"
|
||||
backupsv1alpha1 "github.com/cozystack/cozystack/api/backups/v1alpha1"
|
||||
@@ -867,6 +871,302 @@ func TestReconcileMariaDBRestore_KindCheckedBeforeSrcBackupGet(t *testing.T) {
|
||||
}
|
||||
}
|
||||
|
||||
// The operator reports a failed backing Job as Complete=True with reason
|
||||
// JobFailed (SetCompleteWithJob in mariadb-operator 25.10.2), so the
|
||||
// Complete status alone does not tell success from failure.
|
||||
var mariadbCompleteOutcomeCases = []struct {
|
||||
name string
|
||||
noCondition bool
|
||||
status metav1.ConditionStatus
|
||||
reason string
|
||||
message string
|
||||
expired bool
|
||||
failedJob bool
|
||||
wantFailed bool
|
||||
wantDone bool
|
||||
wantMessage []string
|
||||
}{
|
||||
{name: "Complete=True/JobComplete succeeds", status: metav1.ConditionTrue, reason: mariadbtypes.ConditionReasonJobComplete, message: "Success", wantDone: true},
|
||||
{name: "Complete=True/JobFailed fails with the Job's failure", status: metav1.ConditionTrue, reason: mariadbtypes.ConditionReasonJobFailed, message: "Failed", failedJob: true, wantFailed: true,
|
||||
wantMessage: []string{"tenant/op", "BackoffLimitExceeded", "Job has reached the specified backoff limit"}},
|
||||
{name: "Complete=False/JobFailed fails with the Job's failure", status: metav1.ConditionFalse, reason: mariadbtypes.ConditionReasonJobFailed, message: "Failed", failedJob: true, wantFailed: true,
|
||||
wantMessage: []string{"tenant/op", "BackoffLimitExceeded", "Job has reached the specified backoff limit"}},
|
||||
{name: "Complete=True/JobFailed with its Job gone fails", status: metav1.ConditionTrue, reason: mariadbtypes.ConditionReasonJobFailed, message: "Failed", wantFailed: true,
|
||||
wantMessage: []string{"tenant/op", "Job tenant/op not found"}},
|
||||
{name: "Complete=True with an unknown reason keeps waiting", status: metav1.ConditionTrue, reason: "SomethingElse", message: "Something"},
|
||||
{name: "Complete=False/JobComplete keeps waiting", status: metav1.ConditionFalse, reason: mariadbtypes.ConditionReasonJobComplete, message: "Success"},
|
||||
{name: "Complete=False/JobRunning keeps waiting", status: metav1.ConditionFalse, reason: mariadbtypes.ConditionReasonJobRunning, message: "Running"},
|
||||
{name: "Complete=False/Failed keeps waiting", status: metav1.ConditionFalse, reason: "Failed", message: "Error creating Job"},
|
||||
{name: "no Complete condition keeps waiting", noCondition: true},
|
||||
{name: "no Complete condition past the deadline fails", noCondition: true, expired: true, wantFailed: true,
|
||||
wantMessage: []string{"no Complete condition observed"}},
|
||||
{name: "Complete=True with an unknown reason past the deadline fails", status: metav1.ConditionTrue, reason: "SomethingElse", message: "Something", expired: true, wantFailed: true,
|
||||
wantMessage: []string{"Complete=True/SomethingElse"}},
|
||||
{name: "Complete=False/Failed past the deadline carries the operator's message", status: metav1.ConditionFalse, reason: "Failed", message: "Error creating Job", expired: true, wantFailed: true,
|
||||
wantMessage: []string{"Complete=False/Failed: Error creating Job"}},
|
||||
}
|
||||
|
||||
func mariadbCompleteConditions(noCondition bool, status metav1.ConditionStatus, reason, message string) []metav1.Condition {
|
||||
if noCondition {
|
||||
return nil
|
||||
}
|
||||
return []metav1.Condition{{
|
||||
Type: mariadbtypes.ConditionTypeComplete,
|
||||
Status: status,
|
||||
Reason: reason,
|
||||
Message: message,
|
||||
LastTransitionTime: metav1.Now(),
|
||||
}}
|
||||
}
|
||||
|
||||
// mariadbOutcomeStartedAt returns a StartedAt that is fresh, or older than
|
||||
// both the backup and the default restore deadline.
|
||||
func mariadbOutcomeStartedAt(expired bool) *metav1.Time {
|
||||
if !expired {
|
||||
now := metav1.Now()
|
||||
return &now
|
||||
}
|
||||
past := metav1.NewTime(time.Now().Add(-2 * max(mariadbDefaultBackupDeadline, mariadbDefaultRestoreDeadline)))
|
||||
return &past
|
||||
}
|
||||
|
||||
// mariadbOutcomeObjects adds the operator's Job, named after the operator
|
||||
// Backup or Restore, failed the way the Job controller fails it once the
|
||||
// backoff limit is spent.
|
||||
func mariadbOutcomeObjects(failedJob bool, objs ...client.Object) []client.Object {
|
||||
if !failedJob {
|
||||
return objs
|
||||
}
|
||||
return append(objs, &batchv1.Job{
|
||||
ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: "op"},
|
||||
Status: batchv1.JobStatus{Conditions: []batchv1.JobCondition{{
|
||||
Type: batchv1.JobFailed,
|
||||
Status: corev1.ConditionTrue,
|
||||
Reason: batchv1.JobReasonBackoffLimitExceeded,
|
||||
Message: "Job has reached the specified backoff limit",
|
||||
}}},
|
||||
})
|
||||
}
|
||||
|
||||
func assertMariaDBFailureMessage(t *testing.T, message string, want []string) {
|
||||
t.Helper()
|
||||
if strings.Contains(message, "logs") {
|
||||
t.Errorf("failure message must not send the reader to Job logs, which are gone with the deleted pod: %q", message)
|
||||
}
|
||||
for _, w := range want {
|
||||
if !strings.Contains(message, w) {
|
||||
t.Errorf("failure message must contain %q, got %q", w, message)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestReconcileMariaDBBackup_CompleteConditionOutcome(t *testing.T) {
|
||||
strategyAPIGroup := strategyv1alpha1.GroupVersion.Group
|
||||
resolved := &ResolvedBackupConfig{
|
||||
StrategyRef: corev1.TypedLocalObjectReference{
|
||||
APIGroup: &strategyAPIGroup,
|
||||
Kind: strategyv1alpha1.MariaDBStrategyKind,
|
||||
Name: "mdb-strategy",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tc := range mariadbCompleteOutcomeCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
seed := newMariaDBBackupJob("bj", "tenant")
|
||||
seed.Status.StartedAt = mariadbOutcomeStartedAt(tc.expired)
|
||||
strategy := &strategyv1alpha1.MariaDB{
|
||||
ObjectMeta: metav1.ObjectMeta{Name: "mdb-strategy"},
|
||||
Spec: strategyv1alpha1.MariaDBSpec{Template: *newRenderedMariaDBTemplate()},
|
||||
}
|
||||
operatorMariaDB := &mariadbtypes.MariaDB{
|
||||
ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: mariadbNameForApp(seed.Spec.ApplicationRef.Name)},
|
||||
}
|
||||
operatorBackup := &mariadbtypes.Backup{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Namespace: "tenant",
|
||||
Name: "op",
|
||||
Labels: map[string]string{
|
||||
backupsv1alpha1.OwningJobNameLabel: seed.Name,
|
||||
backupsv1alpha1.OwningJobNamespaceLabel: seed.Namespace,
|
||||
},
|
||||
},
|
||||
Status: mariadbtypes.BackupStatus{Conditions: mariadbCompleteConditions(tc.noCondition, tc.status, tc.reason, tc.message)},
|
||||
}
|
||||
c := newMariaDBStrategyTestClient(t, mariadbOutcomeObjects(tc.failedJob, seed, newMariaDBApp(seed.Spec.ApplicationRef.Name, "tenant"),
|
||||
strategy, operatorMariaDB, operatorBackup)...)
|
||||
r := &BackupJobReconciler{Client: c, Scheme: c.Scheme(), Recorder: record.NewFakeRecorder(10)}
|
||||
|
||||
bj := &backupsv1alpha1.BackupJob{}
|
||||
if err := c.Get(context.Background(), client.ObjectKeyFromObject(seed), bj); err != nil {
|
||||
t.Fatalf("seed Get: %v", err)
|
||||
}
|
||||
res, err := r.reconcileMariaDB(context.Background(), bj, resolved)
|
||||
if err != nil {
|
||||
t.Fatalf("reconcileMariaDB: %v", err)
|
||||
}
|
||||
|
||||
stored := &backupsv1alpha1.BackupJob{}
|
||||
if err := c.Get(context.Background(), client.ObjectKeyFromObject(seed), stored); err != nil {
|
||||
t.Fatalf("persisted Get: %v", err)
|
||||
}
|
||||
artifacts := &backupsv1alpha1.BackupList{}
|
||||
if err := c.List(context.Background(), artifacts, client.InNamespace("tenant")); err != nil {
|
||||
t.Fatalf("list Backups: %v", err)
|
||||
}
|
||||
switch {
|
||||
case tc.wantFailed:
|
||||
if stored.Status.Phase != backupsv1alpha1.BackupJobPhaseFailed {
|
||||
t.Errorf("expected Phase=Failed, got %q", stored.Status.Phase)
|
||||
}
|
||||
assertMariaDBFailureMessage(t, stored.Status.Message, tc.wantMessage)
|
||||
if stored.Status.BackupRef != nil || len(artifacts.Items) != 0 {
|
||||
t.Errorf("a failed run must not produce a Backup: ref=%v artifacts=%d", stored.Status.BackupRef, len(artifacts.Items))
|
||||
}
|
||||
case tc.wantDone:
|
||||
if stored.Status.Phase != backupsv1alpha1.BackupJobPhaseSucceeded {
|
||||
t.Errorf("expected Phase=Succeeded, got %q (message %q)", stored.Status.Phase, stored.Status.Message)
|
||||
}
|
||||
if stored.Status.BackupRef == nil || len(artifacts.Items) != 1 {
|
||||
t.Errorf("a successful run must produce exactly one Backup: ref=%v artifacts=%d", stored.Status.BackupRef, len(artifacts.Items))
|
||||
}
|
||||
default:
|
||||
if stored.Status.Phase != backupsv1alpha1.BackupJobPhaseRunning {
|
||||
t.Errorf("expected Phase=Running, got %q", stored.Status.Phase)
|
||||
}
|
||||
if res.RequeueAfter == 0 {
|
||||
t.Errorf("expected a requeue while the run is in progress, got %+v", res)
|
||||
}
|
||||
if len(artifacts.Items) != 0 {
|
||||
t.Errorf("an unfinished run must not produce a Backup, got %d", len(artifacts.Items))
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestMariaDBJobFailedMessage_JobUnreadable(t *testing.T) {
|
||||
cond := &metav1.Condition{Type: mariadbtypes.ConditionTypeComplete, Status: metav1.ConditionTrue, Reason: mariadbtypes.ConditionReasonJobFailed}
|
||||
readErr := apierrors.NewForbidden(batchv1.Resource("jobs"), "op", errors.New("rbac"))
|
||||
c := interceptor.NewClient(newMariaDBStrategyTestClient(t).(client.WithWatch), interceptor.Funcs{
|
||||
Get: func(ctx context.Context, cl client.WithWatch, key client.ObjectKey, obj client.Object, opts ...client.GetOption) error {
|
||||
if _, ok := obj.(*batchv1.Job); ok {
|
||||
return readErr
|
||||
}
|
||||
return cl.Get(ctx, key, obj, opts...)
|
||||
},
|
||||
})
|
||||
|
||||
got := mariadbJobFailedMessage(context.Background(), c, "Backup", "tenant", "op", cond)
|
||||
for _, want := range []string{"k8s.mariadb.com/Backup tenant/op failed (Complete=True/JobFailed)", "reading Job tenant/op", readErr.Error()} {
|
||||
if !strings.Contains(got, want) {
|
||||
t.Errorf("message must contain %q, got %q", want, got)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestMariaDBJobFailedMessage_JobWithoutFailedCondition(t *testing.T) {
|
||||
cond := &metav1.Condition{Type: mariadbtypes.ConditionTypeComplete, Status: metav1.ConditionTrue, Reason: mariadbtypes.ConditionReasonJobFailed}
|
||||
c := newMariaDBStrategyTestClient(t, &batchv1.Job{
|
||||
ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: "op"},
|
||||
Status: batchv1.JobStatus{Conditions: []batchv1.JobCondition{
|
||||
{Type: batchv1.JobFailureTarget, Status: corev1.ConditionTrue, Reason: batchv1.JobReasonPodFailurePolicy},
|
||||
{Type: batchv1.JobFailed, Status: corev1.ConditionFalse, Reason: batchv1.JobReasonBackoffLimitExceeded},
|
||||
}},
|
||||
})
|
||||
|
||||
got := mariadbJobFailedMessage(context.Background(), c, "Restore", "tenant", "op", cond)
|
||||
if !strings.Contains(got, "Job tenant/op reports no Failed condition") ||
|
||||
strings.Contains(got, batchv1.JobReasonBackoffLimitExceeded) || strings.Contains(got, batchv1.JobReasonPodFailurePolicy) {
|
||||
t.Errorf("a Failed condition that is not True must not be reported as the cause, got %q", got)
|
||||
}
|
||||
}
|
||||
|
||||
func TestMariaDBCompleteDetail(t *testing.T) {
|
||||
for _, tc := range []struct {
|
||||
cond *metav1.Condition
|
||||
want string
|
||||
}{
|
||||
{nil, "no Complete condition observed"},
|
||||
{&metav1.Condition{Status: metav1.ConditionFalse, Reason: "Failed", Message: "Backup not complete"}, "Complete=False/Failed: Backup not complete"},
|
||||
{&metav1.Condition{Status: metav1.ConditionFalse, Reason: "Failed"}, "Complete=False/Failed"},
|
||||
} {
|
||||
if got := mariadbCompleteDetail(tc.cond); got != tc.want {
|
||||
t.Errorf("mariadbCompleteDetail(%+v) = %q, want %q", tc.cond, got, tc.want)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func TestReconcileMariaDBRestore_CompleteConditionOutcome(t *testing.T) {
|
||||
apps := mariadbapp.GroupName
|
||||
|
||||
for _, tc := range mariadbCompleteOutcomeCases {
|
||||
t.Run(tc.name, func(t *testing.T) {
|
||||
cozyBackup := &backupsv1alpha1.Backup{
|
||||
ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: "src-cozy-bk"},
|
||||
Spec: backupsv1alpha1.BackupSpec{
|
||||
ApplicationRef: corev1.TypedLocalObjectReference{Kind: "MariaDB", Name: "src", APIGroup: &apps},
|
||||
DriverMetadata: map[string]string{mariadbBackupNameKey: "src-op-bk"},
|
||||
},
|
||||
}
|
||||
seed := &backupsv1alpha1.RestoreJob{
|
||||
ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: "rj"},
|
||||
Spec: backupsv1alpha1.RestoreJobSpec{
|
||||
BackupRef: corev1.LocalObjectReference{Name: cozyBackup.Name},
|
||||
TargetApplicationRef: &corev1.TypedLocalObjectReference{Kind: "MariaDB", Name: "target", APIGroup: &apps},
|
||||
},
|
||||
Status: backupsv1alpha1.RestoreJobStatus{StartedAt: mariadbOutcomeStartedAt(tc.expired), Phase: backupsv1alpha1.RestoreJobPhaseRunning},
|
||||
}
|
||||
operatorRestore := &mariadbtypes.Restore{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Namespace: "tenant",
|
||||
Name: "op",
|
||||
Labels: map[string]string{
|
||||
backupsv1alpha1.OwningJobNameLabel: seed.Name,
|
||||
backupsv1alpha1.OwningJobNamespaceLabel: seed.Namespace,
|
||||
},
|
||||
},
|
||||
Status: mariadbtypes.RestoreStatus{Conditions: mariadbCompleteConditions(tc.noCondition, tc.status, tc.reason, tc.message)},
|
||||
}
|
||||
c := newMariaDBStrategyTestClient(t, mariadbOutcomeObjects(tc.failedJob, cozyBackup, seed, operatorRestore,
|
||||
&mariadbtypes.Backup{ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: "src-op-bk"}},
|
||||
&mariadbtypes.MariaDB{ObjectMeta: metav1.ObjectMeta{Namespace: "tenant", Name: mariadbNameForApp("target")}})...)
|
||||
r := &RestoreJobReconciler{Client: c, Recorder: record.NewFakeRecorder(10)}
|
||||
|
||||
rj := &backupsv1alpha1.RestoreJob{}
|
||||
if err := c.Get(context.Background(), client.ObjectKeyFromObject(seed), rj); err != nil {
|
||||
t.Fatalf("seed Get: %v", err)
|
||||
}
|
||||
res, err := r.reconcileMariaDBRestore(context.Background(), rj, cozyBackup)
|
||||
if err != nil {
|
||||
t.Fatalf("reconcileMariaDBRestore: %v", err)
|
||||
}
|
||||
|
||||
stored := &backupsv1alpha1.RestoreJob{}
|
||||
if err := c.Get(context.Background(), client.ObjectKeyFromObject(seed), stored); err != nil {
|
||||
t.Fatalf("persisted Get: %v", err)
|
||||
}
|
||||
switch {
|
||||
case tc.wantFailed:
|
||||
if stored.Status.Phase != backupsv1alpha1.RestoreJobPhaseFailed {
|
||||
t.Errorf("expected Phase=Failed, got %q", stored.Status.Phase)
|
||||
}
|
||||
assertMariaDBFailureMessage(t, stored.Status.Message, tc.wantMessage)
|
||||
case tc.wantDone:
|
||||
if stored.Status.Phase != backupsv1alpha1.RestoreJobPhaseSucceeded {
|
||||
t.Errorf("expected Phase=Succeeded, got %q (message %q)", stored.Status.Phase, stored.Status.Message)
|
||||
}
|
||||
default:
|
||||
if stored.Status.Phase != backupsv1alpha1.RestoreJobPhaseRunning {
|
||||
t.Errorf("expected Phase=Running, got %q", stored.Status.Phase)
|
||||
}
|
||||
if res.RequeueAfter == 0 {
|
||||
t.Errorf("expected a requeue while the run is in progress, got %+v", res)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// ---------------------------------------------------------------------------
|
||||
// Test helpers
|
||||
// ---------------------------------------------------------------------------
|
||||
|
||||
@@ -27,16 +27,20 @@ const (
|
||||
GroupName = "k8s.mariadb.com"
|
||||
Version = "v1alpha1"
|
||||
|
||||
// Operator-side condition type set on Backup and Restore once the run
|
||||
// terminates. Status=True means success; Status=False with Reason
|
||||
// explains the failure or in-progress state.
|
||||
// Operator-side condition type set on Backup and Restore. Status=True
|
||||
// means the backing Job terminated, successfully or not; only the
|
||||
// Reason tells the two apart (SetCompleteWithJob in mariadb-operator).
|
||||
ConditionTypeComplete = "Complete"
|
||||
|
||||
// Reason values the upstream operator emits on the Complete condition.
|
||||
// JobComplete -> Status=True (run succeeded).
|
||||
// JobFailed -> Status=False (terminal failure of the backing Job).
|
||||
// JobFailed -> Status=True (terminal failure of the backing Job).
|
||||
// JobRunning -> Status=False (still in progress).
|
||||
// JobSuspended -> Status=False (admin-suspended via spec).
|
||||
// The operator also writes reason Failed with Status=False and its own
|
||||
// message ("Error creating Job", "Backup not complete") when a run fails
|
||||
// outside its Job. It retries those, so the driver keeps waiting on
|
||||
// Failed until its deadline rather than failing the run at once.
|
||||
ConditionReasonJobComplete = "JobComplete"
|
||||
ConditionReasonJobFailed = "JobFailed"
|
||||
ConditionReasonJobRunning = "JobRunning"
|
||||
@@ -183,7 +187,7 @@ type S3TLS struct {
|
||||
}
|
||||
|
||||
// BackupStatus mirrors Backup.status. The operator expresses success
|
||||
// via condition type "Complete" with status=True.
|
||||
// via condition type "Complete" with reason JobComplete.
|
||||
type BackupStatus struct {
|
||||
Conditions []metav1.Condition `json:"conditions,omitempty"`
|
||||
}
|
||||
@@ -217,7 +221,7 @@ type RestoreSpec struct {
|
||||
}
|
||||
|
||||
// RestoreStatus mirrors Restore.status. Same condition convention as
|
||||
// Backup: type=Complete, Status=True on success.
|
||||
// Backup: type=Complete, reason JobComplete on success.
|
||||
type RestoreStatus struct {
|
||||
Conditions []metav1.Condition `json:"conditions,omitempty"`
|
||||
}
|
||||
Reference in new issue
Block a user