یکپارچه‌سازی با Assembla

این بخش توضیح می‌دهد چگونه TestRail را با Assembla یکپارچه کنید. در حال حاضر، سه روش برای یکپارچه‌سازی TestRail با Assembla وجود دارد:

• استفاده از defect URLها برای لینک کردن test resultها به Assembla
• استفاده از defect plugin مخصوص Assembla برای ارسال و جست‌وجوی ticketهای Assembla
• استفاده از reference URLها برای لینک کردن test caseها به Assembla
• استفاده از reference plugin مخصوص Assembla برای جست‌وجوی ticketهای Assembla در فیلد References موجودیت‌های TestRail، مانند test caseها، test runها و milestoneها.

لازم نیست از همه گزینه‌های یکپارچه‌سازی فهرست‌شده استفاده کنید؛ می‌توانید این یکپارچه‌سازی را همراه با ابزارهای دیگر هم به کار ببرید. پیکربندی آن معمولاً فقط چند دقیقه زمان می‌برد. این راهنما توضیح می‌دهد این یکپارچه‌سازی چگونه پیکربندی می‌شود و چطور کار می‌کند.

یکپارچه‌سازی پیشرفته Assembla #

TestRail یکپارچه‌سازی با Assembla را با استفاده از OAuth ارائه می‌دهد. با این روش، کاربران می‌توانند instanceهای TestRail و Assembla خود را سریع به هم وصل کنند، بدون اینکه لازم باشد API key پیکربندی کنند یا credentialهای اضافی وارد کنند.

اتصال به Assembla #

به‌عنوان TestRail Administrator، می‌توانید از نمای Integration در بخش Administration به یک instance از Assembla متصل شوید. در این نما، دکمه Configure Assembla را انتخاب کنید و مراحل پنجره اتصال را ادامه دهید:

بعد از وارد کردن Organization URL و Space مربوط به Assembla در پنجره، می‌توانید دکمه Connect Account را انتخاب کنید تا TestRail پیکربندی را برای شما کامل کند. همچنین می‌توانید API Key و API Secret را به‌صورت دستی وارد کنید.

گزینه‌های Defect integration و Reference integration به شما امکان می‌دهند یکپارچه‌سازی‌های Defect و Reference را نیز به‌صورت خودکار برای instance خود پیکربندی کنید.

OAuth برای کاربران #

بعد از اتصال TestRail به Assembla، می‌توانید حساب TestRail خود را با استفاده از OAuth به Assembla وصل کنید. در بخش My Settings حساب کاربری خود، تب OAuth را باز کنید:

با انتخاب دکمه Connect Account یک access token از Assembla دریافت می‌شود و در حساب TestRail شما ذخیره می‌شود. همچنین می‌توانید به‌صورت دستی یک User Access Token را در تب Settings وارد کنید.

همچنین می‌توانید هر زمان که خواستید اتصال حساب کاربری خود را قطع کنید.

API key و secret برای کاربران #

اگر TestRail با استفاده از API Key و Secret به Assembla متصل شده باشد، باید در حساب Assembla خود یک API key و secret بسازید. این کار را می‌توانید از مسیر Account > API Applications & Session انجام دهید. حتماً گزینه‌های API access و Repository access را فعال کنید.

پس از ذخیره، API key و secret در دسترس خواهند بود. در TestRail باید key و secret خود را در User Variables مربوط به این یکپارچه‌سازی ذخیره کنید.

Defect URLها #

Defect URLها به TestRail کمک می‌کنند تا بداند چطور یک Defect ID را به URL مربوط به نمونه Assembla شما تبدیل کند. دو نوع URL وجود دارد: View URL و Add URL.

گزینه Defect View URL برای ساختن لینک به Assembla بر اساس Defect ID استفاده می‌شود؛ بنابراین می‌توانید روی یک ID کلیک کنید و issue را مستقیم در Assembla باز کنید.

گزینه Defect Add URL برای ایجاد لینک به صفحه ساخت issue در Assembla استفاده می‌شود. پس از پیکربندی URL، یک لینک Add جدید کنار فیلد Defects در پنجره Add Test Result و در منوی Defects در قابلیت Push Defect From Anywhere در TestRail نمایش داده می‌شود. این لینک به شما امکان می‌دهد برای گزارش یک bug جدید، مستقیم به فرم New Issue در Assembla بروید.

اگر از لینک Add استفاده کنید، می‌توانید ID مربوط به issue جدید خود در Assembla را کپی کرده و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.

می‌توانید URLهای Assembla را در TestRail به‌صورت سراسری از مسیر Administration > Integration پیکربندی کنید، یا آن‌ها را برای هر project جداگانه در تنظیمات همان project تنظیم کنید. برای پیکربندی آدرس‌ها، از URLهای نمونه زیر استفاده کنید:

Assembla installation
Defect View Url: https://app.assembla.com/spaces/<space>/tickets/%id%
Defect Add Url:  https://app.assembla.com/spaces/<space>/tickets/new?from=tickets

حتماً مقدار موردنظر را <space> با نام واقعی portfolio و space در Assembla که می‌خواهید با آن یکپارچه شود، جایگزین کنید.

اگر نمونه Assembla شما در اتحادیه اروپا قرار دارد، URLهای شما باید با https://eu-app.assembla.com/… شروع شوند.

Reference URLها #

Reference URLها تقریباً به همان روشی پیاده‌سازی می‌شوند که برای Defect URLها در بالا توضیح داده شد. تفاوت اصلی این است که Reference URLها برای فیلد References در موجودیت‌های مختلف TestRail استفاده می‌شوند، نه برای فیلد Defects.

گزینه Reference View URL به همان روش توضیح‌داده‌شده در بالا پیکربندی می‌شود و به TestRail اجازه می‌دهد بر اساس ID واردشده در فیلد References، یک لینک مستقیم به Assembla ایجاد کند.

گزینه Reference Add URL نیز مانند Defect Add URL پیکربندی می‌شود. پس از پیکربندی، یک لینک Add کنار هر فیلد References در نمونه یا project شما نمایش داده می‌شود. اگر از لینک Add استفاده کنید، می‌توانید ID مربوط به issue جدید خود در Assembla را کپی کرده و آن را در هر فیلد Defects یا References داخل TestRail وارد کنید.

اگر Reference plugin را پیکربندی کرده باشید، می‌توانید نشانگر ماوس را روی Reference ID نگه دارید و جزئیات issue را مستقیم داخل TestRail ببینید. در ادامه توضیح می‌دهیم چطور از Defect Plugin و Reference Plugin استفاده کنید و آن‌ها را پیکربندی کنید.

Defect pluginها #

Defect pluginها برای پیاده‌سازی یکپارچه‌سازی نزدیک با bug tracker استفاده می‌شوند، و TestRail یک Assembla defect plugin آماده استفاده دارد. برای پیکربندی defect plugin، گزینه Admin > Integration را انتخاب کنید و در فهرست کشویی Defect Plugin گزینه Assembla را انتخاب کنید. در مرحله بعد، همه تنظیمات اتصال لازم را پیکربندی کنید. همچنین می‌توانید pluginها و تنظیمات پیکربندی مخصوص هر project را به‌صورت اختیاری از مسیر Admin > Projects مشخص کنید.
لطفاً دقت کنید که از workspace ID استفاده کنید، نه از نام workspace. وقتی وارد محیط Assembla خود شده‌اید، این ID در نوار URL قابل مشاهده است.

بعد از پیکربندی defect plugin، یک Push link در کنار Defects در Add Test Result dialog نمایش داده می‌شود. با کلیک روی این link، یک پنجره popup باز می‌شود که به شما امکان می‌دهد بدون خروج از TestRail، یک bug report را به Assembla ارسال کنید.

بعد از اضافه شدن test result، با نگه داشتن نشانگر ماوس روی defect ID پنجره‌ای باز می‌شود که اطلاعات مفید و جزئیات وضعیت defect در Assembla را نشان می‌دهد.

بعد از پیکربندی defect plugin، یک Push link در کنار Defects در Add Test Result dialog نمایش داده می‌شود. با کلیک روی این link، یک پنجره popup باز می‌شود که به شما امکان می‌دهد بدون خروج از TestRail، یک bug report را به Assembla ارسال کنید.

سفارشی‌سازی‌ها #

defect plugin مربوط به Assembla برای کار با پیکربندی استاندارد Assembla ساخته شده است. TestRail به شما امکان می‌دهد فیلدهایی را که در Push dialog نمایش داده می‌شوند، و همچنین فیلدهایی را که هنگام نگه داشتن ماوس روی defect IDها نشان داده می‌شوند، سفارشی کنید. فیلدهای ازپیش‌پیکربندی‌شده push و hover را می‌توانید در بخش‌های مربوطه، یعنی [push.fields] و [hover.fields]، روی «روشن» یا «خاموش» تنظیم کنید، یا ترتیب نمایش آن‌ها را با جابه‌جایی فیلدها در هر بخش تغییر دهید.

توجه داشته باشید بعضی فیلدها، مثل فیلد title، همیشه فعال هستند و ممکن است در این بخش‌ها نمایش داده نشوند، چون TestRail یا Assembla همیشه به آن‌ها نیاز دارد.

Assembla Defect Plugin از تغییر ویژگی‌های فیلدها و همچنین custom fieldها هم پشتیبانی می‌کند.

علاوه بر فعال‌سازی، غیرفعال‌سازی یا مرتب‌سازی دوباره فیلدها طبق توضیح بالا، می‌توانید گزینه‌های بیشتری را برای هر فیلد تغییر دهید. برای این کار، باید یک بخش مخصوص آن فیلد تعریف کنید؛ برای مثال [push.field.description]، و گزینه‌های اضافی را داخل همان بخش مشخص کنید.

[push.field.description]
label=Detailed Description
required=true

برای فهرست کامل گزینه‌های فیلد و توضیح هرکدام، بخش زیر را ببینید:

گزینه	توضیحات
label	نام نمایشی فیلد را در Push Defect dialog مشخص می‌کند برای custom fieldها الزامی است
size	مشخص می‌کند که فیلد به‌صورت فشرده نمایش داده شود compact یا تمام عرض dialog را اشغال کند full
remember	مشخص می‌کند مقدارهایی که قبلاً برای این فیلد انتخاب شده‌اند، ذخیره شوند و دفعه بعد که Push Defect dialog باز می‌شود دوباره برگردانده شوند یا نه
required	مشخص می‌کند این فیلد اجباری است یا اختیاری، و آیا کاربران باید در Push Defect dialog مقداری برای آن وارد کنند یا نه
type	نوع این فیلد را مشخص می‌کند. برای دیدن فهرست نوع‌های فیلد پشتیبانی‌شده، بخش Custom fields در ادامه را ببینید (برای فیلدهای سفارشی الزامی است)

فیلدهای سفارشی #

می‌توانید از روش بالا برای افزودن فیلدهای سفارشی به پنجره Push Defect در TestRail هم استفاده کنید. برای این کار، کافی است در بخش [push.fields] یک خط برای فیلد سفارشی خود اضافه کنید؛ مانند نمونه زیر:

[push.fields]
...
description=on
customfield_11002=on

فیلدهای سفارشی با پیشوند customfield_ مشخص می‌شوند. مقدار ID یک فیلد سفارشی را می‌توانید از طریق Assembla API به دست بیاورید، یا با استفاده از مرورگر مقدار فیلد سفارشی را داخل یک ticket بررسی کنید، یا آن را در URL صفحه ویرایش همان فیلد سفارشی پیدا کنید.

سپس یک بخش [field.settings.customfield_] اضافه کنید. وجود این بخش الزامی است تا plugin بتواند داده‌ها را به ابزار شما ارسال کند و/یا از آن بازیابی کند. نمونه زیر را ببینید:

[field.settings.customfield_11002]
label=Customer
size=compact
type=dropdown
required=true

انواع فیلدهای زیر پشتیبانی می‌شوند:

نوع فیلد	توضیح
dropdown	یک فهرست کشویی که به کاربران اجازه می‌دهد یکی از چند گزینه موجود را انتخاب کنند
multiselect	به کاربران اجازه می‌دهد چند گزینه از پیش تعریف‌شده را انتخاب کنند
string	یک فیلد متن آزاد کوچک، تا حداکثر ۲۵۰ کاراکتر
text	یک فیلد متن آزاد بزرگ، بدون محدودیت عملی برای اندازه متن

پیوست‌ها #

Assembla Defect Plugin از ارسال پیوست‌ها به Assembla هم پشتیبانی می‌کند. این فیلد را می‌توانید فعال یا غیرفعال کنید، اما امکان سفارشی‌سازی آن وجود ندارد. برای ارسال یک یا چند پیوست به Assembla، کافی است فایل پیوست را به ناحیه پیوست‌ها یا توضیحات در پنجره push بکشید، یا روی آن ناحیه کلیک کنید و یک فایل را از سیستم خود انتخاب کنید.

Reference plugin #

Reference pluginها می‌توانند با استفاده از IDهایی که در فیلد References موجودیت‌های TestRail، مانند test caseها، test runها و milestoneها وارد شده‌اند، اطلاعات بیشتری را بازیابی کنند. Reference Plugin از تب References در تنظیمات integration پیکربندی می‌شود؛ درست مشابه روش پیکربندی Defect Plugin.

این plugin از نمایش اطلاعات هنگام بردن نشانگر روی Reference IDها پشتیبانی می‌کند، اما برای فیلد References پنجره Push ندارد. همچنین می‌توانید فیلدهایی را که با hover روی لینک نمایش داده می‌شوند سفارشی کنید و مطابق توضیحات بالا، فیلدهای سفارشی اضافه کنید.

اگر Defect Plugin را از قبل برای Assembla پیکربندی کرده‌اید، کافی است بخش‌های [connection] و [hover.fields] را از Defect Plugin به تنظیمات Reference plugin کپی کنید. همچنین می‌توانید فیلدهای متفاوتی را برای نمایش در References و Defects انتخاب کنید.

سفارشی‌سازی‌های بیشتر #

TestRail از defect pluginهای سفارشی هم پشتیبانی می‌کند. اگر تیم شما از TestRail Server استفاده می‌کند، می‌توانید defect plugin را بیشتر سفارشی کنید یا plugin اختصاصی خودتان را بسازید تا از انواع فیلدهای بیشتر یا داده‌های دیگر پشتیبانی کند. برای اطلاعات بیشتر، به مستندات Custom Plugins مراجعه کنید.