Add basic tests (WIP)

.github/workflows/workflow.yml

@@ -19,10 +19,12 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+
       - run: |
           curl mise.run | sh
           echo 'export PATH=$HOME/.local/bin:$PATH' >> $GITHUB_ENV
+
       - run: mkdir -p ~/.local/share/mise/plugins
       - run: ln -s $PWD ~/.local/share/mise/plugins/poetry
       - run: mise i poetry@latest python
@@ -33,12 +35,18 @@ jobs:
       - run: cat poetry-installer-error-*.log && exit 1
         if: failure()
 
+      - name: Run tests
+        run: |-
+          mise config set settings.trusted_config_paths "${PWD}/tests"
+          mise -C "${PWD}/tests" install
+          make test
+
   lint:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Homebrew
         id: set-up-homebrew
@@ -55,7 +63,7 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Homebrew
         id: set-up-homebrew

Makefile

@@ -12,3 +12,7 @@ format-check:
 lint:
 	shellcheck $(SH_SRCFILES)
 .PHONY: lint
+
+test:
+	tests/run_tests.sh
+.PHONY: test

tests/.mise.toml

@@ -0,0 +1,2 @@
+[tools]
+"aqua:bats-core/bats-core" = "latest"

tests/01_simple/.mise.toml

@@ -0,0 +1,7 @@
+[tools]
+python = { version = "3.12" }
+poetry = { version = "latest", pyproject="{{ config_root }}/pyproject.toml" }
+
+[env]
+MISE_POETRY_AUTO_INSTALL = "true"
+MISE_POETRY_VENV_AUTO = "false"

tests/01_simple/poetry.toml

@@ -0,0 +1,3 @@
+[virtualenvs]
+in-project = true
+prefer-active-python = true

tests/01_simple/pyproject.toml

@@ -0,0 +1,12 @@
+[tool.poetry]
+name = "test"
+version = "0.0.0"
+description = "Test"
+authors = [
+  "Josh Bode <[email protected]>",
+]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+pbr = "^6.0.0"

tests/01_simple/test.bats

@@ -0,0 +1,18 @@
+#! /usr/bin/env bats
+
+@test "check environment: VIRTUAL_ENV is set" {
+    [[ ${VIRTUAL_ENV} == "${PWD}/.venv" ]]
+}
+
+@test "check environment: POETRY_ACTIVE == 1" {
+    [[ ${POETRY_ACTIVE} == "1" ]]
+}
+
+@test "check environment: PATH contains venv bin" {
+    [[ ":${PATH}:" == *":${VIRTUAL_ENV}/bin:"* ]]
+}
+
+@test "check installed packages" {
+    result=$(which pbr)
+    [[ ${result} == "${VIRTUAL_ENV}/bin/pbr" ]]
+}

tests/02_auto_venv_with_lock/.mise.toml

@@ -0,0 +1,7 @@
+[tools]
+python = { version = "3.12" }
+poetry = { version = "latest", pyproject="{{ config_root }}/pyproject.toml" }
+
+[env]
+MISE_POETRY_AUTO_INSTALL = "true"
+MISE_POETRY_VENV_AUTO = "true"

tests/02_auto_venv_with_lock/poetry.toml

@@ -0,0 +1,3 @@
+[virtualenvs]
+in-project = true
+prefer-active-python = true

tests/02_auto_venv_with_lock/pyproject.toml

@@ -0,0 +1,12 @@
+[tool.poetry]
+name = "test"
+version = "0.0.0"
+description = "Test"
+authors = [
+  "Josh Bode <[email protected]>",
+]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+pbr = "^6.0.0"

tests/02_auto_venv_with_lock/test.bats

@@ -0,0 +1,18 @@
+#! /usr/bin/env bats
+
+@test "check environment: VIRTUAL_ENV is set" {
+    [[ ${VIRTUAL_ENV} == "${PWD}/.venv" ]]
+}
+
+@test "check environment: POETRY_ACTIVE == 1" {
+    [[ ${POETRY_ACTIVE} == "1" ]]
+}
+
+@test "check environment: PATH contains venv bin" {
+    [[ ":${PATH}:" == *":${VIRTUAL_ENV}/bin:"* ]]
+}
+
+@test "check installed packages" {
+    result=$(which pbr)
+    [[ ${result} == "${VIRTUAL_ENV}/bin/pbr" ]]
+}

tests/02_auto_venv_without_lock/.mise.toml

@@ -0,0 +1,7 @@
+[tools]
+python = { version = "3.12" }
+poetry = { version = "latest", pyproject="{{ config_root }}/pyproject.toml" }
+
+[env]
+MISE_POETRY_AUTO_INSTALL = "true"
+MISE_POETRY_VENV_AUTO = "true"

tests/02_auto_venv_without_lock/poetry.toml

@@ -0,0 +1,3 @@
+[virtualenvs]
+in-project = true
+prefer-active-python = true

tests/02_auto_venv_without_lock/pyproject.toml

@@ -0,0 +1,12 @@
+[tool.poetry]
+name = "test"
+version = "0.0.0"
+description = "Test"
+authors = [
+  "Josh Bode <[email protected]>",
+]
+package-mode = false
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+pbr = "^6.0.0"

tests/02_auto_venv_without_lock/test.bats

@@ -0,0 +1,9 @@
+#! /usr/bin/env bats
+
+@test "check environment: VIRTUAL_ENV is not set" {
+    [[ ! -v VIRTUAL_ENV ]]
+}
+
+@test "check environment: POETRY_ACTIVE is not set" {
+    [[ ! -v POETRY_ACTIVE ]]
+}

tests/run_tests.sh

@@ -0,0 +1,48 @@
+#! /usr/bin/env bash
+
+set -u
+shopt -s nullglob
+
+BASE_DIR=${0%/*}
+if [ "${BASE_DIR}" = "." ]; then
+  BASE_DIR=${PWD}
+elif [ "${BASE_DIR}" = "${BASE_DIR#/}" ]; then
+  BASE_DIR=${PWD}/${BASE_DIR}
+fi
+
+SUCCESS=()
+FAILURE=()
+
+printf '██ Running tests\n'
+
+FILES=("${BASE_DIR}"/*)
+for DIR in "${FILES[@]}"; do
+  if [[ ! -d ${DIR} ]]; then
+    continue
+  fi
+  NAME=${DIR#"${BASE_DIR}/"}
+  printf '█ %s\n\n' "${NAME}"
+
+  if mise exec -C "${DIR}" -- bats -r "${DIR}"; then
+    SUCCESS+=("${NAME}")
+  else
+    FAILURE+=("${NAME}")
+  fi
+done
+
+declare -i EXIT=0
+
+if ((${#SUCCESS[@]})); then
+  printf '██ Passed:\n'
+  printf '  - %s\n' "${SUCCESS[@]}"
+  printf '\n'
+fi
+
+if ((${#FAILURE[@]})); then
+  printf '██ Failed:\n'
+  printf '  - %s\n' "${FAILURE[@]}"
+  printf '\n'
+  EXIT=1
+fi
+
+exit ${EXIT}