آشنایی با Allure ابزار گزارش گیری گزارش سازی تست اتوماتیک

گزارش تست Allure یک ابزار گزارش‌دهی تست است که می‌تواند با فریم‌ورک‌های مختلف تست یکپارچه شود و گزارش‌های زیبا و مفصل از نتایج تست‌ها تولید کند. این ابزار به‌طور گسترده با فریم‌ورک‌های مختلفی مانند JUnit، TestNG، Cucumber و JUnit5 استفاده می‌شود و می‌توان آن را با ابزارهایی مانند Cypress، Selenium، Appium و دیگر ابزارها یکپارچه کرد.

مراحل ادغام Allure با فریم‌ورک‌های تست

1. نصب Allure Commandline

برای تولید گزارش‌های Allure، ابتدا باید ابزار خط فرمان Allure را نصب کنید. شما می‌توانید آن را با استفاده از Homebrew، Scoop یا npm نصب کنید.

برای Homebrew (در macOS):

brew install allure

برای npm (از طریق Node.js):

npm install -g allure-commandline --save-dev

2. ادغام Allure با فریم‌ورک تست شما

برای ادغام Allure با پروژه‌های تست خود، باید وابستگی‌های Allure را به پروژه خود اضافه کنید. در اینجا چند نمونه از این کار در فریم‌ورک‌های مختلف آورده شده است.

مثال: Cypress + Allure

گام 1: نصب وابستگی‌ها

برای ادغام Allure با Cypress، باید پلاگین cypress-allure-plugin را نصب کنید.

برای نصب Allure و پلاگین آن از طریق npm، دستور زیر را وارد کنید:

npm install --save-dev @shelex/cypress-allure-plugin allure-commandline

گام 2: به‌روزرسانی cypress.json

در فایل cypress.json خود تنظیمات زیر را اضافه کنید تا پلاگین Allure فعال شود:

{
  &quotreporter&quot: &quotmocha-allure-reporter&quot,
  &quotreporterOptions&quot: {
    &quotallureResultsPath&quot: &quotallure-results&quot
  }
}

گام 3: افزودن پلاگین Allure به commands.js

در فایل commands.js (معمولاً در پوشه support) پلاگین Allure را ثبت کنید:

import '@shelex/cypress-allure-plugin';

گام 4: اجرای تست‌های Cypress

حالا می‌توانید تست‌های خود را به‌طور معمول اجرا کنید:

npx cypress run

نتایج در پوشه allure-results ذخیره خواهد شد.

گام 5: تولید گزارش Allure

پس از اجرای تست‌ها، برای تولید گزارش Allure دستور زیر را وارد کنید:

allure serve allure-results

این دستور گزارش Allure را تولید کرده و آن را در مرورگر شما باز می‌کند.

مثال: JUnit + Allure

گام 1: افزودن وابستگی‌های Allure

برای Maven، وابستگی‌های زیر را به فایل pom.xml خود اضافه کنید:

<dependencies>
    <dependency>
        <groupId>io.qameta.allure</groupId>
        <artifactId>allure-java-commons</artifactId>
        <version>2.14.0</version>
    </dependency>
    <dependency>
        <groupId>io.qameta.allure</groupId>
        <artifactId>allure-junit4</artifactId>
        <version>2.14.0</version>
    </dependency>
</dependencies>

برای Gradle، این کد را به فایل build.gradle خود اضافه کنید:

dependencies {
    testImplementation 'io.qameta.allure:allure-java-commons:2.14.0'
    testImplementation 'io.qameta.allure:allure-junit4:2.14.0'
}

گام 2: اجرای تست‌های JUnit

تست‌های JUnit خود را با دستور زیر اجرا کنید:

mvn clean test

یا اگر از Gradle استفاده می‌کنید:

gradle test

گام 3: تولید گزارش Allure

پس از اجرای تست‌ها، گزارش Allure را با دستور زیر تولید کنید:

allure serve allure-results

مثال: Selenium + Allure

گام 1: افزودن وابستگی‌های Allure

برای Maven، این وابستگی‌ها را به pom.xml خود اضافه کنید:

<dependencies>
    <dependency>
        <groupId>io.qameta.allure</groupId>
        <artifactId>allure-java-commons</artifactId>
        <version>2.14.0</version>
    </dependency>
    <dependency>
        <groupId>io.qameta.allure</groupId>
        <artifactId>allure-java-selenium</artifactId>
        <version>2.14.0</version>
    </dependency>
</dependencies>

گام 2: افزودن آناسیون‌های Allure به کلاس‌های تست

در تست‌های Selenium خود می‌توانید آناسیون‌های Allure را به این صورت اضافه کنید:

import io.qameta.allure.Step;

public class SeleniumTest {
    @Test
    @Step(&quotPerforming a login test&quot)
    public void loginTest() {
        // مراحل تست شما اینجا می‌آید
    }
}

گام 3: اجرای تست‌ها

تست‌ها را با دستور زیر اجرا کنید:

mvn clean test

گام 4: تولید گزارش Allure

بعد از اجرای تست‌ها، گزارش Allure را تولید کنید:

allure serve allure-results

ویژگی‌های گزارش Allure

1. تاریخچه تست‌ها: گزارش‌های Allure تاریخچه اجرای تست‌ها را با جزئیات نشان می‌دهند و اطلاعات کاملی درباره تست‌های موفق، شکست خورده و رد شده ارائه می‌کنند.
2. مراحل تست: گزارش‌ها مراحل تست را نشان می‌دهند و به راحتی می‌توان فهمید که شکست در کدام مرحله رخ داده است.
3. ضمیمه‌ها: شما می‌توانید تصاویر، لاگ‌ها یا فایل‌های دیگر را به نتایج تست خود اضافه کنید.
4. دسته‌بندی‌های سفارشی: امکان دسته‌بندی تست‌ها به گروه‌هایی مانند "Regression" و "Smoke" وجود دارد.
5. گراف‌ها و نمودارها: گزارش Allure شامل نمودارها و گراف‌های مفصل است که اطلاعات آماری و وضعیت تست‌ها را نمایش می‌دهد.

پیکربندی گزارش Allure

شما می‌توانید از فایل‌های پیکربندی Allure برای سفارشی‌سازی بیشتر گزارش‌ها استفاده کنید. این شامل تنظیم متغیرهای محیطی، اضافه کردن برچسب‌ها و موارد دیگر می‌شود.

• allure.properties: تنظیم ویژگی‌های سفارشی مانند نام محیط.
• محیط: می‌توانید اطلاعات محیطی (مانند مرورگر، سیستم‌عامل) را به گزارش‌ها اضافه کنید.

نمونه‌ای از پیکربندی:

allure.results.directory=allure-results
allure.report.directory=allure-report

نتیجه‌گیری

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