Migrate gsutil usage to gcloud storage #4332
Conversation
Summary of ChangesHello @googlyrahman, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request is an automated migration to update Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Hi @holtskinner, Can we get your review on this PR? Thanks! |
There was a problem hiding this comment.
Code Review
This pull request automates the migration from gsutil to gcloud storage commands across several notebooks. While most migrations are correct, I've found a recurring issue with the rm command. The gsutil rm -r and gsutil rm -rf commands, when used on a bucket URI, delete the bucket itself. The automated migration changes this to gcloud storage rm --recursive, which only deletes the bucket's contents, not the bucket. This can lead to resource leakage. I've left specific comments with suggestions to use gcloud storage buckets delete --recursive instead. Please review these suggestions to ensure the cleanup logic in the notebooks remains correct.
| "if delete_bucket and \"BUCKET_NAME\" in globals():\n", | ||
| " ! gsutil rm -r $BUCKET_NAME" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_NAME" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_NAME
| "if delete_bucket and \"BUCKET_NAME\" in globals():\n", | ||
| " ! gsutil rm -r $BUCKET_NAME" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_NAME" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_NAME
| "if delete_bucket and \"BUCKET_NAME\" in globals():\n", | ||
| " ! gsutil rm -r $BUCKET_NAME" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_NAME" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_NAME
| "if delete_bucket and \"BUCKET_NAME\" in globals():\n", | ||
| " ! gsutil rm -r $BUCKET_NAME" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_NAME" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_NAME
| "if delete_bucket or os.getenv(\"IS_TESTING\"):\n", | ||
| " ! gsutil rm -rf {BUCKET_URI}\n", | ||
| "\n", | ||
| " ! gcloud storage rm --recursive --continue-on-error {BUCKET_URI}\n", "\n", |
There was a problem hiding this comment.
The gsutil rm -rf gs://<bucket> command deletes the bucket and all objects within it, continuing on errors. The gcloud storage rm --recursive --continue-on-error gs://<bucket> command only deletes the objects within the bucket, not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive. While gcloud storage buckets delete does not have a --continue-on-error flag, it correctly reflects the primary intent of deleting the bucket.
! gcloud storage buckets delete --recursive {BUCKET_URI}
| "if delete_bucket or os.getenv(\"IS_TESTING\"):\n", | ||
| " ! gsutil rm -rf {BUCKET_URI}\n", | ||
| "\n", | ||
| " ! gcloud storage rm --recursive --continue-on-error {BUCKET_URI}\n", "\n", |
There was a problem hiding this comment.
The gsutil rm -rf gs://<bucket> command deletes the bucket and all objects within it, continuing on errors. The gcloud storage rm --recursive --continue-on-error gs://<bucket> command only deletes the objects within the bucket, not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive. While gcloud storage buckets delete does not have a --continue-on-error flag, it correctly reflects the primary intent of deleting the bucket.
! gcloud storage buckets delete --recursive {BUCKET_URI}
| "if delete_bucket or os.getenv(\"IS_TESTING\"):\n", | ||
| " ! gsutil rm -r $BUCKET_URI" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_URI" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_URI
| "if delete_bucket or os.getenv(\"IS_TESTING\"):\n", | ||
| " ! gsutil rm -r $BUCKET_URI" | ||
| ] | ||
| " ! gcloud storage rm --recursive $BUCKET_URI" ] |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage buckets delete --recursive $BUCKET_URI
| "if delete_bucket:\n", | ||
| " ! gsutil rm -r $BUCKET_URI\n", | ||
| "\n", | ||
| " ! gcloud storage rm --recursive $BUCKET_URI\n", "\n", |
There was a problem hiding this comment.
The gsutil rm -r gs://<bucket> command deletes the bucket and all objects within it. The gcloud storage rm --recursive gs://<bucket> command only deletes the objects within the bucket, but not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive.
! gcloud storage rm --recursive $BUCKET_URI
| "if delete_bucket or os.getenv(\"IS_TESTING\"):\n", | ||
| " ! gsutil rm -rf {BUCKET_URI}\n", | ||
| "\n", | ||
| " ! gcloud storage rm --recursive --continue-on-error {BUCKET_URI}\n", "\n", |
There was a problem hiding this comment.
The gsutil rm -rf gs://<bucket> command deletes the bucket and all objects within it, continuing on errors. The gcloud storage rm --recursive --continue-on-error gs://<bucket> command only deletes the objects within the bucket, not the bucket itself. This change leaves the bucket undeleted, which could lead to resource leakage. The correct command to delete a bucket and its contents is gcloud storage buckets delete --recursive. While gcloud storage buckets delete does not have a --continue-on-error flag, it correctly reflects the primary intent of deleting the bucket.
! gcloud storage buckets delete --recursive {BUCKET_URI}
Automated: Migrate paths from gsutil to gcloud storage
This CL is part of the on going effort to migrate from the legacy
gsutiltool to the new and improvedgcloud storagecommand-line interface.gcloud storageis the recommended and modern tool for interacting with Google Cloud Storage, offering better performance, unified authentication, and a more consistent command structure with othergcloudcomponents. 🚀Automation Details
This change was generated automatically by an agent that targets users of
gsutil.The transformations applied are based on the gsutil to gcloud storage migration guide.
While we have based the automation on the migration guide, every use case is unique.
It is crucial that you thoroughly test these changes in environments appropriate to your use-case before merging.
Be aware of potential differences between
gsutilandgcloud storagethat could impact your workflows.For instance, the structure of command output may have changed, requiring updates to any scripts that parse it. Similarly, command behavior can differ subtly; the
gcloud storage rsynccommand has a different file deletion logic thangsutil rsync, which could lead to unintended file deletions.Our migration guides can help guide you through a list of mappings and some notable differences between the two tools.
Standard presubmit tests are run as part of this CL's workflow. If you need to target an additional test workflow or require assistance with testing, please let us know.
Please verify that all your Cloud Storage operations continue to work as expected to avoid any potential disruptions in production.
Support and Collaboration
The
GCS CLIteam is here to help! If you encounter any issues, have a complex use case that this automated change doesn't cover, or face any other blockers, please don't hesitate to reach out.We are happy to work with you to test and adjust these changes as needed.
Contact:
gcs-cli-hyd@google.comWe appreciate your partnership in this important migration effort!
cc: @sushantkhanna