Fix 'source' on scripts in util/ (chapel-lang#26298)

This PR replaces `(dirname $0)` with `(dirname ${BASH_SOURCE[0]})` in
most scripts in `util/`. Using `BASH_SOURCE` allows these scripts to be
`source`-ed from a bash prompt. The previous `$0` would give an
unintended filename, ex. /bin/bash, in this scenario. `BASH_SOURCE` was
already used in many scripts in `util/`.

This PR also replaces `CWD` with `UTIL_CRON_DIR` in `util/cron/`,
addressing part of chapel-lang#25162, in a separate commit.

This PR also removes two "No newline at end of file", in yet another
separate commit.

### Discussion

At first I wanted to exclude those scripts that are unlikely to be
`source`-ed, ex. `start_test`. For such scripts this change can be
considered unnecessary. I gave up because it was difficult to judge.
Also, there is little downside, if any, for making this change even if
it is unnecessary.

I excluded the following scripts because they requested `sh`, not
`bash`, in their `#!` line. I suspect we can switch them to bash and
replace $0 with $BASH_SOURCE for consistency. I am leaving this for
another time.

config/compileline
config/llvmVersions
printchplenv
start_test
test/genGraphs
test/paratest.chapdl
test/sub_test


This post includes a good discussion of `$0` vs. `$BASH_SOURCE` :
    https://stackoverflow.com/questions/35006457/choosing-between-0-and-bash-source

### Correctness testing - BASH_SOURCE

This PR makes only two sets of identical edits, as shows by `sort -u
commit1.diff`: in the context of `CWD=` (93 files) and in the context of
`export CHPL_HOME=` (2 files). I ran `source` on one file in each of the
two groups and checked the execution and/or outcome to verify that the
modified line executed correctly:
```
util/cron/test-cray-xc-arkouda.bash
util/config/run-in-venv-common.bash
```

I also confirmed that the line `CWD=` modified by this PR is identical
to that in 50-some other scripts in util/.

### Correctness testing - UTIL_CRON_DIR

I examined manually the output of `sort -u commit2.diff` and collated
the after-change lines down to:

+$UTIL_CRON_DIR/nightly ......
+$UTIL_CRON_DIR/../buildRelease/gen_release $CHPL_VERSION
+$UTIL_CRON_DIR/../buildRelease/testRelease
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+WORKSPACE=${WORKSPACE:-$UTIL_CRON_DIR/../..}
+cCompiler=`PYTHONPATH=$CHPL_HOME/util/chplenv python3 $UTIL_CRON_DIR/getCompiler.py`
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
+source $UTIL_CRON_DIR/......

The placement of UTIL_CRON_DIR in these lines is correct.

I also ran `source ...../util/cron/common-arkouda.bash` , which is
modified by this commit, and observed correct execution of the
UTIL_CRON_DIR line.

r: @jabraham17

Author: vasslitvinov

util/buildRelease/smokeTest

@@ -7,7 +7,7 @@
 # This should fail as soon as something goes awry.
 set -e
 
-CWD=$(cd $(dirname $0) ; pwd)
+CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 MASON=0
 DOCS=0

util/config/run-in-venv-common.bash

@@ -4,7 +4,7 @@
 
 if [ -z "$CHPL_HOME" ]; then
   # compute the chpl home directory
-  export CHPL_HOME=$(cd $(dirname $0) ; cd ..; cd ..; pwd)
+  export CHPL_HOME=$(cd $(dirname ${BASH_SOURCE[0]}) ; cd ..; cd ..; pwd)
 fi
 
 python=$($CHPL_HOME/util/config/find-python.sh)

util/config/run-in-venv-with-python-bindings.bash

@@ -2,7 +2,7 @@
 # Active the virtual environment (including Python bindings) and run the command supplied
 # usage: ./run-in-venv-with-python-bindings prog [args]
 
-CWD=$(cd $(dirname $0) ; pwd)
+CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 CC=$("$CHPL_HOME/util/printchplenv" --value --only CHPL_HOST_CC)
 PLATFORM=$("$CHPL_HOME/util/printchplenv" --value --only CHPL_HOST_PLATFORM)

util/config/run-in-venv.bash

@@ -2,7 +2,7 @@
 # Active the virtual environment and run the command supplied
 # usage: ./run-in-venv prog [args]
 
-CWD=$(cd $(dirname $0) ; pwd)
+CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 # Perform checks and set up environment variables for virtual env.
 source $CWD/run-in-venv-common.bash

util/cron/common-arkouda.bash

@@ -2,7 +2,7 @@
 #
 # Configure environment for arkouda testing
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 COMMON_DIR=/hpcdc/project/chapel
 if [ ! -d "$COMMON_DIR" ]; then
@@ -13,7 +13,7 @@ fi
 export CHPL_TEST_ARKOUDA_PERF=${CHPL_TEST_ARKOUDA_PERF:-true}
 export CHPL_TEST_GEN_ARKOUDA_GRAPHS=${CHPL_TEST_GEN_ARKOUDA_GRAPHS:-true}
 if [ "${CHPL_TEST_ARKOUDA_PERF}" = "true" ]; then
-  source $CWD/common-perf.bash
+  source $UTIL_CRON_DIR/common-perf.bash
   ARKOUDA_PERF_DIR=${ARKOUDA_PERF_DIR:-$COMMON_DIR/NightlyPerformance/arkouda}
   export CHPL_TEST_PERF_DIR=$ARKOUDA_PERF_DIR/$CHPL_TEST_PERF_CONFIG_NAME
   export CHPL_TEST_NUM_TRIALS=3
@@ -61,18 +61,18 @@ function test_release() {
   git checkout $currentSha -- $CHPL_HOME/util/test/perf/
   git checkout $currentSha -- $CHPL_HOME/util/test/computePerfStats
   git checkout $currentSha -- $CHPL_HOME/third-party/chpl-venv/test-requirements.txt
-  $CWD/nightly -cron ${nightly_args}
+  $UTIL_CRON_DIR/nightly -cron ${nightly_args}
 }
 
 # test against Chapel nightly
 function test_nightly() {
   export CHPL_TEST_PERF_DESCRIPTION=nightly
   export CHPL_TEST_PERF_CONFIGS="release:v,nightly:v"
-  $CWD/nightly -cron ${nightly_args}
+  $UTIL_CRON_DIR/nightly -cron ${nightly_args}
 }
 
 function test_correctness() {
-  $CWD/nightly -cron ${nightly_args}
+  $UTIL_CRON_DIR/nightly -cron ${nightly_args}
 }
 
 function sync_graphs() {

util/cron/common-asan.bash

@@ -2,7 +2,7 @@
 #
 # Configure environment for testing AddressSanitizer.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 export CHPL_MEM=cstdlib
 export CHPL_HOST_MEM=cstdlib

util/cron/common-c-backend.bash

@@ -2,7 +2,7 @@
 #
 # Configure environment for testing C backends
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 # Do not set CHPL_LLVM=none here for all c-backend testing.
 # Generally speaking, we would like for tests of the C backend

util/cron/common-champs.bash

@@ -3,7 +3,7 @@
 # Configure environment for CHAMPS testing
 
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 COMMON_DIR=/cy/users/chapelu
 
 export CHAMPS_COMMON_DIR=$COMMON_DIR/champs-nightly
@@ -23,7 +23,7 @@ module list
 
 module purge
 
-source $CWD/common-perf-hpe-apollo-hdr.bash
+source $UTIL_CRON_DIR/common-perf-hpe-apollo-hdr.bash
 
 module list
 
@@ -41,12 +41,12 @@ module list
 export CHPL_HOST_PLATFORM=hpe-apollo
 export CHPL_TEST_LAUNCHCMD=\$CHPL_HOME/util/test/chpl_launchcmd.py
 export CHPL_LAUNCHER_TIMEOUT=pbs
-source $CWD/load-base-deps.bash
+source $UTIL_CRON_DIR/load-base-deps.bash
 
 module list
 
 # Perf configuration
-source $CWD/common-perf.bash
+source $UTIL_CRON_DIR/common-perf.bash
 CHAMPS_PERF_DIR=${CHAMPS_PERF_DIR:-$COMMON_DIR/NightlyPerformance/champs}
 export CHPL_TEST_PERF_CONFIG_NAME='16-node-apollo-hdr'
 export CHPL_TEST_PERF_DIR=$CHAMPS_PERF_DIR/$CHPL_TEST_PERF_CONFIG_NAME

util/cron/common-cray-cs.bash

@@ -5,7 +5,7 @@
 #             Cray CS system, otherwise silent 
 #  output: iff this seems to be a CS, CHPL_HOST_PLATFORM=cray-cs
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 function loadCSModule()
 {
@@ -24,7 +24,7 @@ if module avail craype- 2>&1 | grep -q craype- ; then
   # that wipes out. In the future this should unload only the unwanted modules,
   # making re-loading necessary.
   module purge
-  source $CWD/load-base-deps.bash
+  source $UTIL_CRON_DIR/load-base-deps.bash
 
   loadCSModule gcc/8.1.0
   loadCSModule cray-fftw

util/cron/common-gasnet.bash

@@ -3,10 +3,10 @@
 # Configure environment for GASNet testing. This should be sourced by other
 # scripts that wish to make use of the variables set here.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
-source $CWD/common.bash
-source $CWD/common-oversubscribed.bash
+source $UTIL_CRON_DIR/common.bash
+source $UTIL_CRON_DIR/common-oversubscribed.bash
 
 export CHPL_COMM=gasnet
 export GASNET_SPAWNFN=L

util/cron/common-hpe-apollo.bash

@@ -2,12 +2,12 @@
 #
 # Configure environment for a HPE Apollo system.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 export CHPL_HOST_PLATFORM=hpe-apollo
 export CHPL_TEST_LAUNCHCMD=\$CHPL_HOME/util/test/chpl_launchcmd.py
 export CHPL_LAUNCHER_TIMEOUT=pbs
 
 module purge
-source $CWD/load-base-deps.bash
+source $UTIL_CRON_DIR/load-base-deps.bash
 module load gcc

util/cron/common-hpe-cray-ex.bash

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 module unload $(module --terse list 2>&1 | grep PrgEnv-)
 

util/cron/common-llvm.bash

@@ -3,11 +3,11 @@
 # Setup environment for LLVM testing.
 #
 # We examine the first commandline parameter,
-#   $ source $CWD/common-llvm.bash system # $1 is "system", for example
+#   $ source $UTIL_CRON_DIR/common-llvm.bash system # $1 is "system", for example
 # if $1 is "bundled" or "system", we set CHPL_LLVM = $1
 # all other cases, we set CHPL_LLVM = "bundled" for backward-compatibility
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 # set CHPL_LLVM = "bundled" or "system", based on $1 if any
 # (default CHPL_LLVM = "bundled", and CHPL_LLVM = "none" is not allowed)

util/cron/common-mpicc.bash

@@ -2,8 +2,8 @@
 #
 # Configure environment for MPI module testing on linux64
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
-source $CWD/common.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/common.bash
 
 # Currently, only fifo supported for MPI module
 export CHPL_TASKS=fifo

util/cron/common-native-gpu.bash

@@ -1,6 +1,6 @@
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
-source $CWD/common.bash
+source $UTIL_CRON_DIR/common.bash
 
 # Use latest system LLVM, to use an earlier version uncomment and pass version
 # number as a parameter to the script.

util/cron/common-ofi.bash

@@ -3,7 +3,7 @@
 # Configure environment for CHPL_COMM=ofi testing.
 
 if [[ $($CHPL_HOME/util/chplenv/chpl_platform.py --target) != *cray-* ]] ; then
-  source $CWD/common-oversubscribed.bash
+  source $UTIL_CRON_DIR/common-oversubscribed.bash
 fi
 
 export CHPL_COMM=ofi

util/cron/common-perf.bash

@@ -3,9 +3,9 @@
 # Configure environment for performance testing. This should be sourced by other
 # scripts that wish to make use of the variables set here.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
-source $CWD/common.bash
-source $CWD/common-fast.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/common.bash
+source $UTIL_CRON_DIR/common-fast.bash
 
 # It is tempting to use hostname --short, but macs only support the short form
 # of the argument.

util/cron/common-qthreads.bash

@@ -3,11 +3,11 @@
 # Configure environment for qthreads testing. This should be sourced by other
 # scripts that wish to make use of the variables set here.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 comm=$($CHPL_HOME/util/chplenv/chpl_comm.py)
 if [ "${comm}" != "none" ] ; then
-    source $CWD/common-oversubscribed.bash
+    source $UTIL_CRON_DIR/common-oversubscribed.bash
 fi
 
 export CHPL_TASKS=qthreads

util/cron/common-quickstart.bash

@@ -3,8 +3,8 @@
 # Configure environment for quickstart testing. This should be sourced by other
 # scripts that wish to make use of the variables set here.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
-source $CWD/common.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/common.bash
 source ${CHPL_HOME}/util/quickstart/setchplenv.bash
 
 # Skip $CHPL_HOME/test/regex/elliot/I-fail-without-re2

util/cron/common-tarball.bash

@@ -1,8 +1,8 @@
 #!/usr/bin/env bash
 #
-source $CWD/common.bash
+source $UTIL_CRON_DIR/common.bash
 
-export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
 log_info "Setting CHPL_HOME to: ${CHPL_HOME}"
 
 # Load functions for getting version information from the source tree

util/cron/common-valgrind.bash

@@ -2,11 +2,11 @@
 #
 # Configure environment for testing valgrind.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
 # qthreads doesn't work with valgrind, so use fifo and limit running threads to
 # stay below valgrind's --max-threads option, which defaults to 500
-source $CWD/common-fifo.bash
+source $UTIL_CRON_DIR/common-fifo.bash
 export CHPL_RT_NUM_THREADS_PER_LOCALE=450
 export CHPL_RT_NUM_THREADS_PER_LOCALE_QUIET=yes
 

util/cron/common-whitebox.bash

@@ -15,8 +15,8 @@
 #
 # The default is cray-xc
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
-source $CWD/functions.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/functions.bash
 
 # Ensure module commands are available.
 local_bashrc=/etc/bash.bashrc.local
@@ -116,7 +116,7 @@ module unload cray-mpich
 log_info "Unloading atp module"
 module unload atp
 
-export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
 
 # Set CHPL_HOST_COMPILER.
 if [ -n "${chpl_host_value}" ] ; then

util/cron/common.bash

@@ -3,10 +3,10 @@
 # This should be sourced by other scripts that wish to make use of the
 # variables set here.
 
-CWD=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
-source $CWD/functions.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/functions.bash
 
-source $CWD/load-base-deps.bash
+source $UTIL_CRON_DIR/load-base-deps.bash
 
 log_info "gcc version: $(which gcc)"
 gcc --version
@@ -63,7 +63,7 @@ function with_logging()
 if [ "${CHPL_HOME+x}" = "x" ] ; then
     log_info "CHPL_HOME is already set to: ${CHPL_HOME}"
 else
-    export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+    export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
     log_info "CHPL_HOME is not set. Defaulting to: ${CHPL_HOME}"
 fi
 log_info "CHPL_HOME is: ${CHPL_HOME}"

util/cron/create_release_aptrpm.bash

@@ -24,11 +24,11 @@ if [ -z "$DOCKER_DIR_NAME" ]; then echo "DOCKER_DIR_NAME must be set."; exit 1;
 PARALLEL=${PARALLEL:-1}
 
 
-CWD=$(cd $(dirname $0) ; pwd)
-source $CWD/common.bash
-source $CWD/functions.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/common.bash
+source $UTIL_CRON_DIR/functions.bash
 
-export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
 log_info "Setting CHPL_HOME to: ${CHPL_HOME}"
 
 # if any errors occur, this script should fail

util/cron/create_release_tarball.bash

@@ -8,9 +8,9 @@
 # TARBALL_DIR can optionally be set in the environment. If set, the tarball
 # will be copied to that directory after it is built.
 
-CWD=$(cd $(dirname $0) ; pwd)
-source $CWD/common.bash
-source $CWD/functions.bash
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
+source $UTIL_CRON_DIR/common.bash
+source $UTIL_CRON_DIR/functions.bash
 
 if [ "${CHPL_VERSION+x}" != "x" ] ; then
     log_error "CHPL_VERSION must be set in the environment."
@@ -23,7 +23,7 @@ else
     no_tarball_dir=true
 fi
 
-export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
 log_info "Setting CHPL_HOME to: ${CHPL_HOME}"
 
 # Allow caller to tell this script to detect the current version based on the
@@ -51,7 +51,7 @@ log_info "Using release branch: ${CHPL_GEN_RELEASE_BRANCH}"
 
 tarball_output="${CHPL_HOME}/tar/chapel-${CHPL_VERSION}.tar.gz"
 
-$CWD/../buildRelease/gen_release $CHPL_VERSION
+$UTIL_CRON_DIR/../buildRelease/gen_release $CHPL_VERSION
 
 if [ "${no_tarball_dir}" != "true" ] ; then
     expected_loc="${TARBALL_DIR}/$(basename ${tarball_output})"

util/cron/create_tarball.bash

@@ -5,15 +5,15 @@
 #
 # The tarball is left in root of repo in tar/ directory.
 
-CWD=$(cd $(dirname $0) ; pwd)
+UTIL_CRON_DIR=$(cd $(dirname ${BASH_SOURCE[0]}) ; pwd)
 
-source $CWD/common-tarball.bash
+source $UTIL_CRON_DIR/common-tarball.bash
 
 # Tell gen_release to use existing repo instead of creating a new one with
 # git-archive.
 export CHPL_GEN_RELEASE_NO_CLONE=true
 
-export CHPL_HOME=$(cd $CWD/../.. ; pwd)
+export CHPL_HOME=$(cd $UTIL_CRON_DIR/../.. ; pwd)
 log_info "Setting CHPL_HOME to: ${CHPL_HOME}"
 
 export CHPL_LLVM=none