How to read the Build Queue of a particular RTC Project.

Swapnonil Mukherjee (6●1●1) | asked Jan 30 '12, 8:51 a.m.

Hello Everybody,

I have created a RTC project and put a single component inside it. I have also created 2 build engines and a single build definition which is designated to be run on any of the two available build engines.

What I also want to do is to monitor the "Build Queue" of this project programmatically, and see whether there is an item in that queue which is in "pending" state.

I have download the Jazz SDK, and seen some examples of triggering builds but I still have not been able to figure this one out.

With Regards
Swapnonil Mukherjee

5 answers

Most liked answers ↑|Newest answers|Oldest answers

permanent link

Nick Edgar (6.5k●7●11) | answered Jan 31 '12, 5:18 p.m.
JAZZ DEVELOPER

Hi Swapnonil,

The one we use internally is:
com.ibm.team.build.internal.client.ITeamBuildRecordClient.getBuildResultRecords(IProjectAreaHandle, BuildState[], String[], IProgressMonitor):

    /**

     * Get the build result records iterator for all build results in the given

     * project area.

     * 

     * @param projectAreaHandle

     *            The project area to search for build results.

     * @param buildStates

     *            The build states to match. May be &lt;code&gt;null&lt;/code&gt; or empty

     *            array to indicate all states.

     * @param properties

     *            The properties to include in the returned build results.

     * @param progressMonitor

     *            The progress monitor to track progress on or &lt;code&gt;null&lt;/code&gt;

     *            if progress monitoring is not desired.

     * @return A build result record iterator for all build results in the given

     *         project area.. May be empty, but never &lt;code&gt;null&lt;/code&gt;.

     * @throws TeamRepositoryException

     *             If an error occurs while accessing the repository.

     */

    public IBuildResultRecordIterator getBuildResultRecords&#40;IProjectAreaHandle projectAreaHandle,

            BuildState&#91;&#93; buildStates, String&#91;&#93; properties, IProgressMonitor progressMonitor&#41;

            throws TeamRepositoryException;

The client interface can be obtained using:
com.ibm.team.repository.client.ITeamRepository.getClientLibrary(Class)

Note that this is internal though. To avoid using the internals, you'd need to construct your own query and use com.ibm.team.build.client.ITeamBuildBaseClient.queryItems(IItemQuery, Object[], int, IProgressMonitor)

permanent link

Krishna Kishore (501●1●2) | answered Feb 15 '12, 3:39 a.m.
JAZZ DEVELOPER

Hi Nick,

Does the getBuildResultRecords return the queued builds ie even if the build is in pending sate(not started)? Their is a "getQueue" REST call
<repository>/jazz/resource/virtual/build/queue?projectAreaUUID=<item> &profile=REDUCED

which returns the items in the build queue. Is their a similar API on the Jazz SDK side or its subsumed by getBuildResultRecords.

Thanks
Kishore

0	permanent link Nick Edgar (6.5k●7●11) \| answered Feb 15 '12, 9:49 a.m. JAZZ DEVELOPER Hi Kishore, Yes, to see the build queue for the project, use that getBuildResultRecords with states BuildState.NOT_STARTED (aka pending) and BuildState.IN_PROGRESS.

permanent link

Swapnonil Mukherjee (6●1●1) | answered Feb 16 '12, 8:43 a.m.

Hi Everybody

The code that helped me browse the build queue is pasted below.


public static void queryPendingBuilds&#40;ITeamRepository teamRepository&#41;

			throws TeamRepositoryException, URISyntaxException

	&#123;

		ITeamBuildRecordClient buildRecordClient = &#40;ITeamBuildRecordClient&#41; teamRepository

				.getClientLibrary&#40;ITeamBuildRecordClient.class&#41;;

		IProcessClientService processClient = &#40;IProcessClientService&#41; teamRepository

				.getClientLibrary&#40;IProcessClientService.class&#41;;



		URI uri = URI.create&#40;&quot;My Project&quot;.replaceAll&#40;&quot; &quot;, &quot;%20&quot;&#41;&#41;;

		IProjectArea projectArea = &#40;IProjectArea&#41; processClient.findProcessArea&#40;uri, null, null&#41;;

		BuildState&#91;&#93; states = &#123; BuildState.NOT_STARTED &#125;;



		String&#91;&#93; properties = new String&#91;&#93; &#123; IBuildResult.PROPERTY_LABEL &#125;;



		IProgressMonitor monitor = new NullProgressMonitor&#40;&#41;;

		IBuildResultRecordIterator iterator = buildRecordClient.getBuildResultRecords&#40;projectArea.getProjectArea&#40;&#41;,

				states, properties, monitor&#41;;

		while &#40;iterator.hasNext&#40;&#41;&#41;

		&#123;

			IBuildResultRecord record = iterator.next&#40;monitor&#41;;

			System.out.println&#40;record.getBuildDefinition&#40;&#41;&#41;;

		&#125;

	&#125;

However I do not know if this is the best way do so.

With Regards
Swapnonil Mukherjee

0	permanent link Nick Edgar (6.5k●7●11) \| answered Feb 16 '12, 9:11 a.m. JAZZ DEVELOPER That looks fine, except that we also show in-progress builds in the queue in the UI. Also, the use of internals isn't ideal.

It's all about the answers!

Related questions

How to read the Build Queue of a particular RTC Project.

5 answers

Your answer