corso/src/internal/operations/backup_test.go

package operations

import (
	"context"
	"testing"
	"time"

	multierror "github.com/hashicorp/go-multierror"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"github.com/stretchr/testify/suite"

	"github.com/alcionai/corso/internal/connector/support"
	"github.com/alcionai/corso/internal/kopia"
	"github.com/alcionai/corso/internal/tester"
	"github.com/alcionai/corso/pkg/account"
	"github.com/alcionai/corso/pkg/control"
	"github.com/alcionai/corso/pkg/selectors"
	"github.com/alcionai/corso/pkg/store"
)

// ---------------------------------------------------------------------------
// unit
// ---------------------------------------------------------------------------

type BackupOpSuite struct {
	suite.Suite
}

func TestBackupOpSuite(t *testing.T) {
	suite.Run(t, new(BackupOpSuite))
}

func (suite *BackupOpSuite) TestBackupOperation_PersistResults() {
	t := suite.T()
	ctx := context.Background()

	var (
		kw    = &kopia.Wrapper{}
		sw    = &store.Wrapper{}
		acct  = account.Account{}
		now   = time.Now()
		stats = backupStats{
			started:  true,
			readErr:  multierror.Append(nil, assert.AnError),
			writeErr: assert.AnError,
			k: &kopia.BackupStats{
				TotalFileCount: 1,
			},
			gc: &support.ConnectorOperationStatus{
				Successful: 1,
			},
		}
	)

	op, err := NewBackupOperation(ctx, control.Options{}, kw, sw, acct, selectors.Selector{})
	require.NoError(t, err)

	require.NoError(t, op.persistResults(now, &stats))

	assert.Equal(t, op.Status.String(), Completed.String(), "status")
	assert.Equal(t, op.Results.ItemsRead, stats.gc.Successful, "items read")
	assert.Equal(t, op.Results.ReadErrors, stats.readErr, "read errors")
	assert.Equal(t, op.Results.ItemsWritten, stats.k.TotalFileCount, "items written")
	assert.Equal(t, op.Results.WriteErrors, stats.writeErr, "write errors")
	assert.Equal(t, op.Results.StartedAt, now, "started at")
	assert.Less(t, now, op.Results.CompletedAt, "completed at")
}

// ---------------------------------------------------------------------------
// integration
// ---------------------------------------------------------------------------

type BackupOpIntegrationSuite struct {
	suite.Suite
}

func TestBackupOpIntegrationSuite(t *testing.T) {
	if err := tester.RunOnAny(
		tester.CorsoCITests,
		tester.CorsoOperationTests,
	); err != nil {
		t.Skip(err)
	}
	suite.Run(t, new(BackupOpIntegrationSuite))
}

func (suite *BackupOpIntegrationSuite) SetupSuite() {
	_, err := tester.GetRequiredEnvSls(
		tester.AWSStorageCredEnvs,
		tester.M365AcctCredEnvs)
	require.NoError(suite.T(), err)
}

func (suite *BackupOpIntegrationSuite) TestNewBackupOperation() {
	kw := &kopia.Wrapper{}
	sw := &store.Wrapper{}
	acct := tester.NewM365Account(suite.T())

	table := []struct {
		name     string
		opts     control.Options
		kw       *kopia.Wrapper
		sw       *store.Wrapper
		acct     account.Account
		targets  []string
		errCheck assert.ErrorAssertionFunc
	}{
		{"good", control.Options{}, kw, sw, acct, nil, assert.NoError},
		{"missing kopia", control.Options{}, nil, sw, acct, nil, assert.Error},
		{"missing modelstore", control.Options{}, kw, nil, acct, nil, assert.Error},
	}
	for _, test := range table {
		suite.T().Run(test.name, func(t *testing.T) {
			_, err := NewBackupOperation(
				context.Background(),
				test.opts,
				test.kw,
				test.sw,
				test.acct,
				selectors.Selector{})
			test.errCheck(t, err)
		})
	}
}

// TestBackup_Run ensures that Integration Testing works
// for the following scopes: Contacts, Events, and Mail
func (suite *BackupOpIntegrationSuite) TestBackup_Run() {
	t := suite.T()
	ctx := context.Background()

	m365UserID := tester.M365UserID(t)
	acct := tester.NewM365Account(t)

	tests := []struct {
		name       string
		selectFunc func() *selectors.Selector
	}{
		{
			name: "Integration Exchange.Mail",
			selectFunc: func() *selectors.Selector {
				sel := selectors.NewExchangeBackup()
				sel.Include(sel.MailFolders([]string{m365UserID}, []string{"Inbox"}))
				return &sel.Selector
			},
		},

		{
			name: "Integration Exchange.Contacts",
			selectFunc: func() *selectors.Selector {
				sel := selectors.NewExchangeBackup()
				sel.Include(sel.ContactFolders([]string{m365UserID}, selectors.Any()))
				return &sel.Selector
			},
		},
		{
			name: "Integration Exchange.Events",
			selectFunc: func() *selectors.Selector {
				sel := selectors.NewExchangeBackup()
				sel.Include(sel.Events([]string{m365UserID}, selectors.Any()))

				return &sel.Selector
			},
		},
	}

	for _, test := range tests {
		suite.T().Run(test.name, func(t *testing.T) {
			// need to initialize the repository before we can test connecting to it.
			st := tester.NewPrefixedS3Storage(t)
			k := kopia.NewConn(st)
			require.NoError(t, k.Initialize(ctx))

			// kopiaRef comes with a count of 1 and Wrapper bumps it again so safe
			// to close here.
			defer k.Close(ctx)

			kw, err := kopia.NewWrapper(k)
			require.NoError(t, err)
			defer kw.Close(ctx)

			ms, err := kopia.NewModelStore(k)
			require.NoError(t, err)
			defer ms.Close(ctx)

			sw := store.NewKopiaStore(ms)
			selected := test.selectFunc()
			bo, err := NewBackupOperation(
				ctx,
				control.Options{},
				kw,
				sw,
				acct,
				*selected,
			)
			require.NoError(t, err)

			require.NoError(t, bo.Run(ctx))
			require.NotEmpty(t, bo.Results)
			require.NotEmpty(t, bo.Results.BackupID)
			assert.Equal(t, bo.Status, Completed)
			assert.Greater(t, bo.Results.ItemsRead, 0)
			assert.Greater(t, bo.Results.ItemsWritten, 0)
			assert.Zero(t, bo.Results.ReadErrors)
			assert.Zero(t, bo.Results.WriteErrors)
		})
	}
}