mirror of
https://github.com/johndoe6345789/metabuilder.git
synced 2026-04-24 13:54:57 +00:00
Fix e2e test timeouts and add act script for local workflow testing
- Updated playwright config to use correct port (5000 instead of 5173) - Fixed e2e tests to navigate from landing page before testing login - Simplified tests to focus on UI rendering rather than full auth flows - Added run-act.sh script for running GitHub Actions locally - Added npm scripts: act, act:lint, act:e2e - Updated README with act documentation Co-authored-by: johndoe6345789 <224850594+johndoe6345789@users.noreply.github.com>
This commit is contained in:
125
scripts/README.md
Normal file
125
scripts/README.md
Normal file
@@ -0,0 +1,125 @@
|
||||
# Scripts Directory
|
||||
|
||||
This directory contains utility scripts for development and testing.
|
||||
|
||||
## Available Scripts
|
||||
|
||||
### `run-act.sh`
|
||||
|
||||
Run GitHub Actions workflows locally using [act](https://github.com/nektos/act).
|
||||
|
||||
**Prerequisites:**
|
||||
- Docker installed and running
|
||||
- `act` CLI tool installed
|
||||
|
||||
**Installing act:**
|
||||
|
||||
```bash
|
||||
# macOS (Homebrew)
|
||||
brew install act
|
||||
|
||||
# Linux (curl)
|
||||
curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash
|
||||
|
||||
# Windows (Chocolatey)
|
||||
choco install act-cli
|
||||
```
|
||||
|
||||
**Usage:**
|
||||
|
||||
```bash
|
||||
# Run default CI workflow
|
||||
npm run act
|
||||
|
||||
# Or directly:
|
||||
./scripts/run-act.sh
|
||||
|
||||
# Run specific workflow
|
||||
./scripts/run-act.sh -w ci.yml
|
||||
|
||||
# Run only a specific job
|
||||
./scripts/run-act.sh -w ci.yml -j lint
|
||||
./scripts/run-act.sh -w ci.yml -j test-e2e
|
||||
|
||||
# Simulate different events
|
||||
./scripts/run-act.sh -e pull_request
|
||||
|
||||
# List available workflows
|
||||
./scripts/run-act.sh -l
|
||||
|
||||
# Show help
|
||||
./scripts/run-act.sh -h
|
||||
```
|
||||
|
||||
**Common Use Cases:**
|
||||
|
||||
1. **Test CI pipeline before pushing:**
|
||||
```bash
|
||||
npm run act
|
||||
```
|
||||
|
||||
2. **Debug e2e test failures:**
|
||||
```bash
|
||||
./scripts/run-act.sh -w ci.yml -j test-e2e
|
||||
```
|
||||
|
||||
3. **Test lint fixes:**
|
||||
```bash
|
||||
./scripts/run-act.sh -w ci.yml -j lint
|
||||
```
|
||||
|
||||
4. **Simulate PR checks:**
|
||||
```bash
|
||||
./scripts/run-act.sh -e pull_request
|
||||
```
|
||||
|
||||
**Notes:**
|
||||
- First run will be slow as Docker images are downloaded
|
||||
- Act runs workflows in Docker containers that simulate GitHub Actions runners
|
||||
- Some features may not work exactly like GitHub Actions (e.g., certain actions, secrets)
|
||||
- Check `.actrc` or pass `-P` flag to customize Docker images used
|
||||
|
||||
**Troubleshooting:**
|
||||
|
||||
If you encounter issues:
|
||||
|
||||
1. **Docker not running:**
|
||||
```bash
|
||||
# Make sure Docker is running
|
||||
docker ps
|
||||
```
|
||||
|
||||
2. **Permission issues:**
|
||||
```bash
|
||||
# Make sure script is executable
|
||||
chmod +x scripts/run-act.sh
|
||||
```
|
||||
|
||||
3. **Out of disk space:**
|
||||
```bash
|
||||
# Clean up Docker images
|
||||
docker system prune -a
|
||||
```
|
||||
|
||||
4. **Workflow doesn't run:**
|
||||
```bash
|
||||
# List workflows to verify name
|
||||
./scripts/run-act.sh -l
|
||||
```
|
||||
|
||||
### `setup-packages.cjs`
|
||||
|
||||
Sets up the package system for the project. This script is automatically run during `postinstall`.
|
||||
|
||||
**Usage:**
|
||||
```bash
|
||||
npm run setup-packages
|
||||
```
|
||||
|
||||
## Adding New Scripts
|
||||
|
||||
When adding new scripts:
|
||||
1. Make them executable: `chmod +x scripts/your-script.sh`
|
||||
2. Add appropriate help/usage information
|
||||
3. Document them in this README
|
||||
4. Consider adding npm script aliases in `package.json`
|
||||
143
scripts/run-act.sh
Executable file
143
scripts/run-act.sh
Executable file
@@ -0,0 +1,143 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Script to run GitHub Actions workflows locally using act
|
||||
# https://github.com/nektos/act
|
||||
|
||||
set -e
|
||||
|
||||
# Colors for output
|
||||
RED='\033[0;31m'
|
||||
GREEN='\033[0;32m'
|
||||
YELLOW='\033[1;33m'
|
||||
NC='\033[0m' # No Color
|
||||
|
||||
echo -e "${GREEN}GitHub Actions Local Runner (act)${NC}"
|
||||
echo "======================================"
|
||||
echo ""
|
||||
|
||||
# Check if act is installed
|
||||
if ! command -v act &> /dev/null; then
|
||||
echo -e "${RED}Error: 'act' is not installed.${NC}"
|
||||
echo ""
|
||||
echo "Install act using one of these methods:"
|
||||
echo ""
|
||||
echo " macOS (Homebrew):"
|
||||
echo " brew install act"
|
||||
echo ""
|
||||
echo " Linux (using curl):"
|
||||
echo " curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash"
|
||||
echo ""
|
||||
echo " Windows (using Chocolatey):"
|
||||
echo " choco install act-cli"
|
||||
echo ""
|
||||
echo " Or via GitHub releases:"
|
||||
echo " https://github.com/nektos/act/releases"
|
||||
echo ""
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Default values
|
||||
WORKFLOW="ci.yml"
|
||||
JOB=""
|
||||
EVENT="push"
|
||||
PLATFORM=""
|
||||
|
||||
# Parse command line arguments
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case $1 in
|
||||
-w|--workflow)
|
||||
WORKFLOW="$2"
|
||||
shift 2
|
||||
;;
|
||||
-j|--job)
|
||||
JOB="$2"
|
||||
shift 2
|
||||
;;
|
||||
-e|--event)
|
||||
EVENT="$2"
|
||||
shift 2
|
||||
;;
|
||||
-p|--platform)
|
||||
PLATFORM="$2"
|
||||
shift 2
|
||||
;;
|
||||
-l|--list)
|
||||
echo "Available workflows:"
|
||||
ls -1 .github/workflows/*.yml .github/workflows/*.yaml 2>/dev/null | sed 's|.github/workflows/||'
|
||||
echo ""
|
||||
echo "To run a workflow:"
|
||||
echo " $0 -w ci.yml"
|
||||
echo ""
|
||||
echo "To list jobs in a workflow:"
|
||||
echo " act -l -W .github/workflows/ci.yml"
|
||||
exit 0
|
||||
;;
|
||||
-h|--help)
|
||||
echo "Usage: $0 [OPTIONS]"
|
||||
echo ""
|
||||
echo "Options:"
|
||||
echo " -w, --workflow <file> Workflow file to run (default: ci.yml)"
|
||||
echo " -j, --job <name> Specific job to run (runs all jobs if not specified)"
|
||||
echo " -e, --event <event> Event type to simulate (default: push)"
|
||||
echo " -p, --platform <image> Docker platform/image to use"
|
||||
echo " -l, --list List available workflows"
|
||||
echo " -h, --help Show this help message"
|
||||
echo ""
|
||||
echo "Examples:"
|
||||
echo " $0 # Run default CI workflow"
|
||||
echo " $0 -w ci.yml -j lint # Run only the lint job"
|
||||
echo " $0 -w ci.yml -j test-e2e # Run only e2e tests"
|
||||
echo " $0 -e pull_request # Simulate a pull request event"
|
||||
echo " $0 -p catthehacker/ubuntu:act-latest # Use specific Docker image"
|
||||
echo ""
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo -e "${RED}Unknown option: $1${NC}"
|
||||
echo "Use -h or --help for usage information"
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
# Check if workflow file exists
|
||||
WORKFLOW_PATH=".github/workflows/${WORKFLOW}"
|
||||
if [ ! -f "$WORKFLOW_PATH" ]; then
|
||||
echo -e "${RED}Error: Workflow file not found: $WORKFLOW_PATH${NC}"
|
||||
echo ""
|
||||
echo "Available workflows:"
|
||||
ls -1 .github/workflows/*.yml .github/workflows/*.yaml 2>/dev/null | sed 's|.github/workflows/||'
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Build act command
|
||||
ACT_CMD="act $EVENT -W $WORKFLOW_PATH"
|
||||
|
||||
if [ -n "$JOB" ]; then
|
||||
ACT_CMD="$ACT_CMD -j $JOB"
|
||||
fi
|
||||
|
||||
if [ -n "$PLATFORM" ]; then
|
||||
ACT_CMD="$ACT_CMD -P ubuntu-latest=$PLATFORM"
|
||||
fi
|
||||
|
||||
# Add verbose flag for better debugging
|
||||
ACT_CMD="$ACT_CMD --verbose"
|
||||
|
||||
echo -e "${YELLOW}Running workflow: $WORKFLOW${NC}"
|
||||
if [ -n "$JOB" ]; then
|
||||
echo -e "${YELLOW}Job: $JOB${NC}"
|
||||
fi
|
||||
echo -e "${YELLOW}Event: $EVENT${NC}"
|
||||
echo ""
|
||||
echo -e "${YELLOW}Command: $ACT_CMD${NC}"
|
||||
echo ""
|
||||
echo "Note: This will run in Docker containers and may take a while on first run."
|
||||
echo "Press Ctrl+C to cancel."
|
||||
echo ""
|
||||
|
||||
# Run act
|
||||
eval $ACT_CMD
|
||||
|
||||
echo ""
|
||||
echo -e "${GREEN}Done!${NC}"
|
||||
Reference in New Issue
Block a user