Merge pull request #17 from mag37/dev

## Code Cleaning
- printf formatting fixes
- read formatting fixes
- find/replace instead of sed
- directly check error on regctl instead of indirectly 
- safer array-checks (not expanding without index)

README.md

@@ -1,16 +1,19 @@
 # dockcheck
-### A script checking updates for docker images **without the need of pulling** - then having the option to auto-update either all or selecting specific containers.
+### A script checking updates for docker images **without pulling** - then selectively auto-update some/all containers.  
 
 With the help of [`regctl`](https://github.com/regclient/regclient). This is just a concept for inspiration, use with care.
 ___
 
 ## Dependencies:
 Running docker (duh) and compose, either standalone or plugin.   
-`regctl` by [regclient](https://github.com/regclient/regclient)  
-The script will ask to download `regctl` if it's not in PATH or current directory.
+`regctl` by [regclient](https://github.com/regclient/regclient) (will ask to download `regctl` if not in `PATH` or `PWD`)
 ___
+
+
+![](https://github.com/mag37/dockcheck/blob/main/example.gif)
+
 ## `dockcheck.sh`
-```bash
+```
 $ ./dockcheck.sh -h
 Syntax:     dockcheck.sh [OPTION] [part of name to filter]
 Example:    dockcheck.sh -a ng
@@ -19,14 +22,11 @@ Options:
 -h     Print this Help.
 -a|y   Automatic updates, without interaction.
 -n     No updates, only checking availability.
+-r     Allow updating images for docker run, wont update the container.
 ```
 
-
-
-![](https://github.com/mag37/dockcheck/blob/main/example_run.gif)
-
 Basic example:
-```bash
+```
 $ ./dockcheck.sh
 . . .
 Containers on latest version:
@@ -40,46 +40,36 @@ Containers with updates available:
 3) whoogle-search
 
 
-Do you want to update? y/[n] y
-What containers do you like to update? 
-Enter number(s) separated by comma: 1,3
+Choose what containers to update:
+Enter number(s) separated by comma, [q] to quit: 1,3
 
 ```
 Then it proceedes to run `pull` and `up -d` on every container with updates.   
 
+### `-r flag` :warning: disclaimer and warning:
+**Wont auto-update the containers, only their images. (compose is recommended)**   
+`docker run` dont support using new images just by restarting a container.  
+Containers need to be manually stopped, removed and created again to run on the new image.
 
 
-And with `-n` *No updates* and `gl` for `*gl*` filtering:
-```bash
-$ ./dockcheck.sh -n gl
-. . .
-Containers with updates available:
-whoogle-search
-
-Containers on latest version:
-glances
-
-No updates installed, exiting
-```
-
 ### :beetle: Squashed Bugs:
 - ~~No options for running without updates or auto update.~~
 - ~~No filter to check only specific containers.~~
 - ~~Faulty registry checkups stopped the updates completely.~~
 - ~~No clear checks to skip containers producing errors.~~
 - ~~Multi-digest images didn't correctly check with registry, giving false positives on updates.~~
+- ~~Not working with filenames other than `docker-compose.yml`~~
+- ~~Lists are not alphabetically sorted (due to stacks and other parameters)~~
+- ~~Old `docker-compose` binary-check sometimes returned false error~~
+- ~~Stacks gets updated as whole, even if only one service is chosen.~~
+- ~~Path broken occationally (from inspect) - probably due to old docker-compose binary.~~
+- ~~Script breaks if one of the chosen containers are a `docker run` container.~~
+- ~~Using relative paths for volumes eg. `${PWD}/data:data` will create the volumes where you stand.~~
 
 ### :hammer: Known issues
 - ~~No granular choice of what to update (except initial name filter).~~
 - No detailed error feedback (just skip + list what's skipped) .
 
-## `dockcheck_docker-run_ver.sh`
-### Wont auto-update the containers, only their images. (compose is recommended)
-Alternative version for people who use `docker run` and no composes.   
-`docker run` dont support using new images just by restarting a container.  
-Containers need to be stopped, removed and created again to run on the new image.
-
-
 ## `dupc_function.sh`
 Function to quickly check for updates on a single contianer or list of containers by name. **Without the need of pulling**.  
 Preferably placed in `.bashrc` or similar.
@@ -90,3 +80,9 @@ Updates available for local_nginx.
 nginx_reverse is already latest.
 Updates available for paperless-ng.
 ```
+## Also check out a spinoff brother-project [Palleri/dockcheck-web](https://github.com/Palleri/dockcheck-web) for a WebUI-front!
+---
+
+## Special Thanks:
+:bison: [t0rnis](https://github.com/t0rnis)   
+:leopard: [Palleri](https://github.com/Palleri)

dockcheck.sh

@@ -1,6 +1,12 @@
 #!/bin/bash
+VERSION="v0.1.7"
+Github="https://github.com/mag37/dockcheck"
 
-# Help Function:
+### Check if there's a new release of the script:
+LatestRelease="$(curl -s -r 0-30 https://raw.githubusercontent.com/mag37/dockcheck/main/dockcheck.sh | sed -n "/VERSION/s/VERSION=//p" | tr -d '"')"
+[ "$VERSION" != "$LatestRelease" ] && printf "New version available! Latest: %s - Local: %s \nGrab it here: %s \n\n" "$LatestRelease" "$VERSION" "$Github"
+
+### Help Function:
 Help() {
   echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
   echo "Example:    dockcheck.sh -a ng"
@@ -9,18 +15,20 @@ Help() {
   echo "-h     Print this Help."
   echo "-a|y   Automatic updates, without interaction."
   echo "-n     No updates, only checking availability."
+  echo "-r     Allow updating images for docker run, wont update the container"
 }
 
-while getopts "aynh" options; do
+while getopts "aynrh" options; do
   case "${options}" in
     a|y) UpdYes="yes" ;;
     n) UpdYes="no" ;;
+    r) DrUp="yes" ;;
     h|*) Help ; exit 0 ;;
   esac
 done
 shift "$((OPTIND-1))"
 
-### Set $1 to a variable for later
+### Set $1 to a variable for name filtering later.
 SearchName="$1"
 
 ### Check if required binary exists in PATH or directory:
@@ -30,7 +38,7 @@ elif [[ -f "./regctl" ]]; then
   regbin="./regctl"
 else
   printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] "
-  read GetDep
+  read -r GetDep
   if [ "$GetDep" != "${GetDep#[Yy]}" ]; then
     ### Check arch:
     case "$(uname --machine)" in
@@ -47,12 +55,15 @@ else
   fi
 fi
 ### Check docker compose binary:
-if docker compose &> /dev/null ; then 
+if docker compose version &> /dev/null ; then 
   DockerBin="docker compose"
-elif docker-compose &> /dev/null; then
+elif docker-compose -v &> /dev/null; then
   DockerBin="docker-compose"
+elif docker -v &> /dev/null; then
+  printf "%s\n" "No docker compose binary available, using plain docker (Not recommended!)"
+  printf "%s\n" "'docker run' will ONLY update images, not the container itself."
 else
-  printf "%s\n" "No docker compose binary available, quitting."
+  printf "%s\n" "No docker binaries available, exiting."
   exit
 fi
 
@@ -68,21 +79,24 @@ done
 ### Choose from list -function:
 choosecontainers() {
   while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do
-    printf "What containers do you like to update? \n"
-    # options
-    read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice
-    if [ "$Choice" == "0" ] ; then 
-      SelectedUpdates=( ${NumberedUpdates[@]:1} )
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
+    read -r -p "Enter number(s) separated by comma, [q] to quit: " Choice
+    if [[ "$Choice" =~ [qQnN] ]] ; then 
+      exit 0
+    elif [ "$Choice" == "0" ] ; then 
+      SelectedUpdates=( "${NumberedUpdates[@]:1}" )
+      ChoiceClean=${Choice//[,.:;]/ }
+      # ChoiceClean=$(echo "$Choice" |sed 's/[,.:;]/ /g')
     else
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
+      ChoiceClean=${Choice//[,.:;]/ }
+      # ChoiceClean=$(echo "$Choice" |sed 's/[,.:;]/ /g')
       for s in $ChoiceClean; do
-        SelectedUpdates+=( ${NumberedUpdates[$s]} )
+        SelectedUpdates+=( "${NumberedUpdates[$s]}" )
       done
     fi
   done
-  printf "\nYou've SelectedUpdates:\n"
+  printf "\nUpdating containers:\n"
   printf "%s\n" "${SelectedUpdates[@]}"
+  printf "\n"
 }
 
 ### Check the image-hash of every running container VS the registry
@@ -90,47 +104,72 @@ for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
   printf ". "
   RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
   LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
-  RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null)
-  # Check if regtcl produces errors - add to GotErrors if so.
-  if [ $? -eq 0 ] ; then
+  ### Checking for errors while setting the variable:
+  if RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null) ; then
     if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
   else
     GotErrors+=("$i")
   fi
 done
 
+### Sort arrays alphabetically
+IFS=$'\n' 
+NoUpdates=($(sort <<<"${NoUpdates[*]}"))
+GotUpdates=($(sort <<<"${GotUpdates[*]}"))
+GotErrors=($(sort <<<"${GotErrors[*]}"))
+unset IFS
 ### Create new Array to use for the numbered list:
 NumberedUpdates=(ALL "${GotUpdates[@]}")
 
 ### List what containers got updates or not
-if [ -n "$NoUpdates" ] ; then
+if [[ -n ${NoUpdates[*]} ]] ; then
   printf "\n\033[32;1mContainers on latest version:\033[0m\n"
   printf "%s\n" "${NoUpdates[@]}"
 fi
-if [ -n "$GotErrors" ] ; then
+if [[ -n ${GotErrors[*]} ]] ; then
   printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n"
   printf "%s\n" "${GotErrors[@]}"
 fi
-if [ -n "$GotUpdates" ] ; then 
+if [[ -n ${GotUpdates[*]} ]] ; then 
    printf "\n\033[31;1mContainers with updates available:\033[0m\n"
-   [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}"
+   [[ -z "$UpdYes" ]] && options || printf "%s\n" "${GotUpdates[@]}"
 fi
 
 ### Optionally get updates if there's any 
 if [ -n "$GotUpdates" ] ; then
   if [ -z "$UpdYes" ] ; then
-  printf "\n\033[36;1mDo you want to update? y/[n]\033[0m "
-  read UpdYes
-  [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers
+  printf "\n\033[36;1mChoose what containers to update.\033[0m\n"
+  choosecontainers
   else
     SelectedUpdates=( "${GotUpdates[@]}" )
   fi
-  if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then
+  if [ "$UpdYes" == "${UpdYes#[Nn]}" ] ; then
     for i in "${SelectedUpdates[@]}"
     do 
-      ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir"}}')
-      $DockerBin -f "$ContPath/docker-compose.yml" pull 
-      $DockerBin -f "$ContPath/docker-compose.yml" up -d
+      ContPath=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.working_dir" }}')
+      ContConfigFile=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.project.config_files" }}')
+      ContName=$(docker inspect "$i" --format '{{ index .Config.Labels "com.docker.compose.service" }}')
+      ### Checking if compose-values are empty - hence started with docker run:
+      if [ -z "$ContPath" ] ; then 
+        if [ "$DrUp" == "yes" ] ; then
+          ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
+          docker pull "$ContImage"
+          printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
+        else
+          printf "\n\033[33;1m%s\033[0m has no compose labels, probably started with docker run - \033[33;1mskipping\033[0m\n\n" "$i"
+        fi
+        continue 
+      fi
+      ### Checking if "com.docker.compose.project.config_files" returns the full path to the config file or just the file name
+      if [[ $ContConfigFile = '/'* ]] ; then
+        ComposeFile="$ContConfigFile"
+      else
+        ComposeFile="$ContPath/$ContConfigFile"
+      fi
+      ### cd to the compose-file directory to account for people who use relative volumes, eg - ${PWD}/data:data
+      cd "$(dirname "${ComposeFile}")" || { echo "Path error - skipping $i" ; continue ; }
+      $DockerBin -f "$ComposeFile" pull "$ContName"
+      $DockerBin -f "$ComposeFile" up -d "$ContName"
     done
   else
     printf "\nNo updates installed, exiting.\n"

dockcheck_docker-run_ver.sh

@@ -1,146 +0,0 @@
-#!/bin/bash
-
-### DOCKER RUN - VERSION
-
-### WARNING WONT REBUILD CONTAINERS - ONLY GRAB NEW IMAGES
-### If running docker compose, use the main version. (recommended!)
-
-# Help Function:
-Help() {
-  echo "Syntax:     dockcheck.sh [OPTION] [part of name to filter]" 
-  echo "Example:    dockcheck.sh -a ng"
-  echo
-  echo "Options:"
-  echo "-h     Print this Help."
-  echo "-a|y   Automatic updates, without interaction."
-  echo "-n     No updates, only checking availability."
-}
-
-while getopts "aynh" options; do
-  case "${options}" in
-    a|y) UpdYes="yes" ;;
-    n) UpdYes="no" ;;
-    h|*) Help ; exit 0 ;;
-  esac
-done
-shift "$((OPTIND-1))"
-
-### Set $1 to a variable for later
-SearchName="$1"
-
-### Check if required binary exists in PATH or directory:
-if [[ $(builtin type -P "regctl") ]]; then 
-  regbin="regctl"
-elif [[ -f "./regctl" ]]; then
-  regbin="./regctl"
-else
-  printf "Required dependency 'regctl' missing, do you want it downloaded? y/[n] "
-  read GetDep
-  if [ "$GetDep" != "${GetDep#[Yy]}" ]; then
-    ### Check arch:
-    case "$(uname --machine)" in
-      x86_64|amd64) architecture="amd64" ;;
-      arm64|aarch64) architecture="arm64";;
-      *) echo "Architecture not supported, exiting." ; exit ;;
-    esac
-    curl -L https://github.com/regclient/regclient/releases/latest/download/regctl-linux-$architecture >./regctl
-    chmod 755 ./regctl
-    regbin="./regctl"
-  else
-    printf "%s\n" "Dependency missing, quitting."
-    exit
-  fi
-fi
-### Check docker compose binary:
-if docker compose &> /dev/null ; then 
-  DockerBin="docker compose"
-elif docker-compose &> /dev/null; then
-  DockerBin="docker-compose"
-else
-  printf "%s\n" "No docker compose binary available, quitting."
-  exit
-fi
-
-### Numbered List -function:
-options() {
-num=0
-for i in "${NumberedUpdates[@]}"; do
-  echo "$num) $i"
-  ((num++))
-done
-}
-
-### Choose from list -function:
-choosecontainers() {
-  while [[ "$ChoiceClean" =~ [A-Za-z] || -z "$ChoiceClean" ]]; do
-    printf "What containers do you like to update? \n"
-    # options
-    read -p 'Enter number(s) separated by comma (eg. 1,3,4): ' Choice
-    if [ "$Choice" == "0" ] ; then 
-      SelectedUpdates=( ${NumberedUpdates[@]:1} )
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-    else
-      ChoiceClean=$(echo $Choice|sed 's/[,.:;]/ /g')
-      for s in $ChoiceClean; do
-        SelectedUpdates+=( ${NumberedUpdates[$s]} )
-      done
-    fi
-  done
-  printf "\nYou've SelectedUpdates:\n"
-  printf "%s\n" "${SelectedUpdates[@]}"
-}
-
-### Check the image-hash of every running container VS the registry
-for i in $(docker ps --filter "name=$SearchName" --format '{{.Names}}') ; do
-  printf ". "
-  RepoUrl=$(docker inspect "$i" --format='{{.Config.Image}}')
-  LocalHash=$(docker image inspect "$RepoUrl" --format '{{.RepoDigests}}')
-  RegHash=$($regbin image digest --list "$RepoUrl" 2>/dev/null)
-  # Check if regtcl produces errors - add to GotErrors if so.
-  if [ $? -eq 0 ] ; then
-    if [[ "$LocalHash" = *"$RegHash"* ]] ; then NoUpdates+=("$i"); else GotUpdates+=("$i"); fi
-  else
-    GotErrors+=("$i")
-  fi
-done
-
-### Create new Array to use for the numbered list:
-NumberedUpdates=(ALL "${GotUpdates[@]}")
-
-### List what containers got updates or not
-if [ -n "$NoUpdates" ] ; then
-  printf "\n\033[32;1mContainers on latest version:\033[0m\n"
-  printf "%s\n" "${NoUpdates[@]}"
-fi
-if [ -n "$GotErrors" ] ; then
-  printf "\n\033[33;1mContainers with errors, wont get updated:\033[0m\n"
-  printf "%s\n" "${GotErrors[@]}"
-fi
-if [ -n "$GotUpdates" ] ; then 
-   printf "\n\033[31;1mContainers with updates available:\033[0m\n"
-   [ -z "$UpdYes" ] && options || printf "%s\n" "${GotUpdates[@]}"
-fi
-
-### Optionally get updates if there's any 
-if [ -n "$GotUpdates" ] ; then
-  if [ -z "$UpdYes" ] ; then
-  printf "\n\033[36;1mDo you want to update? y/[n]\033[0m "
-  read UpdYes
-  [ "$UpdYes" != "${UpdYes#[Yy]}" ] && choosecontainers
-  else
-    SelectedUpdates=( "${GotUpdates[@]}" )
-  fi
-  if [ "$UpdYes" != "${UpdYes#[Yy]}" ] ; then
-    for i in "${SelectedUpdates[@]}"; do 
-      ContImage=$(docker inspect "$i" --format='{{.Config.Image}}')
-      docker pull $ContImage
-      printf "%s\n" "$i got a new image downloaded, rebuild manually with preferred 'docker run'-parameters"
-    done
-  else
-    printf "\nNo updates installed, exiting.\n"
-  fi
-else
-  printf "\nNo updates available, exiting.\n"
-fi
-
-exit 0