در این بخش نحوه ادغام TestRail با Trello توضیح داده میشود. در حال حاضر چهار روش برای ادغام TestRail با Trello وجود دارد:
- استفاده از Defect URL برای لینک کردن test resultها به Trello
- استفاده از Reference URL برای لینک کردن test caseها به Trello
- استفاده از defect plugin برای Trello جهت ارسال و مشاهده issueهای Trello در فیلد Defects مربوط به test resultها
- استفاده از reference plugin برای Trello جهت مشاهده issueهای Trello در فیلد References موجودیتهای TestRail، مانند test caseها، test runها و milestoneها
لازم نیست از همه گزینههای ادغام که در این فهرست آمدهاند استفاده کنید؛ میتوانید این ادغام را همراه با ابزارهای دیگر هم بهکار ببرید. پیکربندی ادغام معمولاً فقط چند دقیقه زمان میبرد. این راهنما توضیح میدهد ادغام را چگونه پیکربندی کنید و این ادغام چطور کار میکند.
Defect URLها #
Defect URLها به TestRail میگویند که یک Defect ID را چگونه به URL مربوط به Trello instance شما تبدیل کند.
گزینه Defect Add URL برای ایجاد لینک به صفحه ساخت issue در Trello استفاده میشود. بعد از پیکربندی URL، یک لینک جدید با عنوان Add کنار فیلد Defects در پنجره Add Test Result و در منوی Defects در قابلیت Push Defect From Anywhere TestRail نمایش داده میشود. با این لینک میتوانید برای گزارش یک bug جدید مستقیماً به فرم New Issue در Trello بروید.
اگر لینک Add را میبینید، میتوانید ID مربوط به issue جدید Trello را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
میتوانید URLهای Trello را در TestRail بهصورت سراسری از مسیر Administration > Integration یا بهصورت جداگانه برای هر project، از داخل تنظیمات همان project پیکربندی کنید.
Defect Add URL و Reference Add URL میتوانند URLهای مخصوص account یا URL مخصوص board باشند. برای پیکربندی آدرسها از URLهای نمونه زیر استفاده کنید:
Trello installation
Account-specific URL: https://trello.com/<account>/boards
Board-specific URL: https://trello.com/b/<shortLink>/ادغام با Trello از Defect View URL یا Reference View URL پشتیبانی نمیکند، چون ساختار URL در Trello امکان لینک مستقیم به یک card را فراهم نمیکند. Defect Add URL و Reference Add URL میتوانند board، workspace یا هر URL دیگری از Trello باشند که ترجیح میدهید استفاده کنید.
اگر defect plugin را پیکربندی کرده باشید، میتوانید نشانگر را روی Defect ID نگه دارید تا جزئیات issue را مستقیماً داخل TestRail ببینید؛ سپس با کلیک روی جزئیات نمایشدادهشده، مستقیماً به board مربوط به آن card در Trello بروید.
Reference URLها #
Reference URLها تقریباً مشابه Defect URLهایی که بالاتر توضیح داده شد پیادهسازی میشوند. تفاوت اصلی این است که Reference URLها برای فیلد References در موجودیتهای مختلف TestRail استفاده میشوند، نه برای فیلد Defects.
گزینه Reference Add URL هم به همان روش Defect Add URL پیکربندی میشود. بعد از پیکربندی، لینک Add کنار هر فیلد References در instance یا project شما نمایش داده میشود. اگر از لینک Add استفاده کنید، میتوانید ID مربوط به issue جدید Trello را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
اگر Reference plugin را پیکربندی کرده باشید، میتوانید نشانگر را روی یک Reference ID نگه دارید تا جزئیات issue را مستقیماً داخل TestRail ببینید. برای آشنایی با نحوه استفاده و پیکربندی Defect Plugin و Reference Plugin، ادامه مطلب را بخوانید.
Defect plugin #
Defect pluginها برای پیادهسازی ادغام عمیقتر با bug tracker استفاده میشوند، و TestRail یک Trello defect plugin آماده استفاده دارد. برای پیکربندی defect plugin، گزینه Administration > Integration را انتخاب کنید و سپس Trello را در Defect Plugin از فهرست کشویی. گام بعدی این است که همه تنظیمات لازم اتصال را در بخش [connection] پیکربندی کنید. همچنین میتوانید با ویرایش تنظیمات project، این یکپارچهسازی را برای یک project مشخص پیکربندی کنید.
Defect Plugin از API مربوط به Trello استفاده میکند؛ بنابراین برای اتصال به API به اطلاعات ورود معتبر نیاز دارید. میتوانید در این قسمت یک مجموعه اطلاعات ورود را برای همه کاربران Trello وارد کنید، یا از User Variables استفاده کنید تا هر کاربر TestRail بتواند اطلاعات ورود خودش را تنظیم کند. این اطلاعات میتواند ترکیبی از email address یا username همراه با password یا API key باشد.
#
توصیه اکید ما این است که User Variables را پیکربندی کنید. برای اطلاعات بیشتر درباره نحوه پیکربندی آنها، به مستندات User Variables مراجعه کنید.
پس از پیکربندی Defect Plugin، گزینه ثبت یک defect جدید در منوی Defect from Anywhere و همچنین در Add Result dialog داخل یک test run نمایش داده میشود. این dialog به شما امکان میدهد بدون خروج از TestRail، یک issue جدید در Trello ایجاد کنید.
سفارشیسازیها #
Trello defect plugin برای کار با پیکربندی استاندارد Trello طراحی شده است. TestRail به شما امکان میدهد فیلدهایی را که در Push dialog نمایش داده میشوند، و همچنین فیلدهایی را که هنگام بردن نشانگر ماوس روی Defect IDها دیده میشوند، سفارشی کنید. فیلدهای ازپیشپیکربندیشده برای push و hover را میتوانید در بخشهای مربوط به خودشان، یعنی [push.fields] و [hover.fields]، روی «on» یا «off» بگذارید، یا ترتیب نمایش آنها را با جابهجا کردن فیلدها در هر بخش تغییر دهید.
به خاطر داشته باشید بعضی فیلدها، مانند فیلد title، همیشه فعال هستند و چون TestRail یا Trello به آنها نیاز دارد، ممکن است در این بخشها نمایش داده نشوند.
Trello Defect Plugin از تغییر ویژگیهای فیلدها و همچنین custom fieldها هم پشتیبانی میکند.
علاوه بر فعالسازی، غیرفعالسازی یا مرتبسازی دوباره فیلدها که بالاتر توضیح داده شد، میتوانید گزینههای بیشتری را برای هر فیلد تغییر دهید. برای این کار، باید یک بخش برای آن فیلد تعریف کنید؛ برای مثال [push.field.description]، و گزینههای اضافی را داخل همان بخش مشخص کنید.
[push.field.description]
label=Detailed Description
required=trueبرای فهرست کامل گزینههای فیلدهای موجود و توضیح هرکدام، جدول زیر را ببینید:
| گزینه | توضیح |
|---|---|
| api_type | drop-down listها را دقیقتر تعریف میکند. برای فیلدهایی که drop-down نیستند، این مقدار را خالی بگذارید؛ برای مثال: ‘api_type=’. اگر type روی ‘dropdown’ تنظیم شده باشد، برای یک drop-down استاندارد از ‘api_type=dropdown’ و برای checklist از ‘api_type=checked’ استفاده کنید. (برای custom fieldها الزامی است) |
| idCustomField | مستندات مربوط به تعیین این مقدار را میتوانید اینجا ببینید. (برای custom fieldها الزامی است) |
| label | نام نمایشی فیلد را در Push Defect dialog مشخص میکند. (برای custom fieldها الزامی است) |
| size | مشخص میکند فیلد بهصورت compact نمایش داده شود (compact) یا از کل عرض dialog استفاده کند (full) |
| remember | مشخص میکند آیا مقدارهایی که قبلاً برای این فیلد انتخاب شدهاند، ذخیره شوند و دفعه بعد که Push Defect dialog باز میشود دوباره نمایش داده شوند یا نه. |
| required | مشخص میکند این فیلد mandatory است یا optional، و آیا کاربران باید در Push Defect dialog برای این فیلد مقداری وارد کنند یا نه. |
| type | نوع این فیلد را مشخص میکند. برای فهرست field typeهای پشتیبانیشده، بخش Custom fields را در ادامه ببینید. (برای custom fieldها الزامی است) |
فیلدهای سفارشی #
میتوانید از روش بالا برای اضافه کردن فیلدهای سفارشی به dialog مربوط به Push Defect در TestRail هم استفاده کنید. برای این کار، کافی است در بخش [push.fields] یک خط برای فیلد سفارشی خود اضافه کنید. فیلدهای سفارشی با پیشوند customfield_<field_name>مشخص میشوند.
[push.fields]
# ...
description=on
customfied_customer=onسپس یک بخش [field.settings.customfield_<field_name>] اضافه کنید. این بخش لازم است تا plugin بتواند دادهها را به ابزار شما ارسال کند و/یا از آن دریافت کند. <field_name> میتواند هر مقداری باشد، چون ویژگیهای فیلد در بخش مربوط به خودش تعریف میشود. مثال زیر را ببینید:
[field.settings.customfield_customer]
idCustomField=5a6a23abf958725e1ac86c21
api_type=dropdown
label=Customer
size=compact
type=dropdown
required=trueانواع فیلدهای زیر پشتیبانی میشوند:
| نوع فیلد | توضیح |
|---|---|
| bool | یک منوی dropdown بله/خیر برای مقادیر True/False، Yes/No یا مقادیر دودویی مشابه |
| date | یک فیلد رشتهای که مقدار تاریخ را با قالب YYYY-MM-DD یا ساختاری مشابه میپذیرد. قالببندی ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| datetime | یک فیلد رشتهای که مقدار تاریخ و زمان را با قالب YYYY-MM-DD HH:MM یا ساختاری مشابه میپذیرد. قالببندی ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| dropdown | یک فهرست dropdown که به کاربران اجازه میدهد یکی از چند گزینه را انتخاب کنند. |
| integer | یک عدد صحیح. حداکثر مقدار به محدودیتهای ابزار خارجی شما بستگی دارد. |
| multiselect | به کاربران اجازه میدهد چند گزینه از پیش تعریفشده را انتخاب کنند. |
| string | یک فیلد کوچک برای متن آزاد تا سقف ۲۵۰ کاراکتر |
| text | یک فیلد بزرگ برای متن آزاد، بدون محدودیت عملی در اندازه |
پیوستها #
Trello Defect Plugin از ارسال پیوست به Trello نیز پشتیبانی میکند. این فیلد را میتوان روشن یا خاموش کرد، اما امکان سفارشیسازی آن وجود ندارد. برای ارسال یک یا چند پیوست به Trello، کافی است فایل پیوست را به بخش attachments یا description در push dialog بکشید، یا روی همان بخش کلیک کنید و پیوست را از file system خود انتخاب کنید.
Reference Plugin #
Reference pluginها برای دریافت اطلاعات بیشتر از IDهایی استفاده میشوند که در فیلد References موجودیتهای TestRail، مانند test caseها، test runها و milestoneها وارد شدهاند. Reference Plugin در تب References در تنظیمات integration پیکربندی میشود؛ درست مشابه روشی که Defect Plugin را پیکربندی میکنید.
این plugin از نمایش اطلاعات هنگام hover کردن روی Reference IDها پشتیبانی میکند، اما برای فیلد References از Push dialog پشتیبانی نمیکند. همچنین میتوانید همانطور که در بالا توضیح داده شد، فیلدهایی را که با hover روی لینک نمایش داده میشوند سفارشی کنید و فیلدهای سفارشی اضافه کنید.
اگر Defect Plugin را قبلاً برای Trello پیکربندی کردهاید، میتوانید بخشهای [connection] و [hover.fields] را از Defect Plugin کپی کرده و در تنظیمات Reference plugin قرار دهید. همچنین میتوانید فیلدهای متفاوتی را برای References و Defects نمایش دهید.
سفارشیسازیهای بیشتر #
TestRail از defect pluginهای سفارشی نیز پشتیبانی میکند. اگر تیم شما از TestRail Server استفاده میکند، میتوانید defect plugin را بیشتر سفارشی کنید یا plugin خودتان را بسازید تا از انواع فیلدهای بیشتر یا دادههای دیگر پشتیبانی کند. لطفاً به مستندات defect pluginها برای اطلاعات بیشتر مراجعه کنید.
