گزارش اجرای Collection با reporterهای داخلی Newman

Newman چند reporter داخلی دارد که برای تولید گزارش از اجرای Collection استفاده می‌شوند. این گزارش‌ها کمک می‌کنند خروجی اجرا را در ترمینال ببینید، برای CI ذخیره کنید، یا نتیجه تست‌ها را در فرمت‌های قابل پردازش نگه دارید.

Reporterهای داخلی Newman #

• CLI: گزارش را در ترمینال نمایش می‌دهد.
• JSON: گزارش را به صورت فایل JSON می‌سازد.
• JUnit: گزارش را به صورت فایل XML مناسب ابزارهای CI می‌سازد.
• Progress: پیشرفت اجرای Collection را در ترمینال نشان می‌دهد.
• Emoji train: جزئیات گزارش را با emoji در ترمینال نمایش می‌دهد.

استفاده از reporterهای داخلی #

برای انتخاب reporterها از گزینه -r یا --reporters استفاده کنید. مقدارها می‌توانند cli، json، junit، progress یا emojitrain باشند.

برای استفاده از چند reporter، نام‌ها را با کاما جدا کنید:

newman run my-collection.json -r cli,json

Reporter نوع cli وقتی Newman را از ترمینال اجرا می‌کنید به صورت پیش‌فرض فعال است. اما اگر reporter دیگری مثل -r json را مشخص کنید، CLI reporter خاموش می‌شود؛ برای روشن نگه داشتن آن باید صریحا cli را هم بنویسید، مثلا -r cli,json.

پیکربندی reporterها #

اگر چند reporter دارید و فقط می‌خواهید گزینه‌ای را برای یکی از آن‌ها اعمال کنید، از الگوی زیر استفاده کنید:

--reporter-[reporter-name]-[reporter-option]

برای نمونه، این دستور فقط خروجی CLI reporter را silent می‌کند:

newman run my-collection.json -r cli,json --reporter-cli-silent

اگر بخواهید یک گزینه برای همه reporterها اعمال شود، از الگوی عمومی‌تر --reporter-[reporter-option] استفاده کنید:

newman run my-collection.json -r cli,json --reporter-silent

گزینه‌های CLI reporter #

• --reporter-cli-silent: خروجی CLI reporter را خاموش می‌کند.
• --reporter-cli-show-timestamps: زمان محلی هر request را نمایش می‌دهد.
• --reporter-cli-no-summary: جدول خلاصه آماری را چاپ نمی‌کند.
• --reporter-cli-no-failures: جزئیات failureها را چاپ نمی‌کند.
• --reporter-cli-no-assertions: خروجی assertionها را هنگام اجرا خاموش می‌کند.
• --reporter-cli-no-success-assertions: assertionهای موفق را نمایش نمی‌دهد.
• --reporter-cli-no-console: خروجی console.log() و سایر console methodها را از pre-request و post-response scriptها خاموش می‌کند.
• --reporter-cli-no-banner: banner ابتدای اجرای Newman را نمایش نمی‌دهد.

نمونه نمایش زمان هر request:

newman run my-collection.json -r cli,json --reporter-cli-show-timestamps

JSON reporter #

JSON reporter فایل گزارش را در working directory می‌سازد. مسیر پیش‌فرض پوشه /newman است و اگر وجود نداشته باشد ساخته می‌شود. برای تعیین مسیر یا نام فایل از این گزینه استفاده کنید:

• --reporter-json-export [path]: مسیر یا نام فایل خروجی JSON.

newman run my-collection.json -r cli,json --reporter-json-export json-file-reports

JUnit reporter #

JUnit reporter فایل XML می‌سازد و برای بسیاری از ابزارهای CI مناسب است. مسیر پیش‌فرض آن نیز پوشه /newman است.

• --reporter-junit-export [path]: مسیر یا نام فایل خروجی XML.

newman run my-collection.json -r cli,junit --reporter-junit-export xml-file-reports

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