Migrate gsutil usage to gcloud storage #4297
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 part of an ongoing initiative to standardize interactions with Google Cloud Storage by migrating from the legacy 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request contains automated migrations from gsutil to gcloud storage across several Jupyter notebooks. While most of the command conversions are correct, I've found a recurring critical issue in four of the notebooks. The logic to parse the bucket location after migration is broken due to a change in the output format of the gcloud storage command compared to the old gsutil command. This will cause an IndexError and break the execution of these notebooks. I've left specific comments with code suggestions to fix this issue in each affected file. Please review these suggestions carefully. The other migrations appear to be correct.
| " shell_output = ! gsutil ls -Lb {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", | ||
| " bucket_region = shell_output[0].strip().lower()\n", | ||
| # Note: The format of the full listing output is different. gcloud storage uses a title case for keys and will not display a field if its value is "None". | ||
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", |
There was a problem hiding this comment.
The automated migration from gsutil to gcloud storage has introduced a bug here. The output format of gcloud storage ls --full --buckets is different from gsutil ls -Lb. Specifically, the location information is prefixed with Location: instead of Location constraint:. The current grep command will not find a match, causing shell_output to be empty and leading to an IndexError on the next line when trying to access shell_output[0]. This will break the notebook's execution. The grep and sed commands should be updated to parse the new output format.
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", | |
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location:\" | sed 's/Location: *//'\n", " bucket_region = shell_output[0].strip().lower()\n", |
| " assert BUCKET_URI.startswith(\"gs://\"), \"BUCKET_URI must start with `gs://`.\"\n", | ||
| " shell_output = ! gsutil ls -Lb {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", | ||
| " bucket_region = shell_output[0].strip().lower()\n", | ||
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", |
There was a problem hiding this comment.
The automated migration from gsutil to gcloud storage has introduced a bug here. The output format of gcloud storage ls --full --buckets is different from gsutil ls -Lb. Specifically, the location information is prefixed with Location: instead of Location constraint:. The current grep command will not find a match, causing shell_output to be empty and leading to an IndexError on the next line when trying to access shell_output[0]. This will break the notebook's execution. The grep and sed commands should be updated to parse the new output format.
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", | |
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location:\" | sed 's/Location: *//'\n", " bucket_region = shell_output[0].strip().lower()\n", |
| " assert BUCKET_URI.startswith(\"gs://\"), \"BUCKET_URI must start with `gs://`.\"\n", | ||
| " shell_output = ! gsutil ls -Lb {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", | ||
| " bucket_region = shell_output[0].strip().lower()\n", | ||
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", |
There was a problem hiding this comment.
The automated migration from gsutil to gcloud storage has introduced a bug here. The output format of gcloud storage ls --full --buckets is different from gsutil ls -Lb. Specifically, the location information is prefixed with Location: instead of Location constraint:. The current grep command will not find a match, causing shell_output to be empty and leading to an IndexError on the next line when trying to access shell_output[0]. This will break the notebook's execution. The grep and sed commands should be updated to parse the new output format.
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", | |
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location:\" | sed 's/Location: *//'\n", " bucket_region = shell_output[0].strip().lower()\n", |
| " shell_output = ! gsutil ls -Lb {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", | ||
| " bucket_region = shell_output[0].strip().lower()\n", | ||
| # Note: The format of the full listing output is different. gcloud storage uses a title case for keys and will not display a field if its value is "None". | ||
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", |
There was a problem hiding this comment.
The automated migration from gsutil to gcloud storage has introduced a bug here. The output format of gcloud storage ls --full --buckets is different from gsutil ls -Lb. Specifically, the location information is prefixed with Location: instead of Location constraint:. The current grep command will not find a match, causing shell_output to be empty and leading to an IndexError on the next line when trying to access shell_output[0]. This will break the notebook's execution. The grep and sed commands should be updated to parse the new output format.
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location constraint:\" | sed \"s/Location constraint://\"\n", " bucket_region = shell_output[0].strip().lower()\n", | |
| " shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep \"Location:\" | sed 's/Location: *//'\n", " bucket_region = shell_output[0].strip().lower()\n", |
changes for 4297
Apply automated linter fixes for 4297
removed changes from model_garden
3 participants
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