Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions conf/orchestrator-sample-sqlite.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
"PreFailoverProcesses": [
"echo 'Will recover from {failureType} on {failureCluster}' >> /tmp/recovery.log"
],
"FailRecoveryOnFailedPostFailoverProcesses": false,
"PostFailoverProcesses": [
"echo '(for all types) Recovered from {failureType} on {failureCluster}. Failed: {failedHost}:{failedPort}; Successor: {successorHost}:{successorPort}' >> /tmp/recovery.log"
],
Expand Down
1 change: 1 addition & 0 deletions conf/orchestrator-sample.conf.json
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
"PreFailoverProcesses": [
"echo 'Will recover from {failureType} on {failureCluster}' >> /tmp/recovery.log"
],
"FailRecoveryOnFailedPostFailoverProcesses": false,
"PostFailoverProcesses": [
"echo '(for all types) Recovered from {failureType} on {failureCluster}. Failed: {failedHost}:{failedPort}; Successor: {successorHost}:{successorPort}' >> /tmp/recovery.log"
],
Expand Down
11 changes: 9 additions & 2 deletions docs/configuration-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,15 @@ These hooks are available for recoveries:
- `PostFailoverProcesses`: executed at the end of any successful recovery (including and adding to the above two).
- `PostUnsuccessfulFailoverProcesses`: executed at the end of any unsuccessful recovery.
- `PostGracefulTakeoverProcesses`: executed on planned, graceful master takeover, after the old master is positioned under the newly promoted master.

Any process command that ends with `"&"` will be executed asynchronously, and a failure for such process is ignored.
- `FailRecoveryOnFailedPostFailoverProcesses`: when `true` (default `false`), a non-zero exit from the successful-path
post hooks above (`PostFailoverProcesses`, `PostMasterFailoverProcesses`, `PostIntermediateMasterFailoverProcesses`,
`PostGracefulTakeoverProcesses`) marks the recovery as **unsuccessful** in orchestrator's recovery history, returns
an error to the caller, and counts the recovery as failed in metrics. Topology changes already performed are **not**
rolled back. Use this when external hooks (for example service discovery updates) are part of your recovery SLO.
When `false`, hook failures are audited/logged but the recovery remains successful (legacy behavior).

Any process command that ends with `"&"` will be executed asynchronously, and a failure for such process is ignored
(including when `FailRecoveryOnFailedPostFailoverProcesses` is `true`).

All of the above are lists of commands which `orchestrator` executes sequentially, in order of definition.

Expand Down
106 changes: 56 additions & 50 deletions go/config/config.go

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions go/config/config_post_failover_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package config

import "testing"

func TestFailRecoveryOnFailedPostFailoverProcessesDefault(t *testing.T) {
c := newConfiguration()
if c.FailRecoveryOnFailedPostFailoverProcesses {
t.Fatal("default must be false for backward compatibility")
}
}
217 changes: 217 additions & 0 deletions go/logic/post_failover_hooks_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
/*
Copyright 2026 ProxySQL Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package logic

import (
"errors"
"os/exec"
"strings"
"testing"

"github.com/proxysql/orchestrator/go/config"
"github.com/proxysql/orchestrator/go/inst"
)

func stubAuditNoBackend(t *testing.T) {
t.Helper()
orig := auditTopologyRecoveryFn
auditTopologyRecoveryFn = func(tr *TopologyRecovery, message string) error {
return nil
}
t.Cleanup(func() { auditTopologyRecoveryFn = orig })
}

func TestFailOnPostFailoverHookErrorFollowsConfig(t *testing.T) {
orig := config.Config.FailRecoveryOnFailedPostFailoverProcesses
defer func() { config.Config.FailRecoveryOnFailedPostFailoverProcesses = orig }()

config.Config.FailRecoveryOnFailedPostFailoverProcesses = false
if failOnPostFailoverHookError() {
t.Fatal("expected false when config disabled")
}
config.Config.FailRecoveryOnFailedPostFailoverProcesses = true
if !failOnPostFailoverHookError() {
t.Fatal("expected true when config enabled")
}
}

func TestMarkRecoveryUnsuccessfulDueToHooks(t *testing.T) {
stubAuditNoBackend(t)
tr := NewTopologyRecovery(inst.ReplicationAnalysis{})
tr.IsSuccessful = true

markRecoveryUnsuccessfulDueToHooks(tr, errors.New("hook boom"))
if tr.IsSuccessful {
t.Fatal("expected IsSuccessful=false")
}
if len(tr.AllErrors) == 0 {
t.Fatal("expected error recorded on topology recovery")
}
if !strings.Contains(tr.AllErrors[0], "post-failover hooks failed") {
t.Fatalf("unexpected error text: %q", tr.AllErrors[0])
}

// nil-safe
markRecoveryUnsuccessfulDueToHooks(nil, errors.New("x"))
markRecoveryUnsuccessfulDueToHooks(tr, nil)
}

func TestExecuteProcessesFailOnError(t *testing.T) {
stubAuditNoBackend(t)
if _, err := exec.LookPath("false"); err != nil {
t.Skip("false binary not available")
}
tr := NewTopologyRecovery(inst.ReplicationAnalysis{})

err := executeProcesses([]string{"false"}, "TestHooks", tr, true)
if err == nil {
t.Fatal("expected error when failOnError=true and command fails")
}

err = executeProcesses([]string{"false", "true"}, "TestHooks", tr, false)
// failOnError=false: returns first error but continues (true still runs)
if err == nil {
t.Fatal("expected first command error to be returned even when failOnError=false")
}

err = executeProcesses([]string{"true"}, "TestHooks", tr, true)
if err != nil {
t.Fatalf("true should succeed: %v", err)
}

err = executeProcesses(nil, "TestHooks", tr, true)
if err != nil {
t.Fatalf("empty hooks should succeed: %v", err)
}
}

func TestRunPostSuccessFailoverProcessesPolicyOff(t *testing.T) {
stubAuditNoBackend(t)
if _, err := exec.LookPath("false"); err != nil {
t.Skip("false binary not available")
}
orig := config.Config.FailRecoveryOnFailedPostFailoverProcesses
defer func() { config.Config.FailRecoveryOnFailedPostFailoverProcesses = orig }()
config.Config.FailRecoveryOnFailedPostFailoverProcesses = false

tr := NewTopologyRecovery(inst.ReplicationAnalysis{})
tr.IsSuccessful = true
key := inst.InstanceKey{Hostname: "successor.example", Port: 3306}
tr.SuccessorKey = &key

err := runPostSuccessFailoverProcesses([]string{"false"}, "PostFailoverProcesses", tr)
if err != nil {
t.Fatalf("policy off should not return error: %v", err)
}
if !tr.IsSuccessful {
t.Fatal("policy off must not flip IsSuccessful")
}
}

func TestRunPostSuccessFailoverProcessesPolicyOn(t *testing.T) {
stubAuditNoBackend(t)
if _, err := exec.LookPath("false"); err != nil {
t.Skip("false binary not available")
}
orig := config.Config.FailRecoveryOnFailedPostFailoverProcesses
defer func() { config.Config.FailRecoveryOnFailedPostFailoverProcesses = orig }()
config.Config.FailRecoveryOnFailedPostFailoverProcesses = true

origPersist := persistResolvedRecoveryFn
persistCalls := 0
persistResolvedRecoveryFn = func(tr *TopologyRecovery) error {
persistCalls++
if tr.IsSuccessful {
t.Error("persist should see IsSuccessful=false")
}
return nil
}
defer func() { persistResolvedRecoveryFn = origPersist }()

tr := NewTopologyRecovery(inst.ReplicationAnalysis{})
tr.IsSuccessful = true
key := inst.InstanceKey{Hostname: "successor.example", Port: 3306}
tr.SuccessorKey = &key

err := runPostSuccessFailoverProcesses([]string{"false"}, "PostFailoverProcesses", tr)
if err == nil {
t.Fatal("policy on should return hook error")
}
if tr.IsSuccessful {
t.Fatal("policy on must set IsSuccessful=false")
}
if persistCalls != 1 {
t.Fatalf("expected 1 persist call, got %d", persistCalls)
}
}

func TestRunPostSuccessFailoverProcessesPolicyOnPersistError(t *testing.T) {
stubAuditNoBackend(t)
if _, err := exec.LookPath("false"); err != nil {
t.Skip("false binary not available")
}
orig := config.Config.FailRecoveryOnFailedPostFailoverProcesses
defer func() { config.Config.FailRecoveryOnFailedPostFailoverProcesses = orig }()
config.Config.FailRecoveryOnFailedPostFailoverProcesses = true

origPersist := persistResolvedRecoveryFn
persistResolvedRecoveryFn = func(tr *TopologyRecovery) error {
return errors.New("db down")
}
defer func() { persistResolvedRecoveryFn = origPersist }()

tr := NewTopologyRecovery(inst.ReplicationAnalysis{})
tr.IsSuccessful = true

err := runPostSuccessFailoverProcesses([]string{"false"}, "PostFailoverProcesses", tr)
if err == nil {
t.Fatal("expected combined error")
}
if !strings.Contains(err.Error(), "db down") {
t.Fatalf("expected persist error in message: %v", err)
}
if !strings.Contains(err.Error(), "post-failover hooks failed") {
t.Fatalf("expected hook failure in message: %v", err)
}
}

func TestRunPostSuccessFailoverProcessesSuccess(t *testing.T) {
stubAuditNoBackend(t)
if _, err := exec.LookPath("true"); err != nil {
t.Skip("true binary not available")
}
orig := config.Config.FailRecoveryOnFailedPostFailoverProcesses
defer func() { config.Config.FailRecoveryOnFailedPostFailoverProcesses = orig }()
config.Config.FailRecoveryOnFailedPostFailoverProcesses = true

origPersist := persistResolvedRecoveryFn
persistResolvedRecoveryFn = func(tr *TopologyRecovery) error {
t.Fatal("persist should not run on success")
return nil
}
defer func() { persistResolvedRecoveryFn = origPersist }()

tr := NewTopologyRecovery(inst.ReplicationAnalysis{})
tr.IsSuccessful = true

if err := runPostSuccessFailoverProcesses([]string{"true"}, "PostFailoverProcesses", tr); err != nil {
t.Fatalf("unexpected error: %v", err)
}
if !tr.IsSuccessful {
t.Fatal("success should keep IsSuccessful")
}
}
Loading
Loading