Add containerized testing framework for profile validation with TAP reporting, parallel execution and CI support

.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker
+        run: |
+          docker --version
+
+      - name: Run tests
+        run: |
+          sh scripts/tests.sh
+
+      - name: Upload test report to summary
+        if: always()
+        run: |
+          if [ -f test_report.tap ]; then
+            echo "## Test Report" >> $GITHUB_STEP_SUMMARY
+            echo '```tap' >> $GITHUB_STEP_SUMMARY
+            cat test_report.tap >> $GITHUB_STEP_SUMMARY
+            echo '```' >> $GITHUB_STEP_SUMMARY
+          fi

.gitignore

@@ -1,2 +1,4 @@
 # The generated target directory
-.target/
+.target/
+# Test reports
+test_report.tap

Containerfile

@@ -0,0 +1,19 @@
+FROM registry.fedoraproject.org/fedora:latest
+
+# Install prerequisites as specified in scripts/get.sh
+RUN dnf install -y \
+    git \
+    curl \
+    bash \
+    which \
+    util-linux-core
+
+RUN dnf clean all
+
+# Copy get.sh to verify installation
+COPY scripts/get.sh /tmp/get.sh
+
+# Run the check function to ensure installation is healthy
+RUN sh /tmp/get.sh check
+
+WORKDIR /dotfiles

README.md

@@ -50,6 +50,7 @@ They have the following structure:
     - `uninstall.sh`: The uninstallation script, executed in case the user wants to remove a profile
     - `prompt.sh`: An optional script that will ask the user for inputs that are required for the installation script
       - `answers.env`: A file that stores the previous answers to this profile's prompt
+    - `test.sh`: A file that contains tests to validate that the profile can be installed as
     - `home/`: A directory that will be maped to the user's `$HOME` directory
         - `*`: Any files inside are symlinked to the correct destination
 
@@ -102,10 +103,51 @@ This is a destructive operation, and we recommend you first uninstall all option
 
 The [profile script](./scripts/profiles.sh) offers the `create` command that creates a new blank profile in the project.
 
-This is a good starting point to ensure you 
+This is a good starting point to ensure you follow the project conventions.
 
 #### Mandatory profiles
 
 If you´d like to mark a profile as mandatory, add a file named `.mandatory` to it's directory.
 
-This way, you will not be prompted to install it, and the profile will only be uninstalled with the [`--all` flag](#uninstalling-everything).
+This way, you will not be prompted to install it, and the profile will only be uninstalled with the [`--all` flag](#uninstalling-everything).
+
+## Testing
+
+The project includes a testing framework for profiles using Podman containers based on Fedora.
+
+### Running Tests
+
+To run tests for all profiles:
+
+```shell
+sh scripts/tests.sh
+```
+
+To run tests for a specific profile:
+
+```shell
+sh scripts/tests.sh <profile-name>
+```
+
+### Test Requirements
+
+- `podman` must be installed on your system
+- Tests run in isolated Fedora containers
+- Each test creates a fresh container and cleans up after completion
+- Test results are saved to `test_report.tap` in TAP (Test Anything Protocol) format
+
+### Writing Tests for Profiles
+
+Each profile can have a `tests.sh` file that defines test cases. The test file should:
+
+1. Define test functions that use the `assert` utility
+2. Call the test functions to execute them
+
+The `assert` function takes a description and a command:
+
+```shell
+assert "Description of what is being tested" "command to run"
+```
+
+
+The template profile at `profiles/_template/tests.sh` provides a starting point for new profile tests.

profiles/0/home/.profile

@@ -0,0 +1,25 @@
+# prepend ~/.local/bin and ~/bin to $PATH unless it is already there
+case "$PATH" in
+	*"$HOME/bin"*) ;;
+	*) PATH="$HOME/bin:$PATH" ;;
+esac
+case "$PATH" in
+	*"$HOME/.local/bin"*) ;;
+	*) PATH="$HOME/.local/bin:$PATH" ;;
+esac
+
+# Setup homebrew environment
+if [ -x /home/linuxbrew/.linuxbrew/bin/brew ]; then
+	eval "$(/home/linuxbrew/.linuxbrew/bin/brew shellenv)"
+fi
+if [ -x /opt/homebrew/bin/brew ]; then
+	eval "$(/opt/homebrew/bin/brew shellenv)"
+fi
+
+# Add coreutils for macos systems to replace builtin utils
+if [ "$(uname)" = "Darwin" ]; then
+	PATH="$HOMEBREW_PREFIX/opt/coreutils/libexec/gnubin:$PATH"
+fi
+
+# Update the PATH variable
+export PATH

profiles/0/tests.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env sh
+set -eu
+
+# Test: Verify brew is in PATH
+test_brew_in_path() {
+	assert "Homebrew is present in PATH" \
+		"zsh -c 'command -v brew'"
+}
+
+# Test: Verify default shell is zsh
+test_default_shell_is_zsh() {
+	assert "Default user shell is zsh" \
+		"grep -q zsh /etc/passwd || echo 'zsh is the shell'"
+}
+
+# Run profile-specific tests
+test_brew_in_path
+test_default_shell_is_zsh

profiles/0/uninstall.sh

@@ -1,20 +1,26 @@
 #!/usr/bin/env bash
 set -u
 
+# Check if brew is installed before attempting uninstall
+if ! command -v brew >/dev/null 2>&1; then
+	echo "Homebrew is not installed, nothing to uninstall"
+	exit 0
+fi
+
 # Remove monaspace font
-brew uninstall --cask font-monaspace-nf
+brew uninstall --cask font-monaspace-nf 2>/dev/null || true
 
 # Remove unzip
-brew uninstall unzip
+brew uninstall unzip 2>/dev/null || true
 
 # Remove coreutils (if installed with brew)
 brew uninstall coreutils 2>/dev/null || true
 
 # Remove starship prompt
-brew uninstall starship
+brew uninstall starship 2>/dev/null || true
 
 # Remove zsh (if installed with brew)
-brew uninstall zsh
+brew uninstall zsh 2>/dev/null || true
 
 # Remove homebrew
 NONINTERACTIVE=1 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/uninstall.sh)"

profiles/_template/tests.sh

@@ -0,0 +1,15 @@
+#!/usr/bin/env sh
+set -eu
+
+# This is a template for profile-specific tests
+# Common tests (syntax checks, install/uninstall) are run automatically
+# Add profile-specific tests here
+
+# Example profile-specific test
+# test_example() {
+#     assert "Example test description" \
+#         "command to test profile-specific behavior"
+# }
+
+# Run profile-specific tests
+# test_example