Newman Reporters — Generating Detailed API Test Reports from Newman Runs

# CLI + JUnit + HTMLExtra reporters
newman run threat-api-collection.json \
  --reporters cli,junit,htmlextra,json \
  --reporter-junit-export reports/junit-results.xml \
  --reporter-htmlextra-export reports/html-report.html \
  --reporter-json-export reports/raw-results.json

# TeamCity reporter for JetBrains CI
newman run threat-api-collection.json \
  --reporters cli,teamcity

# Custom reporter
newman run threat-api-collection.json \
  --reporters cli,custom-reporter \
  --reporter-custom-reporter-option key=value

const newman = require("newman");
const fs = require("fs");

newman.run({
    collection: require("./threat-api-collection.json"),
    reporters: ["cli", "json"],
    reporter: {
        json: { export: "./results/raw.json" }
    }
}, function (err, summary) {
    if (err) throw err;

    const run = summary.run;
    const stats = run.stats;
    const failures = run.failures;
    const timings = run.timings;

    // Generate custom summary report
    const report = {
        timestamp: new Date().toISOString(),
        duration: timings.completed - timings.started,
        environment: summary.environment?.name || "unknown",
        collection: summary.collection?.info?.name || "unknown",
        stats: {
            total: stats.assertions.total,
            passed: stats.assertions.passed,
            failed: stats.assertions.failed,
            skipped: stats.assertions.pending || 0
        },
        failures: failures.map(f => ({
            source: f.source.name,
            test: f.error.test,
            message: f.error.message,
            at: f.at
        })),
        responseTimes: {
            min: stats.responses.min,
            max: stats.responses.max,
            avg: stats.responses.mean,
            median: stats.responses.median
        }
    };

    fs.writeFileSync(
        `./reports/summary-${Date.now()}.json`,
        JSON.stringify(report, null, 2)
    );

    // Calculate pass rate
    const passRate = (stats.assertions.passed / stats.assertions.total) * 100;
    console.log(`Pass rate: ${passRate.toFixed(1)}%`);

    // Fail if below threshold
    if (passRate < 95) {
        process.exit(1);
    }
});