♻️ Introduce unit-testing

elgohr · elgohr · commit c1b51ed293e7 · 2024-11-02T15:14:52.000+01:00
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "docker"
+    directory: "/"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,6 +7,13 @@ on:
       - '*'
 
 jobs:
+  test:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+    - uses: actions/checkout@v4
+    - run: make test
   integration-test:
     runs-on: ubuntu-latest
     permissions:
@@ -27,7 +34,6 @@ jobs:
       with:
         title: ${{ github.sha }}
         tag: ${{ github.run_id }}
-
   release:
     runs-on: ubuntu-latest
     needs:
diff --git a/Dockerfile b/Dockerfile
@@ -0,0 +1,10 @@
+FROM ubuntu:24.04@sha256:99c35190e22d294cdace2783ac55effc69d32896daaa265f0bbedbcde4fbe3e5 as testEnv
+RUN apt-get update && apt-get install -y coreutils bats
+
+ADD mock.sh /usr/local/mock/gh
+ADD mock.sh /usr/local/mock/cd
+
+ADD entrypoint.sh /entrypoint.sh
+ADD test.bats /test.bats
+
+RUN /test.bats
diff --git a/Makefile b/Makefile
@@ -0,0 +1,5 @@
+.EXPORT_ALL_VARIABLES:
+DOCKER_BUILDKIT=0# to prevent caching of test results
+
+test:
+	podman build .
diff --git a/entrypoint.sh b/entrypoint.sh
@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/usr/bin/env sh
 
 if [ ! -z "${INPUT_WORKDIR}" ]; then
     cd "${INPUT_WORKDIR}"
diff --git a/mock.sh b/mock.sh
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+binary="$0"
+parameters="$@"
+
+echo "${binary} ${parameters}" >> mockArgs
+stdin=$(cat -)
+echo "${binary} ${stdin}" >> mockStdin
+
+function mockShouldFail() {
+  [ "${MOCK_RETURNS[${binary}]}" = "_${parameters}" ]
+}
+
+source mockReturns
+
+if [ ! -z "${MOCK_RETURNS[${binary}]}" ] || [ ! -z "${MOCK_RETURNS[${binary} $1]}" ]; then
+  if mockShouldFail ; then
+    exit 1
+  fi
+  if [ ! -z "${MOCK_RETURNS[${binary} $1]}" ]; then
+    echo ${MOCK_RETURNS[${binary} $1]}
+    exit 0
+  fi
+  echo ${MOCK_RETURNS[${binary}]}
+fi
+
+exit 0
diff --git a/test.bats b/test.bats
@@ -0,0 +1,50 @@
+#!/usr/bin/env bats
+
+setup(){
+    export PATH="/usr/local/mock:/usr/bin"
+    cat /dev/null >| mockArgs
+    cat /dev/null >| mockStdin
+
+    declare -A -p MOCK_RETURNS=(
+    ['/usr/local/mock/gh']=""
+    ['/usr/local/mock/cd']=""
+    ) > mockReturns
+
+    export INPUT_TITLE='TITLE'
+}
+
+teardown() {
+    unset INPUT_WORKDIR
+    unset INPUT_TAG
+}
+
+@test "it creates a release" {
+    run /entrypoint.sh
+
+    expectMockCalledIs "/usr/local/mock/gh release create release-$(date +%Y%m%d%H%M%S) -t TITLE --generate-notes"
+}
+
+@test "it creates a release with a predefined tag" {
+    export INPUT_TAG="TAG"
+
+    run /entrypoint.sh
+
+    expectMockCalledIs "/usr/local/mock/gh release create ${INPUT_TAG} -t TITLE --generate-notes"
+}
+
+@test "it creates a release in a working directory" {
+    export INPUT_WORKDIR="WORKDIR"
+    export INPUT_TAG="TAG"
+
+    run /entrypoint.sh
+
+    expectMockCalledIs "/usr/local/mock/gh release create ${INPUT_TAG} -t TITLE --generate-notes"
+}
+
+expectMockCalledIs() {
+    local expected=$(echo "${1}" | tr -d '\n')
+    local got=$(cat mockArgs | tr -d '\n')
+    echo "Expected: |${expected}|
+    Got: |${got}|"
+    [ "${got}" == "${expected}" ]
+}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-#!/bin/sh`
	`1`	`+#!/usr/bin/env sh`
`2`	`2`
`3`	`3`	`if [ ! -z "${INPUT_WORKDIR}" ]; then`
`4`	`4`	`cd "${INPUT_WORKDIR}"`