این بخش توضیح میدهد چگونه TestRail را با Mantis یکپارچه کنید. در حال حاضر چهار روش برای یکپارچهسازی TestRail با Mantis وجود دارد:
- استفاده از Defect URLها برای لینک کردن نتایج تست به Mantis
- استفاده از defect plugin مخصوص Mantis برای ارسال و جستجوی issueهای Mantis
- استفاده از Reference URLها برای لینک کردن test caseها به Mantis
- استفاده از reference plugin مخصوص Mantis برای جستجوی issueهای Mantis در فیلد References موجودیتهای TestRail، مانند test caseها، test runها و milestoneها
لازم نیست از همه گزینههای یکپارچهسازی فهرستشده استفاده کنید؛ همچنین میتوانید این یکپارچهسازی را با ابزارهای دیگر ترکیب کنید. پیکربندی آن معمولاً فقط چند دقیقه زمان میبرد. این راهنما توضیح میدهد این یکپارچهسازی چگونه پیکربندی میشود و چطور کار میکند.
همچنین میتوانید راهنمای یکپارچهسازی را در وبسایت MantisHub از اینجا پیدا کنید.
Defect URLها #
Defect URLها به TestRail میگویند که یک Defect ID را برای نمونهی Mantis شما چگونه به URL تبدیل کند. دو نوع URL وجود دارد: View URL و Add URL.
گزینهی Defect View URL برای ساخت لینک به Mantis بر اساس Defect ID استفاده میشود؛ بنابراین میتوانید روی یک ID کلیک کنید و issue را مستقیم در Mantis باز کنید.
گزینهی Defect Add URL برای ایجاد لینک به صفحهی ساخت issue در Mantis استفاده میشود. بعد از پیکربندی URL، یک لینک Add جدید کنار فیلد Defects در پنجرهی Add Test Result و در منوی Defects در قابلیت Push Defect From Anywhere TestRail ظاهر میشود. با این لینک میتوانید برای گزارش یک bug جدید، به فرم New Issue در Mantis بروید.
اگر لینک «Add» را میبینید، میتوانید ID issue جدید Mantis را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
میتوانید URLهای Mantis را در TestRail بهصورت سراسری از مسیر Administration > Integration یا بهصورت جداگانه برای هر project، از تنظیمات همان project پیکربندی کنید.
برای پیکربندی آدرسها، از URLهای نمونهی زیر استفاده کنید:
Mantis installation
Defect View Url: http://<your-server>/mantis/view.php?id=%id%
Defect Add Url: http://<your-server>/mantis/bug_report_page.phpحتماً مقدار <your-server> را با URL سرور Mantis که میخواهید با آن یکپارچه شوید جایگزین کنید.
اگر defect plugin را پیکربندی کرده باشید، با نگه داشتن نشانگر روی Defect ID میتوانید جزئیات issue را مستقیم از داخل TestRail ببینید.
Reference URLها #
Reference URLها تقریباً به همان روشی پیادهسازی میشوند که برای Defect URLها در بالا توضیح داده شد. تفاوت اصلی این است که Reference URLها برای فیلد References در موجودیتهای مختلف TestRail استفاده میشوند، نه برای فیلد Defects.
گزینهی Reference View URL به همان روشی که بالا توضیح داده شد پیکربندی میشود و به TestRail اجازه میدهد بر اساس ID واردشده در فیلد References، یک لینک مستقیم به Mantis بسازد.
گزینهی Reference Add URL نیز مثل Defect Add URL پیکربندی میشود. پس از پیکربندی، یک «Add» لینک کنار هر فیلد References در instance یا project شما نمایش داده میشود. اگر از Add link استفاده کنید، میتوانید ID issue جدید Mantis را کپی کنید و آن را در هر فیلد Defects یا References در TestRail وارد کنید.
اگر Reference plugin را پیکربندی کرده باشید، میتوانید نشانگر ماوس را روی یک Reference ID نگه دارید و جزئیات issue را مستقیماً داخل TestRail ببینید. در ادامه، نحوه استفاده و پیکربندی Defect Plugin و Reference Plugin را توضیح میدهیم.
Mantis installation
Reference View Url: http://your-server/mantis/view.php?id=%id%
Reference Add Url: http://your-server/mantis/bug_report_page.phpDefect Plugin #
از Defect pluginها میتوانید برای پیادهسازی یکپارچهسازی عمیقتر با bug tracker استفاده کنید و TestRail یک Mantis Defect Plugin آماده استفاده هم دارد. برای پیکربندی Defect Plugin، به Administration > Integration بروید و Mantis را از فهرست کشویی Defect Plugin انتخاب کنید. مرحله بعد این است که همه تنظیمات لازم برای اتصال را در بخش [connection] پیکربندی کنید. همچنین میتوانید با ویرایش تنظیمات project، این یکپارچهسازی را برای یک project مشخص پیکربندی کنید.
Defect Plugin از API Mantis استفاده میکند؛ بنابراین برای اتصال به API به اطلاعات ورود معتبر نیاز دارید. میتوانید اینجا یک مجموعه اطلاعات ورود برای همه کاربران Mantis وارد کنید، یا با استفاده از User Variables اجازه دهید هر کاربر TestRail اطلاعات ورود خودش را پیکربندی کند. این اطلاعات میتواند شامل email address یا username همراه با password یا API key باشد.
#
اکیداً توصیه میکنیم User Variables را پیکربندی کنید. برای اطلاعات بیشتر درباره پیکربندی آنها، به مستندات User Variables
پس از پیکربندی Defect Plugin، گزینه push کردن یک defect جدید در منوی Defect from Anywhere و همچنین در dialog Add Result داخل یک test run نمایش داده میشود. این dialog به شما اجازه میدهد بدون خروج از TestRail، یک issue جدید در Mantis ایجاد کنید.
بعد از اضافه شدن test result، اگر نشانگر ماوس را روی case ID نگه دارید، پنجرهای باز میشود که اطلاعات مفید و جزئیات وضعیت case را در Mantis نشان میدهد.
#
برای سفارشیسازی plugin باید از Defect و Reference plugin با نام Mantis_REST استفاده کنید؛ این plugin در TestRail ۶.۵ و نسخههای بعدی در دسترس است.
سفارشیسازیها #
Mantis Defect Plugin برای کار با یک پیکربندی استاندارد Mantis ساخته شده است. TestRail به شما امکان میدهد فیلدهایی را که در Push dialog و همچنین هنگام نگه داشتن ماوس روی Defect IDها نمایش داده میشوند، سفارشی کنید. فیلدهای ازپیشپیکربندیشده push و hover را میتوانید در بخشهای مربوط به خودشان، یعنی [push.fields] و [hover.fields]، روی on یا off بگذارید؛ همچنین با جابهجا کردن فیلدها در هر بخش، ترتیب نمایش آنها را تغییر دهید.
توجه داشته باشید بعضی فیلدها، مثل فیلد title، همیشه فعال هستند و ممکن است در این بخشها نمایش داده نشوند، چون TestRail یا Mantis همیشه به آنها نیاز دارد.
Mantis Defect Plugin از تغییر ویژگیهای فیلدها و همچنین custom fields هم پشتیبانی میکند.
علاوه بر فعالکردن، غیرفعالکردن یا مرتبسازی دوباره فیلدها طبق توضیح بالا، میتوانید گزینههای بیشتری را برای هر فیلد تغییر دهید. برای این کار، بخشی مخصوص آن فیلد تعریف میکنید، مثلاً [push.field.description]، و گزینههای اضافی را در همان بخش مشخص میکنید.
[push.field.description]
label=Detailed Description
required=trueفهرست کامل گزینههای فیلد و توضیح هرکدام را در ادامه ببینید:
| گزینه | توضیح |
|---|---|
| label | نام نمایشی فیلد را در Push Defect dialog مشخص میکند (برای custom fields الزامی است) |
| size | مشخص میکند آیا فیلد بهصورت فشرده نمایش داده شود (compact) یا تمام عرض dialog را بگیرد (full) |
| remember | مشخص میکند آیا مقادیر قبلاً انتخابشده برای این فیلد ذخیره شوند و دفعه بعد که پنجره Push Defect باز میشود، دوباره بازیابی شوند یا نه. |
| الزامی | مشخص میکند این فیلد اجباری است یا اختیاری، و آیا کاربران باید در پنجره Push Defect برای آن مقداری وارد کنند یا نه. |
| نوع | نوع این فیلد را مشخص میکند. برای دیدن فهرست نوع فیلدهای پشتیبانیشده، بخش فیلدهای سفارشی را در ادامه ببینید. این گزینه برای فیلدهای سفارشی الزامی است. |
فیلدهای سفارشی #
برای اضافه کردن فیلدهای سفارشی به پنجره Push Defect در TestRail هم میتوانید از روش بالا استفاده کنید. برای این کار، کافی است یک خط شامل فیلد سفارشی خود را به بخش [push.fields] اضافه کنید. فیلدهای سفارشی با این پیشوند مشخص میشوند: customfield_<id>.
[push.fields]
# ...
description=on
customfield_11002=onسپس یک بخش [field.settings.customfield_<id>] اضافه کنید. این بخش لازم است تا plugin بتواند دادهها را به ابزار شما ارسال کند و/یا از آن دریافت کند.
اطلاعات فیلد سفارشی را میتوانید از طریق یک درخواست GET Projects دریافت کنید؛ همانطور که در مستندات MantisHub API توضیح داده شده است اینجا. نمونهای از پیکربندی فیلد سفارشی در ادامه آمده است:
[field.settings.customfield_<id>]
label=Customer
size=compact
type=dropdown
required=trueنوع فیلدهای زیر پشتیبانی میشوند:
| نوع فیلد | توضیح |
|---|---|
| date | یک فیلد متنی که مقدار تاریخ را با قالب YYYY-MM-DD یا ساختاری مشابه میپذیرد. قالب دقیق ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| datetime | یک فیلد متنی که مقدار تاریخ و زمان را با قالب YYYY-MM-DD HH:MM یا ساختاری مشابه میپذیرد. قالب دقیق ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| dropdown | یک فهرست کشویی که به کاربران اجازه میدهد یکی از چند گزینه را انتخاب کنند. |
| string | یک فیلد متن آزاد کوتاه، با حداکثر ۲۵۰ کاراکتر. |
| text | یک فیلد متن آزاد بزرگ، بدون محدودیت عملی برای اندازه متن. |
پیوستها #
Mantis Defect Plugin از ارسال پیوست به Mantis هم پشتیبانی میکند. این فیلد را میتوان فعال یا غیرفعال کرد، اما قابل سفارشیسازی نیست. برای ارسال یک یا چند پیوست به Mantis، کافی است فایل پیوست را به بخش attachments یا description در push dialog بکشید، یا روی همان بخش کلیک کنید و فایل را از سیستم خود انتخاب کنید.
Reference Plugin #
از Reference plugin میتوان برای دریافت اطلاعات بیشتر از IDهایی استفاده کرد که در فیلد References موجودیتهای TestRail، مانند test case، test run و milestone، وارد شدهاند. Reference Plugin در تب References از تنظیمات integration پیکربندی میشود؛ درست مانند Defect Plugin.
این plugin از نمایش اطلاعات هنگام hover روی Reference IDها پشتیبانی میکند، اما برای فیلد References پنجره Push ندارد. همچنین میتوانید فیلدهایی را که با hover روی لینک نمایش داده میشوند سفارشی کنید و همانطور که در بالا توضیح داده شد، فیلدهای سفارشی اضافه کنید.
اگر Defect Plugin را از قبل برای Mantis پیکربندی کردهاید، میتوانید بخشهای [connection] و [hover.fields] را از Defect Plugin کپی کرده و در پیکربندی Reference plugin قرار دهید. همچنین میتوانید برای References و Defects فیلدهای متفاوتی را برای نمایش انتخاب کنید.
سفارشیسازیهای بیشتر #
TestRail از defect pluginهای سفارشی هم پشتیبانی میکند. اگر تیم شما از TestRail Server استفاده میکند، میتوانید defect plugin را بیشتر سفارشی کنید، یا plugin خودتان را بسازید، تا از نوع فیلدهای بیشتر یا دادههای دیگر پشتیبانی کند. لطفاً مستندات Defect plugins را برای اطلاعات بیشتر ببینید.
