Add support for GCS #138
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,142 @@ | ||||||||
| #!/bin/bash | ||||||||
|
|
||||||||
| if [ -z "${BUILDKITE_PLUGIN_GCS_CACHE_BUCKET}" ]; then | ||||||||
| echo '+++ 🚨 Missing GCS bucket configuration' | ||||||||
| exit 1 | ||||||||
| fi | ||||||||
|
|
||||||||
| # Detect which GCS CLI to use | ||||||||
| detect_gcs_cli() { | ||||||||
| # Check for explicit preference | ||||||||
| if [ -n "${BUILDKITE_PLUGIN_GCS_CACHE_CLI}" ]; then | ||||||||
| echo "${BUILDKITE_PLUGIN_GCS_CACHE_CLI}" | ||||||||
| return | ||||||||
| fi | ||||||||
|
|
||||||||
| # Auto-detect: prefer gcloud storage if available | ||||||||
| if command -v gcloud &>/dev/null && gcloud storage --help &>/dev/null 2>&1; then | ||||||||
| echo "gcloud" | ||||||||
| elif command -v gsutil &>/dev/null; then | ||||||||
| echo "gsutil" | ||||||||
| else | ||||||||
| echo '+++ 🚨 Neither gcloud storage nor gsutil found' >&2 | ||||||||
| exit 1 | ||||||||
| fi | ||||||||
| } | ||||||||
|
|
||||||||
| # Lazy load CLI selection | ||||||||
| get_gcs_cli() { | ||||||||
| if [ -z "${GCS_CLI}" ]; then | ||||||||
| GCS_CLI=$(detect_gcs_cli) | ||||||||
| fi | ||||||||
| echo "${GCS_CLI}" | ||||||||
| } | ||||||||
|
|
||||||||
| build_key() { | ||||||||
| if [ -n "${BUILDKITE_PLUGIN_GCS_CACHE_PREFIX}" ]; then | ||||||||
| echo "${BUILDKITE_PLUGIN_GCS_CACHE_PREFIX}/${1}" | ||||||||
| else | ||||||||
| echo "$1" | ||||||||
| fi | ||||||||
| } | ||||||||
|
|
||||||||
| gcs_cmd() { | ||||||||
| local cmd_args=() | ||||||||
| local cli | ||||||||
| cli=$(get_gcs_cli) | ||||||||
|
|
||||||||
| if [ "${cli}" = "gcloud" ]; then | ||||||||
| cmd_args=(gcloud storage) | ||||||||
| if [ -n "${BUILDKITE_PLUGIN_GCS_CACHE_QUIET}" ]; then | ||||||||
| cmd_args+=(--verbosity=none) | ||||||||
| fi | ||||||||
| else | ||||||||
| cmd_args=(gsutil) | ||||||||
| if [ -n "${BUILDKITE_PLUGIN_GCS_CACHE_QUIET}" ]; then | ||||||||
| cmd_args+=(-q) | ||||||||
| fi | ||||||||
| fi | ||||||||
|
|
||||||||
| "${cmd_args[@]}" "$@" | ||||||||
| } | ||||||||
|
|
||||||||
| gcs_copy() { | ||||||||
| local from="$1" | ||||||||
| local to="$2" | ||||||||
| local use_rsync="${3:-true}" | ||||||||
| local cli | ||||||||
| cli=$(get_gcs_cli) | ||||||||
|
|
||||||||
| if [ "${use_rsync}" = 'true' ]; then | ||||||||
| # Use rsync for directories | ||||||||
| if [ "${cli}" = "gcloud" ]; then | ||||||||
| gcs_cmd rsync -r -d "${from}" "${to}" | ||||||||
| else | ||||||||
| gcs_cmd -m rsync -r -d "${from}" "${to}" | ||||||||
| fi | ||||||||
| else | ||||||||
| # Use cp for single files | ||||||||
| gcs_cmd cp "${from}" "${to}" | ||||||||
| fi | ||||||||
| } | ||||||||
|
|
||||||||
| gcs_exists() { | ||||||||
| local key="$1" | ||||||||
| local full_path="gs://${BUILDKITE_PLUGIN_GCS_CACHE_BUCKET}/$(build_key "${key}")" | ||||||||
|
|
||||||||
| # Check if the object exists using ls | ||||||||
| # For directories, ls will list contents | ||||||||
| # For files, it will return the file path | ||||||||
| if gcs_cmd ls "${full_path}*" &>/dev/null; then | ||||||||
|
Contributor
There was a problem hiding this comment. Would it be possible for us to do this without the wildcard? As this may cause some false positives |
||||||||
| return 0 | ||||||||
| else | ||||||||
| return 1 | ||||||||
| fi | ||||||||
| } | ||||||||
|
|
||||||||
| restore_cache() { | ||||||||
| local from="$1" | ||||||||
| local to="$2" | ||||||||
| local use_rsync='false' | ||||||||
| local key="$(build_key "${from}")" | ||||||||
|
Contributor
There was a problem hiding this comment. Fixes a spellchecker issue
Suggested change
|
||||||||
| local full_path="gs://${BUILDKITE_PLUGIN_GCS_CACHE_BUCKET}/${key}" | ||||||||
|
|
||||||||
| # Check if it's a directory by trying to list it as a prefix | ||||||||
| if gcs_cmd ls "${full_path}/" &>/dev/null; then | ||||||||
|
Contributor
There was a problem hiding this comment. It may be preferable here to use |
||||||||
| use_rsync='true' | ||||||||
| fi | ||||||||
|
|
||||||||
| gcs_copy "${full_path}" "${to}" "${use_rsync}" | ||||||||
| } | ||||||||
|
|
||||||||
| save_cache() { | ||||||||
| local to="$1" | ||||||||
| local from="$2" | ||||||||
| local use_rsync='true' | ||||||||
| local key="$(build_key "${to}")" | ||||||||
|
Contributor
There was a problem hiding this comment. Fixes a spellchecker issue
Suggested change
|
||||||||
| local full_path="gs://${BUILDKITE_PLUGIN_GCS_CACHE_BUCKET}/${key}" | ||||||||
|
|
||||||||
| if [ -f "${from}" ]; then | ||||||||
| use_rsync='false' | ||||||||
| fi | ||||||||
|
|
||||||||
| gcs_copy "${from}" "${full_path}" "${use_rsync}" | ||||||||
| } | ||||||||
|
|
||||||||
| exists_cache() { | ||||||||
| if [ -z "$1" ]; then exit 1; fi | ||||||||
| gcs_exists "$1" | ||||||||
| } | ||||||||
|
|
||||||||
| OPCODE="$1" | ||||||||
| shift | ||||||||
|
|
||||||||
| if [ "$OPCODE" = 'exists' ]; then | ||||||||
| exists_cache "$@" | ||||||||
| elif [ "$OPCODE" = 'get' ]; then | ||||||||
| restore_cache "$@" | ||||||||
| elif [ "$OPCODE" = 'save' ]; then | ||||||||
| save_cache "$@" | ||||||||
| else | ||||||||
| exit 255 | ||||||||
| fi | ||||||||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
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.
Fixes a spellchecker issue