Migrate gsutil usage to gcloud storage #4301
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 systematically migrates all Google Cloud Storage operations within several Jupyter notebooks from the deprecated 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 notebooks. The majority of the command translations are correct. However, I've identified a couple of issues. In two notebooks, the parsing of gcloud storage ls output will fail due to case-sensitivity changes in the output keys, which I've flagged as high severity. I've also found a shell command in another notebook that, while likely functional, is confusingly written and could be improved for clarity and robustness. I've provided suggestions for all these points.
| " 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 output format of gcloud storage ls --full uses 'Title Case' for keys, so 'Location constraint:' has become 'Location Constraint:'. The grep and sed commands are case-sensitive and will fail to find and replace the string. Please update them to match the new output format. Using grep -i would also work but it's better to be explicit.
shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep "Location Constraint:" | sed "s/Location Constraint: *//"
There was a problem hiding this comment.
[Resolved] addressed the comments
| " 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 output format of gcloud storage ls --full uses 'Title Case' for keys, so 'Location constraint:' has become 'Location Constraint:'. The grep and sed commands are case-sensitive and will fail to find and replace the string. Please update them to match the new output format. Using grep -i would also work but it's better to be explicit.
shell_output = ! gcloud storage ls --full --buckets {BUCKET_NAME} | grep "Location Constraint:" | sed "s/Location Constraint: *//"
| "# create placeholder file for instructions for data labeling\n", | ||
| "! echo \"this is instruction\" >> instruction.txt | gsutil cp instruction.txt $BUCKET_URI" | ||
| ] | ||
| "! echo \"this is instruction\" >> instruction.txt | gcloud storage cp instruction.txt $BUCKET_URI" ] |
There was a problem hiding this comment.
The use of a pipe | here is confusing. The output of echo is redirected to instruction.txt, so nothing is passed through the pipe to the gcloud storage cp command. The pipe acts as a command separator, but && or ; would be more explicit.
Additionally, using >> will append to instruction.txt on each run, which might not be the desired behavior. Using > would overwrite the file.
A cleaner approach is to pipe the output of echo directly to gcloud storage cp without creating a temporary local file.
! echo "this is instruction" | gcloud storage cp - $BUCKET_URI/instruction.txt
There was a problem hiding this comment.
[Resolved] not needed existing is fine
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