How to get the build result with Java API?

Jia Jia Li (805●8●157●192) | asked Sep 04 '12, 2:05 p.m.

Hi, I use the Java API to request the build, and then I want to wait the build result to output if the build pass or fail.

I use the following code, but do not know how to get the build result, any one can help?

ITeamBuildClient buildClient = (ITeamBuildClient) teamRepository

.getClientLibrary(ITeamBuildClient.class);

IBuildDefinitionHandle buildDefinition = buildClient.getBuildDefinition(

buildDefinitionId, monitor);

ITeamBuildRequestClient requestClient = (ITeamBuildRequestClient) teamRepository

.getClientLibrary(ITeamBuildRequestClient.class);

IBuildRequest buildRequest = requestClient.requestBuild(

buildDefinition, true, monitor);

Accepted answer

permanent link

Nick Edgar (6.5k●7●11) | answered Sep 18 '12, 2:47 p.m.
JAZZ DEVELOPER

Using IBuildRequest's getBuildResult() will give you the IBuildResultHandle. You can then fetch the corresponding IBuildResult using teamRepository.itemManager().fetch...

Be sure to specify IItemManager.REFRESH for the flags arg, so it gets the latest state from the server rather than using the cached, last-read item. If you only want to check the state, then it would be faster to do a partial fetch, specifying to fetch just the state and/or status properties.

e.g.

IBuildResultHandle buildResultHandle = buildRequest.getBuildResult();
IBuildResult buildResult = (IBuildResult) teamRepository.itemManager().fetchPartialItem(buildResultHandle, IItemManager.REFRESH,
                Arrays.asList(new String[] { IBuildResult.PROPERTY_STATE, IBuildResult.PROPERTY_STATUS })

To avoid swamping the server, you should probably have some kind of pause between retries. For example, the waitForTeamBuild Ant task waits 30 secs between retries, by default.

Jia Jia Li selected this answer as the correct answer

Comments

Jia Jia Li commented Sep 18 '12, 6:58 p.m. | edited Sep 25 '12, 9:50 a.m.

Hi, Nick

Thanks for your information very much. Here is my sample code to request the build ,and then wait for the result to do something, could you please help to review it? Thanks!

TeamPlatform.startup();

........

ITeamBuildClient buildClient = (ITeamBuildClient) teamRepository

.getClientLibrary(ITeamBuildClient.class);

IBuildDefinitionHandle buildDefinition = buildClient.getBuildDefinition(

buildDefinitionId, monitor);

ITeamBuildRequestClient requestClient = (ITeamBuildRequestClient) teamRepository

.getClientLibrary(ITeamBuildRequestClient.class);

IBuildRequest buildRequest = requestClient.requestBuild(

buildDefinition, true, monitor);

IBuildResult buildResult = (IBuildResult) teamRepository.itemManager().fetchCompleteItem(buildRequest.getBuildResult(), IItemManager.REFRESH, null);

System.out.println("wait the build completed........");

while(buildResult.getState().toString()!="COMPLETED"){

Thread.sleep(1000*30);

buildResult = (IBuildResult) teamRepository.itemManager().fetchCompleteItem(buildRequest.getBuildResult(), IItemManager.REFRESH, null);

}

........

finally{

TeamPlatform.shutdown();

}

Jia Jia Li commented Sep 18 '12, 6:59 p.m.

Hi, Nick I use while to get the buildresult state, waiting for his completed and do something else. I attach my code in the following, could you please to check if there is anything wrong?

Nick Edgar commented Sep 19 '12, 9:41 a.m. | edited Sep 19 '12, 9:42 a.m.

JAZZ DEVELOPER

That looks good. A couple of suggestions:

Pass the monitor to the fetch calls, and check isCanceled() on it if you want to allow cancelation. Normally operations throw OperationCanceledException in this case, and client code catches it at some reasonable top level, e.g. the UI action's job doing the work.
You can compare enum's directly, without having to convert to string. e.g. buildResult.getState() != BuildState.COMPLETED

Ralph Schoon commented Sep 19 '12, 11:00 a.m.

FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

Jia, you might find some inspiration in https://jazz.net/library/article/807 if you didn't already read the article. Would you mind if I kooe the link to this code for future usage?

Nick Edgar commented Sep 19 '12, 11:45 a.m.

JAZZ DEVELOPER

Thanks Ralph. I've added a pointer to your article in the Build FAQ: https://jazz.net/wiki/bin/view/Main/BuildFAQ#Is_there_a_programmatic_API_for

Jia Jia Li commented Sep 25 '12, 5:29 a.m.

Hi, Nick, thanks for your suggestion very much! I will modify it.

Also Ralph, thanks for your always help very much! Your article is very useful!

showing 5 of 6 show 1 more comments

3 other answers

Most liked answers ↑|Newest answers|Oldest answers

permanent link

Takehiko Amano (1.3k●37●41) | answered Sep 06 '12, 10:34 p.m.
JAZZ DEVELOPER
edited Sep 06 '12, 10:35 p.m.

Refer to this wiki page.

https://jazz.net/wiki/bin/view/Main/BuildJavaProgrammingExamples
Section: "Querying for Builds with a Given Tag".

Additionally, use buildResult.getState().toString()

function to obtain state of build, e.g. like "COMPLETED". For full list of enum of build status, take a look at "Enum BuildState" in com.ibm.team.build.common.model package.

Hope this helps !

permanent link

Pancha Gyaneswari Yelika (45●8●11) | answered Mar 18 '13, 8:03 a.m.

Hi,

I am writing the server side operation participant for the Request build. I need to get the latest build label which is run.

ENV: RTC 4.0.1

I have written the code, but it is going on the infinite loop, in the while condition.

Please let me know the issue in the code below.

IRepositoryItemService repositoryItemService = getService(IRepositoryItemService.class);

ITeamBuildService teamBuildService = getService(ITeamBuildService.class);

try {

if(operation.getOperationData() instanceof BuildRequestParams){

BuildRequestParams buildRequestParams = (BuildRequestParams)operation.getOperationData();

IBuildDefinitionHandle buildDefinitionHandle = buildRequestParams.getBuildDefinition();

IBuildResult[] buildResults = teamBuildService.getBuildResultsForBuildDefinition(buildDefinitionHandle, null);

if(buildResults != null && buildResults.length > 0){

IBuildResult latestBuildResult = buildResults[buildResults.length - 1];

latestBuildResult = (IBuildResult)repositoryItemService.fetchItem(latestBuildResult.getItemHandle(), IRepositoryItemService.COMPLETE);

while(latestBuildResult.getState()!= BuildState.COMPLETED){

Thread.currentThread();

Thread.sleep(1000);

latestBuildResult = (IBuildResult)repositoryItemService.fetchItem(latestBuildResult.getItemHandle(), IRepositoryItemService.COMPLETE);

}

System.out.println("Build Label ::: "+latestBuildResult.getLabel());

}

This is running into an infinite loop and the latestBuildResult.getState() is always NOT_STARTED.

I am not able to get the refreshed state of the build result.

Please help

permanent link

Nick Edgar (6.5k●7●11) | answered Mar 18 '13, 9:36 a.m.
JAZZ DEVELOPER

Hi Pancha,

I see two issues in the code:

1) in the while loop, it keeps fetching the same item. You'd need to iterate through the items in the array instead.

2) the results from getBuildResultsForBuildDefinition are not in any particular order (it depends on the DB), so starting from the end does not necessarily return the latest build. I suggest using com.ibm.team.build.internal.common.ITeamBuildService.getQueryPageForBuildResultsForBuildDefinitions(IBuildDefinitionHandle[], String[]). This lets you pass the desired build state(s) too, e.g. pass new String[] { BuildState.COMPLETED.name() } for the second arg. The results are ordered by build start time, most recent first. So the latest build would be at index 0.

Your answer

Register or log in to post your answer.

Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.

It's all about the answers!

Related questions

How to get the build result with Java API?

Accepted answer

3 other answers

Your answer