bavithiran94/newman-trigger-control-plane repository overview

⁠Newman Trigger Control Plane

Dockerized Newman execution platform for centralized API test orchestration.

Built to solve the repeated operational setup teams face while running Newman across projects, CI/CD pipelines, and environments.

⁠What Problem It Solves

• Repeated Newman setup across environments
• Custom execution scripts for every pipeline
• Environment-specific execution failures
• No reusable centralized execution layer
• Report persistence problems
• Manual API test execution workflows
• Rebuilding execution infrastructure for every project

⁠Core Features

• REST API-driven Newman execution
• Multi-project API test orchestration
• Dockerized reusable execution layer
• Persistent execution history
• HTML / JSON / JUnit report generation
• Project-specific execution presets
• Shared collection & environment management
• Trigger APIs for CI/CD pipelines
• Swagger/OpenAPI support
• SQLite-backed run history
• Token-secured execution endpoints

⁠UI Functionalities

⁠Dashboard UI

• Centralized execution dashboard
• Latest execution visibility
• Multi-project execution monitoring
• Run status tracking
• Execution filtering and search

⁠Run Management

• View execution history
• Track running executions
• View failed/success executions
• Download execution artifacts
• Download execution logs

⁠Project Management UI

• View all projects
• Project-specific execution tracking
• Collection/environment visibility
• Preset execution management

⁠Swagger UI

• Interactive API explorer
• Direct API execution from browser
• OpenAPI contract visibility
• Endpoint testing support

⁠API Functionalities

⁠Health APIs

⁠Health Check

GET /health

⁠Project APIs

⁠Create Project

POST /projects

⁠List Projects

GET /projects

⁠Get Project Details

GET /projects/{projectId}

⁠Collection APIs

⁠Upload Collection

POST /projects/{projectId}/collections

⁠List Collections

GET /projects/{projectId}/collections

⁠Environment APIs

⁠Upload Environment

POST /projects/{projectId}/environments

⁠List Environments

GET /projects/{projectId}/environments

⁠Preset APIs

⁠Create Preset

POST /projects/{projectId}/presets

⁠List Presets

GET /projects/{projectId}/presets

⁠Execution APIs

⁠Trigger Test Execution

POST /run-tests

⁠Trigger Project Execution

POST /projects/{projectId}/run-tests

⁠Trigger Release Execution

POST /projects/{projectId}/release/trigger

⁠Get Run Status

GET /runs/{runId}

⁠List Run History

GET /runs

⁠Artifact APIs

⁠Download Execution Log

GET /runs/{runId}/log

⁠Download JUnit Report

GET /runs/{runId}/artifacts/junit

⁠Download JSON Report

GET /runs/{runId}/artifacts/json

⁠Download HTML Report

GET /runs/{runId}/artifacts/html

⁠UI Endpoints

⁠Dashboard UI

/ui

⁠Swagger UI

/swagger/index.html

⁠OpenAPI Contract

/openapi-trigger-service.yaml

⁠Execution Workflow

Project → Collection → Environment → Preset → Trigger Execution → Reports → History Tracking

⁠Supported Report Types

• CLI Reports
• HTML Reports
• JSON Reports
• JUnit Reports

⁠Persistence Support

Supports persistent Docker volumes for:

• Execution history
• Reports
• Uploaded collections
• Environment assets
• Execution logs
• SQLite execution database

⁠Ideal Use Cases

• Centralized API test execution
• Shared QA automation infrastructure
• Azure DevOps pipeline integration
• CI/CD quality gates
• Scheduled regression execution
• Multi-project SDET platforms
• Remote Newman orchestration

⁠Deployment Targets

• Docker
• Kubernetes
• Azure App Service
• Azure Container Apps
• Render
• Railway
• GitHub Actions
• Azure DevOps Pipelines

⁠License

MIT License