نصب و اجرای Newman

Newman بر پایه Node.js ساخته شده است. برای استفاده از آن، ابتدا Node.js را نصب کنید و بعد Newman را اضافه کنید. پس از نصب، می‌توانید Collectionهای Postman را به صورت فایل JSON یا با URL از خط فرمان اجرا کنید.

نصب Newman #

قبل از نصب Newman، مطمئن شوید Node.js نسخه ۱۶ یا جدیدتر روی سیستم یا محیط CI شما نصب است. سپس Newman را به صورت global نصب کنید تا از هر مسیر ترمینال قابل اجرا باشد:

npm install -g newman

به‌روزرسانی Newman #

اگر قبلا Newman را نصب کرده‌اید، می‌توانید آن را به نسخه جدیدتر ارتقا دهید. در پروژه‌هایی که از نسخه‌های قدیمی Newman استفاده می‌کنند، سازگاری نسخه Node.js را هم بررسی کنید.

اجرای یک Collection با Newman #

ابتدا Collection را از Postman به صورت فایل JSON export کنید. سپس آن را با دستور زیر اجرا کنید:

newman run my-collection.json

Newman نمی‌تواند scriptها و تست‌های packageهایی را اجرا کند که داخل Postman Package Library تیم شما هستند. برای این نوع packageها از Postman CLI استفاده کنید.

اجرای Collection با URL #

اگر Collection شما با URL قابل دسترسی است، می‌توانید URL را به Newman بدهید. مقدار <collection-id> را با شناسه Collection جایگزین کنید:

newman run https://www.postman.com/collections/<collection-id>

برای پیدا کردن شناسه Collection، در Postman بخش Collections را باز کنید، Collection را انتخاب کنید و در نوار کناری سمت راست از بخش Info شناسه را ببینید و کپی کنید. اگر URL عمومی نیست، برای اجرای Collection با Newman باید از Postman API استفاده کنید.

اجرای Collection همراه با Environment #

اگر Collection شما از environment variable استفاده می‌کند، باید environment مربوطه را از Postman export کنید و با گزینه -e به Newman بدهید:

newman run my-collection.json -e dev-environment.json

Newman از OAuth ۲.۰ authentication به صورت مستقیم پشتیبانی نمی‌کند. اگر سناریوی شما به OAuth ۲.۰ نیاز دارد، ابتدا token را طبق جریان مناسب دریافت کنید و سپس در درخواست‌ها استفاده کنید.

نمونه اجرای Collection با تست ناموفق #

تصویر زیر نمونه خروجی Newman را زمانی نشان می‌دهد که اجرای Collection دارای تست ناموفق است.

در این خروجی، عبارت test-scripts به post-response scriptها اشاره دارد. Newman از همان کتابخانه‌ها و objectهایی پشتیبانی می‌کند که در sandbox اسکریپت‌های Postman برای pre-request و post-response استفاده می‌شوند.

سفارشی‌سازی اجرای Collection #

Newman گزینه‌های مختلفی برای کنترل اجرا دارد؛ مثل انتخاب environment، داده‌های تکرار، timeoutها، reporterها و رفتار اجرا هنگام شکست تست‌ها.

استفاده از Newman در CI/CD #

به صورت پیش‌فرض، اگر اجرا بدون exception تمام شود، Newman با status code برابر 0 خارج می‌شود. ابزار CI می‌تواند همین کد خروجی را برای pass یا fail کردن build استفاده کند. با گزینه --bail می‌توانید کاری کنید که Newman هنگام خطای تست، اجرا را متوقف کند و status code برابر 1 برگرداند.

استفاده از Newman به عنوان کتابخانه Node.js #

می‌توانید Newman را در پروژه‌های JavaScript هم به عنوان ماژول Node.js استفاده کنید:

const newman = require('newman');

newman.run({
    collection: require('./sample-collection.json'),
    reporters: 'cli'
}, function (err) {
    if (err) { throw err; }
    console.log('collection run complete!');
});

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.