Migrate gsutil usage to gcloud storage #4337
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 effort to update several Jupyter notebooks by replacing 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
|
|
Hi @gericdong, Can we get your review on this PR? Thanks! |
There was a problem hiding this comment.
Code Review
This pull request automates the migration of gsutil commands to gcloud storage across several Jupyter notebooks. The changes are largely correct, but I've identified a critical syntax error in one notebook that would prevent it from being parsed correctly, and a bug in another that would cause a runtime error due to case-sensitivity in a grep command. Please review the suggested fixes to ensure the notebooks remain functional after this migration.
| " ! gsutil cat $folder/prediction*.jsonl\n", | ||
| " break\n", | ||
| " ! gcloud storage ls $folder/prediction*.jsonl\n", "\n", | ||
| ! gcloud storage cat $folder/prediction*.jsonl\n", " break\n", |
There was a problem hiding this comment.
There appears to be a syntax error in this line within the notebook's JSON structure. The line is missing an opening double quote and seems to be a malformed combination of two lines. This will cause a JSON parsing error when trying to open or execute the notebook. You should replace this single malformed line with two separate lines in the source array as shown in the suggestion.
| ! gcloud storage cat $folder/prediction*.jsonl\n", " break\n", | |
| " ! gcloud storage cat $folder/prediction*.jsonl\n", | |
| " break\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\".\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 grep command is case-sensitive and is looking for "Location constraint:", but the output of gcloud storage ls --full --buckets is "Location Constraint:". This will cause shell_output to be empty and the subsequent code at line 350 to fail with an IndexError. You should either make the grep case-insensitive with -i or change the string to match the new output.
shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep -i "Location constraint:" | sed "s/Location constraint://i"
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