adds get folder method in bucket.go

internal/gcsx/prefix_bucket.go

@@ -20,6 +20,7 @@ import (
 	"strings"
 	"unicode/utf8"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	"golang.org/x/net/context"
 )
@@ -216,3 +217,8 @@ func (b *prefixBucket) DeleteFolder(ctx context.Context, folderName string) (err
 	mFolderName := b.wrappedName(folderName)
 	return b.wrapped.DeleteFolder(ctx, mFolderName)
 }
+
+func (b *prefixBucket) GetFolder(ctx context.Context, folderName string) (folder *controlpb.Folder, err error) {
+	mFolderName := b.wrappedName(folderName)
+	return b.wrapped.GetFolder(ctx, mFolderName)
+}

internal/gcsx/prefix_bucket_test.go

@@ -396,3 +396,25 @@ func (t *PrefixBucketTest) DeleteObject() {
 	var notFoundErr *gcs.NotFoundError
 	ExpectTrue(errors.As(err, &notFoundErr))
 }
+
+func (t *PrefixBucketTest) GetFolder_Prefix() {
+	var err error
+
+	// Replace the use of CreateObject with CreateFolder once the CreateFolder API has been successfully implemented.
+	err = storageutil.CreateObjects(
+		t.ctx,
+		t.wrapped,
+		map[string][]byte{
+			"something": []byte(""),
+		})
+
+	AssertEq(nil, err)
+
+	result, err := t.bucket.GetFolder(
+		t.ctx,
+		"something")
+
+	AssertEq(nil, err)
+	AssertEq("projects/_/buckets/some_bucket/folders/foo_something", result.GetName())
+
+}

internal/monitor/bucket.go

@@ -20,6 +20,7 @@ import (
 	"io"
 	"time"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/logger"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/monitor/tags"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
@@ -202,6 +203,13 @@ func (mb *monitoringBucket) DeleteFolder(ctx context.Context, folderName string)
 	return err
 }
 
+func (mb *monitoringBucket) GetFolder(ctx context.Context, folderName string) (*controlpb.Folder, error) {
+	startTime := time.Now()
+	folder, err := mb.wrapped.GetFolder(ctx, folderName)
+	recordRequest(ctx, "GetFolder", startTime)
+	return folder, err
+}
+
 // recordReader increments the reader count when it's opened or closed.
 func recordReader(ctx context.Context, ioMethod string) {
 	if err := stats.RecordWithTags(

internal/ratelimit/throttled_bucket.go

@@ -17,6 +17,7 @@ package ratelimit
 import (
 	"io"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	"golang.org/x/net/context"
 )
@@ -197,6 +198,19 @@ func (b *throttledBucket) DeleteFolder(ctx context.Context, folderName string) (
 	return
 }
 
+func (b *throttledBucket) GetFolder(ctx context.Context, folderName string) (folder *controlpb.Folder, err error) {
+	// Wait for permission to call through.
+	err = b.opThrottle.Wait(ctx, 1)
+	if err != nil {
+		return
+	}
+
+	// Call through.
+	folder, err = b.wrapped.GetFolder(ctx, folderName)
+
+	return folder, err
+}
+
 ////////////////////////////////////////////////////////////////////////
 // readerCloser
 ////////////////////////////////////////////////////////////////////////

internal/storage/bucket_handle.go

@@ -509,6 +509,20 @@ func (b *bucketHandle) getStorageLayout() (*controlpb.StorageLayout, error) {
 	return stoargeLayout, err
 }
 
+func (b *bucketHandle) GetFolder(ctx context.Context, folderName string) (*controlpb.Folder, error) {
+	var callOptions []gax.CallOption
+
+	folder, err := b.controlClient.GetFolder(ctx, &controlpb.GetFolderRequest{
+		Name: "projects/_/buckets/" + b.bucketName + "/folders/" + folderName,
+	}, callOptions...)
+
+	if err != nil {
+		err = fmt.Errorf("error getting metadata for folder: %s, %w", folderName, err)
+	}
+
+	return folder, err
+}
+
 func isStorageConditionsNotEmpty(conditions storage.Conditions) bool {
 	return conditions != (storage.Conditions{})
 }

internal/storage/bucket_handle_test.go

@@ -28,6 +28,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/mock"
 	"github.com/stretchr/testify/suite"
+	"google.golang.org/grpc/codes"
+	"google.golang.org/grpc/status"
 )
 
 const missingObjectName string = "test/foo"
@@ -1291,3 +1293,39 @@ func (testSuite *BucketHandleTest) TestDeleteFolderWhenFolderNotExistForHierarch
 	mockClient.AssertExpectations(testSuite.T())
 	assert.Equal(testSuite.T(), "DeleteFolder: mock error", err.Error())
 }
+
+func (testSuite *BucketHandleTest) TestGetFolderWhenFolderExistsForHierarchicalBucket() {
+	ctx := context.Background()
+	mockClient := new(MockStorageControlClient)
+	folderPath := "projects/_/buckets/" + TestBucketName + "/folders/" + TestObjectName
+	mockFolder := controlpb.Folder{
+		Name: folderPath,
+	}
+	mockClient.On("GetFolder", ctx, &controlpb.GetFolderRequest{Name: folderPath}, mock.Anything).
+		Return(&mockFolder, nil)
+	testSuite.bucketHandle.controlClient = mockClient
+	testSuite.bucketHandle.bucketType = gcs.Hierarchical
+
+	result, err := testSuite.bucketHandle.GetFolder(ctx, TestObjectName)
+
+	mockClient.AssertExpectations(testSuite.T())
+	assert.Nil(testSuite.T(), err)
+	assert.Equal(testSuite.T(), folderPath, result.GetName())
+}
+
+func (testSuite *BucketHandleTest) TestGetFolderWhenFolderDoesNotExistsForHierarchicalBucket() {
+	ctx := context.Background()
+	mockClient := new(MockStorageControlClient)
+	folderPath := "projects/_/buckets/" + TestBucketName + "/folders/" + missingObjectName
+
+	mockClient.On("GetFolder", ctx, &controlpb.GetFolderRequest{Name: folderPath}, mock.Anything).
+		Return(nil, status.Error(codes.NotFound, "folder not found"))
+	testSuite.bucketHandle.controlClient = mockClient
+	testSuite.bucketHandle.bucketType = gcs.Hierarchical
+
+	result, err := testSuite.bucketHandle.GetFolder(ctx, missingObjectName)
+
+	mockClient.AssertExpectations(testSuite.T())
+	assert.Nil(testSuite.T(), result)
+	assert.ErrorContains(testSuite.T(), err, "folder not found")
+}

internal/storage/caching/fast_stat_bucket.go

@@ -20,6 +20,7 @@ import (
 	"sync"
 	"time"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/cache/metadata"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/storageutil"
@@ -140,7 +141,7 @@ func (b *fastStatBucket) CreateObject(
 	// Throw away any existing record for this object.
 	b.invalidate(req.Name)
 
-	// Create the new object.
+	// TODO: create object to be replaced with create folder api once integrated
 	o, err = b.wrapped.CreateObject(ctx, req)
 	if err != nil {
 		return
@@ -294,3 +295,18 @@ func (b *fastStatBucket) StatObjectFromGcs(ctx context.Context,
 
 	return
 }
+
+func (b *fastStatBucket) GetFolder(
+	ctx context.Context,
+	prefix string) (folder *controlpb.Folder, err error) {
+	// Fetch the listing.
+	folder, err = b.wrapped.GetFolder(ctx, prefix)
+	if err != nil {
+		return
+	}
+
+	// TODO: add folder metadata in stat cache
+	// b.insertFolder(folder)
+
+	return
+}

internal/storage/control_client_wrapper.go

@@ -29,4 +29,6 @@ type StorageControlClient interface {
 	DeleteFolder(ctx context.Context,
 		req *controlpb.DeleteFolderRequest,
 		opts ...gax.CallOption) error
+
+	GetFolder(ctx context.Context, req *controlpb.GetFolderRequest, opts ...gax.CallOption) (*controlpb.Folder, error)
 }

internal/storage/debug_bucket.go

@@ -20,6 +20,7 @@ import (
 	"sync/atomic"
 	"time"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/logger"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	"golang.org/x/net/context"
@@ -237,3 +238,11 @@ func (b *debugBucket) DeleteFolder(ctx context.Context, folderName string) (err
 	err = b.wrapped.DeleteFolder(ctx, folderName)
 	return err
 }
+
+func (b *debugBucket) GetFolder(ctx context.Context, folderName string) (folder *controlpb.Folder, err error) {
+	id, desc, start := b.startRequest("GetFolder(%q)", folderName)
+	defer b.finishRequest(id, desc, start, &err)
+
+	folder, err = b.wrapped.GetFolder(ctx, folderName)
+	return
+}

internal/storage/fake/bucket.go

@@ -27,6 +27,7 @@ import (
 	"strings"
 	"unicode/utf8"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/storageutil"
 	"github.com/jacobsa/syncutil"
@@ -882,3 +883,10 @@ func (b *bucket) DeleteFolder(ctx context.Context, folderName string) (err error
 
 	return
 }
+
+func (b *bucket) GetFolder(ctx context.Context, foldername string) (*controlpb.Folder, error) {
+	folder := controlpb.Folder{
+		Name: "projects/_/buckets/" + b.Name() + "/folders/" + foldername,
+	}
+	return &folder, nil
+}

internal/storage/gcs/bucket.go

@@ -17,6 +17,7 @@ package gcs
 import (
 	"io"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"golang.org/x/net/context"
 )
 
@@ -142,4 +143,6 @@ type Bucket interface {
 		req *DeleteObjectRequest) error
 
 	DeleteFolder(ctx context.Context, folderName string) error
+
+	GetFolder(ctx context.Context, folderName string) (*controlpb.Folder, error)
 }

internal/storage/mock_bucket.go

@@ -12,6 +12,7 @@ import (
 	runtime "runtime"
 	unsafe "unsafe"
 
+	"cloud.google.com/go/storage/control/apiv2/controlpb"
 	"github.com/googlecloudplatform/gcsfuse/v2/internal/storage/gcs"
 	oglemock "github.com/jacobsa/oglemock"
 	context "golang.org/x/net/context"
@@ -345,3 +346,32 @@ func (m *mockBucket) UpdateObject(p0 context.Context, p1 *gcs.UpdateObjectReques
 
 	return
 }
+
+func (m *mockBucket) GetFolder(
+	ctx context.Context,
+	prefix string) (o0 *controlpb.Folder, o1 error) {
+	// Get a file name and line number for the caller.
+	_, file, line, _ := runtime.Caller(1)
+
+	// Hand the call off to the controller, which does most of the work.
+	retVals := m.controller.HandleMethodCall(
+		m,
+		"GetFolder",
+		file,
+		line,
+		[]interface{}{})
+
+	if len(retVals) != 2 {
+		panic(fmt.Sprintf("mockBucket.GetFolder: invalid return values: %v", retVals))
+	}
+
+	if retVals[0] != nil {
+		o0 = retVals[0].(*controlpb.Folder)
+	}
+
+	// o1 error
+	if retVals[1] != nil {
+		o1 = retVals[1].(error)
+	}
+	return
+}

internal/storage/mock_control_client.go

@@ -43,3 +43,16 @@ func (m *MockStorageControlClient) DeleteFolder(ctx context.Context,
 	args := m.Called(ctx, req, opts)
 	return args.Error(0)
 }
+
+func (m *MockStorageControlClient) GetFolder(ctx context.Context,
+	req *controlpb.GetFolderRequest,
+	opts ...gax.CallOption) (*controlpb.Folder, error) {
+	args := m.Called(ctx, req, opts)
+
+	// Needed to assert folder in only those cases where folder is present
+	if folder, ok := args.Get(0).(*controlpb.Folder); ok {
+		return folder, nil
+	}
+
+	return nil, args.Error(1)
+}