Skip to content

Commit

Permalink
scripts: minor refactor to scripts (#7403)
Browse files Browse the repository at this point in the history
  • Loading branch information
arvindbr8 authored Jul 12, 2024
1 parent e7d8822 commit c5c0e18
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 79 deletions.
File renamed without changes.
91 changes: 91 additions & 0 deletions scripts/install-protoc.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
#!/bin/bash
#
# Copyright 2024 gRPC authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# install-protoc.sh
#
# This script installs the Protocol Buffers compiler (protoc) on the local
# machine. It is used to generate code from .proto files for gRPC communication.
# The script downloads the protoc binary from the official GitHub repository and
# installs it in the system.
#
# Usage: ./install-protoc.sh [INSTALL_PATH]
#
# Arguments:
# INSTALL_PATH: The path where the protoc binary will be installed (optional).
# If not provided, the script will install the binary in the the
# directory named by the GOBIN environment variable, which
# defaults to $GOPATH/bin or $HOME/go/bin if the GOPATH
# environment variable is not set.
#
# Note: This script requires internet connectivity to download the protoc binary.

set -eu -o pipefail

source "$(dirname $0)/common.sh"

# The version of protoc that will be installed.
PROTOC_VERSION="27.1"

INSTALL_PATH="${1:-${GOBIN:-${GOPATH:-$HOME/go}}}"

# downloads the pre-built binaries for Linux to $INSTALL_PATH.
# Usage:
# download_binary ARCH OS
# Arguments:
# ARCH: The architecture of the system. Accepted values: [x86_64, aarch_64]
# OS: The operating system of the system. Accepted values: [osx, linux]
download_binary() {
DOWNLOAD_URL="https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/protoc-${PROTOC_VERSION}-$2-$1.zip"
# -L follows redirects.
# -O writes output to a file.
curl -LO "${DOWNLOAD_URL}"
unzip "protoc-${PROTOC_VERSION}-$2-$1.zip" -d "${INSTALL_PATH}"
rm "protoc-${PROTOC_VERSION}-$2-$1.zip"
rm "${INSTALL_PATH}/readme.txt"
}

main() {
# Check if protoc is already available.
if command -v protoc &> /dev/null; then
if INSTALL_VERSION=$(protoc --version | cut -d' ' -f2 2>/dev/null); then
if [ "$INSTALL_VERSION" = "$PROTOC_VERSION" ]; then
echo "protoc version $PROTOC_VERSION is already installed."
return
else
die "Existing protoc version ($INSTALL_VERSION) differs. Kindly make sure you have $PROTOC_VERSION installed."
fi
fi
fi

# Detect the architecture
case "$(uname -m)" in
"x86_64") ARCH="x86_64";;
"aarch64") ARCH="aarch_64";;
"arm64") ARCH="aarch_64";;
*) die "Unsupported architecture. Please consider manual installation from "\
"https://github.com/protocolbuffers/protobuf/releases/ and add to PATH."
esac

# Detect the Operating System
case "$(uname -s)" in
"Darwin") download_binary $ARCH "osx";;
"Linux") download_binary $ARCH "linux";;
*) die "Unsupported OS. Please consider manual installation from "\
"https://github.com/protocolbuffers/protobuf/releases/ and add to PATH" ;;
esac
}

main "$@"
69 changes: 0 additions & 69 deletions scripts/install_protoc.sh

This file was deleted.

10 changes: 4 additions & 6 deletions scripts/regenerate.sh
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,12 @@ WORKDIR=$(mktemp -d)

function finish {
rm -rf "$WORKDIR"
# Revert back the PATH to client's original value
export PATH=$ORIGINAL_PATH
}
trap finish EXIT

GOBIN="${WORKDIR}"/bin
ORIGINAL_PATH=$PATH
./scripts/install-protoc.sh "${WORKDIR}"

export GOBIN="${WORKDIR}"/bin
export PATH="${GOBIN}:${PATH}"
mkdir -p "${GOBIN}"

Expand All @@ -51,7 +50,6 @@ mkdir -p "${WORKDIR}/googleapis/google/rpc"
echo "curl https://raw.githubusercontent.com/googleapis/googleapis/master/google/rpc/code.proto"
curl --silent https://raw.githubusercontent.com/googleapis/googleapis/master/google/rpc/code.proto > "${WORKDIR}/googleapis/google/rpc/code.proto"

source ./scripts/install_protoc.sh $WORKDIR

mkdir -p "${WORKDIR}/out"

Expand Down Expand Up @@ -98,7 +96,7 @@ Mgrpc/testing/empty.proto=google.golang.org/grpc/interop/grpc_testing

for src in ${SOURCES[@]}; do
echo "protoc ${src}"
protoc --go_out=${OPTS}:${WORKDIR}/out --go-grpc_out=${OPTS},use_generic_streams_experimental=true:${WORKDIR}/out \
protoc --go_out=${OPTS}:${WORKDIR}/out --go-grpc_out=${OPTS}:${WORKDIR}/out \
-I"." \
-I"${WORKDIR}/grpc-proto" \
-I"${WORKDIR}/googleapis" \
Expand Down
6 changes: 3 additions & 3 deletions scripts/vet-proto.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ set -ex # Exit on error; debugging enabled.
set -o pipefail # Fail a pipe if any sub-command fails.

# - Source them sweet sweet helpers.
source "$(dirname $0)/vet-common.sh"
source "$(dirname $0)/common.sh"

# - Check to make sure it's safe to modify the user's git repo.
git status --porcelain | fail_on_output
Expand All @@ -21,9 +21,9 @@ trap cleanup EXIT
# go.)
if [[ "$1" = "-install" ]]; then
if [[ "${GITHUB_ACTIONS}" = "true" ]]; then
source ./scripts/install_protoc.sh "/home/runner/go"
source ./scripts/install-protoc.sh "/home/runner/go"
else
die "run protoc installer https://github.com/grpc/grpc-go/blob/master/scripts/install_protoc.sh"
die "run protoc installer https://github.com/grpc/grpc-go/blob/master/scripts/install-protoc.sh"
fi
echo SUCCESS
exit 0
Expand Down
2 changes: 1 addition & 1 deletion scripts/vet.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
set -ex # Exit on error; debugging enabled.
set -o pipefail # Fail a pipe if any sub-command fails.

source "$(dirname $0)/vet-common.sh"
source "$(dirname $0)/common.sh"

# Check to make sure it's safe to modify the user's git repo.
git status --porcelain | fail_on_output
Expand Down

0 comments on commit c5c0e18

Please sign in to comment.