fix double filename calls while put'ing#26
Draft
petermueller wants to merge 8 commits into
Draft
Conversation
WIP - adding more robusts integration tests
Closed
Collaborator
Author
|
@achempion My only concern is that the dependencies of gcp go back to Google 's maintained library that is half abandoned and still using a very outdated version of Poison and some other libraries. When we pull it in I think it may be beneficial to have waffle be a monorepo for the ease of testing all the adapters but still separate mix files until we can move away from that library or figure something else out What are your thoughts? |
Member
It shouldn't be an issue with monorepo, as including them will be a part of adapter specific documentation similar to how it works in Swoosh
agree 👍 |
Introduce Waffle.GCSCase, an ExUnit.CaseTemplate that centralizes the integration-test setup, helpers (env_bucket/bucket_url/with_env), and assertion macros (assert_public/assert_private/assert_header/ assert_public_with_extension/assert_acls_public_reader/ delete_and_assert_gone) that were previously copy-pasted across test files. It also applies the :integration and :tmp_dir moduletags. Add feature_definitions.ex: focused, single-purpose Waffle definitions (GCSTest.*), each exercising exactly one feature, plus GCSTest.FilenameProbe (@async false + a send/self probe) used by the double-filename regression test.
gcs_features_test.exs is the canonical public-API integration suite: each test drives one Waffle feature through definition.store/url/delete against real GCS, using the single-purpose GCSTest.* definitions and the shared Waffle.GCSCase. It folds back the coverage the earlier ad-hoc suites had dropped: object ACL assertions, stored-name equality checks, the pre-store URL assertion for a definition-level bucket, and per-version extension assertions. double_filename_regression_test.exs is an explicit guard for issue #25: GCSTest.FilenameProbe announces every filename/2 invocation, so the test asserts (assert_received/refute_received) that the name is resolved exactly once per version during store and that the stored object name is not double-prefixed.
cloud_storage_test.exs now covers only the CloudStorage module boundary: pure-unit path/name construction (storage_dir/3, path_for/3, bucket/1 with a literal) that needs no network, plus the put/delete/url round-trips tagged :integration. The duplicated 'from upstream storage tests' block, the copy-pasted assertion macros, and the leftover IO.inspect calls are gone (macros now live only in Waffle.GCSCase). Delete test/support/definitions.ex: the old multi-purpose fixtures were only used by the now-removed redundant suites. Repoint cleanup.ex's after_suite teardown at GCSTest.PublicUpload.
Add a tag-taxonomy comment block to test_helper.exs explaining :integration, :tmp_dir, :bucket_with_file_and_scope, double_filename_regression, skip, and upstream_mismatch, including how each is toggled with --include/--exclude and a note that future-behavior skips should become exclude tags for 0.3. Add a 'mix test.unit' alias (test --exclude integration) with a preferred_env so the fast, offline unit tests run without GCS credentials, and document the env vars and example invocations in the README.
Document how to bring the double-filename fix and the test overhaul forward into main (0.3): the precise put/3 + path_for/3 + fullname/3 lib delta and why it differs from PR #1, the orthogonal token-fetcher divergence to avoid dragging along, the cherry-pick order for the four test commits with their conflict points, and the version-gating flip that makes the :bucket_with_file_and_scope test run (and fail) once main hits 0.3. Lives under plans/, which is outside the mix.exs files: whitelist and so is excluded from the published hex package.
…tooling Distilled from a full review of the lib and test suite. Index in plans/README.md; work items tracked on GitHub as milestone v0.3 (issues #27-#37) plus #38 (offline suite), #39 (client rewrite), and #40 (migration/repair tooling). forward-port-to-main.md updated in place: the section 4 version-gating question is decided as option (a) (bucket-from-scope, #33), and WAFFLE_BUCKET2 is now available as a GHA repository secret.
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
2 participants
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.
DO NOT MERGE TO
mainDue to scope of change (and based on prior discussion) we may prefer to just roll this into a
0.3version release.TODO
unique_basename/tmp_dirtag to the rest of the CloudStorage tests