Skip to content

feat: GCP copy, move, rename bucket #3810

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 122 additions & 2 deletions bindings/gcp/bucket/bucket.go
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,11 @@ const (
metadataKey = "key"
maxResults = 1000

metadataKeyBC = "name"
signOperation = "sign"
metadataKeyBC = "name"
signOperation = "sign"
copyOperation = "copy"
renameOperation = "rename"
moveOperation = "move"
)

// GCPStorage allows saving data to GCP bucket storage.
Expand Down Expand Up @@ -84,6 +87,7 @@ type listPayload struct {
MaxResults int32 `json:"maxResults"`
Delimiter string `json:"delimiter"`
}

type signResponse struct {
SignURL string `json:"signURL"`
}
Expand Down Expand Up @@ -138,6 +142,9 @@ func (g *GCPStorage) Operations() []bindings.OperationKind {
bindings.DeleteOperation,
bindings.ListOperation,
signOperation,
copyOperation,
renameOperation,
moveOperation,
}
}

Expand All @@ -155,6 +162,12 @@ func (g *GCPStorage) Invoke(ctx context.Context, req *bindings.InvokeRequest) (*
return g.list(ctx, req)
case signOperation:
return g.sign(ctx, req)
case copyOperation:
return g.copy(ctx, req)
case renameOperation:
return g.rename(ctx, req)
case moveOperation:
return g.move(ctx, req)
default:
return nil, fmt.Errorf("unsupported operation %s", req.Operation)
}
Expand Down Expand Up @@ -404,3 +417,110 @@ func (g *GCPStorage) signObject(bucket, object, ttl string) (string, error) {
}
return u, nil
}

type movePayload struct {
DestinationBucket string `json:"destinationBucket"`
}

func (g *GCPStorage) move(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
return nil, errors.New("gcp bucket binding error: can't read key value")
}

var payload movePayload
err := json.Unmarshal(req.Data, &payload)
if err != nil {
return nil, errors.New("gcp bucket binding error: invalid move payload")
}

if payload.DestinationBucket == "" {
return nil, errors.New("gcp bucket binding error: required 'destinationBucket' missing")
}

src := g.client.Bucket(g.metadata.Bucket).Object(key)
dst := g.client.Bucket(payload.DestinationBucket).Object(key)
if _, err := dst.CopierFrom(src).Run(ctx); err != nil {
return nil, fmt.Errorf("gcp bucket binding error while copying object: %w", err)
}

if err := src.Delete(ctx); err != nil {
return nil, fmt.Errorf("gcp bucket binding error while deleting object: %w", err)
}

return &bindings.InvokeResponse{
Data: []byte(fmt.Sprintf("object %s moved to %s", key, payload.DestinationBucket)),
}, nil
}

type renamePayload struct {
NewName string `json:"newName"`
}

func (g *GCPStorage) rename(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
return nil, errors.New("gcp bucket binding error: can't read key value")
}

var payload renamePayload
err := json.Unmarshal(req.Data, &payload)
if err != nil {
return nil, errors.New("gcp bucket binding error: invalid rename payload")
}

if payload.NewName == "" {
return nil, errors.New("gcp bucket binding error: required 'newName' missing")
}

src := g.client.Bucket(g.metadata.Bucket).Object(key)
dst := g.client.Bucket(g.metadata.Bucket).Object(payload.NewName)
if _, err := dst.CopierFrom(src).Run(ctx); err != nil {
return nil, fmt.Errorf("gcp bucket binding error while copying object: %w", err)
}

if err := src.Delete(ctx); err != nil {
return nil, fmt.Errorf("gcp bucket binding error while deleting object: %w", err)
}

return &bindings.InvokeResponse{
Data: []byte(fmt.Sprintf("object %s renamed to %s", key, payload.NewName)),
}, nil
}

type copyPayload struct {
DestinationBucket string `json:"destinationBucket"`
}

func (g *GCPStorage) copy(ctx context.Context, req *bindings.InvokeRequest) (*bindings.InvokeResponse, error) {
var key string
if val, ok := req.Metadata[metadataKey]; ok && val != "" {
key = val
} else {
return nil, errors.New("gcp bucket binding error: can't read key value")
}

var payload copyPayload
err := json.Unmarshal(req.Data, &payload)
if err != nil {
return nil, errors.New("gcp bucket binding error: invalid copy payload")
}

if payload.DestinationBucket == "" {
return nil, errors.New("gcp bucket binding error: required 'destinationBucket' missing")
}

src := g.client.Bucket(g.metadata.Bucket).Object(key)
dst := g.client.Bucket(payload.DestinationBucket).Object(key)
if _, err := dst.CopierFrom(src).Run(ctx); err != nil {
return nil, fmt.Errorf("gcp bucket binding error while copying object: %w", err)
}

return &bindings.InvokeResponse{
Data: []byte(fmt.Sprintf("object %s copied to %s", key, payload.DestinationBucket)),
}, nil
}
109 changes: 109 additions & 0 deletions bindings/gcp/bucket/bucket_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -254,3 +254,112 @@ func TestDeleteOption(t *testing.T) {
require.Error(t, err)
})
}

func TestCopyOption(t *testing.T) {
gs := GCPStorage{logger: logger.NewLogger("test")}
gs.metadata = &gcpMetadata{}

t.Run("return error if key is missing", func(t *testing.T) {
r := bindings.InvokeRequest{}
_, err := gs.copy(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: can't read key value", err.Error())
})

t.Run("return error if data is not valid json", func(t *testing.T) {
r := bindings.InvokeRequest{
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.copy(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: invalid copy payload", err.Error())
})

t.Run("return error if destinationBucket is missing", func(t *testing.T) {
r := bindings.InvokeRequest{
Data: []byte(`{}`),
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.copy(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: required 'destinationBucket' missing", err.Error())
})
}

func TestRenameOption(t *testing.T) {
gs := GCPStorage{logger: logger.NewLogger("test")}
gs.metadata = &gcpMetadata{}

t.Run("return error if key is missing", func(t *testing.T) {
r := bindings.InvokeRequest{
Data: []byte(`{"newName": "my_new_name"}`),
}
_, err := gs.rename(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: can't read key value", err.Error())
})

t.Run("return error if data is not valid json", func(t *testing.T) {
r := bindings.InvokeRequest{
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.rename(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: invalid rename payload", err.Error())
})

t.Run("return error if newName is missing", func(t *testing.T) {
r := bindings.InvokeRequest{
Data: []byte(`{}`),
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.rename(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: required 'newName' missing", err.Error())
})
}

func TestMoveOption(t *testing.T) {
gs := GCPStorage{logger: logger.NewLogger("test")}
gs.metadata = &gcpMetadata{}

t.Run("return error if key is missing", func(t *testing.T) {
r := bindings.InvokeRequest{
Data: []byte(`{"destinationBucket": "my_bucket"}`),
}
_, err := gs.move(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: can't read key value", err.Error())
})

t.Run("return error if data is not valid json", func(t *testing.T) {
r := bindings.InvokeRequest{
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.move(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: invalid move payload", err.Error())
})

t.Run("return error if destinationBucket is missing", func(t *testing.T) {
r := bindings.InvokeRequest{
Data: []byte(`{}`),
Metadata: map[string]string{
"key": "my_key",
},
}
_, err := gs.move(t.Context(), &r)
require.Error(t, err)
assert.Equal(t, "gcp bucket binding error: required 'destinationBucket' missing", err.Error())
})
}