Skip to content

Latest commit

 

History

History
213 lines (152 loc) · 9.69 KB

README.md

File metadata and controls

213 lines (152 loc) · 9.69 KB
Raw

Testerra

Maven Central

Setup • Documentation • Extras • Support • Contribute • Contributors • Licensing

About Testerra

Text changing depending on mode. Light: 'So light!' Dark: 'So dark!'

It is an integrated Java framework for automating tests for (web) applications. Testerra can also be understood as a building block for test automation projects with various basic components.

You may see Testerra as an open source test automation library for web frontend testing. It provides a tool suite for many use cases: a base API for Page Object Pattern (including responsive layouts) and GuiElements (smarter WebElements (Selenium)), enhanced reporting functionality, a utility collection and some additional helpful modules.

Testerra is developed by our Test Automation Experts at Telekom MMS in Dresden. In numerous projects Testerra is used as the standard test automation framework and includes the experience of more then 10 years of test automation.

This is the branch of Testerra 2. For Testerra 1 go to https://github.com/telekom/testerra/tree/testerra1

Setup

Include the following dependency in your project.

Gradle:

dependencies {
    implementation 'io.testerra:driver-ui-desktop:2.10'
    implementation 'io.testerra:report-ng:2.10'
}

Maven:

<dependencies>
    <dependency>
        <groupId>io.testerra</groupId>
        <artifactId>driver-ui-desktop</artifactId>
        <version>2.10</version>
    </dependency>
    <dependency>
        <groupId>io.testerra</groupId>
        <artifactId>report-ng</artifactId>
        <version>2.10</version>
    </dependency>
</dependencies>

Testerra requires JDK11 or later and uses Selenium 4.

Using Testerra functionality

Create a Test Class and extend the TesterraTest class:

public class MyTest extends TesterraTest implements UiElementFinderFactoryProvider, WebDriverManagerProvider {
    
    @Test
    public void testT01_My_first_tt_test() {
        UiElementFinder finder = UI_ELEMENT_FINDER_FACTORY.create(WEB_DRIVER_MANAGER.getWebDriver());
        
        finder.find(By.name("q"))
                .type("Hello World")
                .expect().value().endsWith("Hello").is(false);
    }
}

Documentation

Extras

Testing

Every module contains tests that can be run like

gradle test

Additional test properties are listed in the module's README.

Activate Jacoco code coverage analysis by

gradle testCodeCoverageReport

instead of gradle test

License report

Create a report about used licenses for every dependency:

gradle generateLicenseReport

You will find the reports of all modules under license3rdparty.

SBOM reports

Create an SBOM reports for every module:

gradle cyclonedxBom

You will find the JSON files under <root-project>/build/sbom

Publishing

Testerra is deployed and published to Maven Central. All JAR files are signed via Gradle signing plugin.

The following properties have to be set via command line or ~/.gradle/gradle.properties

Property Description
ttVersion Version of deployed Testerra, default is 2-SNAPSHOT
deployUrl Maven repository URL
deployUsername Maven repository username
deployPassword Maven repository password
signing.keyId GPG private key ID (short form)
signing.password GPG private key password
signing.secretKeyRingFile Path to GPG private key

If all properties are set, call the following to build, deploy and release Testerra:

gradle buildReport publish closeAndReleaseRepository

Code of Conduct

This project has adopted the Contributor Covenant in version 2.0 as our code of conduct. Please see the details in our CODE_OF_CONDUCT.md. All contributors must abide by the code of conduct.

Working Language

We decided to apply English as the primary project language.

Consequently, all content will be made available primarily in English. We also ask all interested people to use English as language to create issues, in their code (comments, documentation etc.) and when you send requests to us. The application itself and all end-user faing content will be made available in other languages as needed.

Support and Feedback

The following channels are available for discussions, feedback, and support requests:

Type Channel
Issues
Other Requests

Additional repositories

Testerra extensions

Repository Description
testerra-skeleton Testerra Skeleton Project
testerra-demo Testerra demo projects
testerra-selenoid-connector Testerra Selenoid Connector
testerra-hpqc-connector Testerra HPQC Connector
testerra-teamcity-connector Testerra TeamCity Connector
testerra-cucumber-connector Testerra Cucumber Connector
testerra-xray-connector Testerra Xray Connector
testerra-appium-connector Testerra Appium Connector
testerra-azure-devops-connector Testerra Azure DevOps Connector

Legacy Testerra modules

You will find outdated Testerra modules here: https://github.com/telekom/testerra-legacy

How to Contribute

Contribution and feedback is encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines. By participating in this project, you agree to abide by its Code of Conduct at all times.

Contributors

At the same time our commitment to open source means that we are enabling -in fact encouraging- all interested parties to contribute and become part of its developer community.

Licensing

Copyright (c) 2020 Deutsche Telekom AG.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0.

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the LICENSE for the specific language governing permissions and limitations under the License.