استفاده از فیلدهای سفارشی در یکپارچه‌سازی Jira

پلاگین پیشرفته defect در TestRail برای Jira به تیم‌ها امکان می‌دهد گزارش‌های جدید bug را به Jira ارسال کنند، issueهای Jira را جستجو کنند و requirements و references را یکپارچه کنند. در این مقاله جزئیات بیشتری درباره سفارشی‌سازی این integration با فیلدهای اضافی در Push Defect dialog و همچنین issue linkها و sub-taskهای اضافی آمده است.

فیلدهای نمایش‌داده‌شده #

پلاگین‌های Jira REST به شما امکان می‌دهند فیلدهایی را که در Push Defect dialog و هنگام hover روی link نمایش داده می‌شوند، پیکربندی و تغییر دهید. به‌صورت پیش‌فرض، این پلاگین از قبل فهرستی از فیلدها را به‌عنوان بخشی از پیکربندی پیش‌فرض defect شامل می‌کند؛ برای مثال در tabهای پیکربندی Defect و Reference زیر Admin > Integration یا در تنظیمات integration یک project.

[push.fields]
summary=on
project=on
issuetype=on
# ...
          
[hover.fields]
summary=on
project=on
issuetype=on
# ...

می‌توانید & فیلدهای جداگانه را فعال یا غیرفعال کنید و با تغییر پیکربندی بالا، ترتیب نمایش فیلدها را هم تغییر دهید.

گزینه‌های فیلد #

علاوه بر فعال یا غیرفعال کردن فیلدها، همان‌طور که بالاتر توضیح داده شد، می‌توانید گزینه‌های اضافی را برای هر فیلد هم تغییر دهید. برای این کار، بخشی شبیه [field.settings.components] تعریف می‌کنید تا گزینه‌های اضافی فیلد component مشخص شود. گزینه‌های زیر پشتیبانی می‌شوند:

[field.settings.components]
label=Component
size=compact
remember=false
required=false
type=dropdown

لازم نیست همه گزینه‌ها را مشخص کنید. برای مثال، اگر فقط می‌خواهید گزینه required یک فیلد را تغییر دهید، می‌توانید گزینه‌های دیگر را وارد نکنید. توضیح گزینه‌های مختلف در ادامه آمده است:

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

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

همچنین می‌توانید با روش بالا، فیلدهای سفارشی تعریف‌شده در Jira را به dialog مربوط به Push Defect در TestRail و به نمایش هنگام hover روی link اضافه کنید. برای این کار، کافی است خطی شبیه این را به [push.fields] یا [hover.fields] section اضافه کنید تا یک فیلد افزوده شود:

[push.fields]
summary=on
# ...
customfield_11002=on
# ...

به نام فیلد دقت کنید. فیلد سفارشی Jira همیشه باید با استفاده از customfield_<id> مشخص شود؛ در اینجا ID همان شناسه فیلد سفارشی است که در Jira تعریف شده است. برای پیدا کردن ID فیلد سفارشی در Jira، آن فیلد را در بخش مدیریت Jira ویرایش کنید. این ID بخشی از آدرس وب یا URL صفحه ویرایش است. علاوه بر فعال کردن فیلد به روش بالا، همیشه باید یک تعریف فیلد متناظر شبیه این هم اضافه کنید:

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

typeهای فیلد زیر پشتیبانی می‌شوند. به mappingهای ممکن بین فیلدهای Jira و TestRail هم توجه کنید:

نوع فیلد	Typeها در Jira	توضیح
string	Text Field، Labels	یک فیلد کوچک برای متن آزاد، تا حداکثر ۲۵۰ کاراکتر
متن	فیلد متنی، فیلد متن آزاد	یک فیلد بزرگ برای متن آزاد، بدون محدودیت عملی از نظر اندازه
منوی کشویی	دکمه‌های رادیویی، انتخاب آبشاری، فهرست انتخاب	یک فهرست کشویی که به کاربران اجازه می‌دهد یکی از چند گزینه را انتخاب کنند
چندانتخابی	چندانتخابی، چند چک‌باکس	به کاربران اجازه می‌دهد چند گزینه از پیش تعریف‌شده را انتخاب کنند

Sub-taskها #

Jira REST Defect Plugin از sub-taskها هم پشتیبانی می‌کند. می‌توانید پشتیبانی از sub-taskها را با فیلد والد به شکل زیر فعال کنید:

[push.fields]
parent=on

با این کار یک فیلد جدید Parent در پنجره Push نمایش داده می‌شود تا برای issueهای جدید، ID مربوط به issue والد را وارد کنید. اگر از فیلد References هم برای لینک کردن test caseها به user storyها یا requirementهای ذخیره‌شده در Jira استفاده می‌کنید، می‌توانید گزینه زیر را فعال کنید تا فیلد Parent به‌طور خودکار با مقدار فیلد References پر شود:

[push.field.parent]
autofill=on

Issue linkها #

از TestRail ۴.۰ به بعد، Defect Plugin از issue linkها هم پشتیبانی می‌کند. از این قابلیت می‌توانید برای ایجاد issueهای جدیدی استفاده کنید که به issueهای موجود در Jira لینک می‌شوند. Issue linkها را می‌توان به شکل زیر فعال کرد:

[push.fields]
# ...
linktype=on
links=on

این کار دو فیلد جدید به پنجره Push اضافه می‌کند: Link Type و Issue Links. فیلد Link Type نوع لینکی را که می‌خواهید ایجاد کنید کنترل می‌کند؛ برای مثال «related to» یا «duplicate of». فیلد Issue Links به شما اجازه می‌دهد فهرستی از IDهای issue در Jira را که با کاما جدا شده‌اند وارد کنید تا با استفاده از link type پیکربندی‌شده، به issue جدید لینک شوند.

اگر از فیلد References هم برای لینک کردن test caseها به user storyها یا requirementهای ذخیره‌شده در Jira استفاده می‌کنید، می‌توانید گزینه زیر را فعال کنید تا فیلد Issue Links به‌طور خودکار با مقدار فیلد References پر شود:

[push.field.links]
autofill=on

توجه:  اگر هنگام ایجاد issueهای جدید Jira همراه با link خطایی مانند ۴۰۴ دریافت کردید، مطمئن شوید IDهای issue که در فیلد Issue Links وارد کرده‌اید در Jira وجود دارند.

پیوست‌ها #

Jira Defect Plugin از ارسال پیوست‌ها به Jira هم پشتیبانی می‌کند. این فیلد را می‌توان فعال یا غیرفعال کرد، اما قابل سفارشی‌سازی نیست. برای ارسال یک یا چند پیوست به Jira، کافی است پیوست را به بخش attachments یا description در پنجره Push بکشید، یا روی همان بخش کلیک کنید و پیوست را از 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 ندارد. همچنین می‌توانید فیلدهایی را که هنگام hover روی لینک نمایش داده می‌شوند سفارشی کنید و همان‌طور که بالاتر توضیح داده شد، custom field اضافه کنید.

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