Merge pull request #35 from supplyon/add_mock_interface

fix potential data race

Makefile

@@ -22,7 +22,9 @@ gen-mocks: sep ## Generates test doubles (mocks).
  @echo "--> generate mocks (github.com/golang/mock/gomock is required for this)"
  @go install github.com/golang/mock/mockgen@latest
  @mockgen -source=health/check.go -destination test/mocks/health/mock_check.go
+ @mockgen -source=shutdown/stopable.go -destination shutdown/mock_stopable_test.go -package shutdown
  @mockgen -source=shutdown/stopable.go -destination test/mocks/shutdown/mock_stopable.go
+ @mockgen -source=shutdown/shutdownHandler.go -destination test/mocks/shutdown/mock_shutdownHandler.go
 
 tools: sep ## Installs needed tools
  @echo "--> Install needed tools"

health/monitor.go

@@ -88,6 +88,8 @@ func (m *Monitor) Join() {
 }
 
 func (m *Monitor) String() string {
+ m.mux.Lock()
+ defer m.mux.Unlock()
  return fmt.Sprintf("HealthMonitor (%d checks)", len(m.healthChecks))
 }
 
@@ -132,7 +134,7 @@ func (m *Monitor) evaluateChecks(at time.Time) checkEvaluationResult {
  }
  logEvent.Err(err).
  // don't propagate errors to alerting
- Bool("no_alert",true).
+ Bool("no_alert", true).
  Msgf("Check - '%s'", name)
  }
 

shutdown/shutdownHandler.go

@@ -11,6 +11,12 @@ import (
  "go.uber.org/atomic"
 )
 
+// ShutdownHandler is an helper interface to allow mocking and alternative
+type ShutdownHandler interface {
+ Register(stoppable Stopable, front ...bool)
+ WaitUntilSignal()
+}
+
 // Handler represents a handler for shutdown events
 type Handler struct {
  logger zerolog.Logger

shutdown/shutdownHandler_test.go

@@ -7,7 +7,6 @@ import (
  "testing"
  "time"
 
- mock_shutdown "github.com/ThomasObenaus/go-base/test/mocks/shutdown"
  "github.com/golang/mock/gomock"
  "github.com/rs/zerolog"
  "github.com/stretchr/testify/assert"
@@ -29,9 +28,9 @@ func Test_ShutdownHandler(t *testing.T) {
  mockCtrl := gomock.NewController(t)
  defer mockCtrl.Finish()
  var stopables []Stopable
- stopable1 := mock_shutdown.NewMockStopable(mockCtrl)
+ stopable1 := NewMockStopable(mockCtrl)
  stopables = append(stopables, stopable1)
- stopable2 := mock_shutdown.NewMockStopable(mockCtrl)
+ stopable2 := NewMockStopable(mockCtrl)
  stopables = append(stopables, stopable2)
  var logger zerolog.Logger
  h := Handler{
@@ -67,8 +66,8 @@ func Test_RegisterFront(t *testing.T) {
  // GIVEN
  mockCtrl := gomock.NewController(t)
  defer mockCtrl.Finish()
- stopable1 := mock_shutdown.NewMockStopable(mockCtrl)
- stopable2 := mock_shutdown.NewMockStopable(mockCtrl)
+ stopable1 := NewMockStopable(mockCtrl)
+ stopable2 := NewMockStopable(mockCtrl)
  var logger zerolog.Logger
  h := Handler{
  orderedStopables: make([]Stopable, 0),
@@ -108,8 +107,8 @@ func Test_RegisterBack(t *testing.T) {
  // GIVEN
  mockCtrl := gomock.NewController(t)
  defer mockCtrl.Finish()
- stopable1 := mock_shutdown.NewMockStopable(mockCtrl)
- stopable2 := mock_shutdown.NewMockStopable(mockCtrl)
+ stopable1 := NewMockStopable(mockCtrl)
+ stopable2 := NewMockStopable(mockCtrl)
  var logger zerolog.Logger
  h := Handler{
  orderedStopables: make([]Stopable, 0),