اجرای Collectionهای Postman در محیط CI با Newman

می‌توانید از Newman و Postman API برای اجرای Collectionهای Postman در محیط continuous integration یا CI استفاده کنید. ایده اصلی ساده است: در محیط CI ابتدا Node.js و Newman را نصب می‌کنید، سپس Newman با کمک Postman API، Collection شما را دریافت و اجرا می‌کند.

پیش‌نیازها #

• یک سیستم CI داشته باشید که بتواند دستورهای shell را اجرا کند و شما دسترسی ویرایش تنظیمات آن را داشته باشید.
• یک Postman API key بسازید و برای استفاده در pipeline نگه دارید.
• یک Postman Collection داشته باشید که سرور یا API شما را تست کند. شناسه Collection را کپی کنید. اگر Collection به environment نیاز دارد، شناسه environment را هم کپی کنید.

نصب Newman و Node.js #

اگر محیط CI شما از قبل Node.js دارد، لازم نیست دوباره آن را نصب کنید. در غیر این صورت Node.js را نصب کنید و سپس Newman را اضافه کنید. در بسیاری از pipelineها نصب Newman با npm انجام می‌شود.

اجرای Collection با Newman و Postman API #

برای اجرای Collection از طریق Postman API، دستور زیر را اجرا کنید و مقدارهای collection-id و postman-api-key را با اطلاعات خودتان جایگزین کنید:

newman run "https://api.getpostman.com/collections/collection-id?apikey=postman-api-key"

اگر Collection شما به environment نیاز دارد، گزینه --environment را هم اضافه کنید:

newman run "https://api.getpostman.com/collections/collection-id?apikey=postman-api-key" \
--environment "https://api.getpostman.com/environments/environment-id?apikey=postman-api-key"

در pipeline واقعی، بهتر است API key را مستقیم داخل فایل تنظیمات ننویسید. آن را به صورت secret یا environment variable در ابزار CI ذخیره کنید و در دستور Newman استفاده کنید.

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