Introduction

Source code available at 

• ASF tools repository: https://gitbox.apache.org/repos/asf/ignite-teamcity-bot.git 
• Mirror https://github.com/apache/ignite-teamcity-bot

...

This tool can be also used for checking PR for introduction of new failures.

How to check a PR with the TC Bot

How to use

Analyze latest TeamCity tests results against the latest master:

1. Go to the Home pagePR/Branch check page
2. Find PR, press "Inspect" and then "Show report" button. Or fill Fill the form "Check branch/PR":
   
   1. Leave base branch empty.
   2. Enter branch from TeamCity ("pull/<pull-request-number>/head").
   3. Press "Latest" button to compare with the latest master.
3. On the appeared page you can see a table with failed tests and suites. Also, you can see test's failure rate for last 100 runs of master branch.
   Most important failures are placed under "Possible Blockers" header in the table. You need to fix them or ensure that they aren't yours before moving ticket to Patch Available.

Analyze latest TeamCity tests results against the other branch:

1. Go to the Home PR/Branch check page
2. Fill the form "Check branch/PR":
   
   1. Enter base branch from TeamCity ("pull/<pull-request-number>/head").
   2. Enter branch from TeamCity ("pull/<pull-request-number>/head").
   3. Press "Latest" button to compare PR branch against the base branch.
3. On the appeared page you can see a table with failed tests and suites. Also, you can see test's failure rate for last 100 runs of base branch.
   Most important failures are placed under "Possible Blockers" header in the table.

Analyze specific TeamCity build against the latest master:

1. Go to the Home to the PR/Branch check page
2. Fill the form "Check build" with build ID from TeamCity.
3. On the appeared page you can see a table with failed tests and suites. Also, you can see test's failure rate for last 100 runs of master branch.

Print possible blockers to the JIRA ticket:

1. Go to the PR/Branch check page
2. Fill Find PR, press "Inspect" and then "Comment JIRA". Or fill the form "Notify JIRA":
   1. Enter branch from TeamCity (or "<pull-request-number>" only).
   2. Enter JIRA ticket number. If PR is named according to contributing guide (name starts with "IGNITE-"), you can leave this field empty.

Trigger "Run All" and comment JIRA by one button:

1. Go to the PR/Branch check page
2. Find PR, press "Inspect" and then "Trigger build and comment JIRA after finish". Fill the form "TeamCity Run All":
   1. Enter branch from TeamCity (or "<pull-request-number>" only).
   2. Enter JIRA ticket number. If PR is named according to contributing guide (name starts with "IGNITE-"), you can leave this field empty.
3. Press "Start tests and comment JIRA ticket on ready" button.

View and compare the statistics of "Run All" for master branch for a period of time.

1. Go to the Master Trends page

2. Select the interval and click "Apply". The minimum interval is 1 day, the maximum interval is 7 days.

        The selection includes builds, the start date of which is between 00:00:01 of the first day and 23:59:59 of the last day of the interval.
        By default, when the page is opened, statistics are downloaded for this week (ending today) and the previous week.
        For each field of "TESTS" and "PROBLEMS" sections show general results: min - median - max. By clicking on the icon near field name Image Added will show line chart for all data this field. Cells in the "PROBLEMS" section are additionally dyed green if the current median is less than the median in the other column. If more, then red.
       The TeamCity server stores information about the builds for ~ two weeks. At the end of this period, the data is deleted from the TC server. Apache Ignite Teamcity Helper saves all received data in the cache so that they are available after this time.  But still some of the information may be missing. If for the whole period there is no information on any build, you will receive a message «No data for the selected period». If data are available for not all days, you will receive a message «Data for the period from DD-MM-YYYY to DD-MM-YYY» or «Data for DD-MM-YYY».

Notification Types

This section covers notification types utility can send to dev@ list. User can specify his or her email and select desired tracked branches. All failures in this braches will be also forwarded to user.

...

Lets name result 2 as critical failure. So it is required to have 5 non critical failures and 4 critical to generate notification: ....(0/1)(0/1)(0/1)(0/1)(0/1) 222....You need to fix2222....

Contributing to TC Bot

Please see Github integrated documentation on how to contribute: https://github.com/apache/ignite-teamcity-bot#development

FAQ

Q1. Build Launch problems - Forbidden

In case of password change on the original TeamCity(TC) it is mandatory to manually reset credentials inside TC Bot.

TC bot caches old password data and use it to trigger new builds.

TC data upload is background process so viewing data is available with outdated credentials. 

To reset credentials click on your user at top rigth corner:

Image Added

and then to Reset Credentials button

Image Added

This action will trigger logout from TC bot.

Enter username and new password.