Newman CLI Deep Dive — Running Postman Collections in CI/CD Pipelines

# Basic collection run
newman run threat-api-collection.json \
  --environment staging.postman_environment.json

# With data file and reporters
newman run threat-api-collection.json \
  --environment staging.postman_environment.json \
  --data test-data.csv \
  --reporters cli,junit,htmlextra \
  --reporter-junit-export results/junit-report.xml \
  --reporter-htmlextra-export results/html-report.html \
  --delay-request 100 \
  --timeout-request 10000

# Override environment variables
newman run threat-api-collection.json \
  --env-var "baseUrl=https://staging-api.durga-antivirus.com" \
  --env-var "timeout=15000"

# Folder-specific runs
newman run threat-api-collection.json \
  --folder "Threat Creation" \
  --folder "Authentication"

# Global variables and SSL
newman run threat-api-collection.json \
  --global-var "runId=ci-build-1234" \
  --insecure  # Skip SSL verification for dev

# .github/workflows/api-tests.yml
name: API Test Suite
on: [push, pull_request]

jobs:
  api-tests:
    runs-on: ubuntu-latest
    services:
      postgres:
        image: postgres:15
        env:
          POSTGRES_PASSWORD: testpass
        ports:
          - 5432:5432

    steps:
      - uses: actions/checkout@v4

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "20"

      - name: Install Newman and reporters
        run: |
          npm install -g newman
          npm install -g newman-reporter-htmlextra

      - name: Start API server
        run: |
          docker compose -f docker-compose.test.yml up -d
          sleep 10  # Wait for server

      - name: Run API tests
        run: |
          newman run tests/postman/threat-api.json \
            --environment tests/postman/ci.postman_environment.json \
            --reporters cli,junit,htmlextra \
            --reporter-junit-export results/junit.xml \
            --reporter-htmlextra-export results/report.html \
            --delay-request 50 \
            --timeout-request 5000 || true

      - name: Upload test results
        uses: actions/upload-artifact@v4
        with:
          name: api-test-results
          path: results/

      - name: Publish test report
        uses: dorny/test-reporter@v1
        if: success() || failure()
        with:
          name: API Tests
          path: results/junit.xml
          reporter: java-junit

const newman = require("newman");

async function runApiTests() {
    return new Promise((resolve, reject) => {
        newman.run(
            {
                collection: require("./threat-api-collection.json"),
                environment: require("./staging.postman_environment.json"),
                reporters: ["cli", "junit", "htmlextra"],
                reporter: {
                    junit: { export: "./results/junit.xml" },
                    htmlextra: { export: "./results/report.html" }
                },
                iterationCount: 3,
                delayRequest: 100,
                timeoutRequest: 10000,
                bail: true  // Stop on first failure
            },
            function (err, summary) {
                if (err) {
                    reject(err);
                    return;
                }

                const failures = summary.run.failures.length;
                const assertions = summary.run.stats.assertions;

                console.log(`Tests completed:`);
                console.log(`  Total: ${assertions.total}`);
                console.log(`  Passed: ${assertions.passed}`);
                console.log(`  Failed: ${failures}`);

                if (failures > 0) {
                    summary.run.failures.forEach(f => {
                        console.log(`  FAIL: ${f.error.test} - ${f.error.message}`);
                    });
                }

                resolve(summary);
            }
        );
    });
}

// Run and exit with appropriate code
runApiTests()
    .then(summary => {
        process.exit(summary.run.failures.length > 0 ? 1 : 0);
    })
    .catch(err => {
        console.error("Test run failed:", err);
        process.exit(1);
    });