Skip to main content

​
Quickstart Guide

Get started with the Makers BTG Tests framework by running your first test. This guide will walk you through the process from prerequisites to viewing your first Serenity report.

​
Prerequisites

Before you begin, ensure you have:
1

Verify Java Installation

Check that Java 21 is installed on your system:
java -version
You should see output indicating Java 21 (or higher). If not, see the Installation Guide for setup instructions.
2

Clone the Repository

Clone the Makers BTG Tests repository:
git clone https://github.com/Petzega/mkrs-btg-tests.git
cd mkrs-btg-tests
3

Run Your First Test

Execute the test suite using Gradle:
./gradlew test
The Gradle Wrapper (./gradlew) automatically downloads the correct Gradle version and manages dependencies.
4

View Test Results

After the tests complete, generate the Serenity report:
./gradlew aggregate
Then open the report in your browser:
open target/site/serenity/index.html
Or navigate to target/site/serenity/index.html in your file browser.

​
Understanding Your First Test

The framework includes a sample test scenario for report generation from the Chronos web application:
GeneracionReporte.feature
#language:es
Característica: Generación de reportes desde la web de Chronos

  @test
  Esquema del escenario: [Happy Path] Generacion exitosa de reporte
    Dado el usuario ingresa a la web de Chronos
    Cuando ingrese los datos del reporte "<report>" para la compañia "<company>" segun la fecha "<report_date>"
    Entonces se genera el reporte "<report>" de manera exitosa
    Ejemplos:
      | report | company    | report_date |
      | 417    | compañia 1 | 2026-02-01  |
This test demonstrates:
  • Spanish Gherkin syntax (#language:es) for business-readable scenarios
  • Data-driven testing with Esquema del escenario (Scenario Outline)
  • Parameterized steps using the Examples table

​
Expected Output

When you run the tests, you’ll see console output like: 
Step: el usuario ingresa a la web de Chronos
Step: ingrese los datos del reporte 417 para la compañia compañia 1 segun la fecha 2026-02-01
Step: se genera el reporte 417 de manera exitosa

​
Explore the Serenity Report

The generated HTML report includes:
  • Test Results Dashboard - Overview of passed/failed tests
  • Requirements View - Features organized by business requirements
  • Test Execution Details - Step-by-step breakdown with screenshots
  • Execution Timeline - Visual timeline of test execution
The Serenity report automatically captures screenshots for failed steps, making debugging easier.

​
Running Tests with Tags

You can filter tests using tags. The example test uses the @test tag: 
./gradlew test -Dcucumber.filter.tags="@test"

​
Environment-Specific Testing

The framework supports multiple environments. To run tests against a specific environment: 
./gradlew test -Denvironment=qa
Available environments (configured in serenity.conf):
  • QA: https://qa.btgpactual.com
  • Staging: https://stg.btgpactual.com

​
Next Steps

Now that you’ve run your first test, explore:

Installation Guide

Detailed setup instructions for Java, Gradle, and IDE configuration

Writing Tests

Learn how to create new test scenarios and step definitions

Screenplay Pattern

Understand the Screenplay pattern for maintainable test code

Configuration

Configure environments, browsers, and reporting options

Build docs developers (and LLMs) love

Get started for freeTalk to us