feature: add lint check (#79)

fix #78

Author: Yiyiyimu

.gitignore

@@ -54,4 +54,5 @@ dkms.conf
 # dev
 go
 t/servroot
+utils/lj-releng
 [\.]*

.travis.yml

@@ -43,6 +43,8 @@ install:
   - sudo add-apt-repository -y "deb http://openresty.org/package/ubuntu $(lsb_release -sc) main"
   - sudo apt-get update
   - sudo apt-get install openresty
+  - sudo luarocks install luacheck > build.log 2>&1 || (cat build.log && exit 1)
+  - make utils
   - wget https://github.com/etcd-io/etcd/releases/download/v$ETCD_VER/etcd-v$ETCD_VER-linux-amd64.tar.gz
   - tar xf etcd-v$ETCD_VER-linux-amd64.tar.gz
   # run etcd local cluster, startup at localhost:2379, localhost:22379, and localhost:32379
@@ -51,7 +53,7 @@ install:
 
 script:
   - cd test-nginx && (sudo cpanm --notest . > build.log 2>&1 || (cat build.log && exit 1)) && cd ..
-  - export PATH=$OPENRESTY_PREFIX/nginx/sbin:$PWD/etcd-v$ETCD_VER-linux-amd64:$PATH
+  - export PATH=$OPENRESTY_PREFIX/nginx/sbin:$OPENRESTY_PREFIX/luajit/bin:$PWD/etcd-v$ETCD_VER-linux-amd64:$PATH
   - etcd --version
   - goreman -f ./t/$GOREMAN_CONF start > goreman.log 2>&1 &
   - sleep 5
@@ -61,4 +63,7 @@ script:
   - ./t/v3/add-auth.sh
   - cat goreman.log
   - ps -ef | grep etcd
+  - luajit -v
+  - luajit -v | awk '{print$2}'| grep 2.1
+  - make lint || exit 1
   - make test

Makefile

@@ -19,5 +19,19 @@ help:
 	@echo
 	@grep -E '^### [-A-Za-z0-9_]+:' Makefile | sed 's/###/   /'
 
+### lint:             Lint Lua source code
+.PHONY: lint
+lint: utils
+	chmod a+x utils/check-lua-code-style.sh
+	./utils/check-lua-code-style.sh
+
+### utils:            Installation tools
+.PHONY: utils
+utils:
+ifeq ("$(wildcard utils/lj-releng)", "")
+	wget -O utils/lj-releng https://raw.githubusercontent.com/iresty/openresty-devel-utils/master/lj-releng
+	chmod a+x utils/lj-releng
+endif
+
 test:
 	prove -I../test-nginx/lib -r -s t/

lib/resty/etcd/utils.lua

@@ -7,6 +7,8 @@ local concat_tab    = table.concat
 local tostring      = tostring
 local select        = select
 local ipairs        = ipairs
+local pairs         = pairs
+local type          = type
 
 
 local _M = {http = http}

lib/resty/etcd/v3.lua

@@ -684,6 +684,8 @@ end
 
 function _M.watchcancel(self, http_cli)
     local res, err = http_cli:close()
+    -- to avoid unused variable self
+    local _ = self
     return res, err
 end
 

utils/check-lua-code-style.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+set -ex
+
+luacheck -q lib
+
+find lib -name '*.lua' -exec ./utils/lj-releng {} + > \
+    /tmp/check.log 2>&1 || (cat /tmp/check.log && exit 1)
+
+grep -E "ERROR.*.lua:" /tmp/check.log > /tmp/error.log | true
+if [ -s /tmp/error.log ]; then
+    echo "=====bad style====="
+    cat /tmp/check.log
+    exit 1
+fi