From 6ce197696a64debe405d1603173d90671e094f27 Mon Sep 17 00:00:00 2001
From: Frederik Ring <frederik.ring@gmail.com>
Date: Fri, 9 Jul 2021 08:14:35 +0200
Subject: [PATCH 1/4] scaffold basic testing in CI

---
 .circleci/config.yml            | 22 ++++++++--------------
 src/backup.sh                   | 16 +++++++++++-----
 test/default/docker-compose.yml |  0
 test/default/test.sh            |  5 +++++
 4 files changed, 24 insertions(+), 19 deletions(-)
 create mode 100644 test/default/docker-compose.yml
 create mode 100644 test/default/test.sh

diff --git a/.circleci/config.yml b/.circleci/config.yml
index 5470420..6100f32 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -2,29 +2,23 @@ version: 2.1
 
 jobs:
   canary:
-    docker:
-      - image: cimg/base:2020.06
+    machine:
+      image: ubuntu-1604:202007-01
     working_directory: ~/docker-volume-backup
     steps:
       - checkout
-      - setup_remote_docker:
-          version: 20.10.6
       - run:
           name: Build
           command: |
             docker build . -t offen/docker-volume-backup:canary
       - run:
-          name: Create container from image
+          name: Run tests
           command: |
-            docker run -d offen/docker-volume-backup:canary
-            echo "Sleeping for 30s before checking if container is still running."
-            sleep 30
-            count=$(docker ps -q | wc -l)
-            if [[ $count != "1" ]]; then
-              echo "Expected one container to be running, found $count."
-              exit 1
-            fi
-            docker stop $(docker ps -q)
+            which docker
+            which docker-compose
+            for test in test/**/test.sh; do
+              . $test
+            done
 
   build:
     docker:
diff --git a/src/backup.sh b/src/backup.sh
index d46c7a2..ab98f96 100644
--- a/src/backup.sh
+++ b/src/backup.sh
@@ -17,13 +17,12 @@ DOCKER_SOCK="/var/run/docker.sock"
 
 if [ -S "$DOCKER_SOCK" ]; then
   TEMPFILE="$(mktemp)"
-  docker ps \
-    --format "{{.ID}}" \
+  docker ps -q \
     --filter "label=docker-volume-backup.stop-during-backup=$BACKUP_STOP_CONTAINER_LABEL" \
     > "$TEMPFILE"
   CONTAINERS_TO_STOP="$(cat $TEMPFILE | tr '\n' ' ')"
   CONTAINERS_TO_STOP_TOTAL="$(cat $TEMPFILE | wc -l)"
-  CONTAINERS_TOTAL="$(docker ps --format "{{.ID}}" | wc -l)"
+  CONTAINERS_TOTAL="$(docker ps -q | wc -l)"
   rm "$TEMPFILE"
   echo "$CONTAINERS_TOTAL containers running on host in total."
   echo "$CONTAINERS_TO_STOP_TOTAL containers marked to be stopped during backup."
@@ -99,7 +98,12 @@ if [ ! -z "$BACKUP_RETENTION_DAYS" ]; then
   sleep "$BACKUP_PRUNING_LEEWAY"
   bucket=$AWS_S3_BUCKET_NAME
 
-  rule_applies_to=$(mc rm $MC_GLOBAL_OPTIONS --fake --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket" | wc -l)
+  rule_applies_to=$(
+    mc rm $MC_GLOBAL_OPTIONS --fake --recursive -force \
+      --older-than "${BACKUP_RETENTION_DAYS}d" \
+      "backup-target/$bucket" \
+      | wc -l
+  )
   if [ "$rule_applies_to" == "0" ]; then
     echo "No backups found older than the configured retention period of $BACKUP_RETENTION_DAYS days."
     echo "Doing nothing."
@@ -114,6 +118,8 @@ if [ ! -z "$BACKUP_RETENTION_DAYS" ]; then
     exit 1
   fi
 
-  mc rm $MC_GLOBAL_OPTIONS --recursive -force --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket"
+  mc rm $MC_GLOBAL_OPTIONS \
+    --recursive -force \
+    --older-than "${BACKUP_RETENTION_DAYS}d" "backup-target/$bucket"
   echo "Successfully pruned ${rule_applies_to} backups older than ${BACKUP_RETENTION_DAYS} days."
 fi
diff --git a/test/default/docker-compose.yml b/test/default/docker-compose.yml
new file mode 100644
index 0000000..e69de29
diff --git a/test/default/test.sh b/test/default/test.sh
new file mode 100644
index 0000000..499f26e
--- /dev/null
+++ b/test/default/test.sh
@@ -0,0 +1,5 @@
+#!/bin/sh
+
+set -e
+
+echo "all is well"

From 6d3e43680c8ba44e232c2c8a9dcee31a7aefdde4 Mon Sep 17 00:00:00 2001
From: Frederik Ring <frederik.ring@gmail.com>
Date: Fri, 9 Jul 2021 09:21:42 +0200
Subject: [PATCH 2/4] add basic integration test

---
 .circleci/config.yml            |  4 +---
 .dockerignore                   |  1 +
 src/entrypoint.sh               |  3 ++-
 test/default/docker-compose.yml | 41 +++++++++++++++++++++++++++++++++
 test/default/test.sh            | 15 +++++++++++-
 5 files changed, 59 insertions(+), 5 deletions(-)
 create mode 100644 .dockerignore
 mode change 100644 => 100755 test/default/test.sh

diff --git a/.circleci/config.yml b/.circleci/config.yml
index 6100f32..01129a5 100644
--- a/.circleci/config.yml
+++ b/.circleci/config.yml
@@ -14,10 +14,8 @@ jobs:
       - run:
           name: Run tests
           command: |
-            which docker
-            which docker-compose
             for test in test/**/test.sh; do
-              . $test
+              /bin/sh $test
             done
 
   build:
diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..9daeafb
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1 @@
+test
diff --git a/src/entrypoint.sh b/src/entrypoint.sh
index 1584ef6..10a39ed 100644
--- a/src/entrypoint.sh
+++ b/src/entrypoint.sh
@@ -19,6 +19,7 @@ BACKUP_PRUNING_LEEWAY="${BACKUP_PRUNING_LEEWAY:-10m}"
 
 AWS_S3_BUCKET_NAME="${AWS_S3_BUCKET_NAME:-}"
 AWS_ENDPOINT="${AWS_ENDPOINT:-s3.amazonaws.com}"
+AWS_ENDPOINT_PROTO="${AWS_ENDPOINT_PROTO:-https}"
 
 GPG_PASSPHRASE="${GPG_PASSPHRASE:-}"
 
@@ -29,7 +30,7 @@ EOF
 chmod a+x env.sh
 source env.sh
 
-mc $MC_GLOBAL_OPTIONS alias set backup-target "https://$AWS_ENDPOINT" "$AWS_ACCESS_KEY_ID" "$AWS_SECRET_ACCESS_KEY"
+mc $MC_GLOBAL_OPTIONS alias set backup-target "$AWS_ENDPOINT_PROTO://$AWS_ENDPOINT" "$AWS_ACCESS_KEY_ID" "$AWS_SECRET_ACCESS_KEY"
 
 # Add our cron entry, and direct stdout & stderr to Docker commands stdout
 echo "Installing cron.d entry with expression $BACKUP_CRON_EXPRESSION."
diff --git a/test/default/docker-compose.yml b/test/default/docker-compose.yml
index e69de29..bd08214 100644
--- a/test/default/docker-compose.yml
+++ b/test/default/docker-compose.yml
@@ -0,0 +1,41 @@
+version: '3'
+
+services:
+  minio:
+    image: minio/minio:RELEASE.2020-08-04T23-10-51Z
+    environment:
+      MINIO_ROOT_USER: test
+      MINIO_ROOT_PASSWORD: test
+      MINIO_ACCESS_KEY: test
+      MINIO_SECRET_KEY: GMusLtUmILge2by+z890kQ
+    entrypoint: /bin/ash -c 'mkdir -p /data/backup && minio server /data'
+    volumes:
+      - backup_data:/data
+
+  backup: &default_backup_service
+    image: offen/docker-volume-backup:canary
+    depends_on:
+      - minio
+    restart: always
+    environment:
+      AWS_ACCESS_KEY_ID: test
+      AWS_SECRET_ACCESS_KEY: GMusLtUmILge2by+z890kQ
+      AWS_ENDPOINT: minio:9000
+      AWS_ENDPOINT_PROTO: http
+      AWS_S3_BUCKET_NAME: backup
+      BACKUP_FILENAME: test.tar.gz
+    volumes:
+      - app_data:/backup/app_data:ro
+      - /var/run/docker.sock:/var/run/docker.sock
+
+  offen:
+    image: offen/offen:latest
+    labels:
+      - docker-volume-backup.stop-during-backup=true
+    volumes:
+      - app_data:/var/opt/offen
+
+
+volumes:
+  backup_data:
+  app_data:
diff --git a/test/default/test.sh b/test/default/test.sh
old mode 100644
new mode 100755
index 499f26e..0b6a459
--- a/test/default/test.sh
+++ b/test/default/test.sh
@@ -2,4 +2,17 @@
 
 set -e
 
-echo "all is well"
+cd $(dirname $0)
+
+docker-compose up -d
+sleep 5
+
+docker-compose exec backup backup
+
+docker run --rm -it \
+  -v default_backup_data:/data alpine \
+  ash -c 'tar -xf /data/backup/test.tar.gz && test -f /backup/app_data/offen.db'
+
+docker-compose down --volumes
+
+echo "Test passed"

From 88d4326e6162b21c68265d55038d3a434cfcbbf9 Mon Sep 17 00:00:00 2001
From: Frederik Ring <frederik.ring@gmail.com>
Date: Fri, 9 Jul 2021 09:50:59 +0200
Subject: [PATCH 3/4] define cron schedule that never runs

---
 test/default/docker-compose.yml | 1 +
 1 file changed, 1 insertion(+)

diff --git a/test/default/docker-compose.yml b/test/default/docker-compose.yml
index bd08214..f9e942e 100644
--- a/test/default/docker-compose.yml
+++ b/test/default/docker-compose.yml
@@ -24,6 +24,7 @@ services:
       AWS_ENDPOINT_PROTO: http
       AWS_S3_BUCKET_NAME: backup
       BACKUP_FILENAME: test.tar.gz
+      BACKUP_CRON_EXPRESSION: 0 0 5 31 2 ?
     volumes:
       - app_data:/backup/app_data:ro
       - /var/run/docker.sock:/var/run/docker.sock

From 44d65c1a67fb3996d9ba17369939ccc198a004e5 Mon Sep 17 00:00:00 2001
From: Frederik Ring <frederik.ring@gmail.com>
Date: Fri, 9 Jul 2021 09:57:05 +0200
Subject: [PATCH 4/4] assert that all containers are back up and running after
 backup

---
 test/default/test.sh | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/test/default/test.sh b/test/default/test.sh
index 0b6a459..550cfec 100755
--- a/test/default/test.sh
+++ b/test/default/test.sh
@@ -13,6 +13,12 @@ docker run --rm -it \
   -v default_backup_data:/data alpine \
   ash -c 'tar -xf /data/backup/test.tar.gz && test -f /backup/app_data/offen.db'
 
+if [ "$(docker-compose ps -q | wc -l)" != "3" ]; then
+  echo "Expected all containers to be running post backup, instead seen:"
+  docker-compose ps
+  exit 1
+fi
+
 docker-compose down --volumes
 
 echo "Test passed"