Skip to content

Commit

Permalink
Only log stopping rollback manager once (hashicorp#20041)
Browse files Browse the repository at this point in the history
When testing the Rollback Manager's one-time invocation in Enterprise,
it was noticed that due to the channel being closed, we'd always hit
this case and thus spam logs rather quickly with this message.

Switch to a boolean flip to log this once, as it is not executed in
parallel and thus doesn't need a sync.Once.

This only affected anyone calling the test core's
StopAutomaticRollbacks() helper.

Signed-off-by: Alexander Scheel <alex.scheel@hashicorp.com>
  • Loading branch information
cipherboy committed Apr 10, 2023
1 parent 211fd80 commit 871bf52
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion vault/rollback.go
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,12 @@ func (m *RollbackManager) Stop() {
m.inflightAll.Wait()
}

// StopTicker stops the automatic Rollback manager's ticker, causing us
// to not do automatic rollbacks. This is useful for testing plugin's
// periodic function's behavior, without trying to race against the
// rollback manager proper.
//
// THIS SHOULD ONLY BE CALLED FROM TEST HELPERS.
func (m *RollbackManager) StopTicker() {
close(m.stopTicker)
}
Expand All @@ -104,6 +110,7 @@ func (m *RollbackManager) StopTicker() {
func (m *RollbackManager) run() {
m.logger.Info("starting rollback manager")
tick := time.NewTicker(m.period)
logTestStopOnce := false
defer tick.Stop()
defer close(m.doneCh)
for {
Expand All @@ -116,7 +123,10 @@ func (m *RollbackManager) run() {
return

case <-m.stopTicker:
m.logger.Info("stopping rollback manager ticker for tests")
if !logTestStopOnce {
m.logger.Info("stopping rollback manager ticker for tests")
logTestStopOnce = true
}
tick.Stop()
}
}
Expand Down

0 comments on commit 871bf52

Please sign in to comment.