Skip to content

Commit 6cdec79

Browse files
tanyasethi-msfttanyasethi-msft
authored
Storage/fix Module Name in azfile, azdatalake, azblob (#22273)
* fixModuleName adls * fixModuleName blob, file and test case * linter error * test fix * azblob module name change * azblob * azfile lint error fix * comments address
1 parent 4872e73 commit 6cdec79

23 files changed

Lines changed: 181 additions & 89 deletions

File tree

‎sdk/storage/azblob/appendblob/client.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
4040
conOptions := shared.GetClientOptions(options)
4141
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
4242

43-
azClient, err := azcore.NewClient(shared.AppendBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
43+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
4444
if err != nil {
4545
return nil, err
4646
}
@@ -55,7 +55,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
5555
func NewClientWithNoCredential(blobURL string, options *ClientOptions) (*Client, error) {
5656
conOptions := shared.GetClientOptions(options)
5757

58-
azClient, err := azcore.NewClient(shared.AppendBlobClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
58+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
5959
if err != nil {
6060
return nil, err
6161
}
@@ -72,7 +72,7 @@ func NewClientWithSharedKeyCredential(blobURL string, cred *blob.SharedKeyCreden
7272
conOptions := shared.GetClientOptions(options)
7373
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
7474

75-
azClient, err := azcore.NewClient(shared.AppendBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
75+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
7676
if err != nil {
7777
return nil, err
7878
}

‎sdk/storage/azblob/blob/client.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
4141
conOptions := shared.GetClientOptions(options)
4242
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
4343

44-
azClient, err := azcore.NewClient(shared.BlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
44+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
4545
if err != nil {
4646
return nil, err
4747
}
@@ -55,7 +55,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
5555
func NewClientWithNoCredential(blobURL string, options *ClientOptions) (*Client, error) {
5656
conOptions := shared.GetClientOptions(options)
5757

58-
azClient, err := azcore.NewClient(shared.BlobClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
58+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
5959
if err != nil {
6060
return nil, err
6161
}
@@ -71,7 +71,7 @@ func NewClientWithSharedKeyCredential(blobURL string, cred *SharedKeyCredential,
7171
conOptions := shared.GetClientOptions(options)
7272
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
7373

74-
azClient, err := azcore.NewClient(shared.BlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
74+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
7575
if err != nil {
7676
return nil, err
7777
}

‎sdk/storage/azblob/blockblob/client.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
5050
conOptions := shared.GetClientOptions(options)
5151
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
5252

53-
azClient, err := azcore.NewClient(shared.BlockBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
53+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
5454
if err != nil {
5555
return nil, err
5656
}
@@ -64,7 +64,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
6464
func NewClientWithNoCredential(blobURL string, options *ClientOptions) (*Client, error) {
6565
conOptions := shared.GetClientOptions(options)
6666

67-
azClient, err := azcore.NewClient(shared.BlockBlobClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
67+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
6868
if err != nil {
6969
return nil, err
7070
}
@@ -81,7 +81,7 @@ func NewClientWithSharedKeyCredential(blobURL string, cred *blob.SharedKeyCreden
8181
conOptions := shared.GetClientOptions(options)
8282
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
8383

84-
azClient, err := azcore.NewClient(shared.BlockBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
84+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
8585
if err != nil {
8686
return nil, err
8787
}

‎sdk/storage/azblob/container/client.go‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ func NewClient(containerURL string, cred azcore.TokenCredential, options *Client
4747
conOptions := shared.GetClientOptions(options)
4848
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
4949

50-
azClient, err := azcore.NewClient(shared.ContainerClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
50+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
5151
if err != nil {
5252
return nil, err
5353
}
@@ -61,7 +61,7 @@ func NewClient(containerURL string, cred azcore.TokenCredential, options *Client
6161
func NewClientWithNoCredential(containerURL string, options *ClientOptions) (*Client, error) {
6262
conOptions := shared.GetClientOptions(options)
6363

64-
azClient, err := azcore.NewClient(shared.ContainerClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
64+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
6565
if err != nil {
6666
return nil, err
6767
}
@@ -77,7 +77,7 @@ func NewClientWithSharedKeyCredential(containerURL string, cred *SharedKeyCreden
7777
conOptions := shared.GetClientOptions(options)
7878
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
7979

80-
azClient, err := azcore.NewClient(shared.ContainerClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
80+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
8181
if err != nil {
8282
return nil, err
8383
}
@@ -138,7 +138,7 @@ func (c *Client) URL() string {
138138
func (c *Client) NewBlobClient(blobName string) *blob.Client {
139139
blobName = url.PathEscape(blobName)
140140
blobURL := runtime.JoinPaths(c.URL(), blobName)
141-
return (*blob.Client)(base.NewBlobClient(blobURL, c.generated().InternalClient().WithClientName(shared.BlobClient), c.credential(), c.getClientOptions()))
141+
return (*blob.Client)(base.NewBlobClient(blobURL, c.generated().InternalClient().WithClientName(exported.ModuleName), c.credential(), c.getClientOptions()))
142142
}
143143

144144
// NewAppendBlobClient creates a new appendblob.Client object by concatenating blobName to the end of
@@ -147,7 +147,7 @@ func (c *Client) NewBlobClient(blobName string) *blob.Client {
147147
func (c *Client) NewAppendBlobClient(blobName string) *appendblob.Client {
148148
blobName = url.PathEscape(blobName)
149149
blobURL := runtime.JoinPaths(c.URL(), blobName)
150-
return (*appendblob.Client)(base.NewAppendBlobClient(blobURL, c.generated().InternalClient().WithClientName(shared.AppendBlobClient), c.sharedKey()))
150+
return (*appendblob.Client)(base.NewAppendBlobClient(blobURL, c.generated().InternalClient().WithClientName(exported.ModuleName), c.sharedKey()))
151151
}
152152

153153
// NewBlockBlobClient creates a new blockblob.Client object by concatenating blobName to the end of
@@ -156,7 +156,7 @@ func (c *Client) NewAppendBlobClient(blobName string) *appendblob.Client {
156156
func (c *Client) NewBlockBlobClient(blobName string) *blockblob.Client {
157157
blobName = url.PathEscape(blobName)
158158
blobURL := runtime.JoinPaths(c.URL(), blobName)
159-
return (*blockblob.Client)(base.NewBlockBlobClient(blobURL, c.generated().InternalClient().WithClientName(shared.BlockBlobClient), c.sharedKey()))
159+
return (*blockblob.Client)(base.NewBlockBlobClient(blobURL, c.generated().InternalClient().WithClientName(exported.ModuleName), c.sharedKey()))
160160
}
161161

162162
// NewPageBlobClient creates a new pageblob.Client object by concatenating blobName to the end of
@@ -165,7 +165,7 @@ func (c *Client) NewBlockBlobClient(blobName string) *blockblob.Client {
165165
func (c *Client) NewPageBlobClient(blobName string) *pageblob.Client {
166166
blobName = url.PathEscape(blobName)
167167
blobURL := runtime.JoinPaths(c.URL(), blobName)
168-
return (*pageblob.Client)(base.NewPageBlobClient(blobURL, c.generated().InternalClient().WithClientName(shared.PageBlobClient), c.sharedKey()))
168+
return (*pageblob.Client)(base.NewPageBlobClient(blobURL, c.generated().InternalClient().WithClientName(exported.ModuleName), c.sharedKey()))
169169
}
170170

171171
// Create creates a new container within a storage account. If a container with the same name already exists, the operation fails.

‎sdk/storage/azblob/internal/exported/version.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
package exported
88

99
const (
10-
ModuleName = "azblob"
10+
ModuleName = "github.com/Azure/azure-sdk-for-go/sdk/storage/azblob"
1111
ModuleVersion = "v1.3.0-beta.2"
1212
)

‎sdk/storage/azblob/internal/shared/shared.go‎

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -44,15 +44,6 @@ const (
4444

4545
const crc64Polynomial uint64 = 0x9A6C9329AC4BC9B5
4646

47-
const (
48-
AppendBlobClient = "azblob/appendblob.Client"
49-
BlobClient = "azblob/blob.Client"
50-
BlockBlobClient = "azblob/blockblob.Client"
51-
ContainerClient = "azblob/container.Client"
52-
PageBlobClient = "azblob/pageblob.Client"
53-
ServiceClient = "azblob/service.Client"
54-
)
55-
5647
var CRC64Table = crc64.MakeTable(crc64Polynomial)
5748

5849
// CopyOptions returns a zero-value T if opts is nil.

‎sdk/storage/azblob/pageblob/client.go‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
4141
conOptions := shared.GetClientOptions(options)
4242
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
4343

44-
azClient, err := azcore.NewClient(shared.PageBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
44+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
4545
if err != nil {
4646
return nil, err
4747
}
@@ -55,7 +55,7 @@ func NewClient(blobURL string, cred azcore.TokenCredential, options *ClientOptio
5555
func NewClientWithNoCredential(blobURL string, options *ClientOptions) (*Client, error) {
5656
conOptions := shared.GetClientOptions(options)
5757

58-
azClient, err := azcore.NewClient(shared.PageBlobClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
58+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
5959
if err != nil {
6060
return nil, err
6161
}
@@ -71,7 +71,7 @@ func NewClientWithSharedKeyCredential(blobURL string, cred *blob.SharedKeyCreden
7171
conOptions := shared.GetClientOptions(options)
7272
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
7373

74-
azClient, err := azcore.NewClient(shared.PageBlobClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
74+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
7575
if err != nil {
7676
return nil, err
7777
}

‎sdk/storage/azblob/service/client.go‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ func NewClient(serviceURL string, cred azcore.TokenCredential, options *ClientOp
4545
conOptions := shared.GetClientOptions(options)
4646
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
4747

48-
azClient, err := azcore.NewClient(shared.ServiceClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
48+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
4949
if err != nil {
5050
return nil, err
5151
}
@@ -59,7 +59,7 @@ func NewClient(serviceURL string, cred azcore.TokenCredential, options *ClientOp
5959
func NewClientWithNoCredential(serviceURL string, options *ClientOptions) (*Client, error) {
6060
conOptions := shared.GetClientOptions(options)
6161

62-
azClient, err := azcore.NewClient(shared.ServiceClient, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
62+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, runtime.PipelineOptions{}, &conOptions.ClientOptions)
6363
if err != nil {
6464
return nil, err
6565
}
@@ -75,7 +75,7 @@ func NewClientWithSharedKeyCredential(serviceURL string, cred *SharedKeyCredenti
7575
conOptions := shared.GetClientOptions(options)
7676
plOpts := runtime.PipelineOptions{PerRetry: []policy.Policy{authPolicy}}
7777

78-
azClient, err := azcore.NewClient(shared.ServiceClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
78+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
7979
if err != nil {
8080
return nil, err
8181
}
@@ -150,7 +150,7 @@ func (s *Client) URL() string {
150150
// this Client's URL. The new container.Client uses the same request policy pipeline as the Client.
151151
func (s *Client) NewContainerClient(containerName string) *container.Client {
152152
containerURL := runtime.JoinPaths(s.generated().Endpoint(), containerName)
153-
return (*container.Client)(base.NewContainerClient(containerURL, s.generated().InternalClient().WithClientName(shared.ContainerClient), s.credential(), s.getClientOptions()))
153+
return (*container.Client)(base.NewContainerClient(containerURL, s.generated().InternalClient().WithClientName(exported.ModuleName), s.credential(), s.getClientOptions()))
154154
}
155155

156156
// CreateContainer is a lifecycle method to creates a new container under the specified account.

‎sdk/storage/azblob/service/client_test.go‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ package service_test
99
import (
1010
"context"
1111
"fmt"
12+
"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
1213
"io"
14+
"net/http"
1315
"os"
1416
"strings"
1517
"testing"
@@ -314,6 +316,41 @@ func (s *ServiceRecordedTestsSuite) TestSetPropertiesSetCORSMultiple() {
314316
_require.NoError(err)
315317
}
316318

319+
type userAgentTest struct{}
320+
321+
func (u userAgentTest) Do(req *policy.Request) (*http.Response, error) {
322+
const userAgentHeader = "User-Agent"
323+
324+
currentUserAgentHeader := req.Raw().Header.Get(userAgentHeader)
325+
if !strings.HasPrefix(currentUserAgentHeader, "azsdk-go-azblob/"+exported.ModuleVersion) {
326+
return nil, fmt.Errorf(currentUserAgentHeader + " user agent doesn't match expected agent: azsdk-go-azdatalake/v1.2.0 (go1.19.3; Windows_NT)")
327+
}
328+
329+
return &http.Response{
330+
Request: req.Raw(),
331+
Status: "Created",
332+
StatusCode: http.StatusOK,
333+
Header: http.Header{},
334+
Body: http.NoBody,
335+
}, nil
336+
}
337+
338+
func newTelemetryTestPolicy() policy.Policy {
339+
return &userAgentTest{}
340+
}
341+
342+
func TestUserAgentForAzBlob(t *testing.T) {
343+
client, err := service.NewClientWithNoCredential("https://fake/blob/testpath", &service.ClientOptions{
344+
ClientOptions: policy.ClientOptions{
345+
PerCallPolicies: []policy.Policy{newTelemetryTestPolicy()},
346+
},
347+
})
348+
require.NoError(t, err)
349+
_, err = client.GetProperties(context.Background(), nil)
350+
require.NoError(t, err)
351+
require.NotNil(t, client)
352+
}
353+
317354
func (s *ServiceUnrecordedTestsSuite) TestListContainersBasicUsingConnectionString() {
318355
_require := require.New(s.T())
319356
testName := s.T().Name()

‎sdk/storage/azdatalake/directory/client.go‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ func NewClient(directoryURL string, cred azcore.TokenCredential, options *Client
4949
}
5050
base.SetPipelineOptions((*base.ClientOptions)(conOptions), &plOpts)
5151

52-
azClient, err := azcore.NewClient(shared.DirectoryClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
52+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
5353
if err != nil {
5454
return nil, err
5555
}
@@ -82,7 +82,7 @@ func NewClientWithNoCredential(directoryURL string, options *ClientOptions) (*Cl
8282
plOpts := runtime.PipelineOptions{}
8383
base.SetPipelineOptions((*base.ClientOptions)(conOptions), &plOpts)
8484

85-
azClient, err := azcore.NewClient(shared.DirectoryClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
85+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
8686
if err != nil {
8787
return nil, err
8888
}
@@ -119,7 +119,7 @@ func NewClientWithSharedKeyCredential(directoryURL string, cred *SharedKeyCreden
119119
}
120120
base.SetPipelineOptions((*base.ClientOptions)(conOptions), &plOpts)
121121

122-
azClient, err := azcore.NewClient(shared.DirectoryClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
122+
azClient, err := azcore.NewClient(exported.ModuleName, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
123123
if err != nil {
124124
return nil, err
125125
}
@@ -225,7 +225,7 @@ func (d *Client) NewFileClient(fileName string) (*file.Client, error) {
225225
if err != nil {
226226
return nil, exported.ConvertToDFSError(err)
227227
}
228-
return (*file.Client)(base.NewPathClient(fileURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(shared.FileClient), d.sharedKey(), d.identityCredential(), d.getClientOptions())), nil
228+
return (*file.Client)(base.NewPathClient(fileURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(exported.ModuleName), d.sharedKey(), d.identityCredential(), d.getClientOptions())), nil
229229
}
230230

231231
// NewSubdirectoryClient creates a new directory.Client object by concatenating subdirectoryName to the end of this Client's URL.
@@ -248,7 +248,7 @@ func (d *Client) NewSubdirectoryClient(subdirectoryName string) (*Client, error)
248248
if err != nil {
249249
return nil, exported.ConvertToDFSError(err)
250250
}
251-
return (*Client)(base.NewPathClient(subDirectoryURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(shared.DirectoryClient), d.sharedKey(), d.identityCredential(), d.getClientOptions())), nil
251+
return (*Client)(base.NewPathClient(subDirectoryURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(exported.ModuleName), d.sharedKey(), d.identityCredential(), d.getClientOptions())), nil
252252
}
253253

254254
// Create creates a new directory.
@@ -332,7 +332,7 @@ func (d *Client) Rename(ctx context.Context, destinationPath string, options *Re
332332
if err != nil {
333333
return RenameResponse{}, exported.ConvertToDFSError(err)
334334
}
335-
newDirClient := (*Client)(base.NewPathClient(newPathURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(shared.DirectoryClient), d.sharedKey(), d.identityCredential(), d.getClientOptions()))
335+
newDirClient := (*Client)(base.NewPathClient(newPathURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(exported.ModuleName), d.sharedKey(), d.identityCredential(), d.getClientOptions()))
336336
resp, err := newDirClient.generatedDirClientWithDFS().Create(ctx, createOpts, nil, lac, mac, smac, cpkOpts)
337337
//return RenameResponse{
338338
// Response: resp,

0 commit comments

Comments
 (0)
⚡