Skip to content

Latest commit

 

History

History
185 lines (128 loc) · 7.94 KB

README.md

File metadata and controls

185 lines (128 loc) · 7.94 KB
Raw

TeamCity Connector

Setup • Documentation • Support • Contribute • Contributors • Licensing

About this module

This module provides additional features to Testerra Framework for automated tests.

This module provides a simple notification service for Jetbrains TeamCity. It uses the build script interaction of TeamCity to update build progress messages on test method updates and update general build status on report generation. It will register automatically by using the Testerra ModuleHook.

Setup

Requirements

TeamCity connector Testerra
1.0 1.0.0..1.8
1.1 1.9
2.0-RC-2 >= 2.0-RC-19
2.0 >= 2.0

Usage

Include the following dependency in your project.

Gradle:

implementation 'io.testerra:teamcity-connector:2.0'

Maven:

<dependency>
    <groupId>io.testerra</groupId>
    <artifactId>teamcity-connector</artifactId>
    <version>2.0</version>
</dependency>

Documentation

TeamCity configuration

Please ensure that you have Failure Conditions > Common Failure Conditions > at least one test failed deactivated on your TeamCity build configuration,
because TeamCity Connector will announce the build status on report generation based on test execution statistics.

Gradle / Maven configuration

When using TeamCity Connector you have to ensure that Gradle/Maven will ignore test failures.

Gradle:

test {
    ignoreFailures = true
}

Maven:

<build>
    <plugins>
        <plugin>
            <artifactId>maven-surefire-plugin</artifactId>
            <configuration>
                <skip>true</skip>
                <testFailureIgnore>true</testFailureIgnore>
            </configuration>
        </plugin>
    </plugins>
</build>

Impacts on TeamCity

Changes in TeamCity

TeamCity default With TeamCity connector Description
TeamCity connector set the current test result at runtime.
TeamCity connector set the correct test result and build status.

The TeamCity connector not only set the correct test results but also add useful information. Based on the screenshots in the table above the following information are added.

Meaning o shown information

Part Description
TT-Skeleton The value of the property tt.report.name
regression The value of the property tt.runcfg. This could be the test set (regression, smoketest, etc.)
3 Passed, 1 Failed The result of all test cases of the complete run. At runtime it shows the current result up to that point.
-NOT OK- The status of the complete test run. If all tests passed or the Failure Corridor was matched, the status would be -OK-

The following tables shows some more examples how the result could be.

Test result Description
A test cases was skipped because the corresponding setup method failed. The result of the test run is failed.
The Failure corridor was matched, the status is OK although a test failed.
A test was marked as expected failed, all other tests passed. The restult of the test run is still passed.

Publication

This module 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
moduleVersion Version of deployed module, default is 1-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 this module:

gradle 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

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) 2021 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.