معرفی اسکریپت های رابط کاربری

TestRail امکان شخصی سازی رابط کاربری را از طریق به اصطلاح UI Scripts فراهم می کند. UI Scripts ابزاری بسیار منعطف برای مدیران است تا با نوشتن کد استاندارد جاوا اسکریپت و با تعریف شیوه نامه های ساده، بخش هایی از طراحی و رفتار TestRail را سفارشی کنند.

اسکریپت‌های رابط کاربری را می‌توان روی صفحات تک، چندین صفحه یا حتی کل برنامه اعمال کرد. برای نوشتن اسکریپت های رابط کاربری نیازی به محیط توسعه یا چارچوب خاصی ندارید، زیرا می توانید به سادگی اسکریپت ها را مستقیماً در TestRail تعریف و آزمایش کنید. دانش اولیه HTML، CSS و جاوا اسکریپت برای نوشتن اسکریپت های UI مورد نیاز است، اما یادگیری این موضوع در حین نوشتن اولین اسکریپت های ساده امکان پذیر است.

نوشتن اسکریپت های رابط کاربری #

اسکریپت های UI را می توان در TestRail در زیر تعریف کرد مدیر > سفارشی سازی ها. برای شروع نوشتن اولین اسکریپت UI خود، روی آن کلیک کنید اسکریپت UI را اضافه کنید و ویرایشگر یک مثال اساسی را نشان خواهد داد.

در بخش‌های بعدی به سه قسمتی که یک اسکریپت کامل UI را تشکیل می‌دهند نگاهی خواهیم انداخت، و همچنین می‌توانید به ما نگاهی بیندازید. نمونه‌هایی از اسکریپت‌های رابط کاربری برای شروع

اطلاعات متا #

از آنجایی که UI Script ها بلوک های متنی ساده هستند، می توانید مستقیماً تمام اطلاعات متا مانند نام، نویسنده یا نسخه را به عنوان بخشی از اسکریپت تعریف کنید. این به شما این امکان را می دهد که به راحتی با کپی کردن، اسکریپت های UI را بین نصب های TestRail به اشتراک بگذارید & چسباندن اسکریپت

اولین بلوک یک اسکریپت UI حاوی برخی اطلاعات متا است که عملکرد آن را توصیف می کند و همچنین محدوده آن را تعریف می کند (یعنی صفحاتی که اسکریپت روی آنها اعمال می شود).

name: Hello world
description: Shows a 'Hello, world!' message on the dashboard
author: Gurock Software
version: 1.0
includes: ^dashboard
excludes:

را نام ویژگی به عنوان نام نمایشی اسکریپت در لیست اسکریپت های UI TestRail استفاده می شود، در حالی که توضیحات، نویسنده و نسخه صرفاً برای اهداف اطلاعاتی برای توسعه دهنده در نظر گرفته شده است.

را را شامل می شود و مستثنی می کند ویژگی‌ها مشخص می‌کنند که اسکریپت UI در TestRail روی چه صفحاتی اعمال می‌شود. بنابراین می‌توانید دامنه سفارشی‌سازی را با این ویژگی‌ها محدود کنید و یک UI Script را فقط در صفحات خاص اجرا کنید.

اگر یک اسکریپت UI فقط باید در صفحات خاصی از برنامه اجرا شود، به شدت توصیه می شود که محدوده اسکریپت را از طریق را شامل می شود و مستثنی می کند ویژگی ها به دلایل عملکرد به عنوان مثال، را شامل می شود ویژگی در مثال بالا اسکریپت UI را فقط در داشبورد اعمال می کند. را را شامل می شود و مستثنی می کند ویژگی ها به عنوان عبارات منظم تفسیر می شوند و با آرگومان صفحات TestRail (رشته پرس و جو بعد از index.php؟ بخشی از URL).

در مورد نحوه اعمال فیلترها چند قانون وجود دارد:

• فیلتر حذف همیشه بر فیلتر شامل اولویت دارد.
• رشته های خالی برای هر دو ویژگی شامل و استثنا (یا حذف هر دو ویژگی) به این معنی است که اسکریپت UI برای همه صفحات اعمال خواهد شد.

یک استثنا برای این قوانین وجود دارد: اسکریپت های UI هرگز در خود فرم UI Script اجرا نمی شوند تا مطمئن شوید که می توانید اسکریپت های شکسته را در صورت نیاز غیرفعال کنید.

برگه های سبک #

می‌توانید شیت‌های سبک را با اسکریپت‌های UI از طریق css ویژگی نادیده گرفتن شیوه نامه های داخلی TestRail ساده ترین راه برای سفارشی کردن رابط کاربری TestRail است. به عنوان مثال، می‌توانید رنگ عناصر را تغییر دهید، ظاهر و احساس برخی از جنبه‌های رابط کاربری TestRail را تغییر دهید، یا حتی در صورت نیاز، بخش‌هایی از عملکرد TestRail را کاملاً مخفی کنید. ویژگی css را در یک UI Script به صورت زیر تعریف می کنید:

css:
div.some-class {
  color: red;
}

TestRail مستقیماً شیوه نامه را به تمام صفحاتی که توسط محدوده تعریف شده است اعمال می کند. بنابراین می توانید از مجموعه کامل ویژگی های CSS موجود برای سفارشی سازی TestRail استفاده کنید.

جاوا اسکریپت #

برای سفارشی‌سازی‌های پیچیده‌تر، معمولاً از جاوا اسکریپت علاوه بر یا به جای برگه‌های سبک استفاده می‌کنید. برای تعریف کد جاوا اسکریپت در UI Script خود می توانید به سادگی از آن استفاده کنید js ویژگی به شرح زیر است:

js:
$(document).ready(
  function() {
    alert('Hello, world!');
  }
);

TestRail با کتابخانه محبوب jQuery JavaScript ارائه می شود و می توانید از مجموعه کامل ویژگی های jQuery استفاده کنید. به عنوان مثال، استفاده از jQuery به طور کلی ایده خوبی است $(document).ready() رویداد صبر کنید تا صفحه فعلی به طور کامل بارگیری شود (همانطور که در مثال بالا مشاهده می کنید).

اطلاعات زمینه #

TestRail برخی از اطلاعات زمینه اضافی را ارائه می دهد که می توانید از کد جاوا اسکریپت خود استفاده کنید، مانند جزئیات مربوط به کاربر یا پروژه فعلی. می‌توانید از این اطلاعات زمینه برای محدود کردن اجرای اسکریپت‌های خود به نقش‌ها یا پروژه‌های کاربر خاص استفاده کنید یا از این داده‌ها برای ادغام با ابزارهای خارجی استفاده کنید. ویژگی های زمینه زیر تعریف می شوند:

uiscripts.context.user

• شناسه
• نام
• ایمیل
• is_admin
• role_id

uiscripts.context.project

• شناسه
• نام

به صورت زیر می توانید به اطلاعات زمینه از اسکریپت های خود دسترسی پیدا کنید:

js:
  alert('Welcome ' + uiscripts.context.user.name);

شروع با TestRail ۳.۰، uiscripts.context حاوی جزئیات بیشتری در مورد زمینه صفحه فعلی است و می تواند شامل موارد زیر باشد:

• uiscripts.context.case
• uiscripts.context.milestone
• uiscripts.context.plan
• uiscripts.context.run
• uiscripts.context.suite
• uiscripts.context.test

همچنین در TestRail ۳.۰ جدید است uiscripts.env که حاوی جزئیاتی در مورد محیطی است که TestRail در آن اجرا می شود. ویژگی های زیر برای آن موجود است uiscripts.env:

نام	توضیحات
is_hosted	درست هنگام اجرا در TestRail Hosted و نادرست برای نصب در محل
page_base	آدرس پایه نقطه پایانی index.php TestRail، به عنوان مثال. “index.php؟”. این اجازه می دهد تا به صورت پویا لینک برای صفحات در TestRail ایجاد کنید.
منبع_پایه	آدرس پایه به منابع استاتیک مرجع در TestRail (تصاویر، فایل‌های JS، و غیره)، به عنوان مثال. «https://static.testrail.com/<نسخه>/”.

ملاحظات عملکرد #

همانطور که اسکریپت های UI قدرتمند و انعطاف پذیر هستند، درک مفاهیم عملکرد اسکریپت ها و سفارشی سازی های خود بسیار مهم است. استفاده از انتخابگرهای عمومی جاوا اسکریپت (مثلاً اعمال کد برای همه div ها در صفحه) می تواند اجرای جاوا اسکریپت را به شدت کند کند و زمان بارگذاری صفحات را افزایش دهد.

به عنوان یک قانون کلی، باید اجرای UI Script ها را به صفحاتی که واقعاً می خواهید سفارشی کنید محدود کنید و انتخابگرها را برای کد جاوا اسکریپت خود تا حد امکان دقیق تعریف کنید. بحث درباره نکات کلی عملکرد جاوا اسکریپت خارج از محدوده این مقاله است، اما نکات خوبی وجود دارد منابعی در مورد عملکرد جاوا اسکریپت و جی کوئری بیرون وجود دارد.