[qa] Add shell scripts checking and formatting

Closes #55

Author: devkapilbansal

.editorconfig

@@ -0,0 +1,5 @@
+# config file for shell formatter
+
+[*]
+binary_next_line   = true  # like -bn
+switch_case_indent = true  # like -ci

.github/workflows/ci.yml

@@ -34,6 +34,15 @@ jobs:
 
       - name: QA-Checks
         run: ./run-qa-checks
+        env:
+          CI: 1
+
+      - name: Run sh-checker
+        uses: luizm/action-sh-checker@master
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          sh_checker_comment: true
 
       - name: Tests
         run: ./runtests
@@ -43,7 +52,7 @@ jobs:
           cd openwrt-openwisp-monitoring/tests
           luacov-coveralls -v
         env:
-          COVERALLS_REPO_TOKEN: ${{ github.token }}
+          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
   build:
     name: Build and upload package as artifacts

README.rst

@@ -175,30 +175,30 @@ You can inspect the version of openwisp-monitoring currently installed with::
 Quality Assurance Checks
 ------------------------
 
-We use `LuaFormatter <https://luarocks.org/modules/tammela/luaformatter>`_ to format lua files.
-Once it is installed, you can format all files by::
+We use `LuaFormatter <https://luarocks.org/modules/tammela/luaformatter>`_ and `shfmt <https://github.com/mvdan/sh#shfmt>`_ to format lua files and shell scripts respectively.
+
+Once they are installed, you can format all files by::
 
     ./qa-format
 
+Run quality assurance tests with::
+
+    #install openwisp-utils QA tools first
+    pip install openwisp-utils[qa]
+
+    #run QA checks before committing code
+    ./run-qa-checks
+
 Run tests
 ---------
 
 To run the unit tests, you must install the required dependencies first; to do this, you can take
 a look at the `install-dev.sh <https://github.com/openwisp/openwisp-config/blob/master/install-dev.sh>`_ script.
 
-
 Install test requirements::
 
     sudo ./install-dev.sh
 
-Run quality assurance tests with::
-
-    #install openwisp-utils QA tools first
-    pip install openwisp-utils[qa]
-
-    #run QA checks before committing code
-    ./run-qa-checks
-
 You can run all unit tests by launching the dedicated script::
 
     ./runtests

install-dev.sh

@@ -1,23 +1,25 @@
 #!/bin/sh
 set -e
 apt-get update
-#install cmake and git
+# install cmake and git
 apt-get install -y cmake git
-#install lua
+# install shellcheck
+apt-get install shellcheck
+# install lua
 apt-get install -y lua5.1 liblua5.1-0-dev luarocks
-#install json-c
+# install json-c
 git clone https://github.com/json-c/json-c.git --depth=1
-cd json-c && cmake . && make install && cd ..  || { echo 'Installing json-c failed!' ; exit 1; }
+{ cd json-c && cmake . && make install && cd ..; } || { echo 'Installing json-c failed!' && exit 1; }
 # install openwrt libubox and uci
 git clone https://git.openwrt.org/project/libubox.git --depth=1
-cd libubox && cmake . && make install && cd .. || { echo 'Installing libubox failed!' ; exit 1; }
+{ cd libubox && cmake . && make install && cd ..; } || { echo 'Installing libubox failed!' && exit 1; }
 git clone https://git.openwrt.org/project/uci.git --depth=1
-cd uci && cmake . && make install && cd .. || { echo 'Installing uci failed!' ; exit 1; }
-#install nixio
+{ cd uci && cmake . && make install && cd ..; } || { echo 'Installing uci failed!' && exit 1; }
+# install nixio
 luarocks install https://raw.githubusercontent.com/Neopallium/nixio/master/nixio-scm-0.rockspec
 # install luaformatter
 git clone --recurse-submodules https://github.com/Koihik/LuaFormatter.git
-cd LuaFormatter && cmake . && make install && cd .. || { echo 'Installing LuaFormatter failed'; exit 1; }
+{ cd LuaFormatter && cmake . && make install && cd ..; } || { echo 'Installing LuaFormatter failed' && exit 1; }
 # update links to shared libraries
 ldconfig -v
 # install luaunit
@@ -26,7 +28,7 @@ luarocks install luaunit
 luarocks install luacheck
 # install lua-cjson
 luarocks install lua-cjson
-#install luacov-coveralls
+# install luacov-coveralls
 luarocks install luacov-coveralls
-#clean
+# clean
 rm -rf json-c libubox uci LuaFormatter