Comprehensive automated tests for the LightSpeedWP automation project. Suites span shell (Bats), JavaScript (Jest), Python-based doc/schema validation, plus centralized coverage and quality gates. Test layout mirrors script and schema responsibilities for traceability.

Single source of truth for automation quality: fast feedback locally (Bats/Jest) + full pipeline validation (coverage, lint, schema checks).

graph TB
    A[Testing Framework] --> B[Bats Testing]
    A --> C[Jest Testing]
    A --> D[Coverage Reporting]
    A --> E[Test Helpers]

    B --> F[Shell Script Tests]
    B --> G[CLI Interface Tests]
    B --> H[Integration Tests]

    C --> I[JavaScript Unit Tests]
    C --> J[Agent Module Tests]
    C --> K[Advanced Logic Tests]

    D --> L[Coverage Reports]
    D --> M[Quality Metrics]
    D --> N[Test Summary]

    E --> O[Shared Helpers]
    E --> P[Setup/Teardown]
    E --> Q[Environment Isolation]

    R[CI/CD Pipeline] --> A
    S[Pre-commit Hooks] --> A
    T[Manual Testing] --> A

    style A fill:#e1f5fe
    style B fill:#f3e5f5
    style C fill:#e8f5e8
    style D fill:#fff3e0

Each subfolder includes comprehensive documentation and specialized test coverage:

• awesome-copilot/ — Jest tests for awesome-copilot automation scripts

  • Tests for update-readme.js, validate-collections.js, and yaml-parser.js
  • Validates script loading and basic functionality

• includes/ — Shared test helpers and utilities with specialized subfolders:

  • cli/ — CLI utility testing helpers and shared functions
  • core/ — Core testing functionality including colors, logging, and validation
  • deployment/ — Deployment testing helpers and environment setup
  • filesystem/ — File system operation helpers and utilities

• maintenance/ — Comprehensive tests for maintenance and automation scripts

  • Tests for README generation, label management, badge updates, and changelog automation
  • Covers dry-run modes, CI/CD integration, and edge case handling

• projects/ — Project management and GitHub integration tests

  • fixtures/ — Test fixtures and sample data for project tests
  • Tests for client delivery projects, product development workflows, and project automation

• pytests/ — Python-based tests for documentation validation

  • Tests for changelog validation, documentation links, markdown structure, and PR templates
  • Includes utility functions for changed file detection

• utility/ — Comprehensive Bats and Jest tests for all utility scripts

  • .bats files: Shell/CLI tests for Node.js and shell scripts
  • .test.js files: Jest unit tests for Node.js modules and agent logic

• test-helper.bash — Shared Bats test helpers for setup/teardown and environment isolation
• tests-run-all-tests.bats — Bats test for the test runner script
• TEST_COVERAGE_SUMMARY.md — Detailed documentation of test coverage, structure, and best practices

Run the entire test stack locally (shell + JS + Python) or target specific layers for faster iteration.

Typical commands:

• Run all tests (orchestrated shell + jest): ./run-all-tests.sh
• Run Bats only: bats tests/ (or bats tests/utility for a subset)
• Run Jest unit tests: npm test (alias for npx jest)
• Run Python doc/schema validations: pytest tests/pytests
• Show coverage summary (after Jest): npx jest --coverage or view coverage/README.md

Minimal smoke check (fast):

./run-all-tests.sh --fast

CI calls the same runner during pull requests; failures block merges when thresholds are not met.

Quality gates (indicative targets):

• Overall line coverage >= 80%
• Critical scripts (utility) >= 90% branch coverage
• Zero high-severity ShellCheck warnings
• No markdownlint structural violations

Add new tests by placing .bats or .test.js files following existing naming patterns; keep fixtures isolated in projects/fixtures.

1. Parity: Every executable script in scripts/utility/ must have at least one test (happy + failure path).
2. Isolation: Use test-helper.bash for environment setup/teardown—avoid mutating global state.
3. Determinism: Mock network/filesystem where possible; prefer fixtures over ad-hoc inline data.
4. Coverage Improvement: Focus on untested branches before adding new features.
5. Documentation: When adding complex test helpers, update this README or TEST_COVERAGE_SUMMARY.md.
6. Fast Feedback: Keep critical path tests lean (< 2s) to optimize pre-commit runs.

sequenceDiagram
    participant Dev as Developer
    participant Runner as Test Runner
    participant Bats as Bats Framework
    participant Jest as Jest Framework
    participant Coverage as Coverage Reporter
    participant CI as CI/CD Pipeline

    Dev->>Runner: Execute run-all-tests.sh
    Runner->>Bats: Run shell script tests
    Bats->>Bats: Execute .bats files
    Bats->>Runner: Return Bats results
    Runner->>Jest: Run JavaScript tests
    Jest->>Jest: Execute .test.js files
    Jest->>Runner: Return Jest results
    Runner->>Coverage: Generate coverage reports
    Coverage->>CI: Upload coverage data
    CI->>Dev: Test results & coverage

    Note over Dev,CI: Comprehensive test automation

flowchart TD
    A[Test Execution] --> B{Test Type}
    B -->|Shell Scripts| C[Bats Testing]
    B -->|JavaScript| D[Jest Testing]

    C --> E[CLI Tests]
    C --> F[Integration Tests]
    C --> G[Shell Function Tests]

    D --> H[Unit Tests]
    D --> I[Module Tests]
    D --> J[Agent Tests]

    E --> K[Coverage Collection]
    F --> K
    G --> K
    H --> K
    I --> K
    J --> K

    K --> L[Coverage Analysis]
    L --> M{Coverage Threshold}
    M -->|Pass| N[Success Report]
    M -->|Fail| O[Coverage Warning]

    N --> P[CI/CD Success]
    O --> Q[Quality Gate Failure]

    style A fill:#e1f5fe
    style K fill:#f3e5f5
    style N fill:#c8e6c9
    style Q fill:#ffcdd2

See TEST_COVERAGE_SUMMARY.md for full coverage details and examples.

See repository commit history for granular diffs.

• Integration tests for multi-service workflows are partially stubbed; expand planned.
• Schema validation (AJV) is documented but not fully automated yet.
• Some legacy scripts lack failure-path assertions—backlog item to close gaps.
• Python tests focus on docs/link integrity; functional Python modules (if added) need new test harness.
• Performance benchmarking tests are out-of-scope for current CI pipeline.

Optional local setup acceleration:

brew install bats-core shellcheck
pip install -r requirements-dev.txt  # if present
npm ci

• Test Coverage Summary — Comprehensive coverage analysis and test details
• Jest Configuration — JavaScript testing framework configuration
• Test Runner Script — Automated test execution script
• Quality Assurance — Testing standards and best practices

• Awesome Copilot Tests — Jest tests for awesome-copilot automation scripts
• Test Includes & Helpers — Shared test utilities and helper functions
• CLI Testing Helpers — Command-line interface testing utilities
• Core Testing Functions — Core testing functionality and validation
• Deployment Test Helpers — Deployment testing and environment setup
• Filesystem Test Utilities — File system operation testing helpers
• Maintenance Script Tests — Tests for maintenance and automation scripts
• Project Management Tests — GitHub project integration and workflow tests
• Test Fixtures & Data — Sample data and test fixtures
• Python Documentation Tests — Python-based documentation validation tests
• Utility Script Tests — Comprehensive utility script testing suite

• Bats Testing Framework — Bash Automated Testing System
• Jest Testing Documentation — JavaScript testing framework
• Shared Test Helpers — Common Bats testing utilities
• GitHub Actions Tests Workflow — CI/CD testing automation

• Scripts Directory — Main automation scripts documentation
• Schema Validation — JSON schema validation and configuration
• CodeRabbit Schemas — AI code review configuration schemas
• WordPress Automation Schemas — WordPress theme automation schemas
• Coverage Reports — Test coverage reporting and analysis
• HTML Coverage Reports — Interactive coverage visualization

• Custom Instructions
• Agents Documentation
• Prompts Library
• Scripts Directory
• Contributing Guidelines

🧪 Ensuring quality through comprehensive testing and continuous coverage validation.

Built by 🧱 LightSpeedWP with ☕, 🚀, and open-source spirit! Contributors