Postman v11 与 Newman 自动化

// 在 Pre-request Script 中动态修改变量
// 当前环境切换到分页参数
pm.environment.set("pageNum", 1);
pm.environment.set("pageSize", 20);

// 读取变量（推荐使用 pm 对象，而非已废弃的 postman 对象）
const baseUrl = pm.variables.get("baseUrl");
const token = pm.environment.get("authToken");

// 计算请求签名并写入 Header
// 适用于自研网关要求 HMAC-SHA256 签名的场景
const timestamp = Date.now().toString();
const nonce = pm.variables.replaceIn('{{$guid}}');
const body = pm.request.body.raw || '';
const secret = pm.environment.get("signSecret");

// 使用 CryptoJS（Postman 内置）计算 HMAC
const signature = CryptoJS.HmacSHA256(`${timestamp}${nonce}${body}`, secret)
    .toString(CryptoJS.enc.Hex);

pm.request.headers.upsert({ key: 'X-Timestamp', value: timestamp });
pm.request.headers.upsert({ key: 'X-Nonce', value: nonce });
pm.request.headers.upsert({ key: 'X-Signature', value: signature });

// 若 Environment 中没有 token，先调用登录接口
if (!pm.environment.get("authToken")) {
    const loginRequest = {
        url: pm.variables.get("baseUrl") + "/auth/login",
        method: "POST",
        header: { "Content-Type": "application/json" },
        body: { mode: "raw", raw: JSON.stringify({ username: "test", password: "test123" }) }
    };
    pm.sendRequest(loginRequest, (err, response) => {
        const json = response.json();
        pm.environment.set("authToken", json.token);
    });
}

// 1. 状态码断言
pm.test("状态码应为 200", () => {
    pm.response.to.have.status(200);
});

// 2. 响应时间断言（性能基线）
pm.test("响应时间应小于 500ms", () => {
    pm.expect(pm.response.responseTime).to.be.below(500);
});

// 3. JSON 字段断言
pm.test("返回体应包含 userId 且非空", () => {
    const body = pm.response.json();
    pm.expect(body).to.have.property("userId");
    pm.expect(body.userId).to.not.be.empty;
});

// 4. JSON Schema 断言（契约验证）
const schema = {
    type: "object",
    required: ["userId", "name", "email"],
    properties: {
        userId: { type: "string" },
        name: { type: "string" },
        email: { type: "string", format: "email" }
    }
};
pm.test("响应结构应符合 User Schema", () => {
    pm.response.to.have.jsonSchema(schema);
});

// 5. 提取变量供后续请求使用
const userId = pm.response.json().userId;
pm.environment.set("currentUserId", userId);

username,email,expectedStatus
alice,alice@example.com,201
bob,bob@example.com,201
charlie,invalid-email,400

[
  { "username": "alice", "email": "alice@example.com", "expectedStatus": 201 },
  { "username": "bob", "email": "bob@example.com", "expectedStatus": 201 },
  { "username": "charlie", "email": "invalid-email", "expectedStatus": 400 }
]

// Tests 脚本中根据数据文件中的期望值断言
pm.test("状态码应与期望一致", () => {
    pm.expect(pm.response.code).to.eql(Number(data.expectedStatus));
});

pm.test("用户名应回显", () => {
    // 仅在创建成功的场景下校验回显字段
    if (Number(data.expectedStatus) === 201) {
        pm.expect(pm.response.json().username).to.eql(data.username);
    }
});

// 将本次迭代的 userId 写入变量，供下一次迭代或后续请求使用
if (Number(data.expectedStatus) === 201) {
    pm.environment.set("lastUserId", pm.response.json().userId);
}

# 全局安装 Newman v6
npm install -g newman

# 验证版本
newman --version

# 安装 HTML 报告扩展（v6 推荐使用 newman-reporter-htmlextra）
npm install -g newman-reporter-htmlextra

# 基础执行：指定 Collection 与 Environment
newman run collection.json \
  -e environment.json \                  # 环境变量文件
  -d testdata.csv \                      # 数据驱动文件
  --iteration-count 3 \                  # 迭代次数（与 -d 二选一）
  --folder "认证模块" \                   # 只执行指定 Folder
  --env-var "baseUrl=http://staging.api" # 命令行覆盖变量
  --delay-request 200 \                  # 请求间隔（ms），避免压垮被测系统
  --timeout-request 10000 \              # 单请求超时
  --bail \                               # 失败即退出（CI 推荐）
  --reporters cli,json,htmlextra \       # 报告输出
  --reporter-htmlextra-export report.html

# 同时生成 JUnit + HTML 报告（CI 标准配置）
newman run collection.json \
  -e staging.json \
  --reporters junit,htmlextra \
  --reporter-junit-export results.xml \
  --reporter-htmlextra-export report.html

# .github/workflows/api-tests.yml
name: API 自动化测试

on:
  push:
    branches: [main, develop]
  pull_request:
    branches: [main]

jobs:
  newman-api-tests:
    runs-on: ubuntu-latest
    steps:
      # 1. 拉取代码
      - name: Checkout
        uses: actions/checkout@v4

      # 2. 安装 Node.js
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'

      # 3. 安装 Newman 与报告扩展
      - name: Install Newman
        run: |
          npm install -g newman newman-reporter-htmlextra

      # 4. 启动被测服务（假设为 Docker Compose）
      - name: Start services
        run: docker compose up -d

      # 5. 执行测试
      - name: Run Postman Collection
        run: |
          newman run collections/api-suite.json \
            -e environments/staging.json \
            -d data/test-data.csv \
            --reporters cli,junit,htmlextra \
            --reporter-junit-export reports/junit.xml \
            --reporter-htmlextra-export reports/report.html \
            --bail

      # 6. 发布测试报告
      - name: Publish Test Report
        uses: dorny/test-reporter@v1
        if: always()
        with:
          name: API Test Results
          path: reports/junit.xml
          reporter: java-junit

      # 7. 归档 HTML 报告
      - name: Upload HTML Report
        uses: actions/upload-artifact@v4
        if: always()
        with:
          name: postman-html-report
          path: reports/report.html

# .gitlab-ci.yml
api-tests:
  image: node:20-alpine
  stage: test
  before_script:
    - npm install -g newman newman-reporter-htmlextra
  script:
    - newman run collections/api-suite.json
        -e environments/staging.json
        --reporters cli,junit,htmlextra
        --reporter-junit-export reports/junit.xml
        --reporter-htmlextra-export reports/report.html
  artifacts:
    when: always
    reports:
      junit: reports/junit.xml
    paths:
      - reports/report.html
  rules:
    - if: $CI_PIPELINE_SOURCE == "merge_request_event"

# Dockerfile.newman
FROM node:20-alpine

# 安装 Newman 与常用报告器
RUN npm install -g newman newman-reporter-htmlextra newman-reporter-allure

# 设置工作目录
WORKDIR /etc/newman

# 默认入口（可被 docker run 参数覆盖）
ENTRYPOINT ["newman", "run"]

# 构建镜像
docker build -f Dockerfile.newman -t company/newman:6 .

# 在容器内运行（挂载 Collection 与报告目录）
docker run --rm \
  -v $(pwd)/collections:/etc/newman \
  -v $(pwd)/reports:/reports \
  company/newman:6 \
  api-suite.json \
  -e environments/staging.json \
  --reporters htmlextra \
  --reporter-htmlextra-export /reports/report.html

# 执行 Flows（Postman CLI，需 Postman 账号认证）
postman login --with-api-key $POSTMAN_API_KEY
postman flow run <flow-id> --environment staging

# 通过 API Key 拉取最新 Collection JSON（CI 中常用，避免硬编码文件）
curl --location "https://api.getpostman.com/collections/${COLLECTION_UID}" \
  --header "X-Api-Key: ${POSTMAN_API_KEY}"

# 触发 Monitor 执行（定时巡检）
curl --location --request POST \
  "https://api.getpostman.com/monitors/${MONITOR_UID}/run" \
  --header "X-Api-Key: ${POSTMAN_API_KEY}"

# CI 流水线脚本：每次运行时从 Postman 云端拉取最新版本
curl -s --header "X-Api-Key: $POSTMAN_API_KEY" \
  "https://api.getpostman.com/collections/$COLLECTION_UID" \
  | jq -r '.collection' > collection.json

newman run collection.json -e staging.json --bail