Merge pull request #10585 from ethereum/fix-quoting-and-whitespace-in-shell-scripts

Fix quoting in shell scripts

Author: Leonardo

.circleci/soltest.sh

@@ -36,7 +36,7 @@ set -e
 
 OPTIMIZE=${OPTIMIZE:-"0"}
 EVM=${EVM:-"invalid"}
-REPODIR="$(realpath $(dirname $0)/..)"
+REPODIR="$(realpath "$(dirname "$0")/..")"
 
 source "${REPODIR}/scripts/common.sh"
 # Test result output directory (CircleCI is reading test results from here)
@@ -60,4 +60,4 @@ test "${ABI_ENCODER_V1}" = "1" && SOLTEST_ARGS="${SOLTEST_ARGS} --abiencoderv1"
 
 echo "Running ${REPODIR}/build/test/soltest ${BOOST_TEST_ARGS} -- ${SOLTEST_ARGS}"
 
-${REPODIR}/build/test/soltest ${BOOST_TEST_ARGS} -- ${SOLTEST_ARGS}
+"${REPODIR}/build/test/soltest" ${BOOST_TEST_ARGS} -- ${SOLTEST_ARGS}

.circleci/soltest_all.sh

@@ -26,7 +26,7 @@
 # ------------------------------------------------------------------------------
 set -e
 
-REPODIR="$(realpath $(dirname $0)/..)"
+REPODIR="$(realpath "$(dirname "$0")"/..)"
 
 EVM_VALUES=(homestead byzantium constantinople petersburg istanbul)
 OPTIMIZE_VALUES=(0 1)
@@ -65,9 +65,9 @@ STEP=$(($STEP + 1))
 [[ " $RUN_STEPS " =~ " $STEP " ]] && EVM=istanbul OPTIMIZE=1 ABI_ENCODER_V1=1 BOOST_TEST_ARGS="-t !smtCheckerTests" "${REPODIR}/.circleci/soltest.sh"
 STEP=$(($STEP + 1))
 
-for OPTIMIZE in ${OPTIMIZE_VALUES[@]}
+for OPTIMIZE in "${OPTIMIZE_VALUES[@]}"
 do
-    for EVM in ${EVM_VALUES[@]}
+    for EVM in "${EVM_VALUES[@]}"
     do
         # run tests against hera ewasm evmc vm, only if OPTIMIZE == 0 and evm version is byzantium
         EWASM_ARGS=""

scripts/ASTImportTest.sh

@@ -16,7 +16,7 @@ SPLITSOURCES=${REPO_ROOT}/scripts/splitSources.py
 
 SYNTAXTESTS_DIR="${REPO_ROOT}/test/libsolidity/syntaxTests"
 ASTJSONTESTS_DIR="${REPO_ROOT}/test/libsolidity/ASTJSON"
-NSOURCES="$(find $SYNTAXTESTS_DIR -type f | wc -l)"
+NSOURCES="$(find "$SYNTAXTESTS_DIR" -type f | wc -l)"
 
 # DEV_DIR="${REPO_ROOT}/../tmp/contracts/"
 # NSOURCES="$(find $DEV_DIR -type f | wc -l)" #TODO use find command
@@ -25,7 +25,7 @@ FAILED=0
 UNCOMPILABLE=0
 TESTED=0
 
-if [ $(ls | wc -l) -ne 0 ]; then
+if [ "$(ls | wc -l)" -ne 0 ]; then
     echo "Test directory not empty. Skipping!"
     exit -1
 fi
@@ -37,10 +37,10 @@ fi
 # $1 name of the file to be exported and imported
 # $2 any files needed to do so that might be in parent directories
 function testImportExportEquivalence {
-    if $SOLC $1 $2 > /dev/null 2>&1
+    if $SOLC "$1" $2 > /dev/null 2>&1
     then
         # save exported json as expected result (silently)
-        $SOLC --combined-json ast,compact-format --pretty-json $1 $2> expected.json 2> /dev/null
+        $SOLC --combined-json ast,compact-format --pretty-json "$1" $2 > expected.json 2> /dev/null
         # import it, and export it again as obtained result (silently)
         $SOLC --import-ast --combined-json ast,compact-format --pretty-json expected.json > obtained.json 2> /dev/null
         if [ $? -ne 0 ]
@@ -81,15 +81,15 @@ echo "Looking at $NSOURCES .sol files..."
 WORKINGDIR=$PWD
 
 # for solfile in $(find $DEV_DIR -name *.sol)
-for solfile in $(find $SYNTAXTESTS_DIR $ASTJSONTESTS_DIR -name *.sol)
+for solfile in $(find "$SYNTAXTESTS_DIR" "$ASTJSONTESTS_DIR" -name *.sol)
 do
     echo -n "."
     # create a temporary sub-directory
     FILETMP=$(mktemp -d)
-    cd $FILETMP
+    cd "$FILETMP"
 
     set +e
-    OUTPUT=$($SPLITSOURCES $solfile)
+    OUTPUT=$("$SPLITSOURCES" "$solfile")
     SPLITSOURCES_RC=$?
     set -e
     if [ ${SPLITSOURCES_RC} == 0 ]
@@ -103,29 +103,29 @@ do
         done
     elif [ ${SPLITSOURCES_RC} == 1 ]
     then
-        testImportExportEquivalence $solfile
+        testImportExportEquivalence "$solfile"
     elif [ ${SPLITSOURCES_RC} == 2 ]
     then
         # The script will exit with return code 2, if an UnicodeDecodeError occurred.
         # This is the case if e.g. some tests are using invalid utf-8 sequences. We will ignore
         # these errors, but print the actual output of the script.
         echo -e "\n${OUTPUT}\n"
-        testImportExportEquivalence $solfile
+        testImportExportEquivalence "$solfile"
     else
         # All other return codes will be treated as critical errors. The script will exit.
         echo -e "\nGot unexpected return code ${SPLITSOURCES_RC} from ${SPLITSOURCES}. Aborting."
         echo -e "\n${OUTPUT}\n"
 
-        cd $WORKINGDIR
+        cd "$WORKINGDIR"
         # Delete temporary files
-        rm -rf $FILETMP
+        rm -rf "$FILETMP"
 
         exit 1
     fi
 
-    cd $WORKINGDIR
+    cd "$WORKINGDIR"
     # Delete temporary files
-    rm -rf $FILETMP
+    rm -rf "$FILETMP"
 done
 
 echo ""

scripts/build_emscripten.sh

@@ -35,6 +35,6 @@ else
 fi
 
 # solbuildpackpusher/solidity-buildpack-deps:emscripten-4
-docker run -v $(pwd):/root/project -w /root/project \
+docker run -v "$(pwd):/root/project" -w /root/project \
     solbuildpackpusher/solidity-buildpack-deps@sha256:434719d8104cab47712dd1f56f255994d04eb65b802c0d382790071c1a0c074b \
-    ./scripts/ci/build_emscripten.sh $BUILD_DIR
+    ./scripts/ci/build_emscripten.sh "$BUILD_DIR"

scripts/bytecodecompare/storebytecode.sh

@@ -46,7 +46,7 @@ TMPDIR=$(mktemp -d)
         git clone --depth 1 https://github.com/ethereum/solc-js.git solc-js
         ( cd solc-js; npm install )
         cp "$REPO_ROOT/emscripten_build/libsolc/soljson.js" solc-js/
-        cp ""$REPO_ROOT"/scripts/bytecodecompare/prepare_report.js" .
+        cp "$REPO_ROOT/scripts/bytecodecompare/prepare_report.js" .
         echo "Running the compiler..."
         ./prepare_report.js *.sol > report.txt
         echo "Finished running the compiler."

scripts/chk_shellscripts/chk_shellscripts.sh

@@ -17,8 +17,8 @@ find . -type f -name "*.sh" | sort >"${FOUND_FILES_TMP}"
 
 SHELLCHECK=${SHELLCHECK:-"$(command -v -- shellcheck)"}
 if [ ! -f "${SHELLCHECK}" ]; then
-  echo "error: shellcheck '${SHELLCHECK}' not found."
-  exit 1
+    echo "error: shellcheck '${SHELLCHECK}' not found."
+    exit 1
 fi
 
 FILES=$(join -v2 "${IGNORE_FILES_TMP}" "${FOUND_FILES_TMP}")

scripts/chk_shellscripts/ignore.txt

@@ -1,39 +1,21 @@
-./test/docsCodeStyle.sh
 ./test/cmdlineTests.sh
-./scripts/isoltest.sh
-./scripts/get_version.sh
 ./scripts/soltest.sh
-./scripts/test_emscripten.sh
 ./scripts/wasm-rebuild/docker-scripts/rebuild_tags.sh
 ./scripts/wasm-rebuild/docker-scripts/rebuild_current.sh
 ./scripts/wasm-rebuild/docker-scripts/genbytecode.sh
-./scripts/wasm-rebuild/docker-scripts/patch.sh
-./scripts/wasm-rebuild/rebuild.sh
-./scripts/build_emscripten.sh
 ./scripts/ci/build_emscripten.sh
-./scripts/docker_build.sh
 ./scripts/docs_version_pragma_check.sh
 ./scripts/uniqueErrors.sh
 ./scripts/tests.sh
-./scripts/docker_deploy.sh
 ./scripts/bytecodecompare/storebytecode.sh
 ./scripts/deps-ppa/static_z3.sh
 ./scripts/ASTImportTest.sh
 ./scripts/install_static_z3.sh
-./scripts/install_obsolete_jsoncpp_1_7_4.sh
 ./scripts/install_deps.sh
-./scripts/build.sh
-./scripts/run_proofs.sh
 ./scripts/common_cmdline.sh
 ./scripts/docker_deploy_manual.sh
 ./scripts/endToEndExtraction/create_traces.sh
-./scripts/release.sh
-./scripts/download_ossfuzz_corpus.sh
 ./scripts/release_ppa.sh
-./scripts/install_cmake.sh
-./scripts/release_emscripten.sh
 ./scripts/create_source_tarball.sh
-./scripts/docs.sh
 ./.circleci/soltest.sh
-./.circleci/osx_install_dependencies.sh
 ./.circleci/soltest_all.sh

scripts/ci/build_emscripten.sh

@@ -59,13 +59,13 @@ then
 	echo -n "$CIRCLE_SHA1" >commit_hash.txt
 fi
 
-mkdir -p $BUILD_DIR
-cd $BUILD_DIR
+mkdir -p "$BUILD_DIR"
+cd "$BUILD_DIR"
 emcmake cmake \
-  -DCMAKE_BUILD_TYPE=Release \
-  -DBoost_USE_STATIC_LIBS=1 \
-  -DBoost_USE_STATIC_RUNTIME=1 \
-  -DTESTS=0 \
+	-DCMAKE_BUILD_TYPE=Release \
+	-DBoost_USE_STATIC_LIBS=1 \
+	-DBoost_USE_STATIC_RUNTIME=1 \
+	-DTESTS=0 \
   ..
 make soljson
 # Patch soljson.js for backwards compatibility.
@@ -75,8 +75,8 @@ sed -i -e 's/addFunction(func,sig){/addFunction(func,sig){sig=sig||"viiiii";/' l
 
 cd ..
 mkdir -p upload
-cp $BUILD_DIR/libsolc/soljson.js upload/
-cp $BUILD_DIR/libsolc/soljson.js ./
+cp "$BUILD_DIR/libsolc/soljson.js" upload/
+cp "$BUILD_DIR/libsolc/soljson.js" ./
 
 OUTPUT_SIZE=`ls -la soljson.js`
 

scripts/common_cmdline.sh

@@ -39,8 +39,8 @@ function compileFull()
     fi
     local args=$FULLARGS
     if [[ $1 = '-v' ]]; then
-        if (echo $2 | grep -Po '(?<=0.4.)\d+' >/dev/null); then
-            patch=$(echo $2 | grep -Po '(?<=0.4.)\d+')
+        if (echo "$2" | grep -Po '(?<=0.4.)\d+' >/dev/null); then
+            patch=$(echo "$2" | grep -Po '(?<=0.4.)\d+')
             if (( patch < 22 )); then
                 args=$OLDARGS
             fi

scripts/deps-ppa/static_z3.sh

@@ -32,9 +32,9 @@ DISTRIBUTIONS="focal groovy"
 for distribution in $DISTRIBUTIONS
 do
 cd /tmp/
-rm -rf $distribution
-mkdir $distribution
-cd $distribution
+rm -rf "$distribution"
+mkdir "$distribution"
+cd "$distribution"
 
 pparepo=cpp-build-deps
 ppafilesurl=https://launchpad.net/~ethereum/+archive/ubuntu/${pparepo}/+files
@@ -190,7 +190,7 @@ echo "3.0 (quilt)" > debian/source/format
 chmod +x debian/rules
 
 versionsuffix=1ubuntu0~${distribution}
-EMAIL="$email" dch -v 1:${debversion}-${versionsuffix} "build of ${version}"
+EMAIL="$email" dch -v "1:${debversion}-${versionsuffix}" "build of ${version}"
 
 # build source package
 # If packages is rejected because original source is already present, add
@@ -199,13 +199,13 @@ EMAIL="$email" dch -v 1:${debversion}-${versionsuffix} "build of ${version}"
 debuild -S -d -sa -us -uc
 
 # prepare .changes file for Launchpad
-sed -i -e s/UNRELEASED/${distribution}/ -e s/urgency=medium/urgency=low/ ../*.changes
+sed -i -e "s/UNRELEASED/${distribution}/" -e s/urgency=medium/urgency=low/ ../*.changes
 
 # check if ubuntu already has the source tarball
 (
 cd ..
-orig=${packagename}_${debversion}.orig.tar.gz
-orig_size=$(ls -l $orig | cut -d ' ' -f 5)
+orig="${packagename}_${debversion}.orig.tar.gz"
+orig_size=$(ls -l "$orig" | cut -d ' ' -f 5)
 orig_sha1=$(sha1sum $orig | cut -d ' ' -f 1)
 orig_sha256=$(sha256sum $orig | cut -d ' ' -f 1)
 orig_md5=$(md5sum $orig | cut -d ' ' -f 1)
@@ -218,15 +218,15 @@ then
     new_sha1=$(sha1sum $orig | cut -d ' ' -f 1)
     new_sha256=$(sha256sum $orig | cut -d ' ' -f 1)
     new_md5=$(md5sum $orig | cut -d ' ' -f 1)
-    sed -i -e s,$orig_sha1,$new_sha1,g -e s,$orig_sha256,$new_sha256,g -e s,$orig_size,$new_size,g -e s,$orig_md5,$new_md5,g *.dsc
-    sed -i -e s,$orig_sha1,$new_sha1,g -e s,$orig_sha256,$new_sha256,g -e s,$orig_size,$new_size,g -e s,$orig_md5,$new_md5,g *.changes
+    sed -i -e "s,$orig_sha1,$new_sha1,g" -e "s,$orig_sha256,$new_sha256,g" -e "s,$orig_size,$new_size,g" -e "s,$orig_md5,$new_md5,g" *.dsc
+    sed -i -e "s,$orig_sha1,$new_sha1,g" -e "s,$orig_sha256,$new_sha256,g" -e "s,$orig_size,$new_size,g" -e "s,$orig_md5,$new_md5,g" *.changes
 fi
 )
 
 # sign the package
-debsign --re-sign -k ${keyid} ../${packagename}_${debversion}-${versionsuffix}_source.changes
+debsign --re-sign -k "${keyid}" "../${packagename}_${debversion}-${versionsuffix}_source.changes"
 
 # upload
-dput ${pparepo} ../${packagename}_${debversion}-${versionsuffix}_source.changes
+dput "${pparepo}" "../${packagename}_${debversion}-${versionsuffix}_source.changes"
 
 done