testcommon

Documentation

Overview

Contains common helpers for TESTS ONLY

Contains common helpers for TESTS ONLY

Index

• Constants
• Variables
• func AfterTest(t *testing.T, suite string, test string)
• func BeforeTest(t *testing.T, suite string, test string)
• func CreateNewDirectory(ctx context.Context, _require *require.Assertions, dirName string, ...) *directory.Client
• func CreateNewFileFromShare(ctx context.Context, _require *require.Assertions, fileName string, ...) *file.Client
• func CreateNewFileFromShareWithData(ctx context.Context, _require *require.Assertions, fileName string, ...) *file.Client
• func CreateNewShare(ctx context.Context, _require *require.Assertions, shareName string, ...) *share.Client
• func DeleteDirectory(ctx context.Context, _require *require.Assertions, dirClient *directory.Client)
• func DeleteFile(ctx context.Context, _require *require.Assertions, fileClient *file.Client)
• func DeleteShare(ctx context.Context, _require *require.Assertions, shareClient *share.Client)
• func GenerateData(sizeInBytes int) (io.ReadSeekCloser, []byte)
• func GenerateDirectoryName(testName string) string
• func GenerateEntityName(testName string) string
• func GenerateFileName(testName string) string
• func GenerateShareName(testName string) string
• func GetDirectoryClient(dirName string, s *share.Client) *directory.Client
• func GetFileClientFromShare(fileName string, shareClient *share.Client) *file.Client
• func GetGenericAccountInfo(accountType TestAccountType) (string, string)
• func GetGenericConnectionString(accountType TestAccountType) (*string, error)
• func GetGenericSharedKeyCredential(accountType TestAccountType) (*service.SharedKeyCredential, error)
• func GetGenericTokenCredential() (azcore.TokenCredential, error)
• func GetRequiredEnv(name string) (string, error)
• func GetServiceClient(t *testing.T, accountType TestAccountType, options *service.ClientOptions) (*service.Client, error)
• func GetServiceClientFromConnectionString(t *testing.T, accountType TestAccountType, options *service.ClientOptions) (*service.Client, error)
• func GetServiceClientNoCredential(t *testing.T, sasUrl string, options *service.ClientOptions) (*service.Client, error)
• func GetShareClient(shareName string, s *service.Client) *share.Client
• func SetClientOptions(t *testing.T, opts *azcore.ClientOptions)
• func SetupSuite(suite *suite.Suite) *recording.TestProxyInstance
• func TearDownSuite(suite *suite.Suite, proxy *recording.TestProxyInstance)
• func ValidateFileErrorCode(_require *require.Assertions, err error, code fileerror.Code)
• func ValidateHTTPErrorCode(_require *require.Assertions, err error, code int)
• type FakeCredential
  • func (c *FakeCredential) GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error)
• type TestAccountType

Constants

const (
	DefaultEndpointSuffix       = "core.windows.net/"
	DefaultFileEndpointSuffix   = "file.core.windows.net/"
	AccountNameEnvVar           = "AZURE_STORAGE_ACCOUNT_NAME"
	AccountKeyEnvVar            = "AZURE_STORAGE_ACCOUNT_KEY"
	DefaultEndpointSuffixEnvVar = "AZURE_STORAGE_ENDPOINT_SUFFIX"
	EncryptionScopeEnvVar       = "AZURE_STORAGE_ENCRYPTION_SCOPE"
	PremiumAccountNameEnvVar    = "FILE_STORAGE_ACCOUNT_NAME"
	PremiumAccountKeyEnvVar     = "FILE_STORAGE_ACCOUNT_KEY"
)

const (
	FakeStorageAccount = "fakestorage"
	FakeStorageURL     = "https://fakestorage.file.core.windows.net"
	FakeToken          = "faketoken"
)

const (
	RecordingDirectory = "sdk/storage/azfile/testdata"
	SharePrefix        = "gos"
	DirectoryPrefix    = "godir"
	FilePrefix         = "gotestfile"
	FileDefaultData    = "GoFileDefaultData"
)

const (
	ISO8601 = "2006-01-02T15:04:05.0000000Z07:00"
)

Variables

var BasicMetadata = map[string]*string{
	"foo": to.Ptr("foovalue"),
	"bar": to.Ptr("barvalue"),
}

var (
	SampleSDDL = `O:S-1-5-32-548G:S-1-5-21-397955417-626881126-188441444-512D:(A;;RPWPCCDCLCSWRCWDWOGA;;;S-1-0-0)`
)

Functions

func AfterTest

func AfterTest(t *testing.T, suite string, test string)

func BeforeTest

func BeforeTest(t *testing.T, suite string, test string)

func CreateNewDirectory

func CreateNewDirectory(ctx context.Context, _require *require.Assertions, dirName string, shareClient *share.Client) *directory.Client

func CreateNewFileFromShare

func CreateNewFileFromShare(ctx context.Context, _require *require.Assertions, fileName string, fileSize int64, shareClient *share.Client) *file.Client

func CreateNewFileFromShareWithData

func CreateNewFileFromShareWithData(ctx context.Context, _require *require.Assertions, fileName string, shareClient *share.Client) *file.Client

func CreateNewShare

func CreateNewShare(ctx context.Context, _require *require.Assertions, shareName string, svcClient *service.Client) *share.Client

func DeleteDirectory

func DeleteDirectory(ctx context.Context, _require *require.Assertions, dirClient *directory.Client)

func DeleteFile

func DeleteFile(ctx context.Context, _require *require.Assertions, fileClient *file.Client)

func DeleteShare

func DeleteShare(ctx context.Context, _require *require.Assertions, shareClient *share.Client)

func GenerateData

func GenerateData(sizeInBytes int) (io.ReadSeekCloser, []byte)

func GenerateDirectoryName

func GenerateDirectoryName(testName string) string

func GenerateEntityName

func GenerateEntityName(testName string) string

func GenerateFileName

func GenerateFileName(testName string) string

func GenerateShareName

func GenerateShareName(testName string) string

func GetDirectoryClient

func GetDirectoryClient(dirName string, s *share.Client) *directory.Client

func GetFileClientFromShare

func GetFileClientFromShare(fileName string, shareClient *share.Client) *file.Client

func GetGenericAccountInfo

func GetGenericAccountInfo(accountType TestAccountType) (string, string)

func GetGenericConnectionString

func GetGenericConnectionString(accountType TestAccountType) (*string, error)

func GetGenericSharedKeyCredential

func GetGenericSharedKeyCredential(accountType TestAccountType) (*service.SharedKeyCredential, error)

func GetGenericTokenCredential

func GetGenericTokenCredential() (azcore.TokenCredential, error)

func GetRequiredEnv

func GetRequiredEnv(name string) (string, error)

GetRequiredEnv gets an environment variable by name and returns an error if it is not found

func GetServiceClient

func GetServiceClient(t *testing.T, accountType TestAccountType, options *service.ClientOptions) (*service.Client, error)

func GetServiceClientFromConnectionString

func GetServiceClientFromConnectionString(t *testing.T, accountType TestAccountType, options *service.ClientOptions) (*service.Client, error)

func GetServiceClientNoCredential

func GetServiceClientNoCredential(t *testing.T, sasUrl string, options *service.ClientOptions) (*service.Client, error)

func GetShareClient

func GetShareClient(shareName string, s *service.Client) *share.Client

func SetClientOptions

func SetClientOptions(t *testing.T, opts *azcore.ClientOptions)

func SetupSuite

func SetupSuite(suite *suite.Suite) *recording.TestProxyInstance

func TearDownSuite

func TearDownSuite(suite *suite.Suite, proxy *recording.TestProxyInstance)

func ValidateFileErrorCode

func ValidateFileErrorCode(_require *require.Assertions, err error, code fileerror.Code)

func ValidateHTTPErrorCode

func ValidateHTTPErrorCode(_require *require.Assertions, err error, code int)

Types

type FakeCredential

type FakeCredential struct {
}

func (*FakeCredential) GetToken

func (c *FakeCredential) GetToken(ctx context.Context, opts policy.TokenRequestOptions) (azcore.AccessToken, error)

type TestAccountType

type TestAccountType string

const (
	TestAccountDefault    TestAccountType = ""
	TestAccountSecondary  TestAccountType = "SECONDARY_"
	TestAccountPremium    TestAccountType = "PREMIUM_"
	TestAccountSoftDelete TestAccountType = "SOFT_DELETE_"
)