Initial implimentation of the s3 provider#75
Open
ian-noaa wants to merge 3 commits into
Open
Conversation
Add an s3 provider to unpack a gzipped tarball of stat files from an S3 bucket. Additionally adds tests & some documentation.
ian-noaa
force-pushed
the
add-s3-storage-provider
branch
from
June 25, 2026 22:02
178fdfe to
045d1f6
Compare
Also add a note that I'm not sure we're safe in a concurrent situation
ian-noaa
force-pushed
the
add-s3-storage-provider
branch
from
June 30, 2026 18:18
cc9e510 to
340502e
Compare
ian-noaa
marked this pull request as ready for review
July 15, 2026 15:35
Contributor
|
Hi, Ian, I have some notes on setting up localstack on Mac/Linux. Since you got this working with Ministack, may be it is a good idea to capture these in some place. |
Collaborator
Author
|
Thanks for checking this out Gopa! I did add a few notes on running ministack for the test suite in the dev guide. (linked below) Otherwise, all the ministack & test configuration is done via the test suite - fortunately, getting it going is a |
There was a problem hiding this comment.
Pull request overview
Adds an S3-backed storage provider and supporting utilities so the pipeline can stream a gzipped tarball from S3 and process only .stat / .tcst entries, alongside unit + integration test coverage and a developer guide for running tests locally.
Changes:
- Introduces
S3TarballProviderimplementingstorage.StorageProviderby streaming + iterating.stat/.tcstentries from an S3-hosted.tar.gz. - Adds
ParseS3Eventfor decoding S3 event notification payloads (including URL-decoding object keys). - Adds unit tests and an integration test suite (MiniStack-based) plus developer documentation for running tests/coverage.
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pkg/storage/s3tarball.go | New S3 tarball storage provider that walks stat entries from an S3 GetObject stream |
| pkg/storage/s3tarball_test.go | Unit tests for stat-file detection and tarball walking behavior (filtering, cancellation, errors) |
| pkg/storage/s3event.go | New S3 event JSON parsing helper with key URL-decoding |
| pkg/storage/s3event_test.go | Unit tests covering S3 event parsing scenarios |
| pkg/storage/s3_integration_test.go | MiniStack integration test that uploads a tarball to S3 and validates streaming via the provider |
| pkg/storage/fakes3_test.go | Test fake implementing GetObject for provider unit tests |
| go.mod | Adds AWS SDK v2 dependencies required for S3 support and integration tests |
| go.sum | Records module sums for new AWS SDK v2 dependencies |
| docs/dev-guide.md | New developer guide documenting build/test/integration test setup (MiniStack + Couchbase) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+82
to
+85
| fileCount++ | ||
| if err := fn(hdr.Name, tr); err != nil { // Note - this most likely isn't safe in a concurrent environment given the global state | ||
| return err | ||
| } |
Comment on lines
+130
to
+140
| client.CreateBucket(ctx, &s3.CreateBucketInput{ | ||
| Bucket: aws.String(testBucket), | ||
| }) | ||
|
|
||
| _, err := client.PutObject(ctx, &s3.PutObjectInput{ | ||
| Bucket: aws.String(testBucket), | ||
| Key: aws.String(testKey), | ||
| Body: bytes.NewReader(tarball), | ||
| ContentType: aws.String("application/gzip"), | ||
| ChecksumAlgorithm: "SHA256", | ||
| }) |
| if resp.StatusCode != http.StatusOK { | ||
| t.Fatalf( | ||
| "MiniStack health check returned status %d at %s\n\n"+ | ||
| "Ensure MiniStack is running: localstack start", |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add an s3 provider to unpack a gzipped tarball of stat files from an S3 bucket. Additionally adds tests & some documentation.