8590b24199
<!-- PR description--> Introducing a new `Configurer` interface to abstract out storage config information(for s3, filesystem etc) from caller code. I consider this as a short term solution. We need to consolidate overall config handling in a better way, but that's out of scope for this PR chain. Testing * Most of the changes here are code movement under the hood. So relying on existing tests. * I'll address any test gaps in a later PR. --- #### Does this PR need a docs update or release note? - [ ] ✅ Yes, it's included - [ ] 🕐 Yes, but in a later PR - [x] ⛔ No #### Type of change <!--- Please check the type of change your PR introduces: ---> - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Supportability/Tests - [ ] 💻 CI/Deployment - [x] 🧹 Tech Debt/Cleanup #### Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * https://github.com/alcionai/corso/issues/1416 #### Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [x] ⚡ Unit test - [ ] 💚 E2E
289 lines
6.5 KiB
Go
289 lines
6.5 KiB
Go
package repo_test
|
|
|
|
import (
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/alcionai/clues"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/alcionai/corso/src/cli"
|
|
"github.com/alcionai/corso/src/cli/config"
|
|
cliTD "github.com/alcionai/corso/src/cli/testdata"
|
|
"github.com/alcionai/corso/src/internal/tester"
|
|
"github.com/alcionai/corso/src/internal/tester/tconfig"
|
|
"github.com/alcionai/corso/src/pkg/account"
|
|
"github.com/alcionai/corso/src/pkg/control"
|
|
ctrlRepo "github.com/alcionai/corso/src/pkg/control/repository"
|
|
"github.com/alcionai/corso/src/pkg/repository"
|
|
"github.com/alcionai/corso/src/pkg/storage"
|
|
storeTD "github.com/alcionai/corso/src/pkg/storage/testdata"
|
|
)
|
|
|
|
type S3E2ESuite struct {
|
|
tester.Suite
|
|
}
|
|
|
|
func TestS3E2ESuite(t *testing.T) {
|
|
suite.Run(t, &S3E2ESuite{Suite: tester.NewE2ESuite(
|
|
t,
|
|
[][]string{storeTD.AWSStorageCredEnvs, tconfig.M365AcctCredEnvs})})
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestInitS3Cmd() {
|
|
table := []struct {
|
|
name string
|
|
bucketPrefix string
|
|
hasConfigFile bool
|
|
}{
|
|
{
|
|
name: "NoPrefix",
|
|
bucketPrefix: "",
|
|
hasConfigFile: true,
|
|
},
|
|
{
|
|
name: "S3Prefix",
|
|
bucketPrefix: "s3://",
|
|
hasConfigFile: true,
|
|
},
|
|
{
|
|
name: "NoConfigFile",
|
|
bucketPrefix: "",
|
|
hasConfigFile: false,
|
|
},
|
|
}
|
|
|
|
for _, test := range table {
|
|
suite.Run(test.name, func() {
|
|
t := suite.T()
|
|
|
|
ctx, flush := tester.NewContext(t)
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, nil)
|
|
if !test.hasConfigFile {
|
|
// Ideally we could use `/dev/null`, but you need a
|
|
// toml file plus this works cross platform
|
|
os.Remove(configFP)
|
|
}
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "init", "s3",
|
|
"--config-file", configFP,
|
|
"--bucket", test.bucketPrefix+cfg.Bucket,
|
|
"--prefix", cfg.Prefix)
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
// a second initialization should result in an error
|
|
err = cmd.ExecuteContext(ctx)
|
|
assert.ErrorIs(t, err, repository.ErrorRepoAlreadyExists, clues.ToCore(err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestInitMultipleTimes() {
|
|
t := suite.T()
|
|
ctx, flush := tester.NewContext(t)
|
|
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, nil)
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
for i := 0; i < 2; i++ {
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "init", "s3",
|
|
"--config-file", configFP,
|
|
"--bucket", cfg.Bucket,
|
|
"--prefix", cfg.Prefix,
|
|
"--succeed-if-exists")
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
}
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestInitS3Cmd_missingBucket() {
|
|
t := suite.T()
|
|
ctx, flush := tester.NewContext(t)
|
|
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
force := map[string]string{
|
|
tconfig.TestCfgBucket: "",
|
|
}
|
|
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, force)
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "init", "s3",
|
|
"--config-file", configFP,
|
|
"--prefix", cfg.Prefix)
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.Error(t, err, clues.ToCore(err))
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestConnectS3Cmd() {
|
|
table := []struct {
|
|
name string
|
|
bucketPrefix string
|
|
hasConfigFile bool
|
|
}{
|
|
{
|
|
name: "NoPrefix",
|
|
bucketPrefix: "",
|
|
hasConfigFile: true,
|
|
},
|
|
{
|
|
name: "S3Prefix",
|
|
bucketPrefix: "s3://",
|
|
hasConfigFile: true,
|
|
},
|
|
{
|
|
name: "NoConfigFile",
|
|
bucketPrefix: "",
|
|
hasConfigFile: false,
|
|
},
|
|
}
|
|
|
|
for _, test := range table {
|
|
suite.Run(test.name, func() {
|
|
t := suite.T()
|
|
|
|
ctx, flush := tester.NewContext(t)
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
force := map[string]string{
|
|
tconfig.TestCfgAccountProvider: account.ProviderM365.String(),
|
|
tconfig.TestCfgStorageProvider: storage.ProviderS3.String(),
|
|
tconfig.TestCfgPrefix: cfg.Prefix,
|
|
}
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, force)
|
|
if !test.hasConfigFile {
|
|
// Ideally we could use `/dev/null`, but you need a
|
|
// toml file plus this works cross platform
|
|
os.Remove(configFP)
|
|
}
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
// init the repo first
|
|
_, err = repository.Initialize(
|
|
ctx,
|
|
account.Account{},
|
|
st,
|
|
control.DefaultOptions(),
|
|
ctrlRepo.Retention{})
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
// then test it
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "connect", "s3",
|
|
"--config-file", configFP,
|
|
"--bucket", test.bucketPrefix+cfg.Bucket,
|
|
"--prefix", cfg.Prefix)
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
})
|
|
}
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestConnectS3Cmd_BadBucket() {
|
|
t := suite.T()
|
|
ctx, flush := tester.NewContext(t)
|
|
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, nil)
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "connect", "s3",
|
|
"--config-file", configFP,
|
|
"--bucket", "wrong",
|
|
"--prefix", cfg.Prefix)
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.Error(t, err, clues.ToCore(err))
|
|
}
|
|
|
|
func (suite *S3E2ESuite) TestConnectS3Cmd_BadPrefix() {
|
|
t := suite.T()
|
|
ctx, flush := tester.NewContext(t)
|
|
|
|
defer flush()
|
|
|
|
st := storeTD.NewPrefixedS3Storage(t)
|
|
sc, err := st.StorageConfig()
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
cfg := sc.(*storage.S3Config)
|
|
|
|
vpr, configFP := tconfig.MakeTempTestConfigClone(t, nil)
|
|
|
|
ctx = config.SetViper(ctx, vpr)
|
|
|
|
cmd := cliTD.StubRootCmd(
|
|
"repo", "connect", "s3",
|
|
"--config-file", configFP,
|
|
"--bucket", cfg.Bucket,
|
|
"--prefix", "wrong")
|
|
cli.BuildCommandTree(cmd)
|
|
|
|
// run the command
|
|
err = cmd.ExecuteContext(ctx)
|
|
require.Error(t, err, clues.ToCore(err))
|
|
}
|