[AzDatalake] Directory Client Implementation (#21283)

* Enable gocritic during linting (#20715) Enabled gocritic's evalOrder to catch dependencies on undefined behavior on return statements. Updated to latest version of golangci-lint. Fixed issue in azblob flagged by latest linter. * Cosmos DB: Enable merge support (#20716) * Adding header and value * Wiring and tests * format * Fixing value * change log * [azservicebus, azeventhubs] Stress test and logging improvement (#20710) Logging improvements: * Updating the logging to print more tracing information (per-link) in prep for the bigger release coming up. * Trimming out some of the verbose logging, seeing if I can get it a bit more reasonable. Stress tests: * Add a timestamp to the log name we generate and also default to append, not overwrite. * Use 0.5 cores, 0.5GB as our baseline. Some pods use more and I'll tune them more later. * update proxy version (#20712) Co-authored-by: Scott Beddall <scbedd@microsoft.com> * Return an error when you try to send a message that's too large. (#20721) This now works just like the message batch - you'll get an ErrMessageTooLarge if you attempt to send a message that's too large for the link's configured size. NOTE: there's a patch to `internal/go-amqp/Sender.go` to match what's in go-amqp's main so it returns a programmatically useful error when the message is too large. Fixes #20647 * Changes in test that is failing in pipeline (#20693) * [azservicebus, azeventhubs] Treat 'entity full' as a fatal error (#20722) When the remote entity is full we get a resource-limit-exceeded condition. This isn't something we should keep retrying on and it's best to just abort and let the user know immediately, rather than hoping it might eventually clear out. This affected both Event Hubs and Service Bus. Fixes #20647 * [azservicebus/azeventhubs] Redirect stderr and stdout to tee (#20726) * Update changelog with latest features (#20730) * Update changelog with latest features Prepare for upcoming release. * bump minor version * pass along the artifact name so we can override it later (#20732) Co-authored-by: scbedd <45376673+scbedd@users.noreply.github.com> * [azeventhubs] Fixing checkpoint store race condition (#20727) The checkpoint store wasn't guarding against multiple owners claiming for the first time - fixing this by using IfNoneMatch Fixes #20717 * Fix azidentity troubleshooting guide link (#20736) * [Release] sdk/resourcemanager/paloaltonetworksngfw/armpanngfw/0.1.0 (#20437) * [Release] sdk/resourcemanager/paloaltonetworksngfw/armpanngfw/0.1.0 generation from spec commit: 85fb4ac6f8bfefd179e6c2632976a154b5c9ff04 * client factory * fix * fix * update * add sdk/resourcemanager/postgresql/armpostgresql live test (#20685) * add sdk/resourcemanager/postgresql/armpostgresql live test * update assets.json * set subscriptionId default value * format * add sdk/resourcemanager/eventhub/armeventhub live test (#20686) * add sdk/resourcemanager/eventhub/armeventhub live test * update assets * add sdk/resourcemanager/compute/armcompute live test (#20048) * add sdk/resourcemanager/compute/armcompute live test * skus filter * fix subscriptionId default value * fix * gofmt * update recording * sdk/resourcemanager/network/armnetwork live test (#20331) * sdk/resourcemanager/network/armnetwork live test * update subscriptionId default value * update recording * add sdk/resourcemanager/cosmos/armcosmos live test (#20705) * add sdk/resourcemanager/cosmos/armcosmos live test * update assets.json * update assets.json * update assets.json * update assets.json * Increment package version after release of azcore (#20740) * [azeventhubs] Improperly resetting etag in the checkpoint store (#20737) We shouldn't be resetting the etag to nil - it's what we use to enforce a "single winner" when doing ownership claims. The bug here was two-fold: I had bad logic in my previous claim ownership, which I fixed in a previous PR, but we need to reflect that same constraint properly in our in-memory checkpoint store for these tests. * Eng workflows sync and branch cleanup additions (#20743) Co-authored-by: James Suplizio <jasupliz@microsoft.com> * [azeventhubs] Latest start position can also be inclusive (ie, get the latest message) (#20744) * Update GitHubEventProcessor version and remove pull_request_review procesing (#20751) Co-authored-by: James Suplizio <jasupliz@microsoft.com> * Rename DisableAuthorityValidationAndInstanceDiscovery (#20746) * fix (#20707) * AzFile (#20739) * azfile: Fixing connection string parsing logic (#20798) * Fixing connection string parse logic * Update README * [azadmin] fix flaky test (#20758) * fix flaky test * charles suggestion * Prepare azidentity v1.3.0 for release (#20756) * Fix broken podman link (#20801) Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com> * [azquery] update doc comments (#20755) * update doc comments * update statistics and visualization generation * prep-for-release * Fixed contribution section (#20752) Co-authored-by: Bob Tabor <rotabor@microsoft.com> * [azeventhubs,azservicebus] Some API cleanup, renames (#20754) * Adding options to UpdateCheckpoint(), just for future potential expansion * Make Offset an int64, not a *int64 (it's not optional, it'll always come back with ReceivedEvents) * Adding more logging into the checkpoint store. * Point all imports at the production go-amqp * Add supporting features to enable distributed tracing (#20301) (#20708) * Add supporting features to enable distributed tracing This includes new internal pipeline policies and other supporting types. See the changelog for a full description. Added some missing doc comments. * fix linter issue * add net.peer.name trace attribute sequence custom HTTP header policy before logging policy. sequence logging policy after HTTP trace policy. keep body download policy at the end. * add span for iterating over pages * Restore ARM CAE support for azcore beta (#20657) This reverts commit 9020972. * Upgrade to stable azcore (#20808) * Increment package version after release of data/azcosmos (#20807) * Updating changelog (#20810) * Add fake package to azcore (#20711) * Add fake package to azcore This is the supporting infrastructure for the generated SDK fakes. * fix doc comment * Updating CHANGELOG.md (#20809) * changelog (#20811) * Increment package version after release of storage/azfile (#20813) * Update changelog (azblob) (#20815) * Updating CHANGELOG.md * Update the changelog with correct version * [azquery] migration guide (#20742) * migration guide * Charles feedback * Richard feedback --------- Co-authored-by: Charles Lowell <10964656+chlowell@users.noreply.github.com> * Increment package version after release of monitor/azquery (#20820) * [keyvault] prep for release (#20819) * prep for release * perf tests * update date * added dir methods * small fixes * added rescursive set acl methods * recursive support * added sas and tests --------- Co-authored-by: Joel Hendrix <jhendrix@microsoft.com> Co-authored-by: Matias Quaranta <ealsur@users.noreply.github.com> Co-authored-by: Richard Park <51494936+richardpark-msft@users.noreply.github.com> Co-authored-by: Azure SDK Bot <53356347+azure-sdk@users.noreply.github.com> Co-authored-by: Scott Beddall <scbedd@microsoft.com> Co-authored-by: siminsavani-msft <77068571+siminsavani-msft@users.noreply.github.com> Co-authored-by: scbedd <45376673+scbedd@users.noreply.github.com> Co-authored-by: Charles Lowell <10964656+chlowell@users.noreply.github.com> Co-authored-by: Peng Jiahui <46921893+Alancere@users.noreply.github.com> Co-authored-by: James Suplizio <jasupliz@microsoft.com> Co-authored-by: Sourav Gupta <98318303+souravgupta-msft@users.noreply.github.com> Co-authored-by: gracewilcox <43627800+gracewilcox@users.noreply.github.com> Co-authored-by: Wes Haggard <weshaggard@users.noreply.github.com> Co-authored-by: Bob Tabor <bob.tabor@microsoft.com> Co-authored-by: Bob Tabor <rotabor@microsoft.com>
Azure · Jul 31, 2023 · 757507a · 757507a
1 parent ad288fb
commit 757507a
Show file tree

Hide file tree

Showing 15 changed files with 2,582 additions and 221 deletions.
diff --git a/sdk/storage/azdatalake/assets.json b/sdk/storage/azdatalake/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "go",
   "TagPrefix": "go/storage/azdatalake",
-  "Tag": "go/storage/azdatalake_db1de4a48b"
+  "Tag": "go/storage/azdatalake_9dd1cc3e0e"
 }
diff --git a/sdk/storage/azdatalake/directory/client.go b/sdk/storage/azdatalake/directory/client.go
@@ -12,10 +12,17 @@ import (
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/policy"
 	"github.com/Azure/azure-sdk-for-go/sdk/azcore/runtime"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azblob/blockblob"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/datalakeerror"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/base"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/exported"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/generated"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/path"
 	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/internal/shared"
+	"github.com/Azure/azure-sdk-for-go/sdk/storage/azdatalake/sas"
+	"net/http"
+	"net/url"
+	"strings"
+	"time"
 )
 
 // ClientOptions contains the optional parameters when creating a Client.
@@ -38,7 +45,7 @@ func NewClient(directoryURL string, cred azcore.TokenCredential, options *Client
 	}
 	base.SetPipelineOptions((*base.ClientOptions)(conOptions), &plOpts)
 
-	azClient, err := azcore.NewClient(shared.FileClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
+	azClient, err := azcore.NewClient(shared.DirectoryClient, exported.ModuleVersion, plOpts, &conOptions.ClientOptions)
 	if err != nil {
 		return nil, err
 	}
@@ -154,6 +161,10 @@ func (d *Client) blobClient() *blockblob.Client {
 	return blobClient
 }
 
+func (d *Client) getClientOptions() *base.ClientOptions {
+	return base.GetCompositeClientOptions((*base.CompositeClient[generated.PathClient, generated.PathClient, blockblob.Client])(d))
+}
+
 func (d *Client) sharedKey() *exported.SharedKeyCredential {
 	return base.SharedKeyComposite((*base.CompositeClient[generated.PathClient, generated.PathClient, blockblob.Client])(d))
 }
@@ -176,63 +187,187 @@ func (d *Client) BlobURL() string {
 
 // Create creates a new directory (dfs1).
 func (d *Client) Create(ctx context.Context, options *CreateOptions) (CreateResponse, error) {
-	return CreateResponse{}, nil
+	lac, mac, httpHeaders, createOpts, cpkOpts := options.format()
+	resp, err := d.generatedDirClientWithDFS().Create(ctx, createOpts, httpHeaders, lac, mac, nil, cpkOpts)
+	err = exported.ConvertToDFSError(err)
+	return resp, err
 }
 
-// Delete removes the directory (dfs1).
+// Delete deletes directory and any path under it (dfs1).
 func (d *Client) Delete(ctx context.Context, options *DeleteOptions) (DeleteResponse, error) {
-	//TODO: pass recursive = true
-	return DeleteResponse{}, nil
+	lac, mac, deleteOpts := path.FormatDeleteOptions(options, true)
+	resp, err := d.generatedDirClientWithDFS().Delete(ctx, deleteOpts, lac, mac)
+	err = exported.ConvertToDFSError(err)
+	return resp, err
 }
 
-// GetProperties returns the properties of the directory (blob3). #TODO: we may just move this method to path client
+// GetProperties gets the properties of a directory (blob3)
 func (d *Client) GetProperties(ctx context.Context, options *GetPropertiesOptions) (GetPropertiesResponse, error) {
-	// TODO: format blob response to path response
-	return GetPropertiesResponse{}, nil
+	opts := path.FormatGetPropertiesOptions(options)
+	var respFromCtx *http.Response
+	ctxWithResp := runtime.WithCaptureResponse(ctx, &respFromCtx)
+	resp, err := d.blobClient().GetProperties(ctxWithResp, opts)
+	newResp := path.FormatGetPropertiesResponse(&resp, respFromCtx)
+	err = exported.ConvertToDFSError(err)
+	return newResp, err
 }
 
-// Rename renames the directory (dfs1).
+func (d *Client) renamePathInURL(newName string) (string, string, string) {
+	endpoint := d.DFSURL()
+	separator := "/"
+	// Find the index of the last occurrence of the separator
+	lastIndex := strings.LastIndex(endpoint, separator)
+	// Split the string based on the last occurrence of the separator
+	firstPart := endpoint[:lastIndex] // From the beginning of the string to the last occurrence of the separator
+	newPathURL, newBlobURL := shared.GetURLs(runtime.JoinPaths(firstPart, newName))
+	parsedNewURL, _ := url.Parse(d.DFSURL())
+	return parsedNewURL.Path, newPathURL, newBlobURL
+}
+
+// Rename renames a directory (dfs1)
 func (d *Client) Rename(ctx context.Context, newName string, options *RenameOptions) (RenameResponse, error) {
-	return RenameResponse{}, nil
+	newPathWithoutURL, newBlobURL, newPathURL := d.renamePathInURL(newName)
+	lac, mac, smac, createOpts := path.FormatRenameOptions(options, newPathWithoutURL)
+	var newBlobClient *blockblob.Client
+	var err error
+	if d.identityCredential() != nil {
+		newBlobClient, err = blockblob.NewClient(newBlobURL, *d.identityCredential(), nil)
+	} else if d.sharedKey() != nil {
+		blobSharedKey, _ := d.sharedKey().ConvertToBlobSharedKey()
+		newBlobClient, err = blockblob.NewClientWithSharedKeyCredential(newBlobURL, blobSharedKey, nil)
+	} else {
+		newBlobClient, err = blockblob.NewClientWithNoCredential(newBlobURL, nil)
+	}
+	if err != nil {
+		return RenameResponse{}, err
+	}
+	newDirClient := (*Client)(base.NewPathClient(newPathURL, newBlobURL, newBlobClient, d.generatedDirClientWithDFS().InternalClient().WithClientName(shared.DirectoryClient), d.sharedKey(), d.identityCredential(), d.getClientOptions()))
+	resp, err := newDirClient.generatedDirClientWithDFS().Create(ctx, createOpts, nil, lac, mac, smac, nil)
+	return RenameResponse{
+		Response:           resp,
+		NewDirectoryClient: newDirClient,
+	}, exported.ConvertToDFSError(err)
 }
 
-// SetAccessControl sets the owner, owning group, and permissions for a file or directory (dfs1).
+// SetAccessControl sets the owner, owning group, and permissions for a directory (dfs1).
 func (d *Client) SetAccessControl(ctx context.Context, options *SetAccessControlOptions) (SetAccessControlResponse, error) {
-	return SetAccessControlResponse{}, nil
+	opts, lac, mac, err := path.FormatSetAccessControlOptions(options)
+	if err != nil {
+		return SetAccessControlResponse{}, err
+	}
+	resp, err := d.generatedDirClientWithDFS().SetAccessControl(ctx, opts, lac, mac)
+	err = exported.ConvertToDFSError(err)
+	return resp, err
 }
 
-// SetAccessControlRecursive sets the owner, owning group, and permissions for a file or directory (dfs1).
-func (d *Client) SetAccessControlRecursive(ctx context.Context, options *SetAccessControlRecursiveOptions) (SetAccessControlRecursiveResponse, error) {
-	// TODO explicitly pass SetAccessControlRecursiveMode
-	return SetAccessControlRecursiveResponse{}, nil
+func (d *Client) setAccessControlHelper(mode generated.PathSetAccessControlRecursiveMode, listOptions *generated.PathClientSetAccessControlRecursiveOptions) *runtime.Pager[SetAccessControlRecursiveResponse] {
+	return runtime.NewPager(runtime.PagingHandler[SetAccessControlRecursiveResponse]{
+		More: func(page SetAccessControlRecursiveResponse) bool {
+			return page.Continuation != nil && len(*page.Continuation) > 0
+		},
+		Fetcher: func(ctx context.Context, page *SetAccessControlRecursiveResponse) (SetAccessControlRecursiveResponse, error) {
+			var req *policy.Request
+			var err error
+			if page == nil {
+				req, err = d.generatedDirClientWithDFS().SetAccessControlRecursiveCreateRequest(ctx, mode, listOptions)
+				err = exported.ConvertToDFSError(err)
+			} else {
+				listOptions.Continuation = page.Continuation
+				req, err = d.generatedDirClientWithDFS().SetAccessControlRecursiveCreateRequest(ctx, mode, listOptions)
+				err = exported.ConvertToDFSError(err)
+			}
+			if err != nil {
+				return SetAccessControlRecursiveResponse{}, err
+			}
+			resp, err := d.generatedDirClientWithDFS().InternalClient().Pipeline().Do(req)
+			err = exported.ConvertToDFSError(err)
+			if err != nil {
+				return SetAccessControlRecursiveResponse{}, err
+			}
+			if !runtime.HasStatusCode(resp, http.StatusOK) {
+				return SetAccessControlRecursiveResponse{}, runtime.NewResponseError(resp)
+			}
+			newResp, err := d.generatedDirClientWithDFS().SetAccessControlRecursiveHandleResponse(resp)
+			return newResp, exported.ConvertToDFSError(err)
+		},
+	})
+
 }
 
-// UpdateAccessControlRecursive updates the owner, owning group, and permissions for a file or directory (dfs1).
-func (d *Client) UpdateAccessControlRecursive(ctx context.Context, options *UpdateAccessControlRecursiveOptions) (UpdateAccessControlRecursiveResponse, error) {
-	// TODO explicitly pass SetAccessControlRecursiveMode
-	return SetAccessControlRecursiveResponse{}, nil
+// NewSetAccessControlRecursivePager sets the owner, owning group, and permissions for a directory (dfs1).
+func (d *Client) NewSetAccessControlRecursivePager(ACL string, options *SetAccessControlRecursiveOptions) *runtime.Pager[SetAccessControlRecursiveResponse] {
+	mode, listOptions := options.format(ACL, "set")
+	return d.setAccessControlHelper(mode, listOptions)
 }
 
-// GetAccessControl gets the owner, owning group, and permissions for a file or directory (dfs1).
-func (d *Client) GetAccessControl(ctx context.Context, options *GetAccessControlOptions) (GetAccessControlResponse, error) {
-	return GetAccessControlResponse{}, nil
+// NewUpdateAccessControlRecursivePager updates the owner, owning group, and permissions for a directory (dfs1).
+func (d *Client) NewUpdateAccessControlRecursivePager(ACL string, options *UpdateAccessControlRecursiveOptions) *runtime.Pager[UpdateAccessControlRecursiveResponse] {
+	mode, listOptions := options.format(ACL, "modify")
+	return d.setAccessControlHelper(mode, listOptions)
+}
+
+// NewRemoveAccessControlRecursivePager removes the owner, owning group, and permissions for a directory (dfs1).
+func (d *Client) NewRemoveAccessControlRecursivePager(ACL string, options *RemoveAccessControlRecursiveOptions) *runtime.Pager[RemoveAccessControlRecursiveResponse] {
+	mode, listOptions := options.format(ACL, "remove")
+	return d.setAccessControlHelper(mode, listOptions)
 }
 
-// RemoveAccessControlRecursive removes the owner, owning group, and permissions for a file or directory (dfs1).
-func (d *Client) RemoveAccessControlRecursive(ctx context.Context, options *RemoveAccessControlRecursiveOptions) (RemoveAccessControlRecursiveResponse, error) {
-	// TODO explicitly pass SetAccessControlRecursiveMode
-	return SetAccessControlRecursiveResponse{}, nil
+// GetAccessControl gets the owner, owning group, and permissions for a directory (dfs1).
+func (d *Client) GetAccessControl(ctx context.Context, options *GetAccessControlOptions) (GetAccessControlResponse, error) {
+	opts, lac, mac := path.FormatGetAccessControlOptions(options)
+	resp, err := d.generatedDirClientWithDFS().GetProperties(ctx, opts, lac, mac)
+	err = exported.ConvertToDFSError(err)
+	return resp, err
 }
 
-// SetMetadata sets the metadata for a file or directory (blob3).
+// SetMetadata sets the metadata for a directory (blob3).
 func (d *Client) SetMetadata(ctx context.Context, options *SetMetadataOptions) (SetMetadataResponse, error) {
-	// TODO: call directly into blob
-	return SetMetadataResponse{}, nil
+	opts, metadata := path.FormatSetMetadataOptions(options)
+	resp, err := d.blobClient().SetMetadata(ctx, metadata, opts)
+	err = exported.ConvertToDFSError(err)
+	return resp, err
 }
 
-// SetHTTPHeaders sets the HTTP headers for a file or directory (blob3).
+// SetHTTPHeaders sets the HTTP headers for a directory (blob3).
 func (d *Client) SetHTTPHeaders(ctx context.Context, httpHeaders HTTPHeaders, options *SetHTTPHeadersOptions) (SetHTTPHeadersResponse, error) {
-	// TODO: call formatBlobHTTPHeaders() since we want to add the blob prefix to our options before calling into blob
-	// TODO: call into blob
-	return SetHTTPHeadersResponse{}, nil
+	opts, blobHTTPHeaders := path.FormatSetHTTPHeadersOptions(options, httpHeaders)
+	resp, err := d.blobClient().SetHTTPHeaders(ctx, blobHTTPHeaders, opts)
+	newResp := SetHTTPHeadersResponse{}
+	path.FormatSetHTTPHeadersResponse(&newResp, &resp)
+	err = exported.ConvertToDFSError(err)
+	return newResp, err
+}
+
+// GetSASURL is a convenience method for generating a SAS token for the currently pointed at blob.
+// It can only be used if the credential supplied during creation was a SharedKeyCredential.
+func (f *Client) GetSASURL(permissions sas.DirectoryPermissions, expiry time.Time, o *GetSASURLOptions) (string, error) {
+	if f.sharedKey() == nil {
+		return "", datalakeerror.MissingSharedKeyCredential
+	}
+
+	urlParts, err := sas.ParseURL(f.BlobURL())
+	err = exported.ConvertToDFSError(err)
+	if err != nil {
+		return "", err
+	}
+
+	st := path.FormatGetSASURLOptions(o)
+
+	qps, err := sas.DatalakeSignatureValues{
+		DirectoryPath:  urlParts.PathName,
+		FilesystemName: urlParts.FilesystemName,
+		Version:        sas.Version,
+		Permissions:    permissions.String(),
+		StartTime:      st,
+		ExpiryTime:     expiry.UTC(),
+	}.SignWithSharedKey(f.sharedKey())
+
+	err = exported.ConvertToDFSError(err)
+	if err != nil {
+		return "", err
+	}
+
+	endpoint := f.BlobURL() + "?" + qps.Encode()
+
+	return endpoint, nil
 }