linted

Author: fabiocicerchia

.github/linters/.dockerfilelintrc

@@ -1,3 +1,4 @@
 rules:
   invalid_command: off
   base_image_tag: off
+  missing_tag: off

.github/linters/.ecrc

@@ -0,0 +1,6 @@
+{
+  "Exclude": [
+    "docs/lua-nginx-module/known-issues.md",
+    "docs/lua-nginx-module/nginx-api-for-lua.md"
+  ]
+}

.github/linters/.hadolint.yml

@@ -2,3 +2,4 @@ ignored:
   - DL3008 # Pin versions in apt get install. Instead of `apt-get install <package>` use `apt-get install <package>=<version>`
   - DL3018 # Pin versions in apk add. Instead of `apk add <package>` use `apk add <package>=<version>`
   - DL3033 # Specify version with `yum install -y <package>-<version>`.
+  - DL3006 # Always tag the version of an image explicitly

Dockerfile

@@ -141,84 +141,84 @@ ENV NGX_CFLAGS=$NGX_CFLAGS
 ARG NGX_LDOPT="-Wl,-rpath,/usr/local/lib -Wl,-z,relro -Wl,-z,now -Wl,--as-needed -pie"
 ENV NGX_LDOPT=$NGX_LDOPT
 ARG NGINX_BUILD_CONFIG="\
-        --prefix=/etc/nginx \
-        --sbin-path=/usr/sbin/nginx \
-        --modules-path=/usr/lib/nginx/modules \
-        --conf-path=/etc/nginx/nginx.conf \
-        --error-log-path=/var/log/nginx/error.log \
-        --http-log-path=/var/log/nginx/access.log \
-        --pid-path=/var/run/nginx.pid \
-        --lock-path=/var/run/nginx.lock \
-        --http-client-body-temp-path=/var/cache/nginx/client_temp \
-        --http-proxy-temp-path=/var/cache/nginx/proxy_temp \
-        --http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp \
-        --http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp \
-        --http-scgi-temp-path=/var/cache/nginx/scgi_temp \
-        --with-perl_modules_path=/usr/lib/perl5/vendor_perl \
-        --user=nginx \
-        --group=nginx \
-        --with-compat \
-        --with-file-aio \
-        --with-threads \
-        --with-http_addition_module \
-        --with-http_auth_request_module \
-        --with-http_dav_module \
-        --with-http_flv_module \
-        --with-http_gunzip_module \
-        --with-http_gzip_static_module \
-        --with-http_mp4_module \
-        --with-http_random_index_module \
-        --with-http_realip_module \
-        --with-http_secure_link_module \
-        --with-http_slice_module \
-        --with-http_ssl_module \
-        --with-http_stub_status_module \
-        --with-http_sub_module \
-        --with-http_v2_module \
-        --with-mail \
-        --with-mail_ssl_module \
-        --with-stream \
-        --with-stream_realip_module \
-        --with-stream_ssl_module \
-        --with-stream_ssl_preread_module \
-        --add-module=/lua-nginx-module-${VER_LUA_NGINX_MODULE} \
-        --add-module=/ngx_devel_kit-${VER_NGX_DEVEL_KIT} \
-        --add-module=/lua-upstream-nginx-module-${VER_LUA_UPSTREAM} \
+            --prefix=/etc/nginx \
+            --sbin-path=/usr/sbin/nginx \
+            --modules-path=/usr/lib/nginx/modules \
+            --conf-path=/etc/nginx/nginx.conf \
+            --error-log-path=/var/log/nginx/error.log \
+            --http-log-path=/var/log/nginx/access.log \
+            --pid-path=/var/run/nginx.pid \
+            --lock-path=/var/run/nginx.lock \
+            --http-client-body-temp-path=/var/cache/nginx/client_temp \
+            --http-proxy-temp-path=/var/cache/nginx/proxy_temp \
+            --http-fastcgi-temp-path=/var/cache/nginx/fastcgi_temp \
+            --http-uwsgi-temp-path=/var/cache/nginx/uwsgi_temp \
+            --http-scgi-temp-path=/var/cache/nginx/scgi_temp \
+            --with-perl_modules_path=/usr/lib/perl5/vendor_perl \
+            --user=nginx \
+            --group=nginx \
+            --with-compat \
+            --with-file-aio \
+            --with-threads \
+            --with-http_addition_module \
+            --with-http_auth_request_module \
+            --with-http_dav_module \
+            --with-http_flv_module \
+            --with-http_gunzip_module \
+            --with-http_gzip_static_module \
+            --with-http_mp4_module \
+            --with-http_random_index_module \
+            --with-http_realip_module \
+            --with-http_secure_link_module \
+            --with-http_slice_module \
+            --with-http_ssl_module \
+            --with-http_stub_status_module \
+            --with-http_sub_module \
+            --with-http_v2_module \
+            --with-mail \
+            --with-mail_ssl_module \
+            --with-stream \
+            --with-stream_realip_module \
+            --with-stream_ssl_module \
+            --with-stream_ssl_preread_module \
+            --add-module=/lua-nginx-module-${VER_LUA_NGINX_MODULE} \
+            --add-module=/ngx_devel_kit-${VER_NGX_DEVEL_KIT} \
+            --add-module=/lua-upstream-nginx-module-${VER_LUA_UPSTREAM} \
 "
 ENV NGINX_BUILD_CONFIG=$NGINX_BUILD_CONFIG
 
 ARG BUILD_DEPS="\
-    curl \
-    g++ \
-    geoip-dev \
-    gzip \
-    lua${VER_LUA} \
-    lua${VER_LUA}-dev \
-    make \
-    openssl-dev \
-    pcre-dev \
-    tar \
-    zlib-dev \
+        curl \
+        g++ \
+        geoip-dev \
+        gzip \
+        lua${VER_LUA} \
+        lua${VER_LUA}-dev \
+        make \
+        openssl-dev \
+        pcre-dev \
+        tar \
+        zlib-dev \
 "
 ENV BUILD_DEPS=$BUILD_DEPS
 
 ARG NGINX_BUILD_DEPS="\
 # NGINX
-    alpine-sdk \
-    bash \
-    findutils \
-    gcc \
-    gd-dev \
-    geoip-dev \
-    libc-dev \
-    libedit-dev \
-    libxslt-dev \
-    linux-headers \
-    make \
-    openssl-dev \
-    pcre-dev \
-    perl-dev \
-    zlib-dev \
+        alpine-sdk \
+        bash \
+        findutils \
+        gcc \
+        gd-dev \
+        geoip-dev \
+        libc-dev \
+        libedit-dev \
+        libxslt-dev \
+        linux-headers \
+        make \
+        openssl-dev \
+        pcre-dev \
+        perl-dev \
+        zlib-dev \
 "
 ENV NGINX_BUILD_DEPS=$NGINX_BUILD_DEPS
 
@@ -237,10 +237,10 @@ RUN set -eux \
         $BUILD_DEPS \
         $NGINX_BUILD_DEPS \
     && [ $EXTENDED_IMAGE -eq 1 ] && \
-	NGINX_BUILD_CONFIG="${NGINX_BUILD_CONFIG} \
-		--add-module=/headers-more-nginx-module-${VER_OPENRESTY_HEADERS} \
-		--add-module=/stream-lua-nginx-module-${VER_OPENRESTY_STREAMLUA} \
-	" \
+        NGINX_BUILD_CONFIG="${NGINX_BUILD_CONFIG} \
+            --add-module=/headers-more-nginx-module-${VER_OPENRESTY_HEADERS} \
+            --add-module=/stream-lua-nginx-module-${VER_OPENRESTY_STREAMLUA} \
+        " \
     && make -j "$(nproc)" deps \
     && make -j "$(nproc)" core \
     && make -j "$(nproc)" luarocks
@@ -285,13 +285,13 @@ LABEL maintainer="Fabio Cicerchia <[email protected]>" \
     versions.stream-lua-nginx-module=${VER_OPENRESTY_STREAMLUA}
 
 ARG PKG_DEPS="\
-    geoip-dev \
-    lua${VER_LUA} \
-    lua${VER_LUA}-dev \
-    openssl-dev \
-    pcre-dev \
-    unzip \
-    zlib-dev \
+        geoip-dev \
+        lua${VER_LUA} \
+        lua${VER_LUA}-dev \
+        openssl-dev \
+        pcre-dev \
+        unzip \
+        zlib-dev \
 "
 ENV PKG_DEPS=$PKG_DEPS
 

README.md

@@ -61,7 +61,7 @@ Lua is a lightweight, high-level, multi-paradigm programming language designed p
 
 | | nginx-lua | OpenResty |
 |--|--|--|
-| nginx latest version | `1.21.0` | `1.19.x` (last tested: `1.19.9`)* |
+| nginx latest version | `1.21.0` | `1.19.x` (last tested: `1.19.9`)<sup>*</sup> |
 | Alpine supported | ✅ | ✅ |
 | Amazon supported | ✅ | ✅ |
 | CentOS supported | ❌ | ✅ |
@@ -70,7 +70,7 @@ Lua is a lightweight, high-level, multi-paradigm programming language designed p
 | Ubuntu supported | ✅ | ✅ |
 | Windows supported | ❌ | ✅ |
 
-* Note: Between OpenResty compatibility for `1.17.4` (28 Sep 2019) and `1.19.3` (3 Nov 2020) have passed ~10 months, and nginx 1.19.3 has been released on 29 Sep 2020.
+<sup>*</sup> Note: Between OpenResty compatibility for `1.17.4` (28 Sep 2019) and `1.19.3` (3 Nov 2020) have passed ~10 months, and nginx 1.19.3 has been released on 29 Sep 2020.
 
 ## Features
 
@@ -183,12 +183,12 @@ Here is an example using docker-compose.yml:
 web:
   image: fabiocicerchia/nginx-lua
   volumes:
-   - ./templates:/etc/nginx/templates
+    - ./templates:/etc/nginx/templates
   ports:
-   - "8080:80"
+    - "8080:80"
   environment:
-   - NGINX_HOST=foobar.com
-   - NGINX_PORT=80
+    - NGINX_HOST=foobar.com
+    - NGINX_PORT=80
 ```
 
 By default, this function reads template files in `/etc/nginx/templates/*.template` and outputs the result of executing `envsubst` to `/etc/nginx/conf.d`.

bin/_common.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# shellcheck disable=SC1091,SC2086
+# shellcheck disable=SC1091,SC2086,SC2207
 
 source supported_versions
 
@@ -29,7 +29,7 @@ function loop_over_nginx_with_os() {
     FUNC=$2
 
     LEN_VER_NGINX=${#NGINX[@]}
-    for ((I = 0; I < LEN_VER_NGINX; I++ )); do
+    for ((I = 0; I < LEN_VER_NGINX; I++)); do
         NGINX_VER="${NGINX[$I]}"
 
         LAST_VER_NGINX=0
@@ -52,7 +52,7 @@ function loop_over_nginx() {
     FUNC=$1
 
     LEN_VER_NGINX=${#NGINX[@]}
-    for ((I = 0; I < LEN_VER_NGINX; I++ )); do
+    for ((I = 0; I < LEN_VER_NGINX; I++)); do
         export NGINX_VER="${NGINX[$I]}"
 
         export LAST_VER_NGINX=0
@@ -89,8 +89,8 @@ function loop_over_os() {
     FUNC=$2
 
     LEN_VER_OS=${#VERSIONS[@]}
-    for ((J = 0; J < LEN_VER_OS; J++ )); do
-        export OS_VER="${VERSIONS[$J]}";
+    for ((J = 0; J < LEN_VER_OS; J++)); do
+        export OS_VER="${VERSIONS[$J]}"
 
         export LAST_VER_OS=0
         if [ "$((J + 1))" == "$LEN_VER_OS" ]; then

bin/docker-build.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# shellcheck disable=SC1091,SC2086
+# shellcheck disable=SC1091,SC2086,SC2207
 
 source ./bin/_common.sh
 source supported_versions

bin/docker-metadata.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# shellcheck disable=SC1091
+# shellcheck disable=SC1091,SC2207
 
 source ./bin/_common.sh
 source supported_versions
@@ -20,7 +20,7 @@ function metadata() {
             echo '```json'
             docker image inspect "fabiocicerchia/nginx-lua:$PATCH-$OS$OS_VER"
             echo '```'
-         } >"docs/metadata/$PATCH-$OS$OS_VER.md"
+        } >"docs/metadata/$PATCH-$OS$OS_VER.md"
     fi
 }
 

bin/docker-push.sh

@@ -1,13 +1,13 @@
 #!/bin/bash
-# shellcheck disable=SC1091
+# shellcheck disable=SC1091,SC2207
 
 source ./bin/_common.sh
 source supported_versions
 
 function docker_push() {
     TAG=$1
     EXITCODE=$(
-        docker push fabiocicerchia/nginx-lua:"$TAG" > /dev/null;
+        docker push fabiocicerchia/nginx-lua:"$TAG" >/dev/null
         echo $?
     )
     if [ "$EXITCODE" -ne "0" ]; then

bin/generate-supported-versions.sh

@@ -18,8 +18,8 @@ fetch_latest() {
     while [ "$VER" = "" ] && [ $PAGE -lt 100 ]; do
         VER=$(wget -q "https://hub.docker.com/v2/repositories/library/$DISTRO/tags?page=$PAGE" -O - |
             jq -rc '.results[] | select( .images[].digest == "'"$DIGEST"'" and .name != "latest" ) | .name' |
-            egrep "$FILTER" | sort -Vr | head -n 1)
-        ((PAGE+=1))
+            grep -E "$FILTER" | sort -Vr | head -n 1)
+        ((PAGE += 1))
     done
 
     echo "$VER"

bin/test-security.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# shellcheck disable=SC1091
+# shellcheck disable=SC1091,SC2207
 
 source ./bin/_common.sh
 source supported_versions

bin/test.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
-# shellcheck disable=SC1091
+# shellcheck disable=SC1091,SC2207
 
 source ./bin/_common.sh
 source supported_versions
@@ -14,11 +14,12 @@ function test() {
         docker run -d --name nginx_lua_test -p 8080:80 -v "$PWD"/test/nginx-lua.conf:/etc/nginx/nginx.conf fabiocicerchia/nginx-lua:"$DOCKER_TAG"
         COUNT=0
         until [ $COUNT -eq 20 ] || [ "$(
-            curl --output /dev/null --silent --head --fail http://localhost:8080;
+            curl --output /dev/null --silent --head --fail http://localhost:8080
             echo $?
         )" == "0" ]; do
-            echo -n '.'; sleep 0.5;
-            COUNT=$((COUNT+1))
+            echo -n '.'
+            sleep 0.5
+            COUNT=$((COUNT + 1))
         done
         curl -v http://localhost:8080 | grep "Welcome to nginx" || exit 1
         curl -v http://localhost:8080/lua_content | grep "Hello world" || exit 1

bin/update-readme.sh

@@ -2,5 +2,5 @@
 
 head -n "$(grep -n START_SUPPORTED_TAGS README.md | cut -d: -f1)" README.md >README.md.tmp
 ./bin/readme-tags.sh >>README.md.tmp
-tail -n "$(($(wc -l < README.md)-$(grep -n END_SUPPORTED_TAGS README.md | cut -d: -f1)+1))" README.md >>README.md.tmp
+tail -n "$(($(wc -l <README.md) - $(grep -n END_SUPPORTED_TAGS README.md | cut -d: -f1)+1))" README.md >>README.md.tmp
 mv README.md.tmp README.md