این بخش توضیح میدهد چطور TestRail را با VersionOne یکپارچه کنید. در حال حاضر چهار روش برای یکپارچهسازی TestRail با VersionOne وجود دارد:
- استفاده از defect URLها برای لینک کردن نتایج تست به VersionOne
- استفاده از reference URLها برای لینک کردن test caseها به VersionOne
- استفاده از defect plugin مخصوص VersionOne برای ارسال و مشاهده issueهای VersionOne در فیلد Defects نتایج تست
- استفاده از reference plugin مخصوص VersionOne برای مشاهده issueهای VersionOne در فیلد References موجودیتهای TestRail، مثل test caseها، test runها و milestoneها
لازم نیست از همه گزینههای یکپارچهسازی فهرستشده استفاده کنید. همچنین میتوانید این یکپارچهسازی را در کنار ابزارهای دیگر بهکار ببرید. پیکربندی آن معمولاً فقط چند دقیقه زمان میبرد. این راهنما توضیح میدهد چطور یکپارچهسازی را پیکربندی کنید و این قابلیت چگونه کار میکند.
Defect URLها #
Defect URLها به TestRail میگویند چطور یک Defect ID را به URL مربوط به VersionOne instance شما تبدیل کند. دو نوع URL وجود دارد: View URL و Add URL.
گزینهٔ Defect View URL برای ساختن لینک به VersionOne بر اساس Defect ID استفاده میشود؛ بنابراین کافی است روی یک ID کلیک کنید تا issue مستقیماً در VersionOne باز شود.
گزینهٔ Defect Add URL برای ساختن لینک به صفحه ایجاد issue در VersionOne استفاده میشود. بعد از پیکربندی URL، یک لینک Add جدید کنار فیلد Defects در پنجره Add Test Result و در منوی Defects مربوط به قابلیت Push Defect From Anywhere در TestRail نمایش داده میشود. این لینک به شما امکان میدهد برای گزارش یک bug جدید، به فرم New Issue در VersionOne بروید.
اگر لینک Add را میبینید، میتوانید ID مربوط به issue جدید خود در VersionOne را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
میتوانید URLهای VersionOne را در TestRail بهصورت سراسری از مسیر Administration > Integration یا بهصورت جداگانه برای هر project، از داخل تنظیمات همان project پیکربندی کنید. برای تنظیم آدرسها از URLهای نمونه زیر استفاده کنید:
VersionOne installation
Defect View Url: https://<server>/<instance>/assetdetail.v1?Number=%id%
Defect Add Url: https://<server>/<instance>حتماً مقدارهای <server> و <instance> را با نام واقعی server و instance در VersionOne که میخواهید با آن یکپارچه شوید جایگزین کنید.
اگر defect plugin را پیکربندی کرده باشید، میتوانید نشانگر ماوس را روی defect ID نگه دارید و جزئیات issue را مستقیماً از داخل TestRail ببینید.
#
در VersionOne لینک مستقیمی به صفحه ایجاد issue جدید وجود ندارد؛ بنابراین Add URL میتواند هر لینکی به VersionOne باشد.
Reference URLها #
Reference URLها تقریباً به همان شکلی پیادهسازی میشوند که برای Defect URLها در بالا توضیح داده شد. تفاوت اصلی این است که Reference URLها برای فیلد References در موجودیتهای مختلف TestRail استفاده میشوند، نه برای فیلد Defects.
گزینهٔ Reference View URL به همان روشی که در بالا توضیح داده شد پیکربندی میشود و به TestRail اجازه میدهد بر اساس ID واردشده در فیلد References، یک لینک مستقیم به VersionOne بسازد.
گزینهٔ Reference Add URL نیز به همان روش Defect Add URL پیکربندی میشود. بعد از پیکربندی، لینک Add کنار هر فیلد References در instance یا project شما نمایش داده میشود. اگر از ‘Add’ لینک، میتوانید ID issue جدید در VersionOne را کپی کنید و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.
اگر Reference Plugin را پیکربندی کرده باشید، میتوانید نشانگر ماوس را روی Reference ID نگه دارید و جزئیات issue را مستقیماً از داخل TestRail ببینید. در ادامه، با نحوه استفاده و پیکربندی Defect Plugin و Reference Plugin آشنا میشوید.
Defect Plugin #
از defect pluginها میتوان برای یکپارچهسازی عمیقتر با bug tracker استفاده کرد و TestRail یک VersionOne defect plugin آماده استفاده دارد. برای پیکربندی defect plugin، گزینه Administration > Integration را انتخاب کنید و سپس VersionOne را در Defect Plugin فهرست کشویی انتخاب کنید. مرحله بعد این است که همه تنظیمات لازم برای اتصال را در بخش [connection] پیکربندی کنید. همچنین میتوانید با ویرایش تنظیمات یک project، این integration را فقط برای همان project پیکربندی کنید.
Defect Plugin از API مربوط به VersionOne استفاده میکند؛ بنابراین برای اتصال به API به credentials معتبر نیاز دارید. میتوانید در این بخش یک مجموعه credentials برای همه کاربران VersionOne وارد کنید، یا از User Variables استفاده کنید تا هر کاربر TestRail بتواند credentials خودش را تنظیم کند. این credentials میتواند ترکیبی از آدرس ایمیل یا نام کاربری همراه با password یا API key باشد.
#
اکیداً توصیه میکنیم User Variables را پیکربندی کنید. برای اطلاعات بیشتر درباره پیکربندی آنها، به مستندات User Variables مراجعه کنید.
بعد از پیکربندی Defect Plugin، گزینه ارسال یک defect جدید در منوی Defect from Anywhere و همچنین در پنجره Add Result داخل یک test run نمایش داده میشود. این پنجره به شما اجازه میدهد بدون خارج شدن از TestRail، یک issue جدید در VersionOne ایجاد کنید.
بعد از اضافه شدن test result، با نگه داشتن نشانگر ماوس روی case ID، پنجرهای باز میشود که اطلاعات مفید و جزئیات وضعیت case در VersionOne را نشان میدهد.
سفارشیسازیها #
VersionOne defect plugin برای کار با پیکربندی استاندارد VersionOne ساخته شده است. TestRail به شما اجازه میدهد فیلدهایی را که در پنجره Push و همچنین هنگام نگه داشتن ماوس روی Defect IDها نمایش داده میشوند سفارشی کنید. فیلدهای ازپیشپیکربندیشده push و hover را میتوان در بخشهای مربوط به خودشان، یعنی [push.fields] و [hover.fields]، روی ‘on’ یا ‘off’ تنظیم کرد. همچنین میتوانید با تغییر ترتیب فیلدها در هر بخش، ترتیب نمایش آنها را عوض کنید.
به خاطر داشته باشید بعضی فیلدها، مانند فیلد title، همیشه فعال هستند و ممکن است در این بخشها نمایش داده نشوند، چون TestRail یا VersionOne همیشه به آنها نیاز دارد.
VersionOne Defect Plugin از تغییر ویژگیهای فیلدها و همچنین custom fieldها هم پشتیبانی میکند.
علاوه بر فعال کردن، غیرفعال کردن یا مرتبسازی دوباره فیلدها طبق توضیح بالا، میتوانید گزینههای بیشتری را برای هر فیلد تغییر دهید. برای این کار، باید بخشی برای آن فیلد تعریف کنید، مثلاً [push.field.description]، و گزینههای اضافی را داخل همان بخش مشخص کنید.
[push.field.description]
label=Detailed Description
required=trueدر ادامه، فهرست کامل گزینههای موجود برای فیلدها و توضیح هرکدام آمده است:
| گزینه | توضیح |
|---|---|
| asset_type | Asset Type مربوط به custom field، مانند ‘Defect’ (برای custom fieldها الزامی است) |
| field_name | نام سیستمی فیلد در VersionOne، مانند ‘Custom_DefectField.’. این مقدار به بزرگی و کوچکی حروف حساس است. (برای custom fieldها الزامی است) |
| label | نام نمایشی فیلد را در پنجره Push Defect مشخص میکند (برای custom fieldها الزامی است) |
| list_type | اگر type برابر dropdown یا multi-select باشد، فیلد list_type هم در [field.settings.c…] لازم است. مقدار list_type میتواند dropdown، multi-select یا checkbox باشد. (برای custom fields الزامی است) |
| size | مشخص میکند که فیلد بهصورت فشرده نمایش داده شود (compact) یا از تمام عرض dialog استفاده کند (full) |
| remember | مشخص میکند که آیا مقدارهایی که قبلاً برای این فیلد انتخاب شدهاند، ذخیره شوند و دفعه بعد که dialog مربوط به Push Defect باز میشود دوباره نمایش داده شوند یا نه. |
| required | مشخص میکند این فیلد اجباری است یا اختیاری، و آیا کاربران باید در dialog مربوط به Push Defect برای آن مقدار وارد کنند یا نه. |
| type | نوع این فیلد را مشخص میکند. برای دیدن فهرست field typeهای پشتیبانیشده، بخش Custom fields را در ادامه ببینید. (برای custom fields الزامی است) |
Custom fields #
برای اضافه کردن custom fields به dialog مربوط به Push Defect در TestRail هم میتوانید از همین روش استفاده کنید. برای این کار، کافی است یک خط شامل custom field خودتان را به بخش [push.fields] اضافه کنید. custom fields با این الگو مشخص میشوند: customfield_<field_name>.
[push.fields]
# ...
description=on
customfield_customer=onسپس یک بخش [field.settings.customfield_ اضافه کنید<field_name>] . این بخش لازم است تا plugin بتواند دادهها را به ابزار شما ارسال کند و/یا از آن دریافت کند. مثال زیر را ببینید:
[field.settings.customfield_customer]
label=Customer Name
asset_type=Defect
field_name=Custom_CustomerName
size=compacttype=dropdown
list_type=dropdown
required=truefield typeهای زیر پشتیبانی میشوند:
| Field Type | توضیحات |
|---|---|
| bool | یک منوی dropdown بله/خیر برای مقدارهای دودویی مثل True/False، Yes/No یا موارد مشابه |
| date | یک فیلد string که مقدار تاریخ را با قالب YYYY-MM-DD یا ساختاری مشابه میپذیرد. قالببندی ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| datetime | یک فیلد string که مقدار تاریخ و زمان را با قالب YYYY-MM-DD HH:MM یا ساختاری مشابه میپذیرد. قالببندی ممکن است به نیازهای ابزار یکپارچهشده بستگی داشته باشد. |
| dropdown | یک فهرست dropdown که به کاربران اجازه میدهد یکی از چند گزینه را انتخاب کنند |
| multiselect | به کاربران اجازه میدهد چند گزینه از پیش تعریفشده را انتخاب کنند |
| string | یک فیلد کوچک برای متن آزاد، تا حداکثر ۲۵۰ کاراکتر |
| text | یک فیلد بزرگ برای متن آزاد، بدون محدودیت عملی در اندازه |
Attachments #
VersionOne Defect Plugin از ارسال attachment به VersionOne هم پشتیبانی میکند. این فیلد را میتوان فعال یا غیرفعال کرد، اما قابل سفارشیسازی نیست. برای ارسال یک یا چند attachment به VersionOne، کافی است attachment را به بخش attachments یا description در push dialog بکشید، یا روی همان بخش کلیک کنید و attachment را از file system خود انتخاب کنید.
پلاگین Reference #
از پلاگینهای Reference میتوانید برای دریافت اطلاعات تکمیلی بر اساس IDهایی استفاده کنید که در فیلد References آیتمهای TestRail، مثل test caseها، test runها و milestoneها وارد شدهاند. Reference Plugin در تب References از تنظیمات یکپارچهسازی پیکربندی میشود؛ درست مثل Defect Plugin.
این پلاگین از نمایش اطلاعات هنگام قرار دادن نشانگر روی Reference IDها پشتیبانی میکند، اما برای فیلد References از Push dialog پشتیبانی نمیکند. همچنین همانطور که بالاتر توضیح داده شد، میتوانید فیلدهایی را که هنگام hover روی لینک نمایش داده میشوند سفارشی کنید و فیلدهای custom اضافه کنید.
اگر Defect Plugin را قبلاً برای VersionOne پیکربندی کردهاید، کافی است بخشهای [connection] و [hover.fields] را از تنظیمات Defect Plugin در پیکربندی Reference Plugin کپی کنید. همچنین میتوانید برای References و Defects فیلدهای متفاوتی را برای نمایش انتخاب کنید.
سفارشیسازیهای بیشتر #
TestRail از defect pluginهای custom هم پشتیبانی میکند. اگر تیم شما از TestRail Server استفاده میکند، میتوانید defect plugin را بیشتر سفارشی کنید یا پلاگین خودتان را بسازید تا از انواع فیلدهای بیشتر یا دادههای دیگر پشتیبانی کند. برای اطلاعات بیشتر، به مستندات defect pluginها مراجعه کنید.
