implement dockerll function incl. unit test

Author: devloberto

Dockerfile

@@ -5,18 +5,17 @@ ENV bashunit_version='0.23.0'
 ENV bashunit_hash='7043c1818016f330ee12671a233f89906f0d373f3b2aa231a8c40123be5a222b'
 
 # bashunit installation dependencies
-RUN apt-get update; apt-get install -y curl perl git; rm -rf /var/lib/apt/lists/*
+RUN apt-get update; apt-get install -y curl perl git docker.io sudo; rm -rf /var/lib/apt/lists/*
 
 RUN mkdir -p $bashunit_dir
 RUN curl -o /tmp/install.sh https://bashunit.typeddevs.com/install.sh
 RUN bash /tmp/install.sh $bashunit_dir $bashunit_version; ln -s $bashunit_dir/bashunit /usr/bin/bashunit; chmod +x $bashunit_dir/bashunit
 
 # verify the sha256sum for bashunit 0.14.0
-RUN DIR="$bashunit_dir"; KNOWN_HASH="$bashunit_hash"; FILE="$DIR/bashunit"; [ "$(shasum -a 256 "$FILE" | awk '{ print $1 }')" = "$KNOWN_HASH" ] && echo -e "✓ \033[1mbashunit\033[0m verified." || { echo -e "✗ \033[1mbashunit\033[0m corrupt"; rm "$FILE"; }
+RUN DIR="$bashunit_dir"; KNOWN_HASH="$bashunit_hash"; FILE="$DIR/bashunit"; [ "$(shasum -a 256 "$FILE" | awk '{ print $1 }')" = "$KNOWN_HASH" ] && echo -e "✓ \033[1mbashunit\033[0m verified." || { echo -e "✗ \033[1mbashunit\033[0m corrupt"; rm "$FILE"; } ; bashunit --version;
 
-RUN bashunit --version
-
-RUN groupadd -g 1000 dev && useradd -m -u 1000 -g dev dev
+RUN groupadd -g 1000 dev && useradd -m -u 1000 -g dev dev && \
+  echo "dev ALL=(ALL) NOPASSWD:ALL" > /etc/sudoers.d/dev && chmod 0440 /etc/sudoers.d/dev
 
 WORKDIR /home/dev/shell-dev-tools
 
@@ -30,5 +29,5 @@ RUN git config --global init.defaultBranch master && \
   git config --global user.email "shell@dev.tools" && \
   git config --global user.name "dev"
 
-ENTRYPOINT ["/bin/bash"]
+ENTRYPOINT ["/home/dev/shell-dev-tools/docker-entrypoint.sh"]
 

README.md

@@ -1,6 +1,6 @@
 # shell dev tools
 
-![tests status](https://github.com/devloberto/shell-dev-tools/actions/workflows/test.yml/badge.svg)
+[![tests status](https://github.com/devloberto/shell-dev-tools/actions/workflows/test.yml/badge.svg)](https://github.com/devloberto/shell-dev-tools/actions/workflows/test.yml)
 
 handy tools for developers using bash or zsh
 

compose.yml

@@ -8,5 +8,5 @@ services:
         - shell-dev-tools:debian-trixie
     volumes:
       - $PWD:/home/dev/shell-dev-tools
-    entrypoint: tail -f /dev/null
+      - /var/run/docker.sock:/var/run/docker.sock:ro
 

docker-entrypoint.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+# setup docker group to match the host's docker socket group
+DOCKER_GID=$(stat -c '%g' /var/run/docker.sock)
+if ! getent group docker >/dev/null; then
+  sudo groupadd -g "$DOCKER_GID" docker
+else
+  sudo groupmod -g "$DOCKER_GID" docker
+fi
+sudo usermod -aG docker dev # and add 'dev' user to docker group
+
+# keep the container running
+tail -f /dev/null

shell-dev-tools.sh

@@ -1,6 +1,7 @@
 SOURCE="${BASH_SOURCE[0]:-${(%):-%x}}" # bash and zsh compatability
 SCRIPT_DIR="$(realpath -e -- "$(dirname -- "$SOURCE")")"
 
+source "$SCRIPT_DIR/src/docker.sh"
 source "$SCRIPT_DIR/src/git_delete_all_branches_but_default.sh"
 source "$SCRIPT_DIR/src/strcnt.sh"
 source "$SCRIPT_DIR/src/unix.sh"

src/docker.sh

@@ -0,0 +1,3 @@
+dockerll() {
+  docker ps -a --format "table {{ .Names }}\t{{ .Status }}\t{{ .Networks }}\t{{ .Ports }}"
+}

tests/docker_test.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+
+function set_up() {
+  ROOT_DIR="$(dirname "${BASH_SOURCE[0]}")/.."
+  source "$ROOT_DIR/src/docker.sh"
+}
+
+test_dockerll() {
+  local output=$(dockerll)
+
+  # output header
+  local first_line=$(echo "$output" | head -n 1)
+  assert_contains "NAMES " "$first_line"
+  assert_contains " STATUS " "$first_line"
+  assert_contains " NETWORKS " "$first_line"
+  assert_contains " PORTS" "$first_line"
+
+  # output shell-dev-tools container
+  local second_line=$(echo "$output" | sed -n '2p') # @TODO: what if it's not the 2. line?
+  assert_contains "shell-dev-tools " "$second_line"
+  assert_matches " Up [0-9]+ minutes " "$second_line"
+  assert_contains " shell-dev-tools_default" "$second_line"
+}