Add shellcheck checks

Adam Parkin · Adam Parkin · commit c32453f5796e · 2018-04-02T20:29:20.000-07:00
diff --git a/Dockerfile b/Dockerfile
@@ -1,17 +1,19 @@
-FROM alpine:latest
+FROM koalaman/shellcheck-alpine
 
 WORKDIR /build
 
 RUN apk add --no-cache --update \
     python3 nodejs
 
 RUN python3 -m ensurepip
+RUN pip3 install --upgrade pip
 
 RUN npm install -g markdownlint-cli
 
 COPY requirements.txt /build/requirements.txt
 RUN pip3 install -r requirements.txt
 
+COPY *.sh /build/shell/
 COPY .markdownlint.json /build/content/
 COPY *.py /build/python/
 COPY content/ /build/content/
diff --git a/Makefile b/Makefile
@@ -39,6 +39,8 @@ help:
 	@echo '   make s3_upload                      upload the web site via S3         '
 	@echo '   make markdownlint                   run markdownlint on content        '
 	@echo '   make pylint                         run pylint on content              '
+	@echo '   make shellcheck                     run shellcheck on all the scripts  '
+	@echo '   make lint_the_things                run all linters & checks           '
 	@echo '   make dockerbuild                    build docker image                 '
 	@echo '   make dockerrun                      run a shell in built Docker image  '
 	@echo '                                                                          '
@@ -87,15 +89,20 @@ publish:
 	$(PELICAN) $(INPUTDIR) -o $(OUTPUTDIR) -s $(PUBLISHCONF) $(PELICANOPTS)
 	if test -d $(BASEDIR)/extra; then cp $(BASEDIR)/extra/* $(OUTPUTDIR)/; fi
 
-s3_upload: publish markdownlint pylint
+s3_upload: publish lint_the_things
 	aws s3 sync $(OUTPUTDIR) s3://$(S3_BUCKET) --delete $(S3OPTS)
 
+lint_the_things: markdownlint pylint shellcheck
+
 markdownlint: dockerbuild
 	docker run --rm -it -w /build/content $(DOCKER_IMAGE_NAME):latest markdownlint .
 
 pylint: dockerbuild
 	docker run --rm -it -w /build/python $(DOCKER_IMAGE_NAME):latest pylint *.py
 
+shellcheck: dockerbuild
+	docker run --rm -it -w /build/shell $(DOCKER_IMAGE_NAME):latest shellcheck *.sh
+
 dockerbuild:
 	docker build -t $(DOCKER_IMAGE_NAME):latest .
 
diff --git a/develop_server.sh b/develop_server.sh
@@ -28,55 +28,55 @@ function usage(){
 }
 
 function alive() {
-  kill -0 $1 >/dev/null 2>&1
+  kill -0 "$1" >/dev/null 2>&1
 }
 
 function shut_down(){
-  PID=$(cat $SRV_PID)
-  if [[ $? -eq 0 ]]; then
-    if alive $PID; then
+  PID=$(cat "$SRV_PID")
+  if [ -z "$PID" ]; then
+    echo "HTTP server PIDFile not found"
+  else
+    if alive "$PID"; then
       echo "Stopping HTTP server"
-      kill $PID
+      kill "$PID"
     else
       echo "Stale PID, deleting"
     fi
-    rm $SRV_PID
-  else
-    echo "HTTP server PIDFile not found"
+    rm "$SRV_PID"
   fi
 
-  PID=$(cat $PELICAN_PID)
-  if [[ $? -eq 0 ]]; then
-    if alive $PID; then
+  PID=$(cat "$PELICAN_PID")
+  if [ -z "$PID" ]; then
+    echo "Pelican PIDFile not found"
+  else
+    if alive "$PID"; then
       echo "Killing Pelican"
-      kill $PID
+      kill "$PID"
     else
       echo "Stale PID, deleting"
     fi
-    rm $PELICAN_PID
-  else
-    echo "Pelican PIDFile not found"
+    rm "$PELICAN_PID"
   fi
 }
 
 function start_up(){
   local port=$1
   echo "Starting up Pelican and HTTP server"
   shift
-  $PELICAN --debug --autoreload -r $INPUTDIR -o $OUTPUTDIR -s $CONFFILE $PELICANOPTS &
+  $PELICAN --debug --autoreload -r "$INPUTDIR" -o "$OUTPUTDIR" -s "$CONFFILE" "$PELICANOPTS" &
   pelican_pid=$!
-  echo $pelican_pid > $PELICAN_PID
-  mkdir -p $OUTPUTDIR && cd $OUTPUTDIR
-  $PY -m pelican.server $port &
+  echo $pelican_pid > "$PELICAN_PID"
+  mkdir -p "$OUTPUTDIR" && "cd $OUTPUTDIR" || exit
+  $PY -m pelican.server "$port" &
   srv_pid=$!
-  echo $srv_pid > $SRV_PID
-  cd $BASEDIR
+  echo $srv_pid > "$SRV_PID"
+  cd "$BASEDIR" || exit
   sleep 1
   if ! alive $pelican_pid ; then
     echo "Pelican didn't start. Is the Pelican package installed?"
     return 1
   elif ! alive $srv_pid ; then
-    echo "The HTTP server didn't start. Is there another service using port" $port "?"
+    echo "The HTTP server didn't start. Is there another service using port $port ?"
     return 1
   fi
   echo 'Pelican and HTTP server processes now running in background.'
@@ -94,9 +94,9 @@ if [[ $1 == "stop" ]]; then
   shut_down
 elif [[ $1 == "restart" ]]; then
   shut_down
-  start_up $port
+  start_up "$port"
 elif [[ $1 == "start" ]]; then
-  if ! start_up $port; then
+  if ! start_up "$port"; then
     shut_down
   fi
 else
