-
Notifications
You must be signed in to change notification settings - Fork 6.7k
fix: adds config file and shell script to run storage cloudbuild tests #14022
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,31 @@ | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| set -euxo pipefail | ||||||||||||||||||||||
| echo '--- Installing git and cloning repository on VM ---' | ||||||||||||||||||||||
| sudo apt-get update && sudo apt-get install -y git python3-pip python3-venv | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| # Clone the repository and checkout the specific commit from the build trigger. | ||||||||||||||||||||||
| git clone --no-checkout --depth 1 --sparse --filter=blob:none https://github.com/googleapis/python-docs-samples.git | ||||||||||||||||||||||
iennae marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||||||||||||||||||
| cd python-docs-samples | ||||||||||||||||||||||
| git sparse-checkout set main/storage | ||||||||||||||||||||||
| git fetch origin "refs/pull/${_PR_NUMBER}/head" | ||||||||||||||||||||||
| git checkout ${COMMIT_SHA} | ||||||||||||||||||||||
| cd main/storage | ||||||||||||||||||||||
|
Comment on lines
+8
to
+12
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The directory paths include a
Suggested change
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
|
|
||||||||||||||||||||||
| echo '--- Installing Python and dependencies on VM ---' | ||||||||||||||||||||||
| python3 -m venv env | ||||||||||||||||||||||
| source env/bin/activate | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| echo 'Install testing libraries explicitly, as they are not in setup.py' | ||||||||||||||||||||||
| pip install --upgrade pip | ||||||||||||||||||||||
| pip install pytest pytest-timeout pytest-subtests pytest-asyncio | ||||||||||||||||||||||
| pip install google-cloud-testutils google-cloud-kms | ||||||||||||||||||||||
| pip install -e . | ||||||||||||||||||||||
|
|
||||||||||||||||||||||
| echo '--- Setting up environment variables on VM ---' | ||||||||||||||||||||||
| export ZONAL_BUCKET=${_ZONAL_BUCKET} | ||||||||||||||||||||||
| export RUN_ZONAL_SYSTEM_TESTS=True | ||||||||||||||||||||||
| export GCE_METADATA_MTLS_MODE=None | ||||||||||||||||||||||
| CURRENT_ULIMIT=$(ulimit -n) | ||||||||||||||||||||||
| echo '--- Running Zonal tests on VM with ulimit set to ---' $CURRENT_ULIMIT | ||||||||||||||||||||||
| pytest -vv -s --log-format='%(asctime)s %(levelname)s %(message)s' --log-date-format='%H:%M:%S' samples/snippets/zonal_buckets/zonal_snippets_test.py | ||||||||||||||||||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| substitutions: | ||
| _REGION: "us-central1" | ||
| _ZONE: "us-central1-a" | ||
| _SHORT_BUILD_ID: ${BUILD_ID:0:8} | ||
| _VM_NAME: "py-sdk-sys-test-${_SHORT_BUILD_ID}" | ||
| _ULIMIT: "10000" # 10k, for gRPC bidi streams | ||
|
Comment on lines
+1
to
+6
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Several variables used in the build steps (such as substitutions:
_REGION: "us-central1"
_ZONE: "us-central1-a"
_SHORT_BUILD_ID: ${BUILD_ID:0:8}
_VM_NAME: "py-sdk-sys-test-${_SHORT_BUILD_ID}"
_ULIMIT: "10000" # 10k, for gRPC bidi streams
_ZONAL_VM_SERVICE_ACCOUNT: ""
_ZONAL_BUCKET: ""
_CROSS_REGION_BUCKET: ""
_PR_NUMBER: "" |
||
|
|
||
|
|
||
|
|
||
| steps: | ||
| # Step 0: Generate a persistent SSH key for this build run. | ||
| # This prevents gcloud from adding a new key to the OS Login profile on every ssh/scp command. | ||
| - name: "gcr.io/google.com/cloudsdktool/cloud-sdk" | ||
| id: "generate-ssh-key" | ||
| entrypoint: "bash" | ||
| args: | ||
| - "-c" | ||
| - | | ||
| mkdir -p /workspace/.ssh | ||
| # Generate the SSH key | ||
| ssh-keygen -t rsa -f /workspace/.ssh/google_compute_engine -N '' -C gcb | ||
| # Save the public key content to a file for the cleanup step | ||
| cat /workspace/.ssh/google_compute_engine.pub > /workspace/gcb_ssh_key.pub | ||
| waitFor: ["-"] | ||
|
|
||
| - name: "gcr.io/google.com/cloudsdktool/cloud-sdk" | ||
| id: "cleanup-old-keys" | ||
| entrypoint: "bash" | ||
| args: | ||
| - "-c" | ||
| - | | ||
| #!/bin/bash | ||
| set -e | ||
|
|
||
| echo "Fetching OS Login SSH keys..." | ||
| echo "Removing all keys." | ||
| echo "---------------------------------------------------------------------" | ||
|
|
||
| FINGERPRINTS_TO_DELETE=$$(gcloud compute os-login ssh-keys list \ | ||
| --format="value(fingerprint)") | ||
|
|
||
| echo "Keys to delete: $$FINGERPRINTS_TO_DELETE" | ||
|
|
||
| if [ -z "$$FINGERPRINTS_TO_DELETE" ]; then | ||
| echo "No keys found to delete. Nothing to do." | ||
| exit 0 | ||
| fi | ||
|
|
||
| while IFS= read -r FINGERPRINT; do | ||
| if [ -n "$$FINGERPRINT" ]; then | ||
| echo "Deleting key with fingerprint: $$FINGERPRINT" | ||
| gcloud compute os-login ssh-keys remove \ | ||
| --key="$$FINGERPRINT" \ | ||
| --quiet || true | ||
| fi | ||
| done <<< "$$FINGERPRINTS_TO_DELETE" | ||
|
|
||
| echo "---------------------------------------------------------------------" | ||
| echo "Cleanup complete." | ||
|
Comment on lines
+27
to
+59
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The |
||
|
|
||
| # Step 1 Create a GCE VM to run the tests. | ||
| # The VM is created in the same zone as the buckets to test rapid storage features. | ||
| # It's given the 'cloud-platform' scope to allow it to access GCS and other services. | ||
| - name: "gcr.io/google.com/cloudsdktool/cloud-sdk" | ||
| id: "create-vm" | ||
| entrypoint: "gcloud" | ||
| args: | ||
| - "compute" | ||
| - "instances" | ||
| - "create" | ||
| - "${_VM_NAME}" | ||
| - "--project=${PROJECT_ID}" | ||
| - "--zone=${_ZONE}" | ||
| - "--machine-type=e2-medium" | ||
| - "--image-family=debian-13" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. |
||
| - "--image-project=debian-cloud" | ||
| - "--service-account=${_ZONAL_VM_SERVICE_ACCOUNT}" | ||
| - "--scopes=https://www.googleapis.com/auth/devstorage.full_control,https://www.googleapis.com/auth/devstorage.read_only,https://www.googleapis.com/auth/devstorage.read_write" | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The scopes provided are redundant. - "--scopes=https://www.googleapis.com/auth/cloud-platform" |
||
| - "--metadata=enable-oslogin=TRUE" | ||
| waitFor: ["-"] | ||
|
|
||
| # Step 2: Run the integration tests inside the newly created VM and cleanup. | ||
| # This step uses 'gcloud compute ssh' to execute a remote script. | ||
| # The VM is deleted after tests are run, regardless of success. | ||
| - name: "gcr.io/google.com/cloudsdktool/cloud-sdk" | ||
| id: "run-tests-and-delete-vm" | ||
| entrypoint: "bash" | ||
| args: | ||
| - "-c" | ||
| - | | ||
| set -e | ||
| # Wait for the VM to be fully initialized and SSH to be ready. | ||
| for i in {1..10}; do | ||
| if gcloud compute ssh ${_VM_NAME} --zone=${_ZONE} --internal-ip --ssh-key-file=/workspace/.ssh/google_compute_engine --command="echo VM is ready"; then | ||
| break | ||
| fi | ||
| echo "Waiting for VM to become available... (attempt $i/10)" | ||
| sleep 15 | ||
| done | ||
| # copy the script to the VM | ||
| gcloud compute scp main/storage/cloudbuild/run_zonal_tests.sh ${_VM_NAME}:~ --zone=${_ZONE} --internal-ip --ssh-key-file=/workspace/.ssh/google_compute_engine | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The gcloud compute scp storage/cloudbuild/run_zonal_tests.sh ${_VM_NAME}:~ --zone=${_ZONE} --internal-ip --ssh-key-file=/workspace/.ssh/google_compute_engine |
||
|
|
||
| # Execute the script on the VM via SSH. | ||
| # Capture the exit code to ensure cleanup happens before the build fails. | ||
| set +e | ||
| gcloud compute ssh ${_VM_NAME} --zone=${_ZONE} --internal-ip --ssh-key-file=/workspace/.ssh/google_compute_engine --command="ulimit -n ${_ULIMIT}; COMMIT_SHA=${COMMIT_SHA} _ZONAL_BUCKET=${_ZONAL_BUCKET} CROSS_REGION_BUCKET=${_CROSS_REGION_BUCKET} _PR_NUMBER=${_PR_NUMBER} bash run_zonal_tests.sh" | ||
| EXIT_CODE=$? | ||
| set -e | ||
|
|
||
| echo "--- Deleting GCE VM ---" | ||
| gcloud compute instances delete "${_VM_NAME}" --zone=${_ZONE} --quiet | ||
|
|
||
| # Exit with the original exit code from the test script. | ||
| exit $$EXIT_CODE | ||
| waitFor: | ||
| - "create-vm" | ||
| - "generate-ssh-key" | ||
| - "cleanup-old-keys" | ||
|
|
||
| - name: "gcr.io/google.com/cloudsdktool/cloud-sdk" | ||
| id: "cleanup-ssh-key" | ||
| entrypoint: "bash" | ||
| args: | ||
| - "-c" | ||
| - | | ||
| echo "--- Removing SSH key from OS Login profile to prevent accumulation ---" | ||
| gcloud compute os-login ssh-keys remove \ | ||
| --key-file=/workspace/gcb_ssh_key.pub || true | ||
| waitFor: | ||
| - "run-tests-and-delete-vm" | ||
|
|
||
| timeout: "3600s" # 60 minutes | ||
|
|
||
| options: | ||
| logging: CLOUD_LOGGING_ONLY | ||
| pool: | ||
| name: "projects/${PROJECT_ID}/locations/us-central1/workerPools/cloud-build-worker-pool" | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The shell script is missing a shebang line. It is recommended to start with
#!/bin/bashto ensure it is executed with the correct interpreter.