Get branch information for SVcsModification Follow

Created July 31, 2017 18:01

In a plugin we are trying to determine the changes which are contained in a build and figured out that

final List<SVcsModification> modifications = runningBuild.getChanges( SelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD, false );
for ( final SVcsModification modification : modifications ) {

allows you to iterate over the modifications contained in the build since the last successful one. But what we are interested in are only the changes since the last successful build which are on a specific branch. The reason here is that e.g. a feature branch gets created from the develop and maybe the last build on develop (which is the default branch) was not successful. In this case the changes on develop prior to the branching point are not interesting.

Is there any way to achieve this and determine which branch a modification belongs to?

Thanks,

Hanno

1 comment

Dmitry Neverov

Created August 08, 2017 13:45

Hi,

there is no method for that out of the box, but I believe you can achieve what you want using so called BuildPromotion (every build has one, you can get it using the getBuildPromotion() method [1]. Having a build promotion you can call getPreviousBuildPromotion() [2] with same policy as for computing changes. If the previous promotion has different branch [3], then you can iterate though builds, until you reach the default branch.

Code may look like this:

BuildPromotion promotion = build.getPromotion();
BuildPromotion prevSuccessful = promotion.getPreviousBuildPromotion(SelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD);
if (Objects.equals(promotion.getBranch(), prevSuccessful.getBranch())) {
  return promotion.getChanges(SelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD, false);
} else {
  List<SVcsModification> result = new ArrayList<>();
  do {
    BuildPromotion prev = promotion.getPreviousBuildPromotion(SelectPrevBuildPolicy.SINCE_LAST_FINISHED_BUILD);
    if (Objects.equals(prev.getBranch(), build.getBranch())) {
      result.addAll(promotion.getChanges(SelectPrevBuildPolicy.SINCE_LAST_FINISHED_BUILD, false));
    }
    promotion = prev;
  } while (Objects.equals(promotion.getBranch(), build.getBranch()));
  return result;
}

You can also analyze a commit graph using non-open API [4] which can be changed or removed between TeamCity versions. In this case code may look like this (it assumes that the build configuration has only 1 VCS root and that VCS provides information about commit graph, e.g. it is git or mercurial):

VcsModificationHistoryEx vcsHistory; //get it as a Spring dependency
RepositoryStateManager repositoryStateManager; //get it as a Spring dependency

VcsRootInstance root = build.getVcsRootEntries().get(0).getVcsRoot();
DAG<Long> dag = vcsHistory.getModificationIdDag(root);
RepositoryState state = repositoryStateManager.getRepositoryState(root);
String defaultBranchRevision = state.getDefaultBranchRevision();
if (defaultBranchRevision != null) {
  SVcsModification defaultBranchCommit = vcsHistory.findModificationByVersion(root, defaultBranchRevision);
  if (defaultBranchCommit != null) {
    ReachabilityPredicate predicate = VcsDAGs.createReachabilityPredicate(dag);
    predicate.markUninteresting(defaultBranchCommit.getId());
    List<SVcsModification> result = new ArrayList<>();
    for (SVcsModification change : build.getChanges(SelectPrevBuildPolicy.SINCE_LAST_SUCCESSFULLY_FINISHED_BUILD, false)) {
      if (predicate.isInteresting(change.getId()))
        result.add(change);
    }
    return result;
  }
}

[1] http://javadoc.jetbrains.net/teamcity/openapi/current/jetbrains/buildServer/serverSide/BuildPromotionOwner.html#getBuildPromotion() method
[2] http://javadoc.jetbrains.net/teamcity/openapi/current/jetbrains/buildServer/serverSide/BuildPromotion.html#getPreviousBuildPromotion(jetbrains.buildServer.vcs.SelectPrevBuildPolicy)
[3] http://javadoc.jetbrains.net/teamcity/openapi/current/jetbrains/buildServer/serverSide/BuildPromotion.html#getBranch()
[4] http://download.jetbrains.com/teamcity-repository/org/jetbrains/teamcity/internal/server/2017.1/

Please sign in to leave a comment.