شروع کار با TestRail CLI

را TestRail CLI یک ابزار خط فرمان منبع باز است که آپلود نتایج اتوماسیون آزمایشی را در پروژه های TestRail شما آسان می کند – بدون نوشتن کد یا سروکار داشتن با API.

از آن برای خودکارسازی گردش کار گزارش خود با آپلود نتایج از چارچوب های محبوبی مانند JUnit، TestNG، NUnit، سرو، نمایشنامه نویس، و بیشتر.

اکنون می توانید ادغام کنید نتایج تست عملکرد – از جمله کسانی که از جی متر – استفاده از همان گردش کار مبتنی بر CLI. این برای تست بار، بررسی تاخیر، یا تست استرس به عنوان بخشی از خط لوله CI/CD شما ایده آل است.

CLI از هر دو پشتیبانی می کند کد-اول و مشخصات – اول رویکردهای تست:

• در یک کد-اول راه اندازی، تست ها را در کد تعریف و اجرا می کنید و سپس نتایج را با TestRail همگام می کنید.
• در یک مشخصات – اول با راه اندازی، تست‌کیس‌ها را قبل از اجرا در TestRail ترسیم می کنید و نتایج را به شناسه های آزمایشی موجود پیوند می دهید.

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

چرا از TestRail CLI استفاده کنیم؟ #

گزارش اتوماسیون تست خود را ساده کنید:

• از منحنی یادگیری API بگذرید – فقط به گزارش تست XML خود اشاره کرده و آپلود کنید.
• زبان شناسی – با هر چارچوبی که XML به سبک JUnit را خروجی می کند کار می کند.
• سازگار با CI/CD – به راحتی برای استفاده در خطوط لوله قابل نوشتن است.
• منبع باز – میزبانی شده در GitHub؛ مشارکت یا سفارشی کردن

چارچوب های پشتیبانی شده #

می‌توانید از CLI تقریباً با هر چارچوب اتوماسیون آزمایشی که می‌تواند صادر کند، استفاده کنید سبک JUnit گزارش ها از جمله:

• Cypress.io
• نمایشنامه نویس
• JUnit
• TestNG
• NUnit
• Pytest
• چارچوب ربات
• جی متر

✅ اگر چارچوب شما از خروجی XML به سبک JUnit پشتیبانی می کند، با TestRail CLI کار می کند.

با تجزیه و آپلود نتایج آزمون سبک JUnit در TestRail مستقیماً از خط فرمان یا با اجرای CLI به عنوان بخشی از خط لوله ساخت خودکار در جنکینز، GitLab CI، GitHub Actions یا سایر ابزارهای CI، می‌توانید به جای نگرانی در مورد تماس‌های API و سایر جزئیات فنی مرتبط با بارگذاری نتایج تست، بر نوشتن کد تست تمرکز کنید.

برای نمونه پروژه های اتوماسیون تست با چارچوب های مختلف، می توانید ما را نیز ببینید پروژه یکپارچه سازی چارچوب های اتوماسیون در GitHub.

مثال: بارگذاری نتایج تست در TestRail #

در اینجا یک گردش کار ساده برای آپلود نتایج از آزمون Playwright یا JUnit در TestRail وجود دارد.

trcli --url <TESTRAIL_URL> \
      --project <PROJECT_NAME> \
      --suite <SUITE_NAME> \
      --milestone <MILESTONE_NAME> \
      --run-name "Automated Test Run - $(date +%Y-%m-%d)" \
      --results <PATH_TO_XML_REPORT>

<TESTRAIL_URL> – URL نمونه TestRail شما

<PROJECT_NAME> – نام پروژه شما در TestRail

<SUITE_NAME> – مجموعه آزمایشی برای آپلود نتایج

<MILESTONE_NAME> – نقطه عطف اختیاری در TestRail

<PATH_TO_XML_REPORT> – مسیر فایل نتایج XML به سبک JUnit شما

پیش نیازها #

TestRail CLI در هنگام آپلود نتایج آزمون شما به زبان برنامه نویسی آگنوستیک است، اما خود این ابزار در پایتون توسعه یافته است و می تواند از فهرست عمومی بسته Python (PyPI) نصب شود. 

قبل از نصب CLI، مطمئن شوید:

• پایتون ۳.۱۰.۴ یا بالاتر بر روی دستگاه شما نصب شده است.
• پیپ (مدیر بسته پایتون) از ترمینال شما در دسترس است.
• شما یک حساب TestRail با دسترسی مدیر یا API.

TestRail API را فعال کنید #

• برو به اداره > تنظیمات سایت > API
• بررسی کنید فعال کردن API

پایتون ۳.۱۰+ را نصب کنید #

پایتون ۳.۱۰.۴ را از python.org

در حین نصب، اطمینان حاصل کنید pip گنجانده شده است

python --version
pip --version

اگر این دستورات شماره نسخه را نشان می دهد، می توانید TestRail CLI را نصب کنید. در غیر این صورت، دستورالعمل‌های راه‌اندازی زیر را دنبال کنید: 

در ویندوز #

1. پایتون را از وب سایت رسمی.
2. در حین نصب:
   • “افزودن پایتون به مسیر” را علامت بزنید.
   • مطمئن شوید که پیپ انتخاب شده است.
3. ترمینال خود را مجددا راه اندازی کنید و اجرا کنید:

python --version
pip --version

در macOS #

۱- Homebrew را نصب کنید (اگر قبلاً نصب نشده باشد):

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

۲- برای نصب پایتون از Homebrew استفاده کنید:

brew install python@3.10

۳- تایید نصب:

python3 --version
pip3 --version

sudo apt update
sudo apt install python3.10 python3-pip

python3 --version
pip3 --version

$ pip install trcli

trcli

TestRail CLI v1.1X.X
Copyright 2025 Gurock Software GmbH - www.gurock.com
Supported and loaded modules:
    - parse_junit: JUnit XML Files (& Similar)
    - parse_robot: Robot Framework XML Files
    - parse_openapi: OpenAPI YML Files
    - add_run: Create a new test run