From e44f5a97d999e88de41aed7d54723354ea8505bf Mon Sep 17 00:00:00 2001
From: John Bley <johnbley@gmail.com>
Date: Tue, 2 Apr 2024 19:54:21 -0400
Subject: [PATCH] Clean up shell scripts (#1269)

* Clean up shell scripts
* Add shellcheck CI step
---
 .github/workflows/shellcheck.yml              | 19 +++++++++++++++++++
 script/proto_gen.sh                           |  4 +++-
 script/semantic-conventions/semconv.sh        | 11 ++++++-----
 .../W3CTestService/trace-context-test.sh      |  3 ++-
 4 files changed, 30 insertions(+), 7 deletions(-)
 create mode 100644 .github/workflows/shellcheck.yml

diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml
new file mode 100644
index 000000000..7cb8f93ed
--- /dev/null
+++ b/.github/workflows/shellcheck.yml
@@ -0,0 +1,19 @@
+name: Shellcheck
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  shellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install shellcheck
+        run: sudo apt update && sudo apt install --assume-yes shellcheck
+
+      - name: Run shellcheck
+        run: find . -name \*.sh | xargs shellcheck --severity=warning
diff --git a/script/proto_gen.sh b/script/proto_gen.sh
index 37bc699e8..1e41ed5b3 100755
--- a/script/proto_gen.sh
+++ b/script/proto_gen.sh
@@ -1,4 +1,6 @@
 #!/usr/bin/env bash
+set -e
+
 DESTINATION_DIR=$(realpath "$(dirname "${BASH_SOURCE[0]}")")/../proto/otel
 GPBMETA_DIR="GPBMetadata"
 OTEL_DIR="Opentelemetry"
@@ -12,7 +14,7 @@ git clone https://github.com/open-telemetry/${REPO_DIR}
   cd ${REPO_DIR}
   git config --add advice.detachedHead false
   TAG=$(
-      TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
+      TAG=$(git describe --tags "`git rev-list --tags --max-count=1`")
 
       git checkout "${TAG}"
 
diff --git a/script/semantic-conventions/semconv.sh b/script/semantic-conventions/semconv.sh
index 824c008cd..b32f4b72f 100755
--- a/script/semantic-conventions/semconv.sh
+++ b/script/semantic-conventions/semconv.sh
@@ -9,6 +9,7 @@
 # Source repositories:
 #  - https://github.com/open-telemetry/semantic-conventions/releases
 #  - https://github.com/open-telemetry/build-tools/releases
+set -e
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 ROOT_DIR="${SCRIPT_DIR}/../../"
@@ -21,18 +22,18 @@ SPEC_VERSION=v$SEMCONV_VERSION
 SCHEMA_URL=https://opentelemetry.io/schemas/$SEMCONV_VERSION
 GENERATOR_VERSION=0.23.0
 
-cd "${SCRIPT_DIR}" || exit
+cd "${SCRIPT_DIR}"
 
-rm -rf "${SPEC_DIR}" || true
+rm -rf "${SPEC_DIR}"
 mkdir "${SPEC_DIR}"
-cd "${SPEC_DIR}" || exit
+cd "${SPEC_DIR}"
 
 git init -b main
 git remote add origin https://github.com/open-telemetry/semantic-conventions.git
 git fetch origin "$SPEC_VERSION"
 git reset --hard FETCH_HEAD
 
-cd "${SCRIPT_DIR}" || exit
+cd "${SCRIPT_DIR}"
 
 mkdir -p "${CODE_DIR}"
 find "${CODE_DIR}" -name "*.php" -exec rm -f {} \;
@@ -101,4 +102,4 @@ docker run --rm \
   -Dclass="Resource" \
   -DschemaUrl=$SCHEMA_URL
 
-rm -rf "${SPEC_DIR}" || true
+rm -rf "${SPEC_DIR}"
diff --git a/tests/TraceContext/W3CTestService/trace-context-test.sh b/tests/TraceContext/W3CTestService/trace-context-test.sh
index c012c0cd7..cf2637a7d 100755
--- a/tests/TraceContext/W3CTestService/trace-context-test.sh
+++ b/tests/TraceContext/W3CTestService/trace-context-test.sh
@@ -1,12 +1,13 @@
 #!/usr/bin/env bash
 set -x
+set -e
 
 function install_symfony() {
     curl -1sLf 'https://dl.cloudsmith.io/public/symfony/stable/setup.alpine.sh' | bash >/dev/null
     apk add symfony-cli
 }
 
-cd "tests/TraceContext/W3CTestService" || { echo "error: could not cd into the W3CTestService directory."; exit 1; }
+cd "tests/TraceContext/W3CTestService"
 
 # Install Symfony: we will use the Symfony server as the built-in PHP server doesn't play well with duplicate headers
 install_symfony