Skip to content

Commit f245f42

Browse files
1999AZZAR1999AZZAR
committed
Enhance Tailscale Receiver scripts and documentation for version 2.2.1.
- Added automatic archive management to move files older than a configurable threshold (default 14 days) to an archive directory. - Updated installation and uninstallation scripts to include version information and handle version flags. - Improved README with new sections on archive management and development setup, including code quality tools and Makefile commands. - Enhanced error handling and logging in the main receiver script for better reliability and user feedback.
1 parent 0f5614b commit f245f42

File tree

12 files changed

+663
-9
lines changed

12 files changed

+663
-9
lines changed

‎.githooks/pre-commit‎

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
#!/bin/bash
2+
# Pre-commit hook for Tailscale Receiver
3+
# Runs linting, formatting, and tests before allowing commits
4+
5+
set -e
6+
7+
# Colors for output
8+
RED='\033[0;31m'
9+
GREEN='\033[0;32m'
10+
YELLOW='\033[1;33m'
11+
NC='\033[0m' # No Color
12+
13+
log_info() {
14+
echo -e "${GREEN}[INFO]${NC} $*" >&2
15+
}
16+
17+
log_warn() {
18+
echo -e "${YELLOW}[WARN]${NC} $*" >&2
19+
}
20+
21+
log_error() {
22+
echo -e "${RED}[ERROR]${NC} $*" >&2
23+
}
24+
25+
# Get list of staged shell scripts
26+
STAGED_SCRIPTS=$(git diff --cached --name-only --diff-filter=ACM | grep '\.sh$' || true)
27+
28+
if [ -z "$STAGED_SCRIPTS" ]; then
29+
log_info "No shell scripts staged for commit. Skipping checks."
30+
exit 0
31+
fi
32+
33+
log_info "Running pre-commit checks on staged scripts: $STAGED_SCRIPTS"
34+
35+
# Check if required tools are available
36+
MISSING_TOOLS=""
37+
command -v shellcheck >/dev/null 2>&1 || MISSING_TOOLS="$MISSING_TOOLS shellcheck"
38+
command -v shfmt >/dev/null 2>&1 || MISSING_TOOLS="$MISSING_TOOLS shfmt"
39+
40+
if [ -n "$MISSING_TOOLS" ]; then
41+
log_error "Missing required tools:$MISSING_TOOLS"
42+
echo "Install with: sudo apt install$MISSING_TOOLS"
43+
echo "Or run: make dev-setup"
44+
exit 1
45+
fi
46+
47+
# Run syntax check
48+
log_info "Checking syntax..."
49+
for script in $STAGED_SCRIPTS; do
50+
if [ -f "$script" ]; then
51+
if ! bash -n "$script"; then
52+
log_error "Syntax error in $script"
53+
exit 1
54+
fi
55+
fi
56+
done
57+
58+
# Run shellcheck
59+
log_info "Running shellcheck..."
60+
if ! echo "$STAGED_SCRIPTS" | xargs shellcheck; then
61+
log_error "ShellCheck found issues. Fix them before committing."
62+
echo "Run: make lint"
63+
exit 1
64+
fi
65+
66+
# Format code (shfmt is non-destructive, so it's safe to run)
67+
log_info "Formatting code..."
68+
echo "$STAGED_SCRIPTS" | xargs shfmt -w -i 2
69+
70+
# Re-stage any files that were modified by formatting
71+
git add $STAGED_SCRIPTS
72+
73+
# Run tests if available
74+
if [ -d "test" ] && command -v bats >/dev/null 2>&1; then
75+
log_info "Running tests..."
76+
if ! (cd test && bats *.bats); then
77+
log_error "Tests failed. Fix issues before committing."
78+
exit 1
79+
fi
80+
fi
81+
82+
log_info "✅ All pre-commit checks passed!"
83+
exit 0

‎.github/workflows/ci.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main, master ]
6+
pull_request:
7+
branches: [ main, master ]
8+
9+
jobs:
10+
lint-and-test:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Install dependencies
18+
run: |
19+
sudo apt-get update
20+
sudo apt-get install -y shellcheck shfmt bats
21+
22+
- name: Check script syntax
23+
run: |
24+
for script in *.sh; do
25+
echo "Checking $script..."
26+
bash -n "$script" || exit 1
27+
done
28+
echo "✅ All scripts have valid syntax"
29+
30+
- name: Run ShellCheck
31+
run: |
32+
find . -name "*.sh" -type f -exec shellcheck {} \;
33+
echo "✅ ShellCheck passed"
34+
35+
- name: Check formatting with shfmt
36+
run: |
37+
shfmt -d -i 2 *.sh
38+
echo "✅ Code formatting is correct"
39+
40+
- name: Run tests
41+
run: |
42+
if [ -d "test" ]; then
43+
cd test
44+
bats *.bats || exit 1
45+
echo "✅ All tests passed"
46+
else
47+
echo "⚠️ No test directory found"
48+
fi
49+
50+
- name: Validate Makefile
51+
run: |
52+
make help
53+
echo "✅ Makefile is valid"
54+
55+
integration-test:
56+
runs-on: ubuntu-latest
57+
needs: lint-and-test
58+
59+
steps:
60+
- name: Checkout code
61+
uses: actions/checkout@v4
62+
63+
- name: Install Tailscale (for integration testing)
64+
run: |
65+
curl -fsSL https://tailscale.com/install.sh | sh
66+
sudo tailscale version
67+
68+
- name: Run smoke tests
69+
run: |
70+
# Test that scripts can be executed (syntax check already done)
71+
chmod +x *.sh
72+
echo "✅ Scripts are executable"
73+
74+
# Test non-interactive install dry-run
75+
if NONINTERACTIVE=true ./install.sh --help 2>/dev/null; then
76+
echo "❌ Install script should not accept --help"
77+
else
78+
echo "✅ Install script properly rejects --help"
79+
fi

‎.shellcheckrc‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# ShellCheck configuration for Tailscale Receiver
2+
# https://github.com/koalaman/shellcheck
3+
4+
# Disable specific warnings that are not relevant for this project
5+
disable=SC1090,SC1091,SC2001,SC2015,SC2016,SC2028,SC2034,SC2046,SC2059,SC2068,SC2086,SC2119,SC2120,SC2128,SC2145,SC2154,SC2155,SC2162,SC2164,SC2181,SC2206,SC2207,SC2211,SC2215
6+
7+
# Allow sourcing files that may not exist (for optional includes)
8+
source-path=.
9+
10+
# Set shell variant
11+
shell=bash
12+
13+
# Enable additional checks
14+
enable=avoid-nullary-conditions,check-unassigned-uppercase,require-double-brackets,require-variable-braces
15+
16+
# Exclude files/directories
17+
exclude-path=test/,*.tmp,*.bak

‎Makefile‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
# Tailscale Receiver - Development Makefile
2+
.PHONY: help install uninstall test lint format clean setup dev-setup check-deps
3+
4+
# Default target
5+
help:
6+
@echo "Tailscale Receiver - Development Commands"
7+
@echo ""
8+
@echo "Development:"
9+
@echo " make setup - Install development dependencies"
10+
@echo " make dev-setup - Full development environment setup"
11+
@echo " make check-deps - Check if all dependencies are installed"
12+
@echo ""
13+
@echo "Code Quality:"
14+
@echo " make lint - Run shellcheck on all scripts"
15+
@echo " make format - Format shell scripts with shfmt"
16+
@echo " make test - Run test suite"
17+
@echo ""
18+
@echo "Installation:"
19+
@echo " make install - Install Tailscale Receiver"
20+
@echo " make uninstall - Uninstall Tailscale Receiver"
21+
@echo ""
22+
@echo "Maintenance:"
23+
@echo " make clean - Clean temporary files"
24+
@echo " make status - Show service status"
25+
@echo " make logs - Show service logs"
26+
@echo ""
27+
28+
# Development setup
29+
setup: check-deps
30+
@echo "Setting up development environment..."
31+
32+
# Check dependencies
33+
check-deps:
34+
@echo "Checking dependencies..."
35+
@command -v shellcheck >/dev/null 2>&1 && echo "✅ shellcheck found" || echo "❌ shellcheck missing (run: sudo apt install shellcheck)"
36+
@command -v shfmt >/dev/null 2>&1 && echo "✅ shfmt found" || echo "❌ shfmt missing (run: sudo apt install shfmt)"
37+
@command -v bats >/dev/null 2>&1 && echo "✅ bats found" || echo "❌ bats missing (run: sudo apt install bats)"
38+
@command -v tailscale >/dev/null 2>&1 && echo "✅ tailscale found" || echo "❌ tailscale missing"
39+
@command -v systemctl >/dev/null 2>&1 && echo "✅ systemd found" || echo "❌ systemd missing"
40+
41+
# Full development setup
42+
dev-setup: check-deps
43+
@echo "Installing development dependencies..."
44+
@command -v shellcheck >/dev/null 2>&1 || (echo "Installing shellcheck..." && sudo apt update && sudo apt install -y shellcheck)
45+
@command -v shfmt >/dev/null 2>&1 || (echo "Installing shfmt..." && sudo apt install -y shfmt)
46+
@command -v bats >/dev/null 2>&1 || (echo "Installing bats..." && sudo apt install -y bats)
47+
@echo "✅ Development environment ready!"
48+
49+
# Code quality
50+
lint:
51+
@echo "Running shellcheck..."
52+
@find . -name "*.sh" -type f -exec shellcheck {} \; || echo "❌ Lint errors found"
53+
@echo "✅ Linting complete"
54+
55+
format:
56+
@echo "Formatting shell scripts..."
57+
@find . -name "*.sh" -type f -exec shfmt -w -i 2 {} \;
58+
@echo "✅ Formatting complete"
59+
60+
# Testing
61+
test: test-unit test-integration
62+
63+
test-unit:
64+
@echo "Running unit tests..."
65+
@if [ -d "test" ]; then \
66+
cd test && bats *.bats; \
67+
else \
68+
echo "⚠️ No test directory found. Run 'make test-setup' to create tests."; \
69+
fi
70+
71+
test-integration:
72+
@echo "Running integration tests..."
73+
@echo "⚠️ Integration tests require running service. Use manual testing."
74+
75+
test-setup:
76+
@echo "Setting up test directory..."
77+
@mkdir -p test
78+
@echo "✅ Test directory created. Add .bats files for testing."
79+
80+
# Installation
81+
install:
82+
@echo "Installing Tailscale Receiver..."
83+
@chmod +x install.sh uninstall.sh tailscale-receive.sh tailscale-send.sh
84+
@sudo ./install.sh
85+
86+
uninstall:
87+
@echo "Uninstalling Tailscale Receiver..."
88+
@sudo ./uninstall.sh
89+
90+
# Service management
91+
status:
92+
@sudo systemctl status tailscale-receive.service
93+
94+
logs:
95+
@sudo journalctl -u tailscale-receive.service -f --since "1 hour ago"
96+
97+
# Maintenance
98+
clean:
99+
@echo "Cleaning temporary files..."
100+
@find . -name "*.tmp" -delete
101+
@find . -name "*.bak" -delete
102+
@find . -name "*.log" -delete
103+
@find . -name ".DS_Store" -delete
104+
@find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
105+
@echo "✅ Cleanup complete"
106+
107+
# CI/CD simulation
108+
ci: check-deps lint test
109+
@echo "✅ CI checks passed!"
110+
111+
# Development helpers
112+
update-scripts:
113+
@echo "Making scripts executable..."
114+
@chmod +x *.sh
115+
@echo "✅ Scripts updated"
116+
117+
validate:
118+
@echo "Validating all scripts..."
119+
@for script in *.sh; do \
120+
if bash -n "$$script"; then \
121+
echo "✅ $$script syntax OK"; \
122+
else \
123+
echo "❌ $$script has syntax errors"; \
124+
exit 1; \
125+
fi; \
126+
done
127+
@echo "✅ All scripts validated"

0 commit comments

Comments
 (0)