[Perf] adding perf tests back (Azure#17323)

* adding perf tests

* build errors

Author: seankane-msft

sdk/storage/azblob/testdata/perf/download_blob.go

@@ -0,0 +1,146 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package main
+
+import (
+	"bytes"
+	"context"
+	"flag"
+	"fmt"
+	"io"
+	"os"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/internal/perf"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
+)
+
+type downloadTestOptions struct {
+	size int
+}
+
+var downloadTestOpts downloadTestOptions = downloadTestOptions{size: 10240}
+
+// downloadTestRegister is called once per process
+func downloadTestRegister() {
+	flag.IntVar(&downloadTestOpts.size, "size", 10240, "Size in bytes of data to be transferred in upload or download tests. Default is 10240.")
+}
+
+type downloadTestGlobal struct {
+	perf.PerfTestOptions
+	containerName string
+	blobName      string
+}
+
+// NewDownloadTest is called once per process
+func NewDownloadTest(ctx context.Context, options perf.PerfTestOptions) (perf.GlobalPerfTest, error) {
+	d := &downloadTestGlobal{
+		PerfTestOptions: options,
+		containerName:   "downloadcontainer",
+		blobName:        "downloadblob",
+	}
+
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return nil, fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(connStr, d.containerName, nil)
+	if err != nil {
+		return nil, err
+	}
+	_, err = containerClient.Create(context.Background(), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	blobClient, err := containerClient.NewBlockBlobClient(d.blobName)
+	if err != nil {
+		return nil, err
+	}
+
+	data, err := perf.NewRandomStream(downloadTestOpts.size)
+	if err != nil {
+		return nil, err
+	}
+
+	_, err = blobClient.Upload(context.Background(), data, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return d, nil
+}
+
+func (d *downloadTestGlobal) GlobalCleanup(ctx context.Context) error {
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(connStr, d.containerName, nil)
+	if err != nil {
+		return err
+	}
+
+	_, err = containerClient.Delete(context.Background(), nil)
+	return err
+}
+
+type downloadPerfTest struct {
+	*downloadTestGlobal
+	perf.PerfTestOptions
+	data       io.ReadSeekCloser
+	blobClient *azblob.BlockBlobClient
+}
+
+// NewPerfTest is called once per goroutine
+func (g *downloadTestGlobal) NewPerfTest(ctx context.Context, options *perf.PerfTestOptions) (perf.PerfTest, error) {
+	d := &downloadPerfTest{
+		downloadTestGlobal: g,
+		PerfTestOptions:    *options,
+	}
+
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return nil, fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(connStr, d.downloadTestGlobal.containerName, &azblob.ClientOptions{
+		Transporter: d.PerfTestOptions.Transporter,
+	})
+	if err != nil {
+		return nil, err
+	}
+	bc, err := containerClient.NewBlockBlobClient(d.blobName)
+	if err != nil {
+		return nil, err
+	}
+	d.blobClient = bc
+
+	data, err := perf.NewRandomStream(downloadTestOpts.size)
+	if err != nil {
+		return nil, err
+	}
+	d.data = data
+
+	return d, err
+}
+
+func (d *downloadPerfTest) Run(ctx context.Context) error {
+	get, err := d.blobClient.Download(ctx, nil)
+	if err != nil {
+		return err
+	}
+	downloadedData := &bytes.Buffer{}
+	reader := get.Body(nil)
+	_, err = downloadedData.ReadFrom(reader)
+	if err != nil {
+		return err
+	}
+	return reader.Close()
+}
+
+func (*downloadPerfTest) Cleanup(ctx context.Context) error {
+	return nil
+}

sdk/storage/azblob/testdata/perf/go.mod

@@ -0,0 +1,17 @@
+module github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/testdata/perf
+
+go 1.17
+
+replace github.com/Azure/azure-sdk-for-go/sdk/internal => ../../../../internal
+
+replace github.com/Azure/azure-sdk-for-go/sdk/storage/azblob => ../../.
+
+require github.com/Azure/azure-sdk-for-go/sdk/storage/azblob v0.2.0
+
+require github.com/Azure/azure-sdk-for-go/sdk/internal v0.8.3
+
+require (
+	github.com/Azure/azure-sdk-for-go/sdk/azcore v0.21.1 // indirect
+	golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d // indirect
+	golang.org/x/text v0.3.7 // indirect
+)

sdk/storage/azblob/testdata/perf/go.sum

@@ -0,0 +1,45 @@
+github.com/Azure/azure-sdk-for-go/sdk/azcore v0.21.1 h1:qoVeMsc9/fh/yhxVaA0obYjVH/oI/ihrOoMwsLS9KSA=
+github.com/Azure/azure-sdk-for-go/sdk/azcore v0.21.1/go.mod h1:fBF9PQNqB8scdgpZ3ufzaLntG0AG7C1WjPMsiFOmfHM=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/dnaeon/go-vcr v1.1.0/go.mod h1:M7tiix8f0r6mKKJ3Yq/kqU1OYf3MnfmBWVbPx/yU9ko=
+github.com/dnaeon/go-vcr v1.2.0 h1:zHCHvJYTMh1N7xnV7zf1m1GPBF9Ad0Jk/whtQ1663qI=
+github.com/dnaeon/go-vcr v1.2.0/go.mod h1:R4UdLID7HZT3taECzJs4YgbbH6PIGXB6W/sc5OLb6RQ=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
+github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
+github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
+github.com/modocache/gover v0.0.0-20171022184752-b58185e213c5/go.mod h1:caMODM3PzxT8aQXRPkAt8xlV/e7d7w8GM5g0fa5F0D8=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
+github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
+golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
+golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
+golang.org/x/net v0.0.0-20201010224723-4f7140c49acb/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
+golang.org/x/net v0.0.0-20210610132358-84b48f89b13b/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d h1:20cMwl2fHAzkJMEA+8J4JgqBQcQGzbisXo31MIeenXI=
+golang.org/x/net v0.0.0-20210805182204-aaa1db679c0d/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y=
+golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
+golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
+golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
+golang.org/x/text v0.3.7 h1:olpwvP2KacW1ZWvsR7uQhoyTYvKAupfQrRGBFM352Gk=
+golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20201130134442-10cb98267c6c/go.mod h1:JHkPIbrfpd72SG/EVd6muEfDQjcINNoR0C8j2r3qZ4Q=
+gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
+gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo=
+gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

sdk/storage/azblob/testdata/perf/list_blobs.go

@@ -0,0 +1,133 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License. See License.txt in the project root for license information.
+
+package main
+
+import (
+	"bytes"
+	"context"
+	"flag"
+	"fmt"
+	"os"
+
+	"github.com/Azure/azure-sdk-for-go/sdk/internal/perf"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
+)
+
+type listTestOptions struct {
+	count int
+}
+
+var listTestOpts listTestOptions = listTestOptions{count: 100}
+
+// uploadTestRegister is called once per process
+func listTestRegister() {
+	flag.IntVar(&listTestOpts.count, "num-blobs", 100, "Number of blobs to list.")
+}
+
+type listTestGlobal struct {
+	perf.PerfTestOptions
+	containerName string
+	blobName      string
+}
+
+// NewListTest is called once per process
+func NewListTest(ctx context.Context, options perf.PerfTestOptions) (perf.GlobalPerfTest, error) {
+	l := &listTestGlobal{
+		PerfTestOptions: options,
+		containerName:   "listcontainer",
+		blobName:        "listblob",
+	}
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return nil, fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(connStr, l.containerName, nil)
+	if err != nil {
+		return nil, err
+	}
+	_, err = containerClient.Create(context.Background(), nil)
+	if err != nil {
+		return nil, err
+	}
+
+	for i := 0; i < 100; i++ {
+		blobClient, err := containerClient.NewBlockBlobClient(fmt.Sprintf("%s%d", l.blobName, i))
+		if err != nil {
+			return nil, err
+		}
+		_, err = blobClient.Upload(
+			context.Background(),
+			NopCloser(bytes.NewReader([]byte(""))),
+			nil,
+		)
+		if err != nil {
+			return nil, err
+		}
+	}
+
+	return l, nil
+}
+
+func (l *listTestGlobal) GlobalCleanup(ctx context.Context) error {
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(connStr, l.containerName, nil)
+	if err != nil {
+		return err
+	}
+
+	_, err = containerClient.Delete(context.Background(), nil)
+	return err
+}
+
+type listPerfTest struct {
+	*listTestGlobal
+	perf.PerfTestOptions
+	containerClient *azblob.ContainerClient
+}
+
+// NewPerfTest is called once per goroutine
+func (g *listTestGlobal) NewPerfTest(ctx context.Context, options *perf.PerfTestOptions) (perf.PerfTest, error) {
+	u := &listPerfTest{
+		listTestGlobal:  g,
+		PerfTestOptions: *options,
+	}
+
+	connStr, ok := os.LookupEnv("AZURE_STORAGE_CONNECTION_STRING")
+	if !ok {
+		return nil, fmt.Errorf("the environment variable 'AZURE_STORAGE_CONNECTION_STRING' could not be found")
+	}
+
+	containerClient, err := azblob.NewContainerClientFromConnectionString(
+		connStr,
+		u.listTestGlobal.containerName,
+		&azblob.ClientOptions{
+			Transporter: u.PerfTestOptions.Transporter,
+		},
+	)
+	if err != nil {
+		return nil, err
+	}
+	u.containerClient = containerClient
+
+	return u, nil
+}
+
+func (m *listPerfTest) Run(ctx context.Context) error {
+	c := int32(listTestOpts.count)
+	pager := m.containerClient.ListBlobsFlat(&azblob.ContainerListBlobFlatSegmentOptions{
+		Maxresults: &c,
+	})
+	for pager.NextPage(context.Background()) {
+	}
+	return pager.Err()
+}
+
+func (m *listPerfTest) Cleanup(ctx context.Context) error {
+	return nil
+}

sdk/storage/azblob/testdata/perf/main.go

@@ -0,0 +1,16 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package main
+
+import (
+	"github.com/Azure/azure-sdk-for-go/sdk/internal/perf"
+)
+
+func main() {
+	perf.Run(map[string]perf.PerfMethods{
+		"UploadBlobTest":   {Register: uploadTestRegister, New: NewUploadTest},
+		"ListBlobTest":     {Register: listTestRegister, New: NewListTest},
+		"DownloadBlobTest": {Register: downloadTestRegister, New: NewDownloadTest},
+	})
+}

sdk/storage/azblob/testdata/perf/shared.go

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+package main
+
+import (
+	"io"
+)
+
+type nopCloser struct {
+	io.ReadSeeker
+}
+
+func (n nopCloser) Close() error {
+	return nil
+}
+
+// NopCloser returns a ReadSeekCloser with a no-op close method wrapping the provided io.ReadSeeker.
+func NopCloser(rs io.ReadSeeker) io.ReadSeekCloser {
+	return nopCloser{rs}
+}