8a2e63dcad
Move code for connecting to a repo into a common package so that backup and restore CLI code can both use it This will also make it easier for maintenance code in the future as it can reuse the same helper There are no logic changes in this PR, only code movement --- #### 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 - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [ ] 🗺️ Documentation - [ ] 🤖 Supportability/Tests - [ ] 💻 CI/Deployment - [x] 🧹 Tech Debt/Cleanup #### Issue(s) tangentially related to * #3077 #### Test Plan - [ ] 💪 Manual - [x] ⚡ Unit test - [ ] 💚 E2E
328 lines
9.4 KiB
Go
328 lines
9.4 KiB
Go
package config
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"testing"
|
|
|
|
"github.com/alcionai/clues"
|
|
"github.com/spf13/viper"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/stretchr/testify/suite"
|
|
|
|
"github.com/alcionai/corso/src/internal/tester"
|
|
"github.com/alcionai/corso/src/pkg/account"
|
|
"github.com/alcionai/corso/src/pkg/credentials"
|
|
"github.com/alcionai/corso/src/pkg/storage"
|
|
)
|
|
|
|
const (
|
|
configFileTemplate = `
|
|
` + BucketNameKey + ` = '%s'
|
|
` + EndpointKey + ` = 's3.amazonaws.com'
|
|
` + PrefixKey + ` = 'test-prefix/'
|
|
` + StorageProviderTypeKey + ` = 'S3'
|
|
` + AccountProviderTypeKey + ` = 'M365'
|
|
` + AzureTenantIDKey + ` = '%s'
|
|
` + DisableTLSKey + ` = 'false'
|
|
` + DisableTLSVerificationKey + ` = 'false'
|
|
`
|
|
)
|
|
|
|
type ConfigSuite struct {
|
|
tester.Suite
|
|
}
|
|
|
|
func TestConfigSuite(t *testing.T) {
|
|
suite.Run(t, &ConfigSuite{Suite: tester.NewUnitSuite(t)})
|
|
}
|
|
|
|
func (suite *ConfigSuite) TestRequireProps() {
|
|
table := []struct {
|
|
name string
|
|
props map[string]string
|
|
errCheck assert.ErrorAssertionFunc
|
|
}{
|
|
{
|
|
props: map[string]string{"exists": "I have seen the fnords!"},
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
props: map[string]string{"not-exists": ""},
|
|
errCheck: assert.Error,
|
|
},
|
|
}
|
|
for _, test := range table {
|
|
err := requireProps(test.props)
|
|
test.errCheck(suite.T(), err, clues.ToCore(err))
|
|
}
|
|
}
|
|
|
|
func (suite *ConfigSuite) TestReadRepoConfigBasic() {
|
|
var (
|
|
t = suite.T()
|
|
vpr = viper.New()
|
|
)
|
|
|
|
const (
|
|
b = "read-repo-config-basic-bucket"
|
|
tID = "6f34ac30-8196-469b-bf8f-d83deadbbbba"
|
|
)
|
|
|
|
// Generate test config file
|
|
testConfigData := fmt.Sprintf(configFileTemplate, b, tID)
|
|
testConfigFilePath := filepath.Join(t.TempDir(), "corso.toml")
|
|
err := os.WriteFile(testConfigFilePath, []byte(testConfigData), 0o700)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
|
|
// Configure viper to read test config file
|
|
vpr.SetConfigFile(testConfigFilePath)
|
|
|
|
// Read and validate config
|
|
err = vpr.ReadInConfig()
|
|
require.NoError(t, err, "reading repo config", clues.ToCore(err))
|
|
|
|
s3Cfg, err := s3ConfigsFromViper(vpr)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
assert.Equal(t, b, s3Cfg.Bucket)
|
|
|
|
m365, err := m365ConfigsFromViper(vpr)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
assert.Equal(t, tID, m365.AzureTenantID)
|
|
}
|
|
|
|
func (suite *ConfigSuite) TestWriteReadConfig() {
|
|
var (
|
|
t = suite.T()
|
|
vpr = viper.New()
|
|
// Configure viper to read test config file
|
|
testConfigFilePath = filepath.Join(t.TempDir(), "corso.toml")
|
|
)
|
|
|
|
const (
|
|
bkt = "write-read-config-bucket"
|
|
tid = "3c0748d2-470e-444c-9064-1268e52609d5"
|
|
)
|
|
|
|
err := initWithViper(vpr, testConfigFilePath)
|
|
require.NoError(t, err, "initializing repo config", clues.ToCore(err))
|
|
|
|
s3Cfg := storage.S3Config{Bucket: bkt, DoNotUseTLS: true, DoNotVerifyTLS: true}
|
|
m365 := account.M365Config{AzureTenantID: tid}
|
|
|
|
err = writeRepoConfigWithViper(vpr, s3Cfg, m365, "repoid")
|
|
require.NoError(t, err, "writing repo config", clues.ToCore(err))
|
|
|
|
err = vpr.ReadInConfig()
|
|
require.NoError(t, err, "reading repo config", clues.ToCore(err))
|
|
|
|
readS3Cfg, err := s3ConfigsFromViper(vpr)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
assert.Equal(t, readS3Cfg.Bucket, s3Cfg.Bucket)
|
|
assert.Equal(t, readS3Cfg.DoNotUseTLS, s3Cfg.DoNotUseTLS)
|
|
assert.Equal(t, readS3Cfg.DoNotVerifyTLS, s3Cfg.DoNotVerifyTLS)
|
|
|
|
readM365, err := m365ConfigsFromViper(vpr)
|
|
require.NoError(t, err, clues.ToCore(err))
|
|
assert.Equal(t, readM365.AzureTenantID, m365.AzureTenantID)
|
|
}
|
|
|
|
func (suite *ConfigSuite) TestMustMatchConfig() {
|
|
var (
|
|
t = suite.T()
|
|
vpr = viper.New()
|
|
// Configure viper to read test config file
|
|
testConfigFilePath = filepath.Join(t.TempDir(), "corso.toml")
|
|
)
|
|
|
|
const (
|
|
bkt = "must-match-config-bucket"
|
|
tid = "dfb12063-7598-458b-85ab-42352c5c25e2"
|
|
)
|
|
|
|
err := initWithViper(vpr, testConfigFilePath)
|
|
require.NoError(t, err, "initializing repo config")
|
|
|
|
s3Cfg := storage.S3Config{Bucket: bkt}
|
|
m365 := account.M365Config{AzureTenantID: tid}
|
|
|
|
err = writeRepoConfigWithViper(vpr, s3Cfg, m365, "repoid")
|
|
require.NoError(t, err, "writing repo config", clues.ToCore(err))
|
|
|
|
err = vpr.ReadInConfig()
|
|
require.NoError(t, err, "reading repo config", clues.ToCore(err))
|
|
|
|
table := []struct {
|
|
name string
|
|
input map[string]string
|
|
errCheck assert.ErrorAssertionFunc
|
|
}{
|
|
{
|
|
name: "full match",
|
|
input: map[string]string{
|
|
storage.Bucket: bkt,
|
|
account.AzureTenantID: tid,
|
|
},
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
name: "empty values",
|
|
input: map[string]string{
|
|
storage.Bucket: "",
|
|
account.AzureTenantID: "",
|
|
},
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
name: "no overrides",
|
|
input: map[string]string{},
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
name: "nil map",
|
|
input: nil,
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
name: "no recognized keys",
|
|
input: map[string]string{
|
|
"fnords": "smurfs",
|
|
"nonsense": "",
|
|
},
|
|
errCheck: assert.NoError,
|
|
},
|
|
{
|
|
name: "mismatch",
|
|
input: map[string]string{
|
|
storage.Bucket: tid,
|
|
account.AzureTenantID: bkt,
|
|
},
|
|
errCheck: assert.Error,
|
|
},
|
|
}
|
|
for _, test := range table {
|
|
suite.Run(test.name, func() {
|
|
test.errCheck(suite.T(), mustMatchConfig(vpr, test.input), clues.ToCore(err))
|
|
})
|
|
}
|
|
}
|
|
|
|
// ------------------------------------------------------------
|
|
// integration tests
|
|
// ------------------------------------------------------------
|
|
|
|
type ConfigIntegrationSuite struct {
|
|
tester.Suite
|
|
}
|
|
|
|
func TestConfigIntegrationSuite(t *testing.T) {
|
|
suite.Run(t, &ConfigIntegrationSuite{Suite: tester.NewIntegrationSuite(
|
|
t,
|
|
[][]string{tester.AWSStorageCredEnvs, tester.M365AcctCredEnvs},
|
|
)})
|
|
}
|
|
|
|
func (suite *ConfigIntegrationSuite) TestGetStorageAndAccount() {
|
|
t := suite.T()
|
|
vpr := viper.New()
|
|
|
|
const (
|
|
bkt = "get-storage-and-account-bucket"
|
|
end = "https://get-storage-and-account.com"
|
|
pfx = "get-storage-and-account-prefix/"
|
|
tid = "3a2faa4e-a882-445c-9d27-f552ef189381"
|
|
)
|
|
|
|
// Configure viper to read test config file
|
|
testConfigFilePath := filepath.Join(t.TempDir(), "corso.toml")
|
|
|
|
err := initWithViper(vpr, testConfigFilePath)
|
|
require.NoError(t, err, "initializing repo config", clues.ToCore(err))
|
|
|
|
s3Cfg := storage.S3Config{
|
|
Bucket: bkt,
|
|
Endpoint: end,
|
|
Prefix: pfx,
|
|
DoNotVerifyTLS: true,
|
|
DoNotUseTLS: true,
|
|
}
|
|
m365 := account.M365Config{AzureTenantID: tid}
|
|
|
|
err = writeRepoConfigWithViper(vpr, s3Cfg, m365, "repoid")
|
|
require.NoError(t, err, "writing repo config", clues.ToCore(err))
|
|
|
|
err = vpr.ReadInConfig()
|
|
require.NoError(t, err, "reading repo config", clues.ToCore(err))
|
|
|
|
config, err := getStorageAndAccountWithViper(vpr, true, nil)
|
|
require.NoError(t, err, "getting storage and account from config", clues.ToCore(err))
|
|
|
|
readS3Cfg, err := config.Storage.S3Config()
|
|
require.NoError(t, err, "reading s3 config from storage", clues.ToCore(err))
|
|
assert.Equal(t, readS3Cfg.Bucket, s3Cfg.Bucket)
|
|
assert.Equal(t, readS3Cfg.Endpoint, s3Cfg.Endpoint)
|
|
assert.Equal(t, readS3Cfg.Prefix, s3Cfg.Prefix)
|
|
assert.Equal(t, readS3Cfg.DoNotUseTLS, s3Cfg.DoNotUseTLS)
|
|
assert.Equal(t, readS3Cfg.DoNotVerifyTLS, s3Cfg.DoNotVerifyTLS)
|
|
assert.Equal(t, config.RepoID, "repoid")
|
|
|
|
common, err := config.Storage.CommonConfig()
|
|
require.NoError(t, err, "reading common config from storage", clues.ToCore(err))
|
|
assert.Equal(t, common.CorsoPassphrase, os.Getenv(credentials.CorsoPassphrase))
|
|
|
|
readM365, err := config.Account.M365Config()
|
|
require.NoError(t, err, "reading m365 config from account", clues.ToCore(err))
|
|
assert.Equal(t, readM365.AzureTenantID, m365.AzureTenantID)
|
|
assert.Equal(t, readM365.AzureClientID, os.Getenv(credentials.AzureClientID))
|
|
assert.Equal(t, readM365.AzureClientSecret, os.Getenv(credentials.AzureClientSecret))
|
|
}
|
|
|
|
func (suite *ConfigIntegrationSuite) TestGetStorageAndAccount_noFileOnlyOverrides() {
|
|
t := suite.T()
|
|
vpr := viper.New()
|
|
|
|
const (
|
|
bkt = "get-storage-and-account-no-file-bucket"
|
|
end = "https://get-storage-and-account.com/no-file"
|
|
pfx = "get-storage-and-account-no-file-prefix/"
|
|
tid = "88f8522b-18e4-4d0f-b514-2d7b34d4c5a1"
|
|
)
|
|
|
|
m365 := account.M365Config{AzureTenantID: tid}
|
|
|
|
overrides := map[string]string{
|
|
account.AzureTenantID: tid,
|
|
AccountProviderTypeKey: account.ProviderM365.String(),
|
|
storage.Bucket: bkt,
|
|
storage.Endpoint: end,
|
|
storage.Prefix: pfx,
|
|
storage.DoNotUseTLS: "true",
|
|
storage.DoNotVerifyTLS: "true",
|
|
StorageProviderTypeKey: storage.ProviderS3.String(),
|
|
}
|
|
|
|
config, err := getStorageAndAccountWithViper(vpr, false, overrides)
|
|
require.NoError(t, err, "getting storage and account from config", clues.ToCore(err))
|
|
|
|
readS3Cfg, err := config.Storage.S3Config()
|
|
require.NoError(t, err, "reading s3 config from storage", clues.ToCore(err))
|
|
assert.Equal(t, readS3Cfg.Bucket, bkt)
|
|
assert.Equal(t, config.RepoID, "")
|
|
assert.Equal(t, readS3Cfg.Endpoint, end)
|
|
assert.Equal(t, readS3Cfg.Prefix, pfx)
|
|
assert.True(t, readS3Cfg.DoNotUseTLS)
|
|
assert.True(t, readS3Cfg.DoNotVerifyTLS)
|
|
|
|
common, err := config.Storage.CommonConfig()
|
|
require.NoError(t, err, "reading common config from storage", clues.ToCore(err))
|
|
assert.Equal(t, common.CorsoPassphrase, os.Getenv(credentials.CorsoPassphrase))
|
|
|
|
readM365, err := config.Account.M365Config()
|
|
require.NoError(t, err, "reading m365 config from account", clues.ToCore(err))
|
|
assert.Equal(t, readM365.AzureTenantID, m365.AzureTenantID)
|
|
assert.Equal(t, readM365.AzureClientID, os.Getenv(credentials.AzureClientID))
|
|
assert.Equal(t, readM365.AzureClientSecret, os.Getenv(credentials.AzureClientSecret))
|
|
}
|