Skip to content

chore: Migrate gsutil usage to gcloud storage#1377

Open
bhandarivijay-png wants to merge 1 commit intoGoogleCloudDataproc:mainfrom
bhandarivijay-png:ai-gsutil-migration-df5c59f312684f2593b6e3bc623e00f3
Open

chore: Migrate gsutil usage to gcloud storage#1377
bhandarivijay-png wants to merge 1 commit intoGoogleCloudDataproc:mainfrom
bhandarivijay-png:ai-gsutil-migration-df5c59f312684f2593b6e3bc623e00f3

Conversation

@bhandarivijay-png
Copy link

Automated: Migrate {target_path} from gsutil to gcloud storage

This CL is part of the on going effort to migrate from the legacy gsutil tool to the new and improved gcloud storage command-line interface.
gcloud storage is the recommended and modern tool for interacting with Google Cloud Storage, offering better performance, unified authentication, and a more consistent command structure with other gcloud components. 🚀

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.

⚠️ Action Required: Please Review and Test Carefully

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 gsutil and gcloud storage that 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 rsync command has a different file deletion logic than gsutil 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 CLI team 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.com

We appreciate your partnership in this important migration effort!

#gsutil-migration

@bhandarivijay-png
Copy link
Author

Hi @cjac, Can we get your review on this PR? Thanks!

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 various shell scripts and Python test files from using the legacy gsutil command-line tool to the modern gcloud storage CLI for interacting with Google Cloud Storage. This change aligns with Google Cloud's recommendation for improved performance, unified authentication, and a consistent command structure across gcloud components. The migration covers common operations such as copying files, synchronizing directories, creating buckets, and deleting objects.

Highlights

  • Migration to gcloud storage cp: Replaced gsutil cp commands with gcloud storage cp across multiple shell scripts for various file copy operations, including artifact building, log uploading, JAR downloads, and package installations.
  • Migration to gcloud storage rsync: Updated gsutil rsync commands to gcloud storage rsync --recursive for directory synchronization tasks, such as uploading local logs and pushing modules to GCS.
  • GCS Bucket Management Update: Modified GCS bucket creation (gsutil mb) and deletion (gsutil rm) commands in hbase/test_hbase.py to their gcloud storage equivalents, ensuring proper flag translation.
  • Preserve POSIX Attributes: Translated the gsutil cp -P option to gcloud storage cp --preserve-posix to maintain file attributes during copy operations.
  • Code Cleanup: Removed unnecessary trailing blank lines in rapids/manual-test-runner.sh.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • beam/util/build-beam-artifacts.sh
    • Updated gsutil cp to gcloud storage cp for artifact building.
  • cloudbuild/run-presubmit-on-k8s.sh
    • Replaced gsutil cp with gcloud storage cp for uploading logs.
  • datasketches/datasketches.sh
    • Changed gsutil cp to gcloud storage cp for downloading example JARs.
  • gobblin/gobblin.sh
    • Migrated gsutil cp to gcloud storage cp for package download.
  • gpu/manual-test-runner.sh
    • Updated gsutil -m rsync -r to gcloud storage rsync --recursive for log uploading.
  • hbase/test_hbase.py
    • Replaced gsutil mb with gcloud storage buckets create for bucket creation.
    • Updated gsutil -m rm -rf to gcloud storage rm --recursive --continue-on-error for bucket deletion.
  • hive-lineage/hive-lineage.sh
    • Converted gsutil cp -P to gcloud storage cp --preserve-posix for JAR installation.
  • knox/verify_knox.sh
    • Changed gsutil cp to gcloud storage cp for topology updates.
  • push-to-gcs.sh
    • Migrated gsutil -m rsync -R -x to gcloud storage rsync --recursive --exclude for pushing modules.
  • rapids/manual-test-runner.sh
    • Updated gsutil -m rsync -r to gcloud storage rsync --recursive for log uploading.
    • Removed trailing blank lines.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request automates the migration from gsutil to gcloud storage across several shell scripts and a Python test file. A critical security concern was identified in beam/util/build-beam-artifacts.sh where unquoted variables could lead to command or argument injection. Furthermore, there are opportunities to improve code style and readability in datasketches/datasketches.sh and hbase/test_hbase.py.

function build_job_service() {
./gradlew :beam-runners-flink_2.11-job-server:shadowJar
gsutil cp \
gcloud storage cp \
Copy link
Contributor

Choose a reason for hiding this comment

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

security-medium medium

The gcloud storage cp command uses unquoted variables ${BEAM_JOB_SERVICE_DESTINATION} and ${BEAM_SOURCE_VERSION} on line 18. This can lead to command injection or argument injection if these variables contain shell metacharacters or start with a hyphen. While the change is on line 16, it is part of the same command. It is recommended to quote these variables and use -- to signal the end of options.

Suggested change
gcloud storage cp \
gcloud storage cp -- \
./runners/flink/job-server/build/libs/beam-runners-flink_2.11-job-server-*-SNAPSHOT.jar \
"${BEAM_JOB_SERVICE_DESTINATION}/beam-runners-flink_2.11-job-server-${BEAM_SOURCE_VERSION}-SNAPSHOT.jar"

Comment on lines +18 to 19
self.assert_command('gcloud storage buckets create --default-storage-class=regional --location {} gs://{}'.format(
self.REGION, self.GCS_BUCKET))
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This command string is getting long. To improve readability, you could break it into multiple lines and assign it to a variable before passing it to self.assert_command.

Suggested change
self.assert_command('gcloud storage buckets create --default-storage-class=regional --location {} gs://{}'.format(
self.REGION, self.GCS_BUCKET))
create_bucket_cmd = (
'gcloud storage buckets create '
'--default-storage-class=regional '
'--location {} gs://{}'
).format(self.REGION, self.GCS_BUCKET)
self.assert_command(create_bucket_cmd)


def tearDown(self):
self.assert_command('gsutil -m rm -rf gs://{}'.format(self.GCS_BUCKET))
self.assert_command('gcloud storage rm --recursive --continue-on-error gs://{}'.format(self.GCS_BUCKET))
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

This command string is a bit long. For better readability, consider assigning it to a variable on a separate line and breaking it up for clarity.

        rm_bucket_cmd = (
            'gcloud storage rm --recursive --continue-on-error gs://{}'
        ).format(self.GCS_BUCKET)
        self.assert_command(rm_bucket_cmd)

@cjac
Copy link
Contributor

cjac commented Mar 4, 2026

Sure, I'll take a look today

Copy link
Contributor

@cjac cjac left a comment

Choose a reason for hiding this comment

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

This won't work. These scripts need to detect the version of gcloud and determine the command to use based on what is available on the host. Look through recent changes to custom-images for examples

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.

2 participants