tendermint/libs/service/service_test.go

package service

import (
	"context"
	"sync"
	"testing"
	"time"

	"github.com/fortytw2/leaktest"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/tendermint/tendermint/libs/log"
)

type testService struct {
	started      bool
	stopped      bool
	multiStopped bool
	mu           sync.Mutex
	BaseService
}

func (t *testService) OnStop() {
	t.mu.Lock()
	defer t.mu.Unlock()
	if t.stopped == true {
		t.multiStopped = true
	}
	t.stopped = true
}
func (t *testService) OnStart(context.Context) error {
	t.mu.Lock()
	defer t.mu.Unlock()

	t.started = true
	return nil
}

func (t *testService) isStarted() bool {
	t.mu.Lock()
	defer t.mu.Unlock()
	return t.started
}

func (t *testService) isStopped() bool {
	t.mu.Lock()
	defer t.mu.Unlock()
	return t.stopped
}

func (t *testService) isMultiStopped() bool {
	t.mu.Lock()
	defer t.mu.Unlock()
	return t.multiStopped
}

func TestBaseService(t *testing.T) {
	t.Cleanup(leaktest.Check(t))
	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	logger := log.NewNopLogger()

	t.Run("Wait", func(t *testing.T) {
		wctx, wcancel := context.WithCancel(ctx)
		defer wcancel()
		ts := &testService{}
		ts.BaseService = *NewBaseService(logger, t.Name(), ts)
		err := ts.Start(wctx)
		require.NoError(t, err)
		require.True(t, ts.isStarted())

		waitFinished := make(chan struct{})
		wcancel()
		go func() {
			ts.Wait()
			close(waitFinished)
		}()

		select {
		case <-waitFinished:
			assert.True(t, ts.isStopped(), "failed to stop")
			assert.False(t, ts.IsRunning(), "is not running")

		case <-time.After(100 * time.Millisecond):
			t.Fatal("expected Wait() to finish within 100 ms.")
		}
	})
	t.Run("ManualStop", func(t *testing.T) {
		ts := &testService{}
		ts.BaseService = *NewBaseService(logger, t.Name(), ts)
		require.False(t, ts.IsRunning())
		require.False(t, ts.isStarted())
		require.NoError(t, ts.Start(ctx))

		require.True(t, ts.isStarted())

		require.NoError(t, ts.Stop())
		require.True(t, ts.isStopped())
		require.False(t, ts.IsRunning())
	})
	t.Run("MultiStop", func(t *testing.T) {
		t.Run("SingleThreaded", func(t *testing.T) {
			ts := &testService{}
			ts.BaseService = *NewBaseService(logger, t.Name(), ts)

			require.NoError(t, ts.Start(ctx))
			require.True(t, ts.isStarted())
			require.NoError(t, ts.Stop())
			require.True(t, ts.isStopped())
			require.False(t, ts.isMultiStopped())
			require.Error(t, ts.Stop())
			require.False(t, ts.isMultiStopped())
		})
		t.Run("MultiThreaded", func(t *testing.T) {
			ctx, cancel := context.WithCancel(context.Background())
			defer cancel()

			ts := &testService{}
			ts.BaseService = *NewBaseService(logger, t.Name(), ts)

			require.NoError(t, ts.Start(ctx))
			require.True(t, ts.isStarted())

			go func() { _ = ts.Stop() }()
			go cancel()

			ts.Wait()

			require.True(t, ts.isStopped())
			require.False(t, ts.isMultiStopped())
		})

	})

}