larryh/corso
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

do not return errs from tester setup funcs (#1886)

Browse Source 
## Type of change

- [x] 🤖 Test
- [x] 🐹 Trivial/Minor

## Test Plan

- [x] ⚡ Unit test
- [x] 💚 E2E
This commit is contained in:
Keepers 2022-12-22 09:11:02 -07:00 committed by GitHub
parent 460bf7d096
commit bdd7a456bc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 32 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/cli/backup/exchange_integration_test.go
View File

@ -86,8 +86,7 @@ func (suite *NoBackupExchangeIntegrationSuite) SetupSuite() {
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx = config.SetViper(ctx, suite.vpr)
suite.m365UserID = tester.M365UserID(t)
@ -174,8 +173,7 @@ func (suite *BackupExchangeIntegrationSuite) SetupSuite() {
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx = config.SetViper(ctx, suite.vpr)
suite.m365UserID = tester.M365UserID(t)
@ -267,8 +265,7 @@ func (suite *PreparedBackupExchangeIntegrationSuite) SetupSuite() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx, flush := tester.NewContext()
ctx = config.SetViper(ctx, suite.vpr)
@ -504,8 +501,7 @@ func (suite *BackupDeleteExchangeIntegrationSuite) SetupSuite() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx, flush := tester.NewContext()
ctx = config.SetViper(ctx, suite.vpr)

6
src/cli/backup/onedrive_integration_test.go
View File

@ -75,8 +75,7 @@ func (suite *NoBackupOneDriveIntegrationSuite) SetupSuite() {
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx = config.SetViper(ctx, suite.vpr)
suite.m365UserID = tester.M365UserID(t)
@ -159,8 +158,7 @@ func (suite *BackupDeleteOneDriveIntegrationSuite) SetupSuite() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx, flush := tester.NewContext()
ctx = config.SetViper(ctx, suite.vpr)

6
src/cli/backup/sharepoint_integration_test.go
View File

@ -75,8 +75,7 @@ func (suite *NoBackupSharePointIntegrationSuite) SetupSuite() {
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx = config.SetViper(ctx, suite.vpr)
suite.m365SiteID = tester.M365SiteID(t)
@ -159,8 +158,7 @@ func (suite *BackupDeleteSharePointIntegrationSuite) SetupSuite() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
ctx, flush := tester.NewContext()
ctx = config.SetViper(ctx, suite.vpr)

18
src/cli/repo/s3_integration_test.go
View File

@ -62,8 +62,7 @@ func (suite *S3IntegrationSuite) TestInitS3Cmd() {
cfg, err := st.S3Config()
require.NoError(t, err)
vpr, configFP, err := tester.MakeTempTestConfigClone(t, nil)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, nil)
ctx = config.SetViper(ctx, vpr)
@ -95,8 +94,7 @@ func (suite *S3IntegrationSuite) TestInitMultipleTimes() {
cfg, err := st.S3Config()
require.NoError(t, err)
vpr, configFP, err := tester.MakeTempTestConfigClone(t, nil)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, nil)
ctx = config.SetViper(ctx, vpr)
@ -125,8 +123,7 @@ func (suite *S3IntegrationSuite) TestInitS3Cmd_missingBucket() {
cfg, err := st.S3Config()
require.NoError(t, err)
vpr, configFP, err := tester.MakeTempTestConfigClone(t, nil)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, nil)
ctx = config.SetViper(ctx, vpr)
@ -169,8 +166,7 @@ func (suite *S3IntegrationSuite) TestConnectS3Cmd() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
vpr, configFP, err := tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, force)
ctx = config.SetViper(ctx, vpr)
@ -203,8 +199,7 @@ func (suite *S3IntegrationSuite) TestConnectS3Cmd_BadBucket() {
cfg, err := st.S3Config()
require.NoError(t, err)
vpr, configFP, err := tester.MakeTempTestConfigClone(t, nil)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, nil)
ctx = config.SetViper(ctx, vpr)
@ -229,8 +224,7 @@ func (suite *S3IntegrationSuite) TestConnectS3Cmd_BadPrefix() {
cfg, err := st.S3Config()
require.NoError(t, err)
vpr, configFP, err := tester.MakeTempTestConfigClone(t, nil)
require.NoError(t, err)
vpr, configFP := tester.MakeTempTestConfigClone(t, nil)
ctx = config.SetViper(ctx, vpr)

3
src/cli/restore/exchange_integration_test.go
View File

@ -77,8 +77,7 @@ func (suite *RestoreExchangeIntegrationSuite) SetupSuite() {
tester.TestCfgStorageProvider: "S3",
tester.TestCfgPrefix: cfg.Prefix,
}
suite.vpr, suite.cfgFP, err = tester.MakeTempTestConfigClone(t, force)
require.NoError(t, err)
suite.vpr, suite.cfgFP = tester.MakeTempTestConfigClone(t, force)
suite.m365UserID = tester.M365UserID(t)
users := []string{suite.m365UserID}

18
src/internal/tester/config.go
View File

@ -8,6 +8,7 @@ import (
"github.com/pkg/errors"
"github.com/spf13/viper"
"github.com/stretchr/testify/require"
"golang.org/x/exp/maps"
"github.com/alcionai/corso/src/pkg/account"
@ -158,11 +159,9 @@ func readTestConfig() (map[string]string, error) {
// The overrides prop replaces config values with the provided value.
//
// Returns a filepath string pointing to the location of the temp file.
func MakeTempTestConfigClone(t *testing.T, overrides map[string]string) (*viper.Viper, string, error) {
func MakeTempTestConfigClone(t *testing.T, overrides map[string]string) (*viper.Viper, string) {
cfg, err := readTestConfig()
if err != nil {
return nil, "", err
}
require.NoError(t, err, "reading tester config")
fName := filepath.Base(os.Getenv(EnvCorsoTestConfigFilePath))
if len(fName) == 0 || fName == "." || fName == "/" {
@ -172,9 +171,8 @@ func MakeTempTestConfigClone(t *testing.T, overrides map[string]string) (*viper.
tDir := t.TempDir()
tDirFp := filepath.Join(tDir, fName)
if _, err := os.Create(tDirFp); err != nil {
return nil, "", err
}
_, err = os.Create(tDirFp)
require.NoError(t, err, "creating temp test dir")
ext := filepath.Ext(fName)
vpr := viper.New()
@ -192,11 +190,9 @@ func MakeTempTestConfigClone(t *testing.T, overrides map[string]string) (*viper.
vpr.Set(k, v)
}
if err := vpr.WriteConfig(); err != nil {
return nil, "", err
}
require.NoError(t, vpr.WriteConfig(), "writing temp dir viper config file")
return vpr, tDirFp, nil
return vpr, tDirFp
}
// writes the first non-zero valued string to the map at the key.

22
src/internal/tester/loader.go
View File

@ -3,16 +3,17 @@ package tester
import (
"bufio"
"os"
"testing"
"github.com/stretchr/testify/require"
)
func LoadAFile(aFile string) ([]byte, error) {
func LoadAFile(t *testing.T, fileName string) []byte {
// Preserves '\n' of original file. Uses incremental version when file too large
bytes, err := os.ReadFile(aFile)
bytes, err := os.ReadFile(fileName)
if err != nil {
f, err := os.Open(aFile)
if err != nil {
return nil, err
}
f, err := os.Open(fileName)
require.NoError(t, err, "opening file: "+fileName)
defer f.Close()
@ -24,13 +25,10 @@ func LoadAFile(aFile string) ([]byte, error) {
buffer = append(buffer, temp...)
}
aErr := reader.Err()
if aErr != nil {
return nil, aErr
}
require.NoError(t, reader.Err(), "reading file: "+fileName)
return buffer, nil
return buffer
}
return bytes, nil
return bytes
}