[#2739] Renamed 'upload-db-s3' to 'push-db-s3' and aligned tooling and playground script names.#2740
Conversation
…b taxonomy. Also renamed the manual playground scripts to match the tooling scripts they exercise (for example 'try-email-notification.sh' to 'try-notify-email.sh' and 'try-s3-fetch.sh' to 'try-fetch-db-s3.sh') and updated the playground README and internal usage references.
…pts. Stopped the manual playground scripts from printing credential previews (tokens, API keys, webhook URLs), required an explicit email recipient, made scenario arguments fail fast on unknown values, captured API responses in variables instead of predictable temporary files, enabled xtrace only after credentials are exported, validated the GitHub deployments response shape, and removed dead code.
Enabled pipefail, deferred xtrace until after the signed request so credentials are never traced, added curl connect and overall timeouts with transport-error handling, and URL-encoded the S3 object key used for signing and the request URL.
|
Caution Review failedAn error occurred during the review process. Please try again later. WalkthroughPlayground manual test docs and notification scripts were renamed to the ChangesManual playground updates
S3 push tooling updates
Sequence Diagram(s)sequenceDiagram
participant T as try-push-db-s3.sh
participant P as push-db-s3
participant C as curl
participant S as Amazon S3
T->>P: export VORTEX_PUSH_DB_S3_* and run the binary
P->>C: send signed PUT request for object_key
C->>S: upload the database dump
S-->>P: return HTTP status and response body
P-->>T: print completion message
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Suggested labels
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
📖 Documentation preview for this pull request has been deployed to Netlify: https://6a3e3e5787d7f41aa40fb84b--vortex-docs.netlify.app This preview is rebuilt on every commit and is not the production documentation site. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2740 +/- ##
==========================================
- Coverage 86.67% 86.22% -0.45%
==========================================
Files 96 89 -7
Lines 4719 4560 -159
Branches 47 3 -44
==========================================
- Hits 4090 3932 -158
+ Misses 629 628 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
Code coverage (threshold: 90%) Per-class coverage |
This comment has been minimized.
This comment has been minimized.
2 similar comments
This comment has been minimized.
This comment has been minimized.
|
Code coverage (threshold: 90%) Per-class coverage |
Closes #2739
Summary
Renamed the
upload-db-s3tooling script topush-db-s3(and allVORTEX_UPLOAD_DB_S3_*variables toVORTEX_PUSH_DB_S3_*) to fit thefetch-*(in) /push-*(out) verb taxonomy, sitting besidefetch-db-s3andpush-db-image. Renamed all 12 manual playground scripts to mirror the tooling script each one exercises (e.g.try-slack-notification.sh→try-notify-slack.sh,try-s3-upload.sh→try-push-db-s3.sh). Hardened pre-existing issues in the playground scripts and the shippedpush-db-s3script.Changes
Rename:
upload-db-s3→push-db-s3.vortex/tooling/src/upload-db-s3topush-db-s3..vortex/tooling/tests/unit/upload-db-s3.batstopush-db-s3.bats.VORTEX_UPLOAD_DB_S3_*environment variables toVORTEX_PUSH_DB_S3_*throughout the script and its BATS tests.Playground script naming convention
Renamed all 12 manual playground scripts to match the tooling script each one exercises:
try-email-notification.sh→try-notify-email.shtry-github-notification.sh→try-notify-github.shtry-jira-notification.sh→try-notify-jira.shtry-newrelic-notification.sh→try-notify-newrelic.shtry-slack-notification.sh→try-notify-slack.shtry-webhook-notification.sh→try-notify-webhook.shtry-s3-fetch.sh→try-fetch-db-s3.shtry-s3-upload.sh→try-push-db-s3.shtry-github-auth.sh→try-notify-github-auth.shtry-github-cleanup.sh→try-notify-github-cleanup.shtry-jira-auth.sh→try-notify-jira-auth.shtry-newrelic-auth.sh→try-notify-newrelic-auth.shUpdated the playground
README.mdand each script's internal usage references to reflect the new names.Playground script hardening
Addressed pre-existing issues in the manual playground scripts:
/tmpfiles.set -xonly after credentials are exported so secrets are never traced.Shipped
src/push-db-s3hardeningAddressed pre-existing issues in the shipped tooling script:
pipefailso pipe failures surface correctly.set -xuntil after the S3 signed request is built so credentials are never traced (consistent with the xtrace guard added topush-db-imagein a previous cycle).--connect-timeoutand--max-timeto thecurlcall with transport-error handling.Screenshots
N/A
Before / After
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Tests