وب هوک ها

با Webhooks، می‌توانید بر اساس رویدادهایی که در TestRail اتفاق می‌افتد، اطلاعات بی‌درنگ به سایر برنامه‌ها ارائه دهید.

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

چگونه یک وب هوک اضافه کنیم #

دو روش مختلف برای افزودن یک هوک وجود دارد: به صورت جهانی (که برای هر پروژه ای در نمونه TestRail شما فعال می شود)، یا برای پروژه های خاص.

برای راه‌اندازی یک هوک در تمام پروژه‌های خود، به مدیر > یکپارچه سازی.

را انتخاب کنید وب هوک ها برگه این جایی است که می توانید وب هوک ها را اضافه کنید یا موارد موجود را ویرایش کنید.

کلیک کنید اضافه کردن Webhook برای راه اندازی یک مورد جدید پنجره زیر را مشاهده خواهید کرد که به شما امکان می دهد یک نام اضافه کنید، URL بارگیری، روش، نوع محتوا و اطلاعات کلیدی مانند هدر و بار را مشخص کنید.

• به وب هوک خود یک نام توصیفی بدهید.
• a اضافه کنید آدرس پیلود: این URL جایی است که محتوای وب هوک هنگام راه اندازی به آن ارسال می شود.
• روش: بین POST، GET، PUT، PATCH یا DELETE انتخاب کنید.
• a را انتخاب کنید نوع محتوا. گزینه های موجود عبارتند از:
  • application/json
  • application/x-www-form-urlencoded
  • برنامه/xml
  • متن/xml
  • متن/ساده
• هر اضافی اضافه کنید سرصفحه ها ممکن است برای وب هوک خود نیاز داشته باشید. همه وب هوک ها در TestRail دارای سرصفحه های پیش فرض هستند که به رنگ خاکستری هستند، اما می توانید سرصفحه های سفارشی را نیز اضافه کنید که به رنگ سیاه ظاهر می شوند.
• a اضافه کنید بار به وب هوک شما فیلد Payload به گونه ای طراحی شده است که انعطاف پذیر باشد تا بتوانید تقریباً هر نوع محموله ای را که می خواهید با استفاده از کنسول بسازید یا ارسال کنید. (برای اطلاعات بیشتر به پیلودهای زیر مراجعه کنید.)

• همچنین می توانید a را تنظیم کنید راز در صورت نیاز به وب هوک خود برای اهداف احراز هویت. این در هدرهای وب هوک گنجانده خواهد شد.
• زیر رویدادها، با علامت زدن کادرهای سمت چپ هر گزینه، رویدادهایی را که می خواهید وب هوک ها را راه اندازی کنند، انتخاب کنید
  • شما می توانید چندین رویداد را برای راه اندازی یک وب هوک انتخاب کنید
• زیر پروژه ها، کادرهای مربوط به هر پروژه را علامت بزنید که می خواهید رویدادهای انتخابی شما این وب هوک را فعال کنند.

• در نهایت، می توانید با علامت زدن (یا برداشتن علامت) وب هوک را فعال یا غیرفعال کنید فعال جعبه
• کلیک کنید تنظیمات را ذخیره کنید هنگامی که شما آماده هستید

پس از پیکربندی وب هوک، می توانید تنظیمات وب هوک را با استفاده از دکمه تست در سمت راست بالای صفحه آزمایش کنید. اضافه کردن Webhook گفتگو در اینجا درباره آزمایش پیکربندی webhooks خود بیشتر بیاموزید.

اضافه کردن وب هوک به پروژه های خاص #

همچنین می‌توانید از طریق ویرایش پروژه صفحه برو به مدیر، کلیک کنید پروژه ها از منوی موجود در نوار کناری سمت راست، و سپس روی آن کلیک کنید نماد مداد برای رفتن به ویرایش پروژه صفحه یا، اگر قبلاً در آن هستید بررسی اجمالی پروژه صفحه برای یک پروژه خاص، کلیک کنید ویرایش کنید در گوشه سمت راست بالا در ویرایش پروژه ها صفحه، کلیک کنید وب هوک ها برای افزودن یا ویرایش یک هوک خاص به آن پروژه.

 

تست و ممیزی وب هوک ها #

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

برای آزمایش وبی هوکی که قبلاً ایجاد کرده‌اید یا فعالیت تاریخی را مرور کنید، به آن بازگردید یکپارچه سازی زیر مدیر، و بازگشت به وب هوک ها برگه قسمت Testing را در سمت راست صفحه پیدا کنید. 

در اینجا، می توانید گزارشی از تحویل های اخیر و تاریخ ها را مشاهده کنید. بر روی یک تحویل اخیر کلیک کنید تا اطلاعاتی را که در سرصفحه‌ها گنجانده شده است و حجم بار وب هوک خود را بر اساس رویداد خاصی که باعث آن تحویل شده است، مرور کنید. درخواست کنید برگه

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

رویدادهای وب هوک #

هنگامی که یک وب هوک را در TestRail راه‌اندازی می‌کنید، می‌توانید رویدادهای خاصی را انتخاب کنید که آن را راه‌اندازی کند. در اینجا لیستی از رویدادهایی وجود دارد که می توانید در این زمان برای راه اندازی وب هوک ها انتخاب کنید.

رویداد	توضیحات
طرح ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که یک طرح آزمایشی جدید در پروژه/های انتخاب شده ایجاد می شود، وب هوک فعال می شود.
طرح به روز شد	اگر این رویداد را بررسی کنید، هر بار که به‌روزرسانی طرح آزمایشی در پروژه یا پروژه‌های انتخابی به‌روزرسانی می‌شود، وب هوک فعال می‌شود.
ورود طرح ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که یک ورودی Test Plan در پروژه/های انتخاب شده ایجاد می شود، وب هوک فعال می شود.
برنامه ورود به روز شد	اگر این رویداد را بررسی کنید، هر بار که ورودی طرح آزمایشی در پروژه/های انتخابی به‌روزرسانی می‌شود، وب هوک فعال می‌شود.
اجرا ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که اجرای تست در پروژه/های انتخابی ایجاد می‌شود، وب هوک فعال می‌شود.
اجرا به روز شد	اگر این رویداد را بررسی کنید، هر بار که اجرای تست در پروژه/های انتخابی به‌روزرسانی می‌شود، وب هوک فعال می‌شود.
مورد ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که یک Test Case در پروژه/های انتخابی ایجاد می شود، وب هوک فعال می شود.
مورد به روز شد	اگر این رویداد را بررسی کنید، هر بار که یک Test Case در پروژه/های انتخابی به‌روزرسانی می‌شود، وب هوک فعال می‌شود.
نتیجه آزمایش ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که یک نتیجه آزمایشی در پروژه/های انتخابی ایجاد می‌شود، وب هوک فعال می‌شود.
گزارش ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که گزارشی در پروژه/های انتخابی ایجاد می شود، وب هوک فعال می شود.
گزارش بین پروژه ای ایجاد شد	اگر این رویداد را بررسی کنید، هر بار که یک گزارش بین پروژه‌ای در پروژه/های انتخابی ایجاد می‌شود، وب هوک فعال می‌شود – در دسترس برای طرح های مجوز سازمانی فقط
همه	اگر این کادر را علامت بزنید، هر بار که هر یک از سناریوهای قبلی اتفاق می افتد، وب هوک فعال می شود.

می توانید تعدادی از متغیرها را به پیلود خود اضافه کنید تا زمینه و داده های بیشتری به وب هوک خود اضافه کنید. لیست کامل را در زیر مشاهده کنید.

محموله ها #

فیلد محموله موجود در کنسول webhook به شما امکان می دهد تقریباً هر نوع باری را که می خواهید بسازید و ارسال کنید. این نمونه‌ای از ساختار محموله JSON برای دانستن نوع کارهایی است که می‌توان برای Slack انجام داد.

{
  "text": "%event_creator% created a new test case:",
  "blocks": [
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "*%event_creator% created a new test case:*"
      }
    },
    {
      "type": "divider"
    },
    {
      "type": "section",
      "text": {
        "type": "mrkdwn",
        "text": "*<%url%|%name%>* \n Priority: %case_priority% \n Type: %case_type%"
      }
    }
  ]
}

هنگامی که وب هوک اجرا می شود، نتیجه پیامی مشابه این پیام در حالت slack است.

متغیرهای بار #

متغیرهای مختلفی برای تکمیل بار در دسترس هستند. متغیرهای موجود برای استفاده در بارهای وب هوک در این زمان عبارتند از:

متغیر	تایپ کنید	توضیحات
%assigned_to%	متن	برای نام کاربری که نهاد به آن اختصاص داده شده است استفاده می شود.
%case_priority%	متن	برای وضعیت فیلد اولویت تست‌کیس در هنگام راه‌اندازی یک بار وب هوک مربوط به یک رویداد آزمایشی استفاده می‌شود (مثلاً «بالا»، «متوسط» «کم»).
%case_type%	متن	اگر مشخص شده باشد، برای نوع تست‌کیس که بار رویداد برای آن راه‌اندازی شده است استفاده می‌شود (مانند «عملکردی»، «دود»، «رگرسیون» و غیره).
%completed_on%	مهر زمانی	برای مهر زمانی نقطه عطف/طرح/اجرا (که به عنوان “بسته” مشخص شده است) استفاده می شود.
%config%	متن	برای نام پیکربندی موجودیت استفاده می شود. (فقط ورودی های طرح آزمایشی).
%custom_x%	شی / آرایه	برای برگرداندن تمام فیلدهای تست‌کیس سفارشی، زمانی که یک رویداد تست‌کیس راه اندازی می شود، با فیلد با “custom_” شروع می شود (یعنی جایگزین “x” با نام های فیلد سفارشی) استفاده می شود. (به عنوان مثال، اگر یک فیلد سفارشی به نام “شماره نسخه” ایجاد کرده اید، متغیر باید %custom_version_number٪ باشد.
%شرح%	متن	برای توصیف موجودیتی که یک رویداد برای آن بارگذاری وب هوک را راه‌اندازی می‌کند (مانند شرح نقطه عطف یا شرح اجرای تست) استفاده می‌شود.
%due_on%	مهر زمانی	برای تاریخی که انتظار می رود یک نقطه عطف تکمیل شود استفاده می شود. (فقط نقاط عطف).
%entity_created%	مهر زمانی	برای زمانی استفاده می شود که موجودیت (که رویداد برای آن راه اندازی شده است) ایجاد شده است.
%entity_creator%	متن	برای نام کاربری که موجودیت را ایجاد کرده و رویداد برای آن راه‌اندازی شده است (مثلاً نام کاربری که تست‌کیس را در ابتدا ایجاد کرده است) استفاده می‌شود.
% برآورد %	عدد صحیح	برای میدان تخمین یک تست‌کیس هنگام راه‌اندازی یک بار وب هوک مربوط به یک رویداد تست‌کیس استفاده می‌شود.
%event_created%	مهر زمانی	برای تعیین زمانی که رویداد webhook رخ می دهد استفاده می شود.
%event_creator%	متن	برای نام کاربری که رویداد webhook را ایجاد کرده و راه‌اندازی کرده است استفاده می‌شود.
% event_type%	متن	برای نوع رویدادی که بارگذاری وب هوک را فعال کرده است (مانند «طرح ایجاد شد»، «مورد به‌روزرسانی شد»، «گزارش ایجاد شد» و غیره استفاده می‌شود.
%id%	عدد صحیح	برای شناسه نهادی استفاده می‌شود که رویدادی برای آن بارگذاری وب هوک را راه‌اندازی می‌کند (مثلاً «۱۱۷» در برچسب شناسه موردی «C117» یا «۴۲» در برچسب ID اجرا شده «R42»).
%is_deleted%	بولی	برای نشان دادن اینکه آیا مورد، اجرا، برنامه یا نقطه عطف به عنوان حذف شده علامت گذاری شده است یا خیر استفاده می شود.
%milestone_id%	عدد صحیح	اگر با هر نقطه عطفی مرتبط باشد، برای شناسه منحصربه‌فرد نقطه عطفی که نهاد با آن مرتبط است، استفاده می‌شود.
%more_info%	متن	برای نقطه پایانی API استفاده می‌شود که می‌توان آن را برای یافتن اطلاعات بیشتر در مورد نهادی که رویداد برای آن راه‌اندازی شده است فراخوانی کرد (مثلاً “/api/v2/get_runs/۳”).
%name%	متن	برای نام (یا عنوان) نهادی که یک رویداد برای آن یک بار وب هوک را راه‌اندازی می‌کند، استفاده می‌شود.
%project_id%	عدد صحیح	برای پروژه TestRail که موجودیت به آن مرتبط است استفاده می شود.
%project_ids%	لیست اعداد صحیح	در صورتی که “Cross-Project Report ایجاد شده” انتخاب شده باشد، اینها هستند پروژه های انتخاب شده در گزارش – در دسترس برای طرح های مجوز سازمانی فقط
%refs%	متن	برای هر گونه اطلاعات ذخیره شده در قسمت «مرجع» موجودیت وب هوک (مانند «TR-۷۱، TR-۷۲») استفاده می شود.
%section_id%	عدد صحیح	برای شناسایی بخش مرتبط با یک تست‌کیس استفاده می شود.
%stats%	شی / آرایه	برای مجموعه کاملی از معیارهای نتایج تست مربوط به یک طرح، اجرا یا نقطه عطف (تعداد_گذرشده، تعداد_مسدود، تعداد_تست_نشده، شمارش مجدد، شمارش_ناموفق، شمارش_سفارشی_وضعیت) استفاده می‌شود.
%suite_id%	عدد صحیح	برای شناسایی مجموعه آزمایشی مربوط به اشتراک موجودیت وب هوک استفاده می شود.
%template_name%	متن	برای الگوی تست‌کیس استفاده می‌شود که هنگام راه‌اندازی بارگذاری وب هوک مربوط به یک رویداد آزمایشی استفاده می‌شود (مانند «مراحل آزمایشی»، «جلسه اکتشافی»).
%url%	متن	برای نشانی اینترنتی نمونه استفاده می‌شود که از طریق آن می‌توان موجودیت را در TestRail مشاهده کرد (به‌عنوان مثال: «https://allboard.testrail.com/index.php?/milestones/view/۶۱″).
% مخفی %	متن	در صورت وجود، برای توکن وارد شده در قسمت Secret webhook استفاده می شود.

می‌توانید متغیرها را به فیلد بار اضافه کنید و زمانی که webhook مانند تصویر زیر فعال شد، با داده‌های TestRail مربوطه پر می‌شوند.

نصب در محل (سرور TestRail) #

نصب نسخه سرور TestRail TestRail ۷.۵ شامل برخی مراحل اضافی و اختیاری است که مستقیماً با ویژگی های جدید webhooks مرتبط است. در طول فرآیند نصب یا ارتقا، یک مرحله اضافی به شما ارائه می شود که طی آن می توانید سرور صف پیام RabbitMQ را برای مدیریت بارهای وب هوک خروجی خود پیکربندی کنید.

اگر تصمیم دارید برای این منظور از صف پیام استفاده کنید، در طول نصب یا ارتقاء سرور TestRail، باید موارد زیر را اضافه کنید:

• نام سرور RabbitMQ
• شماره پورت RabbitMQ (به طور پیش فرض ۵۶۷۲)
• نام کاربری و رمز عبور RabbitMQ
• و به صورت اختیاری گواهی RabbitMQ و کلید خصوصی

تنظیمات صف پیام را نیز می توان در آن یافت و اضافه یا به روز کرد مدیر > تنظیمات سایت کنسول