URLهای Defect
URLهای Defect روشی ساده و عمومی برای اتصال TestRail به bug trackerها و ابزارهای مدیریت project هستند. بعد از پیکربندی این URLها، TestRail به شما امکان می‌دهد مستقیم به صفحه New Bug در bug tracker خود بروید و گزارش باگ جدید ثبت کنید. IDهای defect واردشده هم به‌صورت خودکار به bug tracker شما لینک می‌شوند تا پیگیری وضعیت issueهای گزارش‌شده آسان‌تر شود.
پیکربندی integrationهای URL برای Defect
یکپارچه‌سازی URL با bug trackerها و سایر issue trackerهای خارجی را می‌توانید به‌صورت سراسری یا جداگانه برای هر project پیکربندی کنید. همچنین می‌توانید یک bug tracker سراسری تعیین کنید و فقط برای چند project مشخص آن را override کنید. برای پیکربندی bug tracker سراسری، به Admin > Site Settings > Integration بروید و آدرس‌های وب bug tracker خود را وارد کنید.
Defect View URL
این آدرس وب bug tracker شما برای مشاهده یک defect است. از
%id%
Defect Add URL
این آدرس وب bug tracker شما برای ایجاد یک defect است. معمولاً کافی است آدرس فرم افزودن باگ در bug tracker خود را اینجا وارد کنید.
برای پیکربندی bug tracker برای یک project مشخص، project را ویرایش کنید و آدرس‌های وب bug tracker خود را در تب Integration وارد کنید.
نحوه کار integrationهای URL برای Defect
بعد از پیکربندی URLهای Defect، لینک جدید Add کنار فیلد Defects در پنجره Add Test Result نمایش داده می‌شود. با این لینک می‌توانید سریع به فرم New Bug در bug tracker خود بروید و یک باگ جدید گزارش کنید. همچنین IDهای issue واردشده به bug tracker شما لینک می‌شوند تا پیگیری وضعیت issueها آسان‌تر شود.
مثال‌ها
در ادامه، لینک URLهای نمونه برای bug trackerها و ابزارهای مدیریت project محبوب آمده است. اگر از یکی از ابزارهای فهرست‌شده استفاده می‌کنید، کافی است URLهای نمونه را copy & و paste کنید؛ مستندات زیر همچنین سایر روش‌های integration پشتیبانی‌شده برای این ابزارها را فهرست می‌کند.
نمای کلی defect pluginها
Defect pluginها را می‌توانید علاوه بر پیکربندی Defect URLها استفاده کنید تا integration پیشرفته‌تری با bug tracker داشته باشید. با defect plugin می‌توانید گزارش‌های bug را مستقیماً از TestRail و از طریق API یا web service ابزار bug tracking خود به bug tracker ارسال کنید. Defect pluginها همچنین به شما امکان می‌دهند اطلاعات گزارش‌های bug را مستقیماً در TestRail ببینید؛ در نتیجه بررسی و پیگیری وضعیت و تغییرات issueهای گزارش‌شده ساده‌تر می‌شود.
TestRail برای ابزارهای محبوب، defect pluginهای آماده استفاده ارائه می‌دهد. همچنین می‌توانید برای ابزارهای اختصاصی یا سیستم‌های third-party که هنوز پشتیبانی نمی‌شوند، plugin مخصوص خودتان را بسازید. برای آشنایی با نحوه پیکربندی و استفاده از defect pluginها، بخش‌های زیر را ببینید.
Defect pluginها چگونه کار می‌کنند
وقتی یک Defect Plugin پیکربندی شده باشد، لینک جدید Push کنار فیلد Defects در پنجره Add Test Result اضافه می‌شود. با این کار می‌توانید بدون خروج از TestRail، یک bug یا آیتم دیگر را سریع در defect tracker خارجی خود ایجاد کنید.
بعد از ارسال گزارش bug، ID ایجادشده می‌تواند به هر فیلد Defects اضافه شود؛ چه توسط defect plugin و چه به‌صورت دستی. همچنین می‌توانید با نگه داشتن نشانگر ماوس روی defect ID در صفحه test، جزئیات گزارش bug را در TestRail ببینید.
پیکربندی integrationهای defect plugin
Defect pluginها را می‌توان به‌صورت سراسری یا برای هر project به‌طور جداگانه پیکربندی کرد. همچنین می‌توانید یک defect plugin سراسری تعیین کنید و آن را فقط برای چند project مشخص override کنید. برای پیکربندی plugin سراسری، به Admin > Integration بروید و یک defect plugin انتخاب کنید. برای پیکربندی defect plugin برای یک project مشخص، project را ویرایش کنید و plugin را در تب Defects انتخاب کنید.
هر plugin مجموعه‌ای از پارامترهای پیکربندی مخصوص خود را دارد که برای استفاده از آن باید تعریف شوند. برای مثال، بسیاری از bug trackerها برای ارسال گزارش bug به login نیاز دارند؛ بنابراین معمولاً باید username و password مربوط به bug tracker را در TestRail تنظیم کنید. وقتی یک plugin را انتخاب می‌کنید، همه پارامترهای پیکربندی لازم در [connection] بخش نمایش داده می‌شوند.
سفارشی‌سازی توضیحات issue در Push Defect
Defect Pluginها به شما امکان می‌دهند فیلدهایی را که در پنجره Push Defect نمایش داده می‌شوند پیکربندی و تغییر دهید. به‌صورت پیش‌فرض، plugin از فهرستی از فیلدها در [push.fields] بخش پشتیبانی می‌کند.
فیلدهای نمایش‌داده‌شده
می‌توانید با روشن یا خاموش کردن فیلدها، مشخص کنید کدام فیلدها در پنجره push نمایش داده شوند. هر فیلدی که به‌صورت پیش‌فرض در فهرست نیست، می‌تواند به‌عنوان Custom Field تعریف شود؛ به شرطی که ابزار شما از custom field پشتیبانی کند و نوع فیلد هم پشتیبانی شده باشد.
[push.fields]
summary=on
project=on
issuetype=on
component=on
assignee=on
priority=on
affects_version=on
fix_version=off
estimate=off
labels=off
environment=off
description=on
می‌توانید & فیلدهای تکی را فعال یا غیرفعال کنید و با تغییر پیکربندی بالا، ترتیب فیلدها را هم عوض کنید.
گزینه‌های فیلد
علاوه بر فعال یا غیرفعال کردن فیلدها، همان‌طور که بالاتر توضیح داده شد، می‌توانید گزینه‌های بیشتری را برای هر فیلد تغییر دهید. برای این کار، باید برای فیلد یک section مانند [push.field.component] تعریف کنید و گزینه‌های اضافی را در همان section مشخص کنید.
[push.field.component]
label=Component
size=compact
remember=false
required=false
type=dropdownالبته لازم نیست همه گزینه‌ها را مشخص کنید، به‌ویژه برای فیلدهایی که plugin به‌صورت پیش‌فرض از آن‌ها پشتیبانی می‌کند. برای مثال، اگر فقط می‌خواهید گزینه required را برای یک فیلد تغییر دهید، می‌توانید گزینه‌های دیگر را وارد نکنید. توضیح گزینه‌های مختلف را در ادامه ببینید:
| گزینه | توضیح |
|---|---|
| label | نام نمایشی فیلد را در پنجره Push Defect مشخص می‌کند ( برای custom fieldها الزامی است) |
| size | مشخص می‌کند که فیلد به‌صورت فشرده نمایش داده شود ( compact ) یا تمام عرض dialog را بگیرد ( full ) |
| remember | مشخص می‌کند آیا مقدارهایی که قبلاً برای این فیلد انتخاب شده‌اند، ذخیره شوند و دفعه بعد که پنجره Push Defect باز می‌شود دوباره نمایش داده شوند. |
| required | مشخص می‌کند این فیلد اجباری است یا اختیاری، و آیا کاربر باید در پنجره Push Defect برای آن مقداری وارد کند یا نه. |
| type | نوع این فیلد را مشخص می‌کند؛ برای فهرست انواع فیلدهای پشتیبانی‌شده، بخش فیلدهای سفارشی در ادامه را ببینید ( برای فیلدهای سفارشی الزامی است) |
فیلدهای سفارشی
برای افزودن فیلدهای سفارشی به پنجره Push Defect در TestRail هم می‌توانید از همین روش استفاده کنید. برای این کار، کافی است در بخش [push.fields] یک خط برای فیلد سفارشی خود اضافه کنید:
[push.fields]
summary=on
...
description=on
customfield_11002=onسپس یک بخش [field.settings.{custom field identifier}] اضافه کنید. این بخش لازم است تا plugin بتواند داده‌ها را به ابزار شما ارسال کند و/یا از آن دریافت کند. نمونه زیر یک پیکربندی فیلد سفارشی برای Jira است:
[field.settings.customfield_11002]
label=Customer
size=compact
type=dropdown
required=trueممکن است از field typeهای زیر پشتیبانی شود:
| نوع فیلد | توضیح |
|---|---|
| bool | یک منوی کشویی بله/خیر برای مقدارهای دوحالته مثل True/False، Yes/No یا موارد مشابه. |
| date | یک فیلد string که مقدار تاریخ با قالب YYYY-MM-DD یا ساختاری مشابه را می‌پذیرد. قالب دقیق ممکن است به نیازهای ابزار یکپارچه‌شده بستگی داشته باشد. |
| datetime | یک فیلد string که مقدار تاریخ و زمان با قالب YYYY-MM-DD HH:MM یا ساختاری مشابه را می‌پذیرد. قالب دقیق ممکن است به نیازهای ابزار یکپارچه‌شده بستگی داشته باشد. |
| string | یک فیلد متن آزاد کوچک، با ظرفیت حداکثر ۲۰۰۰ کاراکتر |
| text | یک فیلد متن آزاد بزرگ، بدون محدودیت عملی از نظر اندازه |
| dropdown | یک فهرست dropdown که کاربر می‌تواند یکی از چند گزینه را از آن انتخاب کند |
| multiselect | به کاربر اجازه می‌دهد چند گزینه از پیش تعریف‌شده را انتخاب کند |
custom field همیشه باید با قالب customfield_<id> یا نگارشی مشابه مشخص شود. برای تعریف custom fieldها، field typeهای پشتیبانی‌شده و جزئیات مخصوص همان ابزار، مستندات plugin ابزار خود را ببینید.
سفارشی‌سازی پنجره پیش‌نمایش هنگام hover
هنگام مشاهده test resultها، می‌توانید نشانگر ماوس را روی هر ID در هر فیلد Defects نگه دارید تا TestRail اطلاعات آن مورد را از bug tracker یکپارچه‌شده شما دریافت کند. این اطلاعات در یک pop-up dialog نمایش داده می‌شود تا بتوانید بدون خروج از TestRail اطلاعات مهم را ببینید.
مشابه سفارشی‌سازی [push.fields]، defect pluginها به شما اجازه می‌دهند فیلدهایی را که هنگام hover روی Defect ID نمایش داده می‌شوند پیکربندی و تغییر دهید. به‌صورت پیش‌فرض، plugin از فهرستی از فیلدها در بخش [hover.fields] پشتیبانی می‌کند. می‌توانید با قرار دادن فیلدها روی «on» یا «off»، تعیین کنید کدام فیلدها در dialog نمایش داده شوند، و با بخش [field.settings.{field name}] ویژگی‌های فیلد را تغییر دهید؛ همان‌طور که در Field Options توضیح داده شده است.
همچنین می‌توانید برای نمایش اطلاعات هنگام hover روی لینک، فیلدهای سفارشی را پیکربندی کنید. اگر فیلدی به‌صورت پیش‌فرض در فهرست نیست، در صورتی که نوع آن پشتیبانی شود باید آن را به‌عنوان Custom Field تعریف کنید. اگر فیلدی برای پنجره Push پیکربندی شده باشد، لازم نیست یک بخش دوم [field.settings.{custom field identifier}] اضافه کنید.
[hover.fields]
summary=on
project=on
issuetype=on
component=on
assignee=on
priority=on
affects_version=on
fix_version=off
estimate=off
labels=off
environment=off
description=on
می‌توانید فیلدهای جداگانه را فعال یا & غیرفعال کنید و با تغییر پیکربندی بالا، ترتیب فیلدها را هم عوض کنید.
فیلدهای سفارشی در پیش‌نمایش hover نقص
می‌توانید یک فیلد سفارشی را همان‌طور که به بخش [push.fields] اضافه می‌کنید، به بخش [hover.fields] هم اضافه کنید. فیلد سفارشی همیشه باید با customfield_<id> یا قالبی مشابه مشخص شود و باید یک بخش [field.settings.{custom field identifier}] داشته باشد. برای تعریف فیلدهای سفارشی، نوع فیلدهای پشتیبانی‌شده و جزئیات مخصوص هر ابزار، مستندات plugin همان ابزار را ببینید.
Defect از هر جا
در هر projectی که از Defect Plugin و/یا Defect URL استفاده می‌کند، کاربران می‌توانند با استفاده از دکمه «Defects» که در viewهای زیر در TestRail در دسترس است، به ابزار خارجی یکپارچه‌شده وصل شوند:
- صفحه Overview پروژه
- صفحه Milestones پروژه
- صفحه‌های Test Runs و Results پروژه، از جمله از داخل test run یا test plan
- صفحه Test Cases
Push New Defect
این گزینه در منوی Defects برای باز کردن پنجره Push و ثبت یک defect جدید در ابزار خارجی شما استفاده می‌شود، بدون اینکه لازم باشد از TestRail خارج شوید. برای استفاده از این قابلیت، باید یک Defect Plugin برای instance TestRail شما یا project فعلی پیکربندی شده باشد. راهنمای پیکربندی یکپارچه‌سازی defectها را می‌توانید اینجا ببینید.
وقتی با استفاده از این پنجره یک defect جدید را با موفقیت در ابزار خارجی ثبت می‌کنید، TestRail شناسه entity جدید را به شما نشان می‌دهد تا بتوانید آن ID را در فیلدهای Defects یا References مربوط به هر entity مرتبط در TestRail وارد کنید.
Add New Defect
این گزینه در منوی Defects صفحه ایجاد defect را در ابزار خارجی شما باز می‌کند. برای استفاده از این قابلیت، باید Defect Add URL برای instance TestRail شما یا project فعلی پیکربندی شده باشد.
هنگام استفاده از گزینه Add New Defect، TestRail به‌صورت خودکار ID مربوط به entity جدیدی را که ایجاد می‌کنید ثبت نمی‌کند. اگر می‌خواهید این ID را به فیلد Defects یا References یک entity در TestRail اضافه کنید، باید ID را از ابزار خارجی خود بردارید و در entityهای TestRail وارد کنید.