DOCSEARCHbyAlgolia
Submit Docs

TestPlanIt Documentation

website·Indexed 32 days ago

https://docs.testplanit.com

An open-source tool designed to streamline the testing process. Documentation covers test case management, parameterized testing, duplicate detection, and LLM integrations with providers like OpenAI, Google Gemini, and Anthropic Claude. It includes guides on user roles, SCIM 2.0 provisioning, review and approval workflows, and automation candidate selection.

Tokens
201.8K
Snippets
481
Records
1.4K
Agent score
51%

What's inside TestPlanIt

  1. Overview of TestPlanIt SSE Notification Streams

    TestPlanIt uses Server-Sent Events (SSE) with Valkey (or Redis) pub/sub to push real-time updates to clients. The system uses a 'wake-up' model: the server publishes a small payload to a channel, and the client, upon receiving the SSE message, refetches the actual data via policy-enforced API hooks to ensure multi-tenant isolation and access control.

  2. Overview of TestPlanIt Multi-tenant Architecture

    TestPlanIt supports a multi-tenant architecture to reduce infrastructure costs while maintaining data isolation. In this mode, each tenant has its own web application container and database, but all tenants share a single worker container for background jobs. Isolation is achieved via a tenantId field in jobs and tenant-prefixed Elasticsearch indices (e.g., testplanit-tenant-a-repository-cases).

  3. Overview of QuickScript Templates

    QuickScript Templates define the structure of automation scripts generated by QuickScript. They support various frameworks (Playwright, Cypress, pytest, etc.), languages, and file extensions using Mustache-based templating. The system provides header and footer sections for file-level content (like imports) and a live preview for real-time validation with sample data.

  4. Overview of TestPlanIt SCIM 2.0 Implementation

    TestPlanIt implements SCIM 2.0 to allow enterprise Identity Providers (IdPs) to provision, update, and de-provision users and groups. All requests must use Content-Type: application/scim+json and Accept: application/scim+json.

    Supported Capabilities:

    • Users & Groups: Full CRUD support (POST, GET, PUT, PATCH, DELETE). DELETE operations perform a soft-delete to preserve audit trails.
    • Discovery: /ServiceProviderConfig, /Schemas, and /ResourceTypes are open and do not require a bearer token.
    • PATCH: Supports add, remove, and replace operations per RFC 7644 §3.5.2.
    • Filters: Supports eq, and, and pr operators on whitelisted attributes.

    Unsupported Capabilities:

    • Bulk Operations: Returns 501 Not Implemented.
    • Sort: Not supported; results are returned in deterministic insertion order.
    • ChangePassword: Not supported; SCIM-provisioned users authenticate via their IdP.

  5. Overview of TestPlanIt MCP Server

    The TestPlanIt MCP Server implements the Model Context Protocol (MCP), enabling AI assistants (such as Claude and Cursor) to connect directly to a TestPlanIt account. This allows the AI to query, read, and act on live test management data in real-time during a conversation, eliminating the need to manually export data or switch between the AI chat and the TestPlanIt UI. All operations are scoped to the permissions of the user's API token.

  6. Overview of Parameterized Test Cases

    Parameterized test cases enable table-driven testing by allowing a single test case to run multiple times in one test run, once per row of input data. Each execution is called an iteration and receives its own status. The overall case-level status is a 'worst-of' rollup of all its iterations. Parameterized cases are identified by a stacked-squares badge next to their type icon in the UI.

  7. Overview of TestPlanIt Docker services

    The TestPlanIt Docker Compose setup provides a self-contained environment consisting of the following services:

    • TestPlanIt Application (dev/prod): Next.js web application.
    • Background Workers (workers-dev/workers): Handles email, notifications, scheduled tasks (daily digests, forecast updates, automated-run sweeps), search indexing, and file processing.
    • PostgreSQL (postgres): Main database with automatic schema initialization.
    • Valkey (valkey): Redis-compatible in-memory data store for job queue and caching.
    • Elasticsearch (elasticsearch): Search and indexing engine.
    • MinIO (minio): S3-compatible object storage for file attachments.
    • Nginx (nginx): Reverse proxy for internal routing and file access.
    • Database Initialization (db-init/db-init-prod): Automatic schema setup and seeding.
    • MinIO Initialization (minio-init): Automatic bucket creation and permissions.

  8. Overview of Auto Tag feature

    Auto Tag uses AI to automatically suggest relevant tags for test cases, test runs, and exploratory sessions based on their content. It allows users to organize items at scale, maintain tagging consistency by suggesting existing tags, discover untagged items, and control whether new tags can be created or if suggestions should be restricted to the existing project taxonomy.

  9. Overview of TestPlanIt Commenting System

    TestPlanIt provides a contextual commenting system to enable team collaboration directly on test items. Key features include:

    • Contextual Discussions: Add notes directly to test items.
    • User Mentions: Notify team members using @ mentions.
    • Edit History: Track modifications to comments.
    • Access Control: Comments inherit the permissions of the project they are attached to.
    • Notifications: Mentioned users are alerted via in-app and email notifications.

  10. Overview of TestPlanIt

    TestPlanIt is an open-source tool designed to streamline the testing process. It provides a centralized platform for creating, managing, and executing both manual and automated test plans, supporting complex test suites, exploratory testing sessions, and test case organization.

  11. Overview of Categories, Variants, and Configurations

    In TestPlanIt, Configurations are specific combinations of environmental or setup variables (Variants) grouped by Categories. These are used to define test environments (e.g., Browser: Chrome, OS: Windows 11) for matrix-based testing.

    Configurations are project-scoped: they must be assigned to specific Projects to appear in Test Run, Session, and Search pickers. New Configurations start with no Project assignments.

  12. Overview of TestPlanIt Workflow States

    Workflows in TestPlanIt define the lifecycle states and progression for three distinct scopes: Test Cases, Test Runs, and Sessions. Each state is characterized by a name, icon, color, and a fundamental Type.

    Every scope must have at least one state defined for each of the following three Types to ensure application logic functions correctly:

    • Not Started: Initial or pending states.
    • In Progress: Active or intermediate states.
    • Done: Final or terminal states (e.g., Passed, Failed, Closed).