mirror of
https://github.com/versity/versitygw.git
synced 2026-09-24 08:54:47 +00:00
Radu Berinde
7ae119d654
Problem:
- `posix.New` calls `os.Chdir(rootdir)` and uses cwd-relative paths for
every bucket and object. That is the cheapest way to address files, but
the cwd is process-wide: embedding the gateway (`embedgw`) silently moves
the host program's cwd. In particular, Go unit tests that embed the
gateway can no longer read their test data files by relative path.
Change:
- New `PosixOpts.AbsolutePaths`. When set, `New` leaves the working
directory alone and builds every path from the absolute root; a relative
`VersioningDir`/`SideCarDir` is then resolved against the working
directory rather than the root. The default is unchanged: chdir and
relative paths.
- All bucket and object paths go through new `BucketPath`/`ObjectPath`,
which return the name as-is by default and prefix the root with
`AbsolutePaths`. An absolute "bucket" (the versioning directory
substitution) is passed through unchanged.
- `tmpfile` records the bucket directory path so `link()` and its fallbacks
use the same addressing; `ListBuckets` reads the root through the same
helper.
- `meta.XattrMeta` needs the same root with `AbsolutePaths`. New
`meta.RootDirSetter` interface; `posix.New` calls `WithRootDir` on
storers that implement it in that mode. A zero `XattrMeta` keeps
resolving against the cwd. `SideCar`/`NoMeta` unchanged. A type that
embeds `XattrMeta` inherits a `WithRootDir` that returns a bare
`XattrMeta`, so it needs its own (documented on `RootDirSetter`).
- `DeleteObject` (directory object), `ListParts`, and `UploadPartCopy`
passed filesystem paths where the metadata API expects bucket/object
names; they now pass names, so the sidecar layout is unchanged in both
modes.
- Windows `handleParentDirError` walks up until `filepath.Dir` is a fixed
point, which works for relative and absolute paths.
- scoutfs used cwd-relative bucket/object paths in `CreateBucket`,
`GetObject`, `HeadObject`, `RestoreObject` and the glacier walk; they now
go through `BucketPath`/`ObjectPath`. `scoutfs.New` resolves `rootdir`
before `posix.New` so a relative root no longer reopens `rootdir/rootdir`
after the chdir.
- `isBucketValid` unconditionally rejects names that do not denote a single
entry under the root: `""`, `.`, `..`, names containing a path separator,
and absolute paths. `XattrMeta` rejects `""`, `.` and `..` likewise.
With relative paths `os.Stat("")` and `os.RemoveAll(".")` failed by
accident; with absolute paths they would act on the root directory itself
(reachable with strict bucket names disabled, or via the admin
`change-bucket-owner` endpoint which does not validate `bucket`).
- scoutfs had its own `isBucketValid` whose `validateBucketName` flag was
never set, so it accepted everything. It now delegates to the new exported
`Posix.IsBucketValid`.
- `UploadPartCopy` did not validate the copy source's bucket name (unlike
`CopyObject`); it does now.
- `New` opens the root after validating the versioning and sidecar
directories, so those error paths no longer leak the root handle. The
chdir still happens first, so a relative directory resolves against the
root as before.
Tests:
- New `TestDefaultModeChangesWorkingDirectory` documents the default.
- New `TestRootDirIndependentOfWorkingDirectory`: `AbsolutePaths` with a
relative root from an unrelated cwd, checks cwd is untouched and that
put/get/list/delete, copy, multipart upload with checksums and part copy,
directory-object delete, and invalid bucket names behave correctly under
the root, for both metadata storers.
- New `TestVersioningDirIndependentOfWorkingDirectory`: same setup with a
relative versioning directory; versions land there and not under the
root or cwd.
- New `TestXattrMetaPath` covers cwd-relative and root resolution, absolute
pass-through and the rejected names.
- New `BenchmarkPosix*` benchmarks (small-object head/get/put/list, both
storers, both path modes). The default mode matches `main` within noise
on both Linux and macOS. `AbsolutePaths` costs about 0.2µs (Linux) to
0.4µs (macOS) per path lookup; on Linux (arm64 VM, overlayfs) that is
+2-3% on PutObject and +10-27% on the metadata-heavy small-object
HeadObject/GetObject/ListObjectsV2 with xattr metadata, which is why it
is opt-in.
103 lines
3.3 KiB
Go
103 lines
3.3 KiB
Go
// Copyright 2026 Versity Software
|
|
// This file is 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 posix
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"os"
|
|
"testing"
|
|
|
|
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/versity/versitygw/backend/meta"
|
|
"github.com/versity/versitygw/s3err"
|
|
)
|
|
|
|
// newUnversionedGateway creates a Posix backend over a temporary root
|
|
// directory with no versioning directory configured, i.e. gateway-level
|
|
// versioning disabled, matching the default gateway configuration.
|
|
func newUnversionedGateway(t *testing.T) *Posix {
|
|
t.Helper()
|
|
|
|
p, err := New(t.TempDir(), meta.XattrMeta{}, PosixOpts{
|
|
ValidateBucketNames: true,
|
|
})
|
|
if err != nil {
|
|
t.Fatalf("init posix backend: %v", err)
|
|
}
|
|
return p
|
|
}
|
|
|
|
// TestVersioningUnconfigured covers the bucket versioning behavior when the
|
|
// gateway has no versioning directory configured: bucket validation still
|
|
// applies first, GetBucketVersioning returns an empty configuration, and
|
|
// PutBucketVersioning is rejected.
|
|
func TestVersioningUnconfigured(t *testing.T) {
|
|
// New() chdirs into the gateway root; restore the original working
|
|
// directory when the test completes.
|
|
t.Chdir(t.TempDir())
|
|
|
|
t.Run("get bucket versioning invalid bucket name", func(t *testing.T) {
|
|
p := newUnversionedGateway(t)
|
|
|
|
_, err := p.GetBucketVersioning(context.Background(), "bad/bucket")
|
|
if !errors.Is(err, s3err.GetAPIError(s3err.ErrInvalidBucketName)) {
|
|
t.Errorf("expected InvalidBucketName, got %v", err)
|
|
}
|
|
})
|
|
|
|
t.Run("get bucket versioning no such bucket", func(t *testing.T) {
|
|
p := newUnversionedGateway(t)
|
|
|
|
_, err := p.GetBucketVersioning(context.Background(), "does-not-exist")
|
|
if !errors.Is(err, s3err.GetAPIError(s3err.ErrNoSuchBucket)) {
|
|
t.Errorf("expected NoSuchBucket, got %v", err)
|
|
}
|
|
})
|
|
|
|
t.Run("get bucket versioning returns empty config", func(t *testing.T) {
|
|
p := newUnversionedGateway(t)
|
|
|
|
err := os.Mkdir(p.BucketPath("bucket"), 0o755)
|
|
assert.NoError(t, err)
|
|
|
|
res, err := p.GetBucketVersioning(context.Background(), "bucket")
|
|
assert.NoError(t, err)
|
|
assert.Nil(t, res.Status)
|
|
})
|
|
|
|
t.Run("put bucket versioning invalid bucket name", func(t *testing.T) {
|
|
p := newUnversionedGateway(t)
|
|
|
|
err := p.PutBucketVersioning(context.Background(), "bad/bucket", types.BucketVersioningStatusEnabled)
|
|
if !errors.Is(err, s3err.GetAPIError(s3err.ErrInvalidBucketName)) {
|
|
t.Errorf("expected InvalidBucketName, got %v", err)
|
|
}
|
|
})
|
|
|
|
t.Run("put bucket versioning not configured", func(t *testing.T) {
|
|
p := newUnversionedGateway(t)
|
|
|
|
err := os.Mkdir(p.BucketPath("bucket"), 0o755)
|
|
assert.NoError(t, err)
|
|
|
|
err = p.PutBucketVersioning(context.Background(), "bucket", types.BucketVersioningStatusEnabled)
|
|
if !errors.Is(err, s3err.GetAPIError(s3err.ErrVersioningNotConfigured)) {
|
|
t.Errorf("expected VersioningNotConfigured, got %v", err)
|
|
}
|
|
})
|
|
}
|