fix linter errors

Signed-off-by: Tom Plowman <[email protected]>

Author: alsenz

CHANGELOG.md

@@ -13,7 +13,7 @@ We use *breaking :warning:* to mark changes that are not backward compatible (re
 - [#38](https://github.com/thanos-io/objstore/pull/38) GCS: Upgrade cloud.google.com/go/storage version to `v1.43.0`.
 - [#145](https://github.com/thanos-io/objstore/pull/145) Include content length in the response of Get and GetRange.
 - [#157](https://github.com/thanos-io/objstore/pull/157) Azure: Add `az_tenant_id`, `client_id` and `client_secret` configs.
-- [#174](https://github.com/thanos-io/objstore/pull/174) Feature: conditional object upload API
+- [#175](https://github.com/thanos-io/objstore/pull/174) Feature: conditional object upload API
 
 ### Fixed
 - [#153](https://github.com/thanos-io/objstore/pull/153) Metrics: Fix `objstore_bucket_operation_duration_seconds_*` for `get` and `get_range` operations.

go.mod

@@ -19,6 +19,7 @@ require (
 	github.com/opentracing/opentracing-go v1.2.0
 	github.com/oracle/oci-go-sdk/v65 v65.41.1
 	github.com/pkg/errors v0.9.1
+	github.com/pkg/xattr v0.4.10
 	github.com/prometheus/client_golang v1.17.0
 	github.com/prometheus/common v0.44.0
 	github.com/tencentyun/cos-go-sdk-v5 v0.7.40
@@ -94,7 +95,6 @@ require (
 	github.com/mozillazg/go-httpheader v0.2.1 // indirect
 	github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect
 	github.com/pkg/browser v0.0.0-20240102092130-5ac0b6a4141c // indirect
-	github.com/pkg/xattr v0.4.10 // indirect
 	github.com/planetscale/vtprotobuf v0.6.1-0.20240319094008-0393e58bdf10 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/procfs v0.11.1 // indirect

objstore.go

@@ -122,7 +122,7 @@ type BucketReader interface {
 	// IsAccessDeniedErr returns true if access to object is denied.
 	IsAccessDeniedErr(err error) bool
 
-	// IsConditionNotMetErr returns true if an ObjectUploadOption condition parameter (IfNotExists, IfMatch, IfNotMatch) was not met
+	// IsConditionNotMetErr returns true if an ObjectUploadOption condition parameter (IfNotExists, IfMatch, IfNotMatch) was not met.
 	IsConditionNotMetErr(err error) bool
 
 	// Attributes returns information about the specified object.
@@ -263,7 +263,7 @@ func applyUploadOptions(options ...UploadOption) uploadParams {
 var ErrUploadOptionNotSupported = errors.New("upload option is not supported")
 var ErrUploadOptionInvalid = errors.New("upload option is invalid")
 
-// ObjectUploadOptionType is used for type-safe option support checking of ObjectUpload options
+// ObjectUploadOptionType is used for type-safe option support checking of ObjectUpload options.
 type ObjectUploadOptionType int
 
 const (
@@ -273,7 +273,7 @@ const (
 	IfNotMatch
 )
 
-// ObjectUploadOption configures UploadObjectParams
+// ObjectUploadOption configures UploadObjectParams.
 type ObjectUploadOption struct {
 	Type  ObjectUploadOptionType
 	Apply func(params *UploadObjectParams)
@@ -288,7 +288,7 @@ type UploadObjectParams struct {
 	Condition   *ObjectVersion
 }
 
-// WithContentType sets the content type of the object upload operation
+// WithContentType sets the content type of the object upload operation.
 func WithContentType(contentType string) ObjectUploadOption {
 	return ObjectUploadOption{
 		Type: ContentType,
@@ -332,7 +332,7 @@ func WithIfNotMatch(ver *ObjectVersion) ObjectUploadOption {
 	}
 }
 
-// ValidateUploadOptions ensures that only supported options are passed as options
+// ValidateUploadOptions ensures that only supported options are passed as options.
 func ValidateUploadOptions(supportedOptions []ObjectUploadOptionType, opts ...ObjectUploadOption) error {
 	for _, opt := range opts {
 		if !slices.Contains(supportedOptions, opt.Type) {
@@ -349,7 +349,7 @@ func ValidateUploadOptions(supportedOptions []ObjectUploadOptionType, opts ...Ob
 	return nil
 }
 
-// ApplyObjectUploadOptions creates UploadObjectParams from the options
+// ApplyObjectUploadOptions creates UploadObjectParams from the options.
 func ApplyObjectUploadOptions(opts ...ObjectUploadOption) UploadObjectParams {
 	out := UploadObjectParams{}
 	for _, opt := range opts {
@@ -369,20 +369,20 @@ type ObjectAttributes struct {
 	Version *ObjectVersion `json:"version,omitempty"`
 }
 
-// ObjectVersionType is used to specify the type of object version used by the underlying provider
+// ObjectVersionType is used to specify the type of object version used by the underlying provider.
 type ObjectVersionType int
 
 const (
-	// Generation the provider supports a monotonically increasing integer version
+	// Generation the provider supports a monotonically increasing integer version.
 	Generation ObjectVersionType = iota
-	// ETag the provider supports a hash or checksum version
+	// ETag the provider supports a hash or checksum version.
 	ETag ObjectVersionType = iota
 )
 
 type ObjectVersion struct {
-	// Type is the type of object version supported by the provider
+	// Type is the type of object version supported by the provider.
 	Type ObjectVersionType
-	// Value is a string representation of the version data from the provider
+	// Value is a string representation of the version data from the provider.
 	Value string
 }
 

prefixed_bucket.go

@@ -98,7 +98,7 @@ func (p *PrefixedBucket) IsAccessDeniedErr(err error) bool {
 	return p.bkt.IsAccessDeniedErr(err)
 }
 
-// IsConditionNotMetErr returns true if err meets is a condition not met error in the underlying provider
+// IsConditionNotMetErr returns true if err meets is a condition not met error in the underlying provider.
 func (p *PrefixedBucket) IsConditionNotMetErr(err error) bool { return p.bkt.IsConditionNotMetErr(err) }
 
 // Attributes returns information about the specified object.

providers/azure/azure.go

@@ -307,7 +307,7 @@ func (b *Bucket) IsAccessDeniedErr(err error) bool {
 	return bloberror.HasCode(err, bloberror.AuthorizationPermissionMismatch) || bloberror.HasCode(err, bloberror.InsufficientAccountPermissions)
 }
 
-// IsConditionNotMetErr returns true if the error was a blob error nad the code is ConditionNotMet, or BlobAlreadyExists
+// IsConditionNotMetErr returns true if the error was a blob error nad the code is ConditionNotMet, or BlobAlreadyExists.
 func (b *Bucket) IsConditionNotMetErr(err error) bool {
 	return errors.Is(err, errConditionInvalid) ||
 		bloberror.HasCode(err, bloberror.BlobAlreadyExists) ||
@@ -387,7 +387,7 @@ func (b *Bucket) Upload(ctx context.Context, name string, r io.Reader, uploadOpt
 	if err := objstore.ValidateUploadOptions(b.SupportedObjectUploadOptions(), uploadOpts...); err != nil {
 		return err
 	}
-	
+
 	level.Debug(b.logger).Log("msg", "uploading blob", "blob", name)
 	blobClient := b.containerClient.NewBlockBlobClient(name)
 

providers/filesystem/filesystem.go

@@ -372,7 +372,7 @@ func (b *Bucket) checksum(name string) (string, error) {
 	file := filepath.Join(b.rootDir, name)
 	bytes, err := xattr.Get(file, xAttrKey)
 	if err != nil {
-		return "", err // Legacy filesystem buckets would just return empty string for the version (until objects updated)
+		return "", err // Legacy filesystem buckets would just return empty string for the version (until objects updated).
 	}
 	return string(bytes), nil
 }
@@ -395,7 +395,7 @@ func (b *Bucket) checkConditions(name string, params objstore.UploadObjectParams
 			return errConditionNotMet
 		}
 	}
-	//... if the file doesn't exist, and it's an IfNotMatch, that's always fine
+	//... if the file doesn't exist, and it's an IfNotMatch, that's always fine.
 	return nil
 }
 
@@ -456,7 +456,7 @@ func (b *Bucket) IsAccessDeniedErr(_ error) bool {
 	return false
 }
 
-// IsConditionNotMetErr returns true if the error is an internal condition not met error or a ErrExist filesystem error
+// IsConditionNotMetErr returns true if the error is an internal condition not met error or a ErrExist filesystem error.
 func (b *Bucket) IsConditionNotMetErr(err error) bool {
 	return errors.Is(err, errConditionNotMet) || errors.Is(err, fs.ErrExist)
 }

providers/gcs/gcs.go

@@ -399,7 +399,7 @@ func (b *Bucket) IsAccessDeniedErr(err error) bool {
 	return false
 }
 
-// IsConditionNotMetErr returns true if the response status code was Precondition Failed or Not Modified
+// IsConditionNotMetErr returns true if the response status code was Precondition Failed or Not Modified.
 func (b *Bucket) IsConditionNotMetErr(err error) bool {
 	var gapiErr *googleapi.Error
 	// See https://cloud.google.com/storage/docs/json_api/v1/status-codes