ATAF Documentation

This handbook is the main entry point on GitHub Pages. It is versioned with the repository (main).

• GitHub Repository: https://github.com/it-at-m/agile-test-automation-framework/
• Latest releases: github.com/it-at-m/agile-test-automation-framework/releases (used in place of an in-repo changelog)
• Maven coordinates: de.muenchen.ataf:{core,rest,web} on Maven Central

Quick Links

• Project History — how ATAF started and where it's used today
• Releases — versioning and how artifacts are published
• Prerequisites
• Installation — add the Maven dependencies
• Build and Integration Tests — mvn clean package, JIRA-gated tests
• Writing Tests — Cucumber + TestNG/JUnit
• Runners and Running Tests
• Environments and Systems
• Property Files
• Runtime Credentials
• Reporting

About ATAF

The Agile Test Automation Framework (ATAF) is a robust, flexible Java 21 framework for automated testing. It simplifies BDD-style testing with Cucumber alongside traditional TestNG and JUnit test suites, and supports integration with Jira and Xray via their REST APIs.

ATAF is designed for agile projects: fast setup, maintainable test automation, and integration into modern development workflows. In addition to browser-based and API testing, it provides hooks for managing test executions in Jira/Xray.

What ATAF Provides

• Support for both BDD testing with Cucumber and traditional test cases with TestNG and JUnit.
• Seamless integration with popular testing libraries.
• Easy-to-configure runners for TestNG and JUnit.
• Integration with Jira and Xray using their existing REST APIs for test management.

Module Layout

ATAF is split into three artifacts under the de.muenchen.ataf Maven group:

• core — required. Cucumber and Jira integration, test data helpers, properties utilities.
• rest — optional. Classes for API testing.
• web — optional. Classes for browser-based tests.

See Installation for the exact Maven coordinates and snippets.

Built With

This project is built with technologies commonly used in modern Java-based test automation:

• Java 21
• Maven
• Cucumber
• TestNG
• JUnit 5
• Selenium
• Log4j 2
• Jira REST API
• Xray REST API

High-Level Flow

graph TD;
    A[Feature Files] --> B[Test Runner];
    A --> C[Step Definitions];
    B --> D[Test Execution];
    C --> D[Test Execution];
    D --> E[Reports];
    D --> F[Jira / Xray Update];

License

Distributed under the MIT License.

Contact

Overview

Munich contact: it@M – opensource@muenchen.de

ATAF was built primarily by colleagues from digital@M for use at it@M, the IT service provider of the Landeshauptstadt München. See Project History for the full story.