postman-newman-automation

Emits Newman CLI invocations, PowerShell or bash runners, and Jenkins/GitHub Actions stages for exported Postman collections, including CSV iteration data and JUnit/htmlextra reporters. Trigger on newman, postman cli, collection CI, or data-driven API suites. Do not use for Postman GUI collection authoring, the Postman CLI binary, Bruno/Insomnia clients, or Pact contract tests.

仓库: Kayforkind/skill-slice
最近来源活动: 2026年8月14日 20:25
检测到的 SKILL.md 语言: 英语
星标: 0
分支: 0

安装方式

默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。

检查来源文件

决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。

返回搜索返回安装

name	postman-newman-automation
description	Emits Newman CLI invocations, PowerShell or bash runners, and Jenkins/GitHub Actions stages for exported Postman collections, including CSV iteration data and JUnit/htmlextra reporters. Trigger on newman, postman cli, collection CI, or data-driven API suites. Do not use for Postman GUI collection authoring, the Postman CLI binary, Bruno/Insomnia clients, or Pact contract tests.
version	1.0.1
risk	unknown
source	https://github.com/LambdaTest/agent-skills/tree/main/api-skill/postman/postman-to-newman
source_repo	LambdaTest/agent-skills
source_type	community
date_added	2026-07-01T00:00:00.000Z
license	MIT
license_source	https://github.com/LambdaTest/agent-skills/blob/main/LICENSE

Postman Newman Automation

Overview

Newman is the command-line collection runner for Postman. This skill generates ready-to-run Newman CLI commands, reusable shell scripts, and Jenkins pipeline configurations for automated API test execution in local or CI/CD environments. It covers basic runs, data-driven iterations, environment variable overrides, reporter selection, and CI integration patterns.

When to Use

Use this skill when the user needs to:

Run Postman collections from the command line (local or CI)
Automate API test suites with Newman
Integrate Postman tests into Jenkins (declarative or scripted pipelines)
Generate Newman shell scripts with exit-code handling and report archiving
Produce JUnit XML or HTML reports for CI consumption
Run data-driven tests using CSV or JSON iteration data
Override environment variables inline without an environment file

Trigger keywords: newman, postman cli, run postman collection, api test automation, jenkins postman, newman reporter, htmlextra, junit postman, postman ci/cd

Prerequisites

Node.js ≥ 14 installed and on PATH.
Newman installed globally:
```
npm install -g newman
```
Optional reporters (install only if the user requests HTML or custom reports):
```
npm install -g newman-reporter-htmlextra
```
Postman collection file (exported JSON) or a Postman API UID with a valid API key.
Environment file (optional) — exported from Postman as JSON.
On Windows (PowerShell), line continuations use backtick (`) instead of backslash (\). All bash examples below are for CI/Linux runners; see the PowerShell note in Step 2 for local Windows execution.

Procedure

Step 1 — Gather Requirements

Ask or infer from context before generating any command:

Parameter	Question	Example
Collection source	File path, URL, or Postman API UID?	`./collection.json` or UID

12345-abcde

newman run collection.json \
  --environment environment.json \
  --reporters cli,htmlextra \
  --reporter-htmlextra-export reports/report.html \
  --bail

newman run collection.json `
  --environment environment.json `
  --reporters cli,htmlextra `
  --reporter-htmlextra-export reports/report.html `
  --bail

newman run "https://api.getpostman.com/collections/<UID>?apikey={{POSTMAN_API_KEY}}" \
  --environment environment.json \
  --reporters cli,junit \
  --reporter-junit-export results/junit.xml

newman run collection.json \
  --iteration-data test-data.csv \
  --iteration-count 5 \
  --reporters cli,htmlextra \
  --reporter-htmlextra-export reports/data-driven-report.html

newman run collection.json \
  --env-var "base_url=https://staging.api.example.com" \
  --env-var "token=YOUR_TOKEN" \
  --reporters cli

#!/bin/bash
set -e

# Configuration
COLLECTION="./collection.json"
ENVIRONMENT="./environment.json"
REPORT_DIR="./reports"
TIMESTAMP=$(date +"%Y%m%d_%H%M%S")

# Ensure report directory exists
mkdir -p "$REPORT_DIR"

echo "Running Newman collection: $COLLECTION"

newman run "$COLLECTION" \
  --environment "$ENVIRONMENT" \
  --reporters cli,htmlextra,junit \
  --reporter-htmlextra-export "$REPORT_DIR/report_$TIMESTAMP.html" \
  --reporter-junit-export "$REPORT_DIR/junit_$TIMESTAMP.xml" \
  --timeout-request 10000 \
  --bail

EXIT_CODE=$?

if [ $EXIT_CODE -eq 0 ]; then
  echo "✅ All tests passed."
else
  echo "❌ Tests failed. Check report: $REPORT_DIR/report_$TIMESTAMP.html"
  exit $EXIT_CODE
fi

$ErrorActionPreference = "Stop"

$Collection = ".\collection.json"
$Environment = ".\environment.json"
$ReportDir = ".\reports"
$Timestamp = Get-Date -Format "yyyyMMdd_HHmmss"

New-Item -ItemType Directory -Force -Path $ReportDir | Out-Null

Write-Host "Running Newman collection: $Collection"

newman run $Collection `
  --environment $Environment `
  --reporters cli,htmlextra,junit `
  --reporter-htmlextra-export "$ReportDir\report_$Timestamp.html" `
  --reporter-junit-export "$ReportDir\junit_$Timestamp.xml" `
  --timeout-request 10000 `
  --bail

if ($LASTEXITCODE -eq 0) {
    Write-Host "✅ All tests passed."
} else {
    Write-Host "❌ Tests failed. Check report: $ReportDir\report_$Timestamp.html"
    exit $LASTEXITCODE
}

pipeline {
  agent any

  environment {
    POSTMAN_ENV = credentials('postman-environment-file') // Jenkins credential ID
  }

  stages {
    stage('Install Newman') {
      steps {
        sh 'npm install -g newman newman-reporter-htmlextra'
      }
    }

    stage('Run API Tests') {
      steps {
        sh """
          newman run collection.json \
            --environment ${POSTMAN_ENV} \
            --reporters cli,htmlextra,junit \
            --reporter-htmlextra-export reports/report.html \
            --reporter-junit-export reports/junit.xml \
            --timeout-request 10000 \
            --bail
        """
      }
    }
  }

  post {
    always {
      publishHTML(target: [
        allowMissing: false,
        alwaysLinkToLastBuild: true,
        keepAll: true,
        reportDir: 'reports',
        reportFiles: 'report.html',
        reportName: 'Newman API Test Report'
      ])
      junit 'reports/junit.xml'
    }
    failure {
      echo 'API tests failed! Check the Newman report.'
    }
  }
}

node {
  stage('Install Newman') {
    sh 'npm install -g newman newman-reporter-htmlextra'
  }

  stage('Run API Tests') {
    try {
      sh """
        newman run collection.json \
          --environment environment.json \
          --reporters cli,junit \
          --reporter-junit-export reports/junit.xml \
          --bail
      """
    } catch (err) {
      currentBuild.result = 'FAILURE'
      throw err
    } finally {
      junit 'reports/junit.xml'
    }
  }
}

environment {
  BASE_URL = 'https://api.example.com'
  API_TOKEN = credentials('api-token-secret')
}

steps {
  sh """
    newman run collection.json \
      --env-var "base_url=${BASE_URL}" \
      --env-var "token=${API_TOKEN}" \
      --reporters cli,junit \
      --reporter-junit-export results/junit.xml
  """
}

Reporter	Install	Flag	Output
`cli`	built-in	`--reporters cli`	Terminal output
`junit`	built-in	`--reporters junit`	JUnit XML (for Jenkins/GitHub Actions)
`htmlextra`	`npm i -g newman-reporter-htmlextra`	`--reporters htmlextra`	Rich HTML report
`json`	built-in	`--reporters json`	Raw JSON results

Flag Purpose

--bail Stop run on first test failure

--timeout-request 5000 Per-request timeout in ms

--delay-request 200 Delay between requests in ms

--iteration-count 3 Run collection N times

--folder "Folder Name" Run only a specific folder

--env-var "k=v" Inline environment variable

--suppress-exit-code Always exit 0 (don't fail CI)

--verbose Show full request/response details

--color off Disable color (useful for log files)

Newman is installed and on PATH:
```
newman --version
```
Expected: a version number (e.g., 6.x.x).
htmlextra reporter is installed (if used):
```
npm list -g newman-reporter-htmlextra
```
Expected: the package listed with a version.

Collection file is valid JSON:

node -e "JSON.parse(require('fs').readFileSync('collection.json','utf8')); console.log('Valid JSON')"

Expected: Valid JSON.

Dry run — execute the generated command against a small or test collection:
```
newman run collection.json --reporters cli --bail
```
Expected: summary table showing total/failures, exit code 0 if all pass.

Report files were created:

Test-Path reports/report.html
Test-Path reports/junit.xml

Expected: True for each.

Jenkinsfile syntax validation (if pipeline generated): Use Jenkins' Replay or jenkinsfile-runner, or validate via the Jenkins UI Pipeline Syntax > Declarative Directive Generator. At minimum, confirm Groovy compiles without syntax errors.
Exit code reflects test results:
```
newman run collection.json --reporters cli; echo "Exit code: $LASTEXITCODE"
```
Expected: 0 when all tests pass, non-zero when failures exist (unless --suppress-exit-code is used).