Start checking shell scripts (#579)

Author: nichtich

avram-schemas/validate-schemas

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 validate() {
-  npm run --silent avram -- -s $@
+  npm run --silent avram -- -s "$1"
 }
 
 validate avram-schemas/marc-schema.json

common-script

@@ -55,17 +55,17 @@ filter_params() {
 # run validation
 do_validate() {
   GENERAL_PARAMS="--details --trimId --summary --format csv --defaultRecordType BOOKS"
-  OUTPUT_PARAMS="--outputDir ${OUTPUT_DIR} --detailsFileName issue-details.csv --summaryFileName issue-summary.csv"
+  OUTPUT_PARAMS="--outputDir $OUTPUT_DIR --detailsFileName issue-details.csv --summaryFileName issue-summary.csv"
   PARAMS=$(filter_params "validate")
   log "log file: ${LOG_DIR}/validate.log"
   run validate
-  ./validate ${GENERAL_PARAMS} ${OUTPUT_PARAMS} ${PARAMS} ${MARC_DIR}/$MASK 2> ${LOG_DIR}/validate.log
+  ./validate ${GENERAL_PARAMS} ${OUTPUT_PARAMS} ${PARAMS} "$MARC_DIR/$MASK" 2> "$LOG_DIR/validate.log"
 }
 
 do_prepare_solr() {
   log "log file: ${LOG_DIR}/solr.log"
   run prepare-solr
-  ./prepare-solr $NAME 2> ${LOG_DIR}/solr.log
+  ./prepare-solr "$NAME" 2> "$LOG_DIR/solr.log"
 }
 
 do_index() {
@@ -81,20 +81,20 @@ do_index() {
   # fi
   PARAMS="${PARAMS} --outputDir ${OUTPUT_DIR}"
 
-  ONLY_INDEX=$(echo ${PARAMS} | grep -c -P -e '--onlyIndex' || true)
+  ONLY_INDEX=$(echo "$PARAMS" | grep -c -P -e '--onlyIndex' || true)
   if [[ "${ONLY_INDEX}" == "0" ]]; then
     CORE=${NAME}_dev
   else
-    PARAMS=$(echo ${PARAMS} | sed -r 's/\s*--onlyIndex//')
+    PARAMS=$(echo "$PARAMS" | sed -r 's/\s*--onlyIndex//')
     CORE=${NAME}
   fi
-  ./index --core ${CORE} --file-path ${MARC_DIR} --file-mask $MASK ${PARAMS} --trimId 2>> ${LOG_DIR}/solr.log
+  ./index --core "$CORE" --file-path "$MARC_DIR" --file-mask "$MASK" ${PARAMS} --trimId 2>> "$LOG_DIR/solr.log"
 }
 
 do_postprocess_solr() {
   log "log file: ${LOG_DIR}/solr.log"
   run postprocess-solr
-  ./postprocess-solr $NAME 2>> ${LOG_DIR}/solr.log
+  ./postprocess-solr "$NAME" 2>> "$LOG_DIR/solr.log"
 }
 
 do_completeness() {
@@ -623,7 +623,7 @@ fatal() {
 
 # initialize environment, set default values
 # TODO: remove this because it's already done in ./qa-catalogue)
-NAME=${NAME:-$(basename $0 .sh)}
+NAME=${NAME:-$(basename "$0" .sh)}
 BASE_INPUT_DIR=${BASE_INPUT_DIR:-./input}
 BASE_OUTPUT_DIR=${BASE_OUTPUT_DIR:-./output}
 BASE_LOG_DIR=${BASE_LOG_DIR:-./logs}
@@ -664,22 +664,22 @@ done
 
 # check directories for processing commands
 if [[ "$datatask" = true ]]; then
-  ensure_dir $LOG_DIR
-  ensure_dir $OUTPUT_DIR
+  ensure_dir "$LOG_DIR"  
+  ensure_dir "$OUTPUT_DIR"
 
   log "input:  $MARC_DIR/$MASK"
   log "output: $OUTPUT_DIR"
   log "logs:   $LOG_DIR"
 
-  ls ${MARC_DIR}/${MASK} &> /dev/null || fatal "Missing input files: ${MARC_DIR}/${MASK}!\n"
+  ls "$MARC_DIR/$MASK" &> /dev/null || fatal "Missing input files: $MARC_DIR/$MASK!\n"
 
   if [[ -n "${UPDATE:-}" ]]; then
     log "update: $UPDATE"
-    echo "${UPDATE}" > "${OUTPUT_DIR}/last-update.csv"
+    echo "$UPDATE" > "$OUTPUT_DIR/last-update.csv"
   fi
 fi
 
-echo "tasks: ${tasks}"
+echo "tasks: $tasks"
 for task in ${tasks//,/ }; do
   case $task in
     validate)                 do_validate ; do_validate_sqlite ;;

postprocess-solr

@@ -11,7 +11,7 @@ CORE=$1
 CORE_DEV=${CORE}_dev
 
 # dev -> production
-echo "Swap ${CORE_DEV} to ${CORE}"
-swap_cores ${CORE_DEV} ${CORE}
+echo "Swap $CORE_DEV to $CORE"
+swap_cores "$CORE_DEV" "$CORE"
 
 echo "Solr index swapping DONE"

prepare-solr

@@ -17,25 +17,25 @@ CORE2=${DB}_2
 CORE_PROD=${DB}
 CORE_DEV=${DB}_dev
 
-PROD_EXISTS=$(check_core $CORE_PROD)
+PROD_EXISTS=$(check_core "$CORE_PROD")
 echo "$CORE_PROD exists: $PROD_EXISTS"
 if [[ $PROD_EXISTS != 1 ]]; then
   echo "Create Solr core '$CORE1'"
-  create_core $CORE1
-  prepare_schema $CORE1
-  rename_core $CORE1 $CORE_PROD
+  create_core "$CORE1"
+  prepare_schema "$CORE1"
+  rename_core "$CORE1" "$CORE_PROD"
 fi
 
-DEV_EXISTS=$(check_core $CORE_DEV)
+DEV_EXISTS=$(check_core "$CORE_DEV")
 echo "$CORE_DEV exists: $DEV_EXISTS"
 if [[ $DEV_EXISTS != 1 ]]; then
   echo "Create Solr core '$CORE2'"
-  create_core $CORE2
-  prepare_schema $CORE2
-  rename_core $CORE2 $CORE_DEV
+  create_core "$CORE2"
+  prepare_schema "$CORE2"
+  rename_core "$CORE2" "$CORE_DEV"
 fi
 
 echo "Prepare schema"
-prepare_schema $CORE_DEV
+prepare_schema "$CORE_DEV"
 
 echo "Solr preparation DONE"

qa-catalogue

@@ -97,7 +97,7 @@ ENV_FILE:                 ${ENV_FILE:-}
 EOF
 
 # don't proceed if web configuration shall be updated but cannot do so
-if [[ ! -z "$WEB_CONFIG" ]]; then
+if [[ -n "$WEB_CONFIG" ]]; then
   if [[ ! -f "$WEB_CONFIG" ]]; then
     echo "web configuration file missing: $WEB_CONFIG" >&2
     exit 1
@@ -115,16 +115,16 @@ fail() {
 }
 
 # run actual analysis
-./common-script ${1:-} || fail
+./common-script "${1:-}" || fail
 
 # optionally update web configuration
-if [[ ! -z "$WEB_CONFIG" ]]; then
-  HAS_CATALOGUE=$(grep -cP '^\s*catalogue\s*=' $WEB_CONFIG || true)
-  if [[ $HAS_CATALOGUE == 1 ]]; then
-    grep -vP "^\s*catalogue\s*=" $WEB_CONFIG > /tmp/catalogue
-    mv /tmp/catalogue $WEB_CONFIG
+if [[ -n "$WEB_CONFIG" ]]; then
+  HAS_CATALOGUE=$(grep -cP '^\s*catalogue\s*=' "$WEB_CONFIG" || true)
+  if [[ "$HAS_CATALOGUE" == 1 ]]; then
+    grep -vP "^\s*catalogue\s*=" "$WEB_CONFIG" > /tmp/catalogue
+    mv /tmp/catalogue "$WEB_CONFIG"
   fi
-  echo "catalogue=$CATALOGUE" >> $WEB_CONFIG
+  echo "catalogue=$CATALOGUE" >> "$WEB_CONFIG"
 fi
 
 exit 0

scala/build.sh

@@ -15,9 +15,8 @@ echo "v2: '$VERSION'"
 if [[ -e build.sbt ]]; then
   rm build.sbt
 fi
-ln -s build-2.${VERSION}.tpl build.sbt
+ln -s "build-2.${VERSION}.tpl" build.sbt
 
 sbt clean compile package
 
 exit 0
-