Merge pull request #3 from panubo/add_tests

Add tests & fixes

Author: trnubo

.github/workflows/release.yml

@@ -0,0 +1,45 @@
+# Source: https://github.com/panubo/reference-github-actions/blob/master/github-release.yml
+
+on:
+  push:
+    tags:
+      - '*'
+
+name: GitHub Release
+
+jobs:
+  build:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Get Release Notes
+        id: get_release_notes
+        run: |
+          NOTES=$(git log --pretty=format:%s $(git tag --sort=-refname | head -1)...$(git tag --sort=-refname | head -2 | tail -1) | awk '{ print "-", $0  }')
+          NOTES="${NOTES//'%'/'%25'}"
+          NOTES="${NOTES//$'\n'/'%0A'}"
+          NOTES="${NOTES//$'\r'/'%0D'}"
+          echo "NOTES: ${NOTES}"
+          echo "::set-output name=notes::${NOTES}"
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Changes since last release:
+
+            ${{ steps.get_release_notes.outputs.notes }}
+
+          draft: true
+          prerelease: false

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+on:
+  push:
+
+name: Run Tests
+
+jobs:
+  build:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Setup BATS
+        uses: mig4/setup-bats@v1
+        with:
+          bats-version: 1.3.0
+
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Build image
+        run: |
+          make build-with-cache
+
+      - name: Tests
+        run: |
+          make test

Makefile

@@ -10,8 +10,13 @@ build:
 build-quick:
 	docker build -t $(IMAGE_NAME):$(TAG) .
 
+build-with-cache:
+	# Used by CI to speed up build and test process
+	docker pull $(IMAGE_NAME):$(TAG)
+	docker build -t $(IMAGE_NAME):$(TAG) --cache-from $(IMAGE_NAME):$(TAG) .
+
 test:
-	./tests/dind-runner.sh
+	bats -r tests/
 
 push:
 	docker push $(IMAGE_NAME):$(TAG)

README.md

@@ -39,6 +39,19 @@ Or alternatively specify the environment variables:
 
 Some subcommands require additional environment parameters.
 
+## Testing
+
+[bats](https://bats-core.readthedocs.io/en/stable/index.html) is used for testing. To test the image and commands bats and docker are required. Use the following commands to run all of the tests.
+
+```
+make build-with-cache # or make build
+make test
+```
+
+All tests are kept in `tests/` and all of the extension `.bats`. `test_functions.bash` is also loaded by each test. The functions include a setup and teardown (see bats docs) which creates and destroys a postgres target server.
+
+Using bats setup and teardown and avoiding exposing postgres ports etc should allow tests to be run in parallel.
+
 ## Status
 
 Feature incomplete. Work in progress.

commands/common.sh

@@ -86,7 +86,7 @@ parse_options() {
 
     # Options and long options
     local options="h:p:U:d:W:"
-    local longopts="host:,port:,username:,dbname:,password:,password-file:,no-create-database,no-revoke-public-create,drop-database,format:,compression:,skip-globals,skip-database:,skip-analyze,full-count"
+    local longopts="host:,port:,username:,dbname:,password:,password-file:,no-create-database,no-revoke-public-create,drop-database,format:,compression:,umask:,skip-globals,skip-database:,skip-analyze,full-count,aws-args:"
     local parsed
 
     # Parse with getopt (not getopts)
@@ -138,6 +138,10 @@ parse_options() {
           format="${2}"
           shift 2
           ;;
+        --umask)
+          umask="${2}"
+          shift 2
+          ;;
         --compression)
           compression="${2}"
           shift 2
@@ -154,6 +158,10 @@ parse_options() {
           full_count="true"
           shift
           ;;
+        --aws-args)
+          IFS=$' \n\t' read -r -a aws_args <<<"${2}"
+          shift 2
+          ;;
         --)
           shift
           break

commands/create-user-db

@@ -33,8 +33,7 @@ wait_postgres
 
 # Is this a bad idea?
 # Required for the GRANT below
-current_user="${user:-${PGUSER:-${USER}}}"
-
+current_user="${username:-${PGUSER:-${USER}}}"
 
 echoerr ">>> Creating new user (ROLE)"
 # Check is new user already exists
@@ -44,7 +43,7 @@ if [[ "$(/usr/bin/psql "${connection[@]}" -tAc "SELECT 1 FROM pg_roles WHERE rol
         new_password="$(genpasswd)"
         echoerr ">>> Generated a random password: ${new_password}"
     else
-        new_password="${args[2]}"
+        new_password="${args[1]}"
     fi
     /usr/bin/psql "${connection[@]}" -c "CREATE ROLE ${new_user} WITH LOGIN PASSWORD '${new_password}';"
 else
@@ -70,9 +69,9 @@ else
     # shellcheck disable=SC2034
     dbname="${new_user}"
     connection=()
-    for item in host port user dbname; do
+    for item in host port username dbname; do
         if [[ -n "${!item:-}" ]]; then
-            connection+=("--${item}" "${!item}")
+          connection+=("--${item}=${!item}")
         fi
     done
 

commands/save

@@ -28,6 +28,7 @@ usage() {
     echoerr ""
     echoerr "Options:"
     echoerr "    --pgdump-args    NOT IMPLEMENTED"
+    echoerr "    --aws-args    OPTIONS"
     echoerr "    --format    plain|custom"
     echoerr "    --compression    gzip|lz4|bz2|none"
     echoerr "    --date-format    %Y%m%d%H%M%S"
@@ -61,7 +62,7 @@ case "${dest}" in
         ;;
     s3://*)
         echo ">> aws s3"
-        save_cmd=( "aws" "s3" "sync" "--no-progress" )
+        save_cmd=( "aws" "${aws_args[@]}" "s3" "sync" "--no-progress" )
         dest_type="s3"
         ;;
     file://*|/*|./*)
@@ -195,6 +196,7 @@ if [[ "${dest_type}" == "file" ]]; then
     ls -l "${full_path}"
 else
     echo ">> Uploading to ${full_path}"
+    echoerr "${save_cmd[@]}" "${save_path}" "${full_path}"
     "${save_cmd[@]}" "${save_path}" "${full_path}"
 
     # Clean up the save path if successful and not a file type save

tests/00-smoke-test.bats

@@ -0,0 +1,12 @@
+load test_functions.bash
+load standard_setup.bash
+
+@test "smoke test - select 1" {
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=postgres \
+		-e DATABASE_PASSWORD=password \
+		panubo/postgres-toolbox psql -- -c 'SELECT 1;'
+	diag "${output}"
+	[[ "${status}" -eq 0 ]]
+}

tests/config.sh

@@ -0,0 +1,22 @@
+load test_functions.bash
+load standard_setup.bash
+
+@test "create-user-db" {
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=postgres \
+		-e DATABASE_PASSWORD=password \
+		panubo/postgres-toolbox create-user-db myuser myuserpassword
+	diag "${output}"
+	[[ "${status}" -eq 0 ]]
+
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=myuser \
+		-e DATABASE_PASSWORD=myuserpassword \
+		panubo/postgres-toolbox psql -- -c 'SELECT current_database();'
+	diag "${output}"
+	[[ "${status}" -eq 0 ]]
+	# check the output of the second last line
+	[[ "${lines[-2]}" = " myuser" ]]
+}

tests/create-user-db.bats

@@ -0,0 +1,31 @@
+load test_functions.bash
+load standard_setup.bash
+
+@test "drop-user-db" {
+	# create the user
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=postgres \
+		-e DATABASE_PASSWORD=password \
+		panubo/postgres-toolbox create-user-db myuser myuserpassword
+	diag "${output}"
+	[[ "${status}" -eq 0 ]]
+
+	# drop the user
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=postgres \
+		-e DATABASE_PASSWORD=password \
+		panubo/postgres-toolbox drop-user-db --drop-database myuser
+	diag "${output}"
+	[[ "${status}" -eq 0 ]]
+
+	# check the user and db do not exist
+	run docker run --rm \
+		-e DATABASE_HOST=${postgres_container_ip} \
+		-e DATABASE_USERNAME=postgres \
+		-e DATABASE_PASSWORD=password \
+		panubo/postgres-toolbox psql -- -c 'SELECT count(*) FROM pg_database WHERE datname='"'myuser'"';'
+	diag "${output}"
+	[[ "${lines[-2]}" -eq "0" ]]
+}