pulumi/pkg/backend/diy/bucket.go

126 lines
4.2 KiB
Go

// Copyright 2019-2024, Pulumi Corporation.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package diy
import (
"context"
"fmt"
"io"
"path"
"path/filepath"
"strings"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/logging"
"gocloud.dev/blob"
)
// Bucket is a wrapper around an underlying gocloud blob.Bucket. It ensures that we pass all paths
// to it normalized to forward-slash form like it requires.
type Bucket interface {
Copy(ctx context.Context, dstKey, srcKey string, opts *blob.CopyOptions) (err error)
Delete(ctx context.Context, key string) (err error)
List(opts *blob.ListOptions) *blob.ListIterator
SignedURL(ctx context.Context, key string, opts *blob.SignedURLOptions) (string, error)
ReadAll(ctx context.Context, key string) (_ []byte, err error)
WriteAll(ctx context.Context, key string, p []byte, opts *blob.WriterOptions) (err error)
Exists(ctx context.Context, key string) (bool, error)
}
// wrappedBucket encapsulates a true gocloud blob.Bucket, but ensures that all paths we send to it
// are appropriately normalized to use forward slashes as required by it. Without this, we may use
// filepath.join which can make paths like `c:\temp\etc`. gocloud's fileblob then converts those
// backslashes to the hex string __0x5c__, breaking things on windows completely.
type wrappedBucket struct {
bucket *blob.Bucket
}
func (b *wrappedBucket) Copy(ctx context.Context, dstKey, srcKey string, opts *blob.CopyOptions) (err error) {
return b.bucket.Copy(ctx, filepath.ToSlash(dstKey), filepath.ToSlash(srcKey), opts)
}
func (b *wrappedBucket) Delete(ctx context.Context, key string) (err error) {
return b.bucket.Delete(ctx, filepath.ToSlash(key))
}
func (b *wrappedBucket) List(opts *blob.ListOptions) *blob.ListIterator {
optsCopy := *opts
optsCopy.Prefix = filepath.ToSlash(opts.Prefix)
return b.bucket.List(&optsCopy)
}
func (b *wrappedBucket) SignedURL(ctx context.Context, key string, opts *blob.SignedURLOptions) (string, error) {
return b.bucket.SignedURL(ctx, filepath.ToSlash(key), opts)
}
func (b *wrappedBucket) ReadAll(ctx context.Context, key string) (_ []byte, err error) {
return b.bucket.ReadAll(ctx, filepath.ToSlash(key))
}
func (b *wrappedBucket) WriteAll(ctx context.Context, key string, p []byte, opts *blob.WriterOptions) (err error) {
return b.bucket.WriteAll(ctx, filepath.ToSlash(key), p, opts)
}
func (b *wrappedBucket) Exists(ctx context.Context, key string) (bool, error) {
return b.bucket.Exists(ctx, filepath.ToSlash(key))
}
// listBucket returns a list of all files in the bucket within a given directory. go-cloud sorts the results by key
func listBucket(ctx context.Context, bucket Bucket, dir string) ([]*blob.ListObject, error) {
bucketIter := bucket.List(&blob.ListOptions{
Delimiter: "/",
Prefix: dir + "/",
})
files := []*blob.ListObject{}
for {
file, err := bucketIter.Next(ctx)
if err == io.EOF {
break
}
if err != nil {
return nil, fmt.Errorf("could not list bucket: %w", err)
}
files = append(files, file)
}
return files, nil
}
// objectName returns the filename of a ListObject (an object from a bucket).
func objectName(obj *blob.ListObject) string {
// If obj.Key ends in "/" we want to trim that to get the name just before
key := strings.TrimSuffix(obj.Key, "/")
_, filename := path.Split(key)
return filename
}
// removeAllByPrefix deletes all objects with a given prefix (i.e. filepath)
func removeAllByPrefix(ctx context.Context, bucket Bucket, dir string) error {
files, err := listBucket(ctx, bucket, dir)
if err != nil {
return fmt.Errorf("unable to list bucket objects for removal: %w", err)
}
for _, file := range files {
err = bucket.Delete(ctx, file.Key)
if err != nil {
logging.V(5).Infof("error deleting object: %v (%v) skipping", file.Key, err)
}
}
return nil
}