Update Caddy and Muffet (#23)

Author: ruzickap

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.11
+FROM alpine:3.12
 
 LABEL maintainer="Petr Ruzicka <petr.ruzicka@gmail.com>"
 LABEL repository="https://github.com/ruzickap/action-my-broken-link-checker"
@@ -9,10 +9,10 @@ LABEL "com.github.actions.description"="Check broken links on web pages stored l
 LABEL "com.github.actions.icon"="list"
 LABEL "com.github.actions.color"="blue"
 
-ENV MUFFET_VERSION="1.3.3"
+ENV MUFFET_VERSION="2.0.4"
 #ENV MUFFET_VERSION="latest"
 
-ENV CADDY_VERSION="2.1.1"
+ENV CADDY_VERSION="2.2.0"
 #ENV CADDY_VERSION="latest"
 
 SHELL ["/bin/ash", "-eo", "pipefail", "-c"]
@@ -28,7 +28,7 @@ RUN set -eux && \
     if [ "${MUFFET_VERSION}" = "latest" ]; then \
       MUFFET_URL=$(wget -qO- https://api.github.com/repos/raviqqe/muffet/releases/latest | grep "browser_download_url.*muffet_.*_Linux_x86_64.tar.gz" | cut -d \" -f 4) ; \
     else \
-      MUFFET_URL="https://github.com/raviqqe/muffet/releases/download/${MUFFET_VERSION}/muffet_${MUFFET_VERSION}_Linux_x86_64.tar.gz" ; \
+      MUFFET_URL="https://github.com/raviqqe/muffet/releases/download/v${MUFFET_VERSION}/muffet_${MUFFET_VERSION}_Linux_x86_64.tar.gz" ; \
     fi && \
     wget -qO- "${MUFFET_URL}" | tar xzf - -C /usr/local/bin/ muffet && \
     if [ "${CADDY_VERSION}" = "latest" ]; then \

README.md

@@ -47,7 +47,7 @@ parameter and serving the web pages (see the details in [entrypoint.sh](./entryp
   with:
     url: https://www.example.com/test123
     pages_path: ./build/
-    cmd_params: --buffer-size=8192 --concurrency=10 --skip-tls-verification --limit-redirections=5 --timeout=20  # muffet parameters
+    cmd_params: --buffer-size=8192 --max-connections=10 --skip-tls-verification --limit-redirections=5 --timeout=20  # muffet parameters
     run_timeout: 600  # maximum amount of time to run muffet (default is set to 300 seconds)
 ```
 
@@ -58,21 +58,21 @@ Do you want to skip the docker build step? OK, the script mode is also available
   env:
     INPUT_URL: https://www.example.com/test123
     INPUT_PAGES_PATH: ./build/
-    INPUT_CMD_PARAMS: --buffer-size=8192 --concurrency=10 --skip-tls-verification  # --skip-tls-verification is mandatory parameter when using https and "PAGES_PATH"
+    INPUT_CMD_PARAMS: --buffer-size=8192 --max-connections=10 --skip-tls-verification  # --skip-tls-verification is mandatory parameter when using https and "PAGES_PATH"
   run: wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v1/entrypoint.sh | bash
 ```
 
 ## Parameters
 
 Environment variables used by `./entrypoint.sh` script.
 
-| Variable            | Default                               | Description                                                                                                                                                              |
-| ------------------- | ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `INPUT_CMD_PARAMS`  | `--buffer-size=8192 --concurrency=10` | Command line parameters for URL checker [muffet](https://github.com/raviqqe/muffet) - details [here](https://github.com/raviqqe/muffet/blob/master/arguments.go#L16-L34) |
-| `INPUT_DEBUG`       | false                                 | Enable debug mode for the `./entrypoint.sh` script (`set -x`)                                                                                                            |
-| `INPUT_PAGES_PATH`  |                                       | Relative path to the directory with local web pages                                                                                                                      |
-| `INPUT_RUN_TIMEOUT` | 300                                   | Maximum number of seconds that URL checker can be running                                                                                                                |
-| `INPUT_URL`         | (**Mandatory / Required**)            | URL which will be checked                                                                                                                                                |
+| Variable            | Default                                   | Description                                                                                                                                                              |
+| ------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `INPUT_CMD_PARAMS`  | `--buffer-size=8192 --max-connections=10` | Command line parameters for URL checker [muffet](https://github.com/raviqqe/muffet) - details [here](https://github.com/raviqqe/muffet/blob/master/arguments.go#L16-L34) |
+| `INPUT_DEBUG`       | false                                     | Enable debug mode for the `./entrypoint.sh` script (`set -x`)                                                                                                            |
+| `INPUT_PAGES_PATH`  |                                           | Relative path to the directory with local web pages                                                                                                                      |
+| `INPUT_RUN_TIMEOUT` | 300                                       | Maximum number of seconds that URL checker can be running                                                                                                                |
+| `INPUT_URL`         | (**Mandatory / Required**)                | URL which will be checked                                                                                                                                                |
 
 ## Full example
 
@@ -183,7 +183,7 @@ jobs:
         env:
           INPUT_URL: https://${{ github.event.repository.name }}
           INPUT_PAGES_PATH: public
-          INPUT_CMD_PARAMS: --verbose --buffer-size=8192 --concurrency=10 --skip-tls-verification --exclude=linkedin.com
+          INPUT_CMD_PARAMS: --verbose --buffer-size=8192 --max-connections=10 --skip-tls-verification --exclude=linkedin.com
         run: |
           wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v1/entrypoint.sh | bash
 
@@ -250,7 +250,7 @@ jobs:
         env:
           INPUT_URL: https://${{ github.event.repository.owner.name }}.github.io/${{ github.event.repository.name }}
           INPUT_PAGES_PATH: .
-          INPUT_CMD_PARAMS: --buffer-size=8192 --concurrency=10 --skip-tls-verification
+          INPUT_CMD_PARAMS: --buffer-size=8192 --max-connections=10 --skip-tls-verification
         run: |
           ln -s docs/.vuepress/dist ${{ github.event.repository.name }}
           wget -qO- https://raw.githubusercontent.com/ruzickap/action-my-broken-link-checker/v1/entrypoint.sh | bash
@@ -285,7 +285,7 @@ are not already installed on your system.
 
 ```bash
 export INPUT_URL="https://google.com"
-export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --concurrency=10 --verbose"
+export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --max-connections=10 --verbose"
 ./entrypoint.sh
 ```
 
@@ -323,7 +323,7 @@ without touching your system:
 
 ```bash
 export INPUT_URL="https://google.com"
-export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --concurrency=10 --verbose"
+export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --max-connections=10 --verbose"
 docker run --rm -t -e INPUT_URL -e INPUT_CMD_PARAMS peru/my-broken-link-checker
 ```
 

demo/my-broken-link-checker-demo.sh

@@ -47,7 +47,7 @@ pe 'export INPUT_URL="https://google.com"'
 p ''
 
 p 'Add some extra muffet parameters to INPUT_CMD_PARAMS variable:'
-pe 'export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --concurrency=10 --verbose"'
+pe 'export INPUT_CMD_PARAMS="--ignore-fragments --one-page-only --max-connections=10 --verbose"'
 
 p ''
 

entrypoint.sh

@@ -1,9 +1,12 @@
 #!/usr/bin/env bash
 
-set -euo pipefail
+set -Eeuo pipefail
+
+export MUFFET_VERSION="2.0.4"
+export CADDY_VERSION="2.2.0"
 
 # Command line parameters for muffet
-export CMD_PARAMS="${INPUT_CMD_PARAMS:- --buffer-size=8192 --concurrency=10}"
+export CMD_PARAMS="${INPUT_CMD_PARAMS:- --buffer-size=8192 --max-connections=10}"
 # Set path variable containing web pages
 export PAGES_PATH=${INPUT_PAGES_PATH:-}
 # URL to scan / check
@@ -18,6 +21,10 @@ export PAGES_URI
 export RUN_TIMEOUT="${INPUT_RUN_TIMEOUT:-300}"
 # Debug variable - enable by setting non-empty value
 export DEBUG=${INPUT_DEBUG:-}
+# Create caddy log file where will be all the log messages form the caddy server
+CADDY_LOG=$( mktemp /tmp/Caddy-log.XXXXXX )
+# Create caddy configuration to run web server using the domain set in PAGES_DOMAIN + /etc/hosts
+CADDYFILE=$( mktemp /tmp/Caddyfile.XXXXXX )
 
 if [ $EUID != 0 ]; then
   sudo_cmd="sudo"
@@ -40,12 +47,14 @@ cleanup() {
     if ! grep -q -E '(docker|containerd)' /proc/self/cgroup ; then
       $sudo_cmd sed -i "/127.0.0.1 ${PAGES_DOMAIN}  # Created by my-broken-link-checker/d" /etc/hosts
     fi
-    $sudo_cmd caddy stop > /dev/null
+    $sudo_cmd caddy stop &> /dev/null
     [ -f "${CADDYFILE}" ] && rm "${CADDYFILE}"
+    [ -f "${CADDY_LOG}" ] && rm "${CADDY_LOG}"
   fi
 }
 
 error_trap() {
+  cat "${CADDY_LOG}"
   cleanup
   print_error "[$(date +'%F %T')] Something went wrong - see the errors above..."
 }
@@ -60,14 +69,26 @@ trap error_trap ERR
 
 # Install muffet if needed
 if ! hash muffet &> /dev/null ; then
-  MUFFET_URL=$(wget --quiet https://api.github.com/repos/raviqqe/muffet/releases/latest -O - | grep "browser_download_url.*muffet_.*_Linux_x86_64.tar.gz" | cut -d \" -f 4)
-  wget --quiet "${MUFFET_URL}" -O - | $sudo_cmd tar xzf - -C /usr/local/bin/ muffet
+
+  if [ "${MUFFET_VERSION}" = "latest" ]; then
+    MUFFET_URL=$(wget -qO- https://api.github.com/repos/raviqqe/muffet/releases/latest | grep "browser_download_url.*muffet_.*_Linux_x86_64.tar.gz" | cut -d \" -f 4)
+  else
+    MUFFET_URL="https://github.com/raviqqe/muffet/releases/download/v${MUFFET_VERSION}/muffet_${MUFFET_VERSION}_Linux_x86_64.tar.gz"
+  fi
+
+  wget -qO- "${MUFFET_URL}" | $sudo_cmd tar xzf - -C /usr/local/bin/ muffet
 fi
 
 # Install caddy if needed
 if ! hash caddy &> /dev/null && [ -n "${PAGES_PATH}" ] ; then
-  LATEST_CADDY_URL=$(wget --quiet https://api.github.com/repos/caddyserver/caddy/releases/latest -O - | grep "browser_download_url.*caddy_.*_linux_amd64.tar.gz" | cut -d \" -f 4)
-  wget --quiet "${LATEST_CADDY_URL}" -O - | $sudo_cmd tar xzf - -C /usr/local/bin/ caddy
+
+  if [ "${CADDY_VERSION}" = "latest" ]; then
+    CADDY_URL=$(wget --quiet https://api.github.com/repos/caddyserver/caddy/releases/latest -O - | grep "browser_download_url.*caddy_.*_linux_amd64.tar.gz" | cut -d \" -f 4)
+  else
+    CADDY_URL="https://github.com/caddyserver/caddy/releases/download/v${CADDY_VERSION}/caddy_${CADDY_VERSION}_linux_amd64.tar.gz"
+  fi
+
+  wget --quiet "${CADDY_URL}" -O - | $sudo_cmd tar xzf - -C /usr/local/bin/ caddy
 fi
 
 IFS=' ' read -r -a CMD_PARAMS <<< "$CMD_PARAMS"
@@ -93,8 +114,6 @@ else
     $sudo_cmd bash -c "echo \"127.0.0.1 ${PAGES_DOMAIN}  # Created by my-broken-link-checker\" >> /etc/hosts"
   fi
 
-  # Create caddy configuration to run web server using the domain set in PAGES_DOMAIN + /etc/hosts
-  CADDYFILE=$( mktemp /tmp/Caddyfile.XXXXXX )
   {
     echo "${PAGES_URI} {"
     echo "  root * ${PAGES_PATH}"
@@ -104,7 +123,7 @@ else
   } > "${CADDYFILE}"
 
   # Run caddy web server on the background
-  $sudo_cmd caddy start -config "${CADDYFILE}" > /dev/null
+  $sudo_cmd caddy start -config "${CADDYFILE}" &> "${CADDY_LOG}"
   sleep 1
 
   # Run check

tests/fail_tests.sh

@@ -4,7 +4,7 @@ export INPUT_DEBUG="true"
 
 echo -e "\n\n\e[32m!!! Test when RUN_TIMEOUT is too tight\e[m"
 
-export INPUT_CMD_PARAMS="--one-page-only --concurrency=1 --verbose"
+export INPUT_CMD_PARAMS="--one-page-only --max-connections=1 --verbose"
 export INPUT_RUN_TIMEOUT="1"
 export INPUT_URL="https://google.com"
 ../entrypoint.sh

tests/run_tests.sh

@@ -5,7 +5,7 @@ export INPUT_DEBUG="true"
 
 
 echo -e "\n\n\e[32m!!! Check differnet URLs types\e[m"
-export INPUT_CMD_PARAMS="--one-page-only --buffer-size=8192 --concurrency=10 --verbose"
+export INPUT_CMD_PARAMS="--one-page-only --buffer-size=8192 --max-connections=10 --verbose"
 
 export INPUT_URL="https://google.com"
 ../entrypoint.sh
@@ -33,7 +33,7 @@ echo -e "\n\n\e[32m!!! Test docker image\e[m"
 docker build .. -t my-broken-link-checker-test
 
 export INPUT_URL="https://google.com"
-export INPUT_CMD_PARAMS="--one-page-only --buffer-size=8192 --concurrency=10 --verbose"
+export INPUT_CMD_PARAMS="--one-page-only --buffer-size=8192 --max-connections=10 --verbose"
 docker run --rm -t -e INPUT_DEBUG -e INPUT_URL -e INPUT_CMD_PARAMS my-broken-link-checker-test
 
 export INPUT_URL="https://my-testing-domain.com"