Skip to content

Fixed destroy tests staging databases when a PR is merged#729

Merged
rmgpinto merged 1 commit intomainfrom
fix-destroy-dbs
May 26, 2025
Merged

Fixed destroy tests staging databases when a PR is merged#729
rmgpinto merged 1 commit intomainfrom
fix-destroy-dbs

Conversation

@rmgpinto
Copy link
Copy Markdown
Collaborator

ref no-issue

  • Fixed destroy staging databases when a PR is merged

ref no-issue

- Fixed destroy staging databases when a PR is merged
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2025

Walkthrough

This change updates the .github/workflows/cicd.yml file by adding two new steps—"Authenticate with GCP" and "Destroy Tests databases"—to both the deploy-staging and deploy-production jobs. These steps are conditionally executed only for the europe-west4 region. The authentication step uses a workload identity provider, and the database cleanup step identifies and deletes test databases matching a specific pattern. These additions standardize GCP authentication and test database cleanup across deployment workflows, ensuring consistent environment maintenance for both staging and production deployments.

Possibly related PRs

  • Added staging tests to CI/CD #687: Modifies CI/CD workflows to include duplicate deployment and cleanup steps, similar to the test database destruction and GCP authentication steps added in this PR.
  • Added ephemeral staging environments tear down job #536: Introduces an ephemeral staging teardown workflow that automates GCP environment cleanup after PR merges, directly relating to the cleanup enhancements in deployment workflows in this PR.
  • Added production cicd #473: Adds a new production deployment job and adjusts deployment flags, sharing a focus on enhancing CI/CD deployment workflows as in this PR.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@rmgpinto rmgpinto enabled auto-merge (squash) May 26, 2025 14:38
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
.github/workflows/cicd.yml (1)

311-318: Avoid duplicating GCP auth configuration—DRY up with an anchor or composite action.

The “Authenticate with GCP (staging envs)” block is almost identical to other auth steps in this workflow. Consider extracting it into a YAML anchor or a reusable composite action to reduce duplication and simplify maintenance.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0767e0 and 6114ff2.

📒 Files selected for processing (1)
  • .github/workflows/cicd.yml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Build, Test and Push

Comment on lines +319 to +327
- name: "Destroy Tests databases"
if: ${{ matrix.region == 'europe-west4' }}
env:
GCP_PROJECT: ghost-activitypub
run: |
TEST_DATABASES=$(gcloud sql databases list --instance=stg-netherlands-activitypub --filter="name~test*" --format="value(name)" --project ${GCP_PROJECT})
for TEST_DATABASE in ${TEST_DATABASES}; do
gcloud sql databases delete ${TEST_DATABASE} --instance=stg-netherlands-activitypub --quiet --project ${GCP_PROJECT}
done
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Refine database deletion filter to target only ephemeral test databases.

Using --filter="name~test*" risks matching unintended databases. It’s safer to anchor the regex to your ephemeral naming convention (e.g. pr_<number>_test…) and enable strict bash safety flags.

Apply a targeted diff:

- run: |
-   TEST_DATABASES=$(gcloud sql databases list --instance=stg-netherlands-activitypub --filter="name~test*" --format="value(name)" --project ${GCP_PROJECT})
-   for TEST_DATABASE in ${TEST_DATABASES}; do
-     gcloud sql databases delete ${TEST_DATABASE} --instance=stg-netherlands-activitypub --quiet --project ${GCP_PROJECT}
-   done
+ run: |
+   set -euo pipefail
+   TEST_DATABASES=$(gcloud sql databases list \
+     --instance=stg-netherlands-activitypub \
+     --filter="name~'^pr_[0-9]+_test.*$'" \
+     --format="value(name)" \
+     --project="${GCP_PROJECT}")
+   for TEST_DATABASE in ${TEST_DATABASES}; do
+     gcloud sql databases delete "${TEST_DATABASE}" \
+       --instance=stg-netherlands-activitypub \
+       --quiet \
+       --project="${GCP_PROJECT}"
+   done
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- name: "Destroy Tests databases"
if: ${{ matrix.region == 'europe-west4' }}
env:
GCP_PROJECT: ghost-activitypub
run: |
TEST_DATABASES=$(gcloud sql databases list --instance=stg-netherlands-activitypub --filter="name~test*" --format="value(name)" --project ${GCP_PROJECT})
for TEST_DATABASE in ${TEST_DATABASES}; do
gcloud sql databases delete ${TEST_DATABASE} --instance=stg-netherlands-activitypub --quiet --project ${GCP_PROJECT}
done
- name: "Destroy Tests databases"
if: ${{ matrix.region == 'europe-west4' }}
env:
GCP_PROJECT: ghost-activitypub
run: |
set -euo pipefail
TEST_DATABASES=$(gcloud sql databases list \
--instance=stg-netherlands-activitypub \
--filter="name~'^pr_[0-9]+_test.*$'" \
--format="value(name)" \
--project="${GCP_PROJECT}")
for TEST_DATABASE in ${TEST_DATABASES}; do
gcloud sql databases delete "${TEST_DATABASE}" \
--instance=stg-netherlands-activitypub \
--quiet \
--project="${GCP_PROJECT}"
done
🤖 Prompt for AI Agents
In .github/workflows/cicd.yml around lines 319 to 327, the database deletion
command uses a loose filter "name~test*" which may match unintended databases.
Refine the filter to match your specific ephemeral test database naming pattern,
such as "pr_<number>_test", and add bash safety flags like 'set -euo pipefail'
at the start of the run block to improve script robustness and prevent
accidental deletions. Ensure the filter accurately targets only the intended
ephemeral test databases.

@rmgpinto rmgpinto merged commit fd19be9 into main May 26, 2025
8 checks passed
@rmgpinto rmgpinto deleted the fix-destroy-dbs branch May 26, 2025 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant