github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/coldflush_test.go

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

package storage

import (
	"errors"
	"sync"
	"testing"

	"github.com/golang/mock/gomock"
	"github.com/m3db/m3/src/dbnode/persist"
	"github.com/m3db/m3/src/x/instrument"
	xtest "github.com/m3db/m3/src/x/test"
	xtime "github.com/m3db/m3/src/x/time"
	"github.com/stretchr/testify/require"
)

func TestColdFlushManagerFlushAlreadyInProgress(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()

	var (
		mockPersistManager = persist.NewMockManager(ctrl)
		mockFlushPersist   = persist.NewMockFlushPreparer(ctrl)

		// Channels used to coordinate cold flushing
		startCh = make(chan struct{}, 1)
		doneCh  = make(chan struct{}, 1)
	)
	defer func() {
		close(startCh)
		close(doneCh)
	}()

	mockFlushPersist.EXPECT().DoneFlush().Return(nil)
	mockPersistManager.EXPECT().StartFlushPersist().Do(func() {
		startCh <- struct{}{}
		<-doneCh
	}).Return(mockFlushPersist, nil)

	testOpts := DefaultTestOptions().SetPersistManager(mockPersistManager)
	db := newMockdatabase(ctrl)
	db.EXPECT().Options().Return(testOpts).AnyTimes()
	db.EXPECT().IsBootstrapped().Return(true).AnyTimes()
	db.EXPECT().OwnedNamespaces().Return(nil, nil).AnyTimes()

	cfm := newColdFlushManager(db, mockPersistManager, testOpts).(*coldFlushManager)
	cfm.pm = mockPersistManager

	var (
		wg  sync.WaitGroup
		now = xtime.UnixNano(0)
	)
	wg.Add(2)

	// Goroutine 1 should successfully flush.
	go func() {
		defer wg.Done()
		require.True(t, cfm.Run(now))
	}()

	// Goroutine 2 should indicate already flushing.
	go func() {
		defer wg.Done()

		// Wait until we start the cold flushing process.
		<-startCh

		// Ensure it doesn't allow a parallel flush.
		require.False(t, cfm.Run(now))

		// Allow the cold flush to finish.
		doneCh <- struct{}{}
	}()

	wg.Wait()

}

func TestColdFlushManagerFlushDoneFlushError(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()

	var (
		fakeErr            = errors.New("fake error while marking flush done")
		mockPersistManager = persist.NewMockManager(ctrl)
		mockFlushPersist   = persist.NewMockFlushPreparer(ctrl)
	)

	mockFlushPersist.EXPECT().DoneFlush().Return(fakeErr)
	mockPersistManager.EXPECT().StartFlushPersist().Return(mockFlushPersist, nil)

	testOpts := DefaultTestOptions().SetPersistManager(mockPersistManager)
	db := newMockdatabase(ctrl)
	db.EXPECT().Options().Return(testOpts).AnyTimes()
	db.EXPECT().OwnedNamespaces().Return(nil, nil)

	cfm := newColdFlushManager(db, mockPersistManager, testOpts).(*coldFlushManager)
	cfm.pm = mockPersistManager

	require.EqualError(t, fakeErr, cfm.coldFlush().Error())
}

func TestColdFlushManagerSkipRun(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()

	database := newMockdatabase(ctrl)
	cfm := newColdFlushManager(database, nil, DefaultTestOptions())

	database.EXPECT().IsBootstrapped().Return(false)
	require.False(t, cfm.Run(xtime.Now()))
}

func TestColdFlushManagerRunCleanupPanic(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()
	database := newMockdatabase(ctrl)
	database.EXPECT().IsBootstrapped().Return(true)

	cm := NewMockdatabaseCleanupManager(ctrl)
	cfm := newColdFlushManager(database, nil, DefaultTestOptions())
	mgr := cfm.(*coldFlushManager)
	mgr.databaseCleanupManager = cm

	ts := xtime.Now()
	gomock.InOrder(
		cm.EXPECT().ColdFlushCleanup(ts).Return(errors.New("cleanup error")),
	)

	defer instrument.SetShouldPanicEnvironmentVariable(true)()
	require.Panics(t, func() { mgr.Run(ts) })
}

func TestColdFlushManagerRunFlushPanic(t *testing.T) {
	ctrl := xtest.NewController(t)
	defer ctrl.Finish()
	database := newMockdatabase(ctrl)
	database.EXPECT().IsBootstrapped().Return(true)
	database.EXPECT().OwnedNamespaces().Return(nil, errors.New("flush error"))

	cm := NewMockdatabaseCleanupManager(ctrl)
	cfm := newColdFlushManager(database, nil, DefaultTestOptions())
	mgr := cfm.(*coldFlushManager)
	mgr.databaseCleanupManager = cm

	ts := xtime.Now()
	gomock.InOrder(
		cm.EXPECT().ColdFlushCleanup(ts).Return(nil),
	)

	defer instrument.SetShouldPanicEnvironmentVariable(true)()
	require.Panics(t, func() { mgr.Run(ts) })
}