-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
feat(ExternalStorage) Allow the use of 'prefix' in S3 buckets #61585
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
mbartsch
wants to merge
2
commits into
nextcloud:master
Choose a base branch
from
mbartsch:feature/s3-external-prefix
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+269
−20
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\Files_External\Tests\Storage; | ||
|
|
||
| use OCA\Files_External\Lib\Storage\AmazonS3; | ||
|
|
||
| /** | ||
| * Runs the full storage test suite against an S3 mount that has a prefix set, | ||
| * and adds isolation tests to verify that two mounts with different prefixes | ||
| * in the same bucket cannot see each other's files. | ||
| */ | ||
| #[\PHPUnit\Framework\Attributes\Group(name: 'DB')] | ||
| #[\PHPUnit\Framework\Attributes\Group('S3')] | ||
| class Amazons3PrefixTest extends \Test\Files\Storage\Storage { | ||
| use ConfigurableStorageTrait; | ||
|
|
||
| /** @var AmazonS3 */ | ||
| protected $instance; | ||
|
|
||
| protected function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| $this->loadConfig(__DIR__ . '/../config.amazons3.php'); | ||
| $this->instance = new AmazonS3($this->config + ['prefix' => 'test-prefix-a/']); | ||
| } | ||
|
|
||
| protected function tearDown(): void { | ||
| if ($this->instance) { | ||
| $this->instance->rmdir(''); | ||
| } | ||
|
|
||
| parent::tearDown(); | ||
| } | ||
|
|
||
| public function testStat(): void { | ||
| $this->markTestSkipped('S3 doesn\'t update the parents folder mtime'); | ||
| } | ||
|
|
||
| public function testPrefixIsolation(): void { | ||
| $storageA = new AmazonS3($this->config + ['prefix' => 'test-prefix-a/']); | ||
| $storageB = new AmazonS3($this->config + ['prefix' => 'test-prefix-b/']); | ||
|
|
||
| try { | ||
| $storageA->file_put_contents('hello.txt', 'from-a'); | ||
|
|
||
| // B must not see a file written by A | ||
| $this->assertFalse($storageB->file_exists('hello.txt'), 'Storage B must not see files written by Storage A'); | ||
|
|
||
| $storageB->file_put_contents('hello.txt', 'from-b'); | ||
|
|
||
| // Each storage reads its own copy | ||
| $this->assertSame('from-a', $storageA->file_get_contents('hello.txt')); | ||
| $this->assertSame('from-b', $storageB->file_get_contents('hello.txt')); | ||
| } finally { | ||
| $storageA->rmdir(''); | ||
| $storageB->rmdir(''); | ||
| } | ||
| } | ||
|
|
||
| public function testPrefixIsolationDirectory(): void { | ||
| $storageA = new AmazonS3($this->config + ['prefix' => 'test-prefix-a/']); | ||
| $storageB = new AmazonS3($this->config + ['prefix' => 'test-prefix-b/']); | ||
|
|
||
| try { | ||
| $storageA->mkdir('subdir'); | ||
| $storageA->file_put_contents('subdir/file.txt', 'data'); | ||
|
|
||
| $this->assertFalse($storageB->is_dir('subdir'), 'Storage B must not see directories created by Storage A'); | ||
| $this->assertFalse($storageB->file_exists('subdir/file.txt'), 'Storage B must not see files in directories created by Storage A'); | ||
| } finally { | ||
| $storageA->rmdir(''); | ||
| $storageB->rmdir(''); | ||
| } | ||
| } | ||
|
|
||
| public function testNoPrefixAndPrefixedMountDoNotOverlap(): void { | ||
| $withPrefix = new AmazonS3($this->config + ['prefix' => 'test-prefix-a/']); | ||
| $withoutPrefix = new AmazonS3($this->config); | ||
|
|
||
| try { | ||
| $withPrefix->file_put_contents('scoped.txt', 'scoped'); | ||
|
|
||
| // The un-prefixed mount must not see 'scoped.txt' at its root | ||
| $this->assertFalse($withoutPrefix->file_exists('scoped.txt'), 'Un-prefixed mount must not see files from prefixed mount at its root'); | ||
| } finally { | ||
| $withPrefix->rmdir(''); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This can be simplified by doing
$path = $this->addPrefix($path . '/');above theif