این بخش توضیح میدهد چگونه TestRail را با Trac یکپارچه کنید. در حال حاضر چهار روش برای یکپارچهسازی TestRail با Trac وجود دارد:
- استفاده از Defect URLها برای لینک کردن نتایج تست به Trac
- استفاده از defect plugin برای Trac جهت push کردن و مشاهدهی ticketهای Trac
- استفاده از Reference URLها برای لینک کردن test caseها به Trac
- استفاده از reference plugin برای Trac تا issueهای Trac را در فیلد References آیتمهای TestRail مثل test caseها، test runها و milestoneها جستوجو کنید
لازم نیست از همه گزینههای یکپارچهسازی بالا استفاده کنید؛ میتوانید آنها را با integrationهای ابزارهای دیگر هم ترکیب کنید. پیکربندی این integration معمولاً فقط چند دقیقه زمان میبرد. این راهنما توضیح میدهد چطور integration را پیکربندی کنید و این قابلیت چگونه کار میکند.
Defect URLها #
Defect URLها به TestRail میگویند که Defect ID را چطور به URL مربوط به instance شما در Trac تبدیل کند. دو نوع URL وجود دارد: View URL و Add URL.
گزینهی Defect View URL برای ساخت لینک به Trac بر اساس Defect ID استفاده میشود؛ بنابراین کافی است روی یک ID کلیک کنید تا issue مستقیماً در Trac باز شود.
گزینهی Defect Add URL برای ایجاد لینک به صفحه ساخت issue در Trac استفاده میشود. بعد از پیکربندی URL، یک لینک Add جدید کنار فیلد Defects در پنجره Add Test Result و در منوی Defects مربوط به قابلیت Push Defect From Anywhere در TestRail نمایش داده میشود. با این لینک میتوانید برای گزارش bug جدید، مستقیماً به فرم New Issue در Trac بروید.
اگر لینک «Add» را میبینید، میتوانید ID issue جدید در Trac را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
برای پیکربندی URLهای Trac در TestRail، مسیر Administration > Integration را انتخاب کنید. همچنین میتوانید برای هر project، URLهای جداگانهی bug tracker را از مسیر Administration > Projects وارد کنید. برای پیکربندی آدرسها از URLهای نمونهی زیر استفاده کنید:
Trac installation
Defect View Url: http://<your-server>/trac/ticket/%id%
Defect Add Url: http://<your-server>/trac/newticketحتماً مقدار <your-server> را با URL سرور Trac که میخواهید TestRail را به آن متصل کنید، جایگزین کنید.
اگر defect plugin را پیکربندی کرده باشید، میتوانید نشانگر ماوس را روی Defect ID نگه دارید و جزئیات issue را مستقیماً داخل TestRail ببینید.
Reference URLها #
Reference URLها تقریباً به همان روشی پیادهسازی میشوند که بالاتر برای Defect URLها توضیح داده شد. تفاوت اصلی این است که Reference URLها برای فیلد References در آیتمهای مختلف TestRail استفاده میشوند، نه برای فیلد Defects.
گزینهی Reference View URL به همان روشی که در بالا توضیح داده شد پیکربندی میشود و به TestRail اجازه میدهد بر اساس ID واردشده در فیلد References، یک لینک مستقیم به Trac بسازد.
گزینهی Reference Add URL نیز مانند Defect Add URL پیکربندی میشود. پس از پیکربندی، یک لینک «Add» کنار هر فیلد References در instance یا project شما نمایش داده میشود. اگر از Add پس از آن میتوانید ID issue جدید در Trac را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
اگر Reference Plugin را پیکربندی کرده باشید، با نگه داشتن نشانگر ماوس روی Reference ID میتوانید جزئیات issue را مستقیماً در TestRail ببینید. برای آشنایی با نحوه استفاده و پیکربندی Defect Plugin و Reference Plugin ادامه مطلب را بخوانید.
Defect Plugin #
#
Defect Plugin مربوط به Trac به XML-RPC plugin برای Trac نیاز دارد. مطمئن شوید این plugin در نصب Trac شما نصب و فعال شده باشد.
از Defect Pluginها میتوان برای یکپارچهسازی عمیقتر با bug tracker استفاده کرد. TestRail یک Defect Plugin آماده استفاده برای Trac دارد. برای پیکربندی Defect Plugin، به بخش Administration > Integration بروید و سپس Trac را در فهرست کشویی Defect Plugin انتخاب کنید. در مرحله بعد باید همه تنظیمات لازم اتصال را در بخش [connection] پیکربندی کنید. همچنین میتوانید با ویرایش تنظیمات یک project، این integration را فقط برای همان project تنظیم کنید.
Defect Plugin از API مربوط به Trac استفاده میکند، بنابراین برای اتصال به API به credentials معتبر نیاز دارید. میتوانید یک مجموعه credentials برای همه کاربران Trac وارد کنید، یا از User Variables استفاده کنید تا هر کاربر TestRail بتواند credentials خودش را تنظیم کند. این credentials میتواند ترکیبی از آدرس ایمیل یا نام کاربری بههمراه password یا API key باشد.
#
اکیداً توصیه میکنیم User Variables را پیکربندی کنید. برای اطلاعات بیشتر درباره نحوه پیکربندی آنها، به مستندات User Variables
پس از پیکربندی Defect Plugin، گزینه push کردن یک defect جدید در منوی Defect from Anywhere و همچنین در پنجره Add Result داخل یک test run نمایش داده میشود. با این پنجره میتوانید بدون خروج از TestRail، یک issue جدید در Trac ایجاد کنید.
سفارشیسازیها #
Defect Plugin مربوط به Trac برای کار با پیکربندی استاندارد Trac ساخته شده است. TestRail به شما اجازه میدهد فیلدهایی را که در پنجره Push نمایش داده میشوند، و همچنین فیلدهایی را که هنگام نگه داشتن ماوس روی Defect IDها نشان داده میشوند، سفارشی کنید. فیلدهای ازپیشتنظیمشده push و hover را میتوانید در بخشهای مربوط به [push.fields] و [hover.fields] روی on یا off بگذارید، یا با جابهجا کردن فیلدها در هر بخش، ترتیب نمایش آنها را تغییر دهید.
توجه داشته باشید بعضی فیلدها، مثل title، همیشه فعال هستند و ممکن است در این بخشها نمایش داده نشوند، چون TestRail یا Trac همیشه آنها را الزامی میداند.
Trac Defect Plugin همچنین از تغییر ویژگیهای فیلدها و custom fieldها پشتیبانی میکند.
علاوه بر فعال کردن، غیرفعال کردن یا مرتبسازی دوباره فیلدها که بالاتر توضیح داده شد، میتوانید گزینههای بیشتری را برای هر فیلد تغییر دهید. برای این کار، باید برای آن فیلد یک بخش تعریف کنید، مثل [push.field.description]، و گزینههای اضافی را در همان بخش مشخص کنید.
[push.field.description]
label=Detailed Description
required=trueدر ادامه، فهرست کامل گزینههای موجود برای فیلدها همراه با توضیح هرکدام آمده است:
| گزینه | توضیح |
|---|---|
| label | نام نمایشی فیلد را در پنجره Push Defect مشخص میکند. |
| size | مشخص میکند فیلد بهصورت compact نمایش داده شود (compact) یا از تمام عرض پنجره استفاده کند (full) |
| remember | مشخص میکند مقدارهایی که قبلاً برای این فیلد انتخاب شدهاند، ذخیره شوند و دفعه بعد که پنجره Push Defect باز میشود دوباره نمایش داده شوند یا نه. |
| required | مشخص میکند این فیلد اجباری است یا اختیاری، و آیا کاربران باید در پنجره Push Defect برای آن مقدار وارد کنند یا نه. |
پیوستها #
Trac Defect Plugin از ارسال پیوست به Trac هم پشتیبانی میکند. این فیلد را میتوانید فعال یا غیرفعال کنید، اما قابل سفارشیسازی نیست. برای ارسال یک یا چند پیوست به Trac، کافی است فایل را به بخش پیوستها یا توضیحات در push dialog بکشید، یا روی همان بخش کلیک کنید و پیوست را از file system خود انتخاب کنید.
Reference Plugin #
از reference pluginها میتوان برای دریافت اطلاعات تکمیلی بر اساس IDهایی استفاده کرد که در فیلد References موجودیتهای TestRail، مانند test case، test run و milestone وارد شدهاند. Reference Plugin در تب References در تنظیمات یکپارچهسازی، به همان روشی پیکربندی میشود که Defect Plugin پیکربندی میشود.
این plugin از نمایش اطلاعات هنگام بردن نشانگر ماوس روی Reference IDها پشتیبانی میکند، اما برای فیلد References از Push dialog پشتیبانی نمیکند. همچنین میتوانید فیلدهایی را که هنگام hover روی لینک نمایش داده میشوند سفارشی کنید و همانطور که بالاتر توضیح داده شد، custom field اضافه کنید.
اگر Defect Plugin را از قبل برای Trac پیکربندی کردهاید، کافی است بخشهای [connection] و [hover.fields] را از Defect Plugin کپی کرده و در پیکربندی Reference Plugin قرار دهید. همچنین میتوانید فیلدهای متفاوتی را برای نمایش در References و Defects انتخاب کنید.
سفارشیسازیهای بیشتر #
TestRail از defect pluginهای سفارشی هم پشتیبانی میکند. اگر تیم شما از TestRail Server استفاده میکند، میتوانید defect plugin را بیشتر سفارشی کنید، یا plugin خودتان را بسازید، تا از نوعهای فیلد بیشتر یا دادههای دیگر پشتیبانی کند. لطفاً برای اطلاعات بیشتر به مستندات defect pluginها مراجعه کنید.
