یکپارچه‌سازی تست‌های Postman با Jenkins و Newman

Jenkins یک automation server متن‌باز است که می‌تواند به عنوان سرور CI یا مرکز CD استفاده شود. با Newman می‌توانید Collectionهای Postman و تست‌های API آن‌ها را از داخل Jenkins اجرا کنید و حتی زمان‌بندی اجرای آن‌ها را مشخص کنید.

این راهنما از Jenkins محلی استفاده می‌کند، اما در محیط واقعی معمولا Jenkins روی یک build server اجرا می‌شود.

نصب Newman در Jenkins

اگر Jenkins را نصب نکرده‌اید، ابتدا آن را نصب و اجرا کنید. در حالت محلی، Jenkins معمولا در آدرس http://localhost:8080 در دسترس است. سپس NodeJS plugin را نصب کنید و Newman را از طریق آن در Jenkins اضافه کنید.

نصب NodeJS plugin

1. در Jenkins روی Manage Jenkins کلیک کنید.
2. از بخش System Configuration گزینه Plugins را انتخاب کنید.
3. به Available plugins بروید و NodeJS را جستجو کنید.
4. گزینه NodeJS را انتخاب کنید و Install را بزنید.

افزودن Newman به Jenkins

1. روی Manage Jenkins کلیک کنید.
2. از بخش System Configuration گزینه Tools را انتخاب کنید.
3. در بخش NodeJS installations روی Add NodeJS کلیک کنید.
4. برای نصب NodeJS یک نام وارد کنید.
5. در Global npm packages to install مقدار Newman را وارد کنید.
6. روی Save کلیک کنید.

پیکربندی Jenkins برای اجرای Newman

بعد از نصب Newman، یک Postman Collection با حداقل یک request و test آماده کنید و آن را به صورت JSON export کنید.

1. در صفحه Dashboard روی + New Item کلیک کنید.
2. گزینه Freestyle project را انتخاب کنید، برای پروژه نام بگذارید و OK را بزنید.
3. در صفحه Configure، بخش Build Environment را باز کنید و گزینه Provide Node & npm bin/ folder to PATH را فعال کنید. سپس NodeJS installationای را انتخاب کنید که Newman در آن نصب شده است.
4. در بخش Build Steps گزینه Add build step > Execute shell را انتخاب کنید و دستور اجرای Collection را وارد کنید:

newman run ~/Desktop/jenkins_demo_postman_collection.json

5. روی Save کلیک کنید.

تست اجرای Newman در Jenkins

1. در Dashboard، jobای را که تنظیم کرده‌اید انتخاب کنید.
2. روی Build Now کلیک کنید تا build دستی اجرا شود.
3. در Build History وضعیت build را بررسی کنید. Jenkins برای build موفق علامت سبز و برای build ناموفق علامت قرمز نشان می‌دهد.
4. build را انتخاب کنید و Console Output را باز کنید تا خروجی اجرای Collection را ببینید.
5. اگر build شکست خورد، Collection را در Postman اصلاح کنید، دوباره export کنید و build را دوباره اجرا کنید.

تعیین زمان‌بندی اجرای build

می‌توانید Jenkins را طوری تنظیم کنید که Newman را طبق زمان‌بندی اجرا کند؛ مثلا برای اجرای دوره‌ای تست‌های API.

1. در Dashboard، job مربوطه را انتخاب کنید.
2. روی Configure کلیک کنید.
3. در بخش Build Triggers گزینه Build periodically را فعال کنید.
4. زمان‌بندی را با cron syntax وارد کنید. برای نمونه، عبارت زیر build را هر ۱۵ دقیقه اجرا می‌کند:

H/15 * * * *

5. روی Save کلیک کنید.

در محیط production می‌توانید notificationها و تنظیمات Jenkins را مطابق نیاز تیم خود کامل‌تر کنید.

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