gentleman-e2e

When to Use

Use this skill when:

• Adding E2E tests for new features
• Creating Dockerfiles for new platforms
• Modifying the E2E test script
• Debugging installation failures
• Adding backup/restore test coverage

---

Critical Patterns

Pattern 1: Test Script Structure

All E2E tests in e2e_test.sh follow this pattern:

# Colors
RED='\033[0;31m'
GREEN='\033[0;32m'
YELLOW='\033[1;33m'
NC='\033[0m'

# Logging functions
log_test() { printf "${YELLOW}[TEST]${NC} %s\n" "$1"; }
log_pass() { printf "${GREEN}[PASS]${NC} %s\n" "$1"; PASSED=$((PASSED + 1)); }
log_fail() { printf "${RED}[FAIL]${NC} %s\n" "$1"; FAILED=$((FAILED + 1)); }

# Test function pattern
test_feature_name() {
    log_test "Description of what we're testing"

    if some_condition; then
        log_pass "What passed"
    else
        log_fail "What failed"
    fi
}

Pattern 2: Dockerfile Structure

Each platform has a Dockerfile in e2e/:

FROM ubuntu:22.04

# Install base dependencies
RUN apt-get update && apt-get install -y \
    git curl sudo build-essential \
    && rm -rf /var/lib/apt/lists/*

# Create test user (non-root)
RUN useradd -m -s /bin/bash testuser && \
    echo "testuser ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers

# Copy installer binary
COPY gentleman-installer-linux-amd64 /usr/local/bin/gentleman-dots
RUN chmod +x /usr/local/bin/gentleman-dots

# Copy test script
COPY e2e/e2e_test.sh /home/testuser/e2e_test.sh
RUN chmod +x /home/testuser/e2e_test.sh

USER testuser
WORKDIR /home/testuser

# Run tests
CMD ["./e2e_test.sh"]

Pattern 3: Non-Interactive Mode Testing

E2E tests use --non-interactive flag:

test_fish_tmux_nvim() {
    log_test "Install: Fish + Tmux + Nvim"

    if GENTLEMAN_VERBOSE=1 gentleman-dots --non-interactive \
        --shell=fish --wm=tmux --nvim --backup=false 2>&1; then

        # Verify fish config exists
        if [ -f "$HOME/.config/fish/config.fish" ]; then
            log_pass "Fish config was created"
        else
            log_fail "Fish config not found"
            return
        fi

        # Verify nvim config exists
        if [ -d "$HOME/.config/nvim" ]; then
            log_pass "Neovim config directory created"
        else
            log_fail "Neovim config directory not found"
        fi
    else
        log_fail "Installation failed"
    fi
}