Access Build Information from OSLC

Mark Roberts

JAZZ DEVELOPER (120●53●38) Dec 13 '10, 10:17 a.m.

I want to access information regarding the workitems associated with a build from OSLC. I have found the information at this web page : https://jazz.net/wiki/bin/view/Main/RTCAutomationOSLCPrototype which looks helpful but I cannot browse through the OSLC structure to find the starting point for getting this, nor does it work when I paste in an OSLC identifier for the project area into the URL shown below:

If I replace the template below with information about my server then I get a not found error :

URL pattern is:https://someServer:port/jazz/oslc/contexts/{projectAreaId}/automation/services

I have taken the projectAreaId from the information reported by the Work item catalog link here : /ccm/oslc/workitems/catalog which returns :

oslc_disc:details rdf:resource="https://myserver:9443/ccm/process/project-areas/_i777YPCqEd-i17guFPVVOw"

So for the {projetAreaId} I used _i777YPCqEd-i17guFPVVOw from the above.

Can someone please guide me to the OSLC access to the build information starting from the top of the OSLC heirarchy.

Ultimately the customers requirement is to advance a work item through the state lifecycle when it has been associated with a successful build. If anyone has experience of doing that with OSLC then please shout.

1 vote

5 answers

9,775 views

1 vote

5 answers

Permanent link

Nick Edgar

JAZZ DEVELOPER (6.5k●7●11) Dec 14 '10, 11:52 a.m.

The <repo>/rootservices resource does not point to the automation support because the OSLC Automation implementation in RTC 3.0 is only a prototype. Also note that the spec isn't finalized, so there may be further changes in the API, some of which may be breaking API changes.

To get the catalog for automation services, use e.g.:
https://jazz.net/jazz/oslc/automation/catalog

This yields, e.g.:

...

&lt;dc&#58;title&gt;Rational Team Concert&lt;/dc&#58;title&gt;

&lt;oslc_disc&#58;details rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/process/project-areas/_1w8aQEmJEduIY7C8B09Hyw&quot;/&gt;

&lt;oslc_disc&#58;services rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/services.xml&quot;/&gt;

&lt;ns1&#58;consumerRegistry rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/process/project-areas/_1w8aQEmJEduIY7C8B09Hyw/links&quot;/&gt;

&lt;/oslc_disc&#58;ServiceProvider&gt;

&lt;/oslc_disc&#58;entry&gt;

...

Following the services link:
https://jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/services.xml
yields:

...

&lt;oslc&#58;service&gt;

&lt;oslc&#58;Service&gt;

&lt;oslc&#58;queryCapability &gt;

&lt;oslc&#58;QueryCapability &gt;

&lt;dc&#58;title&gt;Automation Plan Query&lt;/dc&#58;title&gt;

&lt;oslc_auto&#58;label&gt;plansquery&lt;/oslc_auto&#58;label&gt;

&lt;oslc&#58;queryBase  rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/plans&quot;/&gt;

&lt;oslc&#58;shape  rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/shapes/plansquery&quot;/&gt;

&lt;/oslc&#58;QueryCapability &gt;

&lt;/oslc&#58;queryCapability &gt;

&lt;oslc&#58;queryCapability &gt;

&lt;oslc&#58;QueryCapability &gt;

&lt;dc&#58;title&gt;Automation Result Query&lt;/dc&#58;title&gt;

&lt;oslc_auto&#58;label&gt;resultsquery&lt;/oslc_auto&#58;label&gt;

&lt;oslc&#58;queryBase  rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/results&quot;/&gt;

&lt;oslc&#58;shape  rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/shapes/resultsquery&quot;/&gt;

&lt;/oslc&#58;QueryCapability &gt;

&lt;/oslc&#58;queryCapability &gt;

&lt;/oslc&#58;Service&gt;

&lt;/oslc&#58;service&gt;

...

The plan query link:
https://jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/plans
yields all plans (i.e. build definitions):

...

&lt;oslc_auto&#58;plan rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/plans/_AHLqcIkAEd6RvINWj6hoDw&quot;&gt;

&lt;dc&#58;identifier&gt;_AHLqcIkAEd6RvINWj6hoDw&lt;/dc&#58;identifier&gt;

&lt;dc&#58;title&gt;rtc.jcb&lt;/dc&#58;title&gt;

&lt;dc&#58;description&gt;

...

&lt;/dc&#58;description&gt;

&lt;oslc_auto&#58;results oslc_cm&#58;collref=&quot;https&#58;//jazz.net/jazz/oslc/contexts/_1w8aQEmJEduIY7C8B09Hyw/automation/results?oslc.where=oslc_auto&#58;plan=%22https&#58;//jazz.net/jazz/oslc/automation/plans/_AHLqcIkAEd6RvINWj6hoDw%22&quot;/&gt;

&lt;/oslc_auto&#58;plan&gt;

...

The use of olsc_cm:collref for the results query is a bug. It should be rdf:resource.

Following that link yields the results:

...

&lt;oslc_auto&#58;AutomationResult rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q&quot;&gt;

&lt;dc&#58;identifier&gt;_pZ804AeZEeCmSNb08EOl6Q&lt;/dc&#58;identifier&gt;

&lt;dc&#58;name&gt;RTC-T20101214-0748&lt;/dc&#58;name&gt;

&lt;oslc_auto&#58;plan rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/plans/_AHLqcIkAEd6RvINWj6hoDw&quot;/&gt;

&lt;dc&#58;creator rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/persons/_MUackFu9Edyy979fBgA6Ww&quot;/&gt;

&lt;dc&#58;created&gt;2010-12-14T15&#58;48&#58;51.117Z&lt;/dc&#58;created&gt;

&lt;oslc_auto&#58;started&gt;2010-12-14T15&#58;48&#58;53.602Z&lt;/oslc_auto&#58;started&gt;

&lt;oslc_auto&#58;ended&gt;2010-12-14T15&#58;48&#58;53.601Z&lt;/oslc_auto&#58;ended&gt;

&lt;oslc_auto&#58;reason&gt;MANUAL&lt;/oslc_auto&#58;reason&gt;

&lt;oslc_auto&#58;state&gt;IN_PROGRESS&lt;/oslc_auto&#58;state&gt;

&lt;oslc_auto&#58;verdict&gt;OK&lt;/oslc_auto&#58;verdict&gt;

&lt;oslc_auto&#58;subject/&gt;

&lt;oslc_auto&#58;contributions rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q/contributions&quot;/&gt;

&lt;/oslc_auto&#58;AutomationResult&gt;

...

Following the contributions link yields the various contributions to the build (logs, downloads, links, etc):

...

&lt;oslc_auto&#58;LinkContribution rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q/contributions/__9yjUAebEeCmSNb08EOl6Q&quot;&gt;

&lt;oslc_auto&#58;result rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q&quot;/&gt;

&lt;dc&#58;title&gt;Build results web page&lt;/dc&#58;title&gt;

&lt;rdf&#58;type&gt;rtc_build&#58;BuildResultContribution&lt;/rdf&#58;type&gt;



&lt;rtc_build&#58;contributionType&gt;

com.ibm.team.build.common.model.IBuildResultContribution.link

&lt;/rtc_build&#58;contributionType&gt;



&lt;dc&#58;url&gt;

http&#58;//jazzweb.beaverton.ibm.com/rtc/maint/T/RTC-T20101214-0748/index.html

&lt;/dc&#58;url&gt;

&lt;/oslc_auto&#58;LinkContribution&gt;



&lt;oslc_auto&#58;LogContribution rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q/contributions/_E_dtcAecEeCmSNb08EOl6Q&quot;&gt;

&lt;oslc_auto&#58;result rdf&#58;resource=&quot;https&#58;//jazz.net/jazz/oslc/automation/results/_pZ804AeZEeCmSNb08EOl6Q&quot;/&gt;

&lt;dc&#58;title&gt;Build suppliers properties file&lt;/dc&#58;title&gt;

&lt;rdf&#58;type&gt;rtc_build&#58;BuildResultContribution&lt;/rdf&#58;type&gt;



&lt;rtc_build&#58;contributionType&gt;

com.ibm.team.build.common.model.IBuildResultContribution.log

&lt;/rtc_build&#58;contributionType&gt;

&lt;oslc_auto&#58;fileName&gt;buildSuppliers.properties&lt;/oslc_auto&#58;fileName&gt;

&lt;oslc_auto&#58;fileSize&gt;2183 bytes&lt;/oslc_auto&#58;fileSize&gt;

&lt;oslc_auto&#58;mediaType&gt;text/plain&lt;/oslc_auto&#58;mediaType&gt;



&lt;oslc_auto&#58;fileContent&gt;

https&#58;//jazz.net/jazz/resource/virtual/build/result/_pZ804AeZEeCmSNb08EOl6Q/contribution/_E_dtcAecEeCmSNb08EOl6Q/buildSuppliers.properties

&lt;/oslc_auto&#58;fileContent&gt;

&lt;/oslc_auto&#58;LogContribution&gt;

...

Unfortunately, there's no way, currently, to determine the work items associated with changes in the build via the OSLC Automation API. The links given are only the links explicitly published as link contributions, not the work item links generated as a side effect of accepting changes.

The only other approach I can see is to use the internal REST interface that supports our web UI.

For example, try:
https://jazz.net/jazz/resource/virtual/build/definitions?_prettyPrint=true
https://jazz.net/jazz/resource/virtual/build/definition/_AHLqcIkAEd6RvINWj6hoDw?_prettyPrint=true
https://jazz.net/jazz/resource/virtual/build/results?definition=rtc.jcb&_prettyPrint=true
https://jazz.net/jazz/resource/virtual/build/resultpresentation/_vp1C4AdqEeCmSNb08EOl6Q?_mediaType=text/json&_prettyPrint=true

These yield JSON, not XML. The _mediaType and _prettyPrint query args are just for debugging.

The result for the last link includes:

...

            &quot;contribution&quot;&#58; &#123;

                &quot;extendedContributionProperties&quot;&#58; &#91;

                    &#123;

                        &quot;name&quot;&#58; &quot;com.ibm.team.build.common.model.IBuildResultContribution.url&quot;,

                        &quot;value&quot;&#58; &quot;https&#58;\/\/jazz.net\/jazz\/resource\/itemName\/com.ibm.team.workitem.WorkItem\/148092&quot;

                    &#125;,

...

                &#93;,

                &quot;extendedContributionTypeId&quot;&#58; &quot;com.ibm.team.build.linktype.includedWorkItems&quot;,

                &quot;internalId&quot;&#58; &quot;_l2k7IAehEeCmSNb08EOl6Q&quot;,

                &quot;label&quot;&#58; &quot;Defect 148092&#58; Compile problems in BuildResultBuilder.java&quot;

            &#125;,

...

There would be one such contribution for every included work item.

Hope this helps. Note that the internal REST interface is internal, so it may too may change at any time. It's been pretty stable since 2.0 though.

3 votes

Permanent link

wang fan

JAZZ DEVELOPER (21●2) Dec 19 '10, 10:39 p.m.

I filed work item https://jazz.net/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/148411 to track oslc_cm:collref issue

0 votes

Permanent link

Mark Roberts

JAZZ DEVELOPER (120●53●38) Jan 07 '11, 10:23 a.m.

Nick,

Thanks very much for the information on the build records from OSLC.

You mention that the list of work items associated with the build as a result of being accepted into the workspace is not available in the build. should that information appear within the 'Contributors' data in the area of :

<oslc_auto>
<oslc_auto>
<dc>
<rdf>rtc_build:BuildResultContribution</rdf>
<rtc_build>fixedWorkItems</rtc_build>
</oslc_auto>

The contributionType of 'Fixed work items' does look like a good candidate to have this information in the future since the link above doesn't really give me a great deal at the present.

0 votes

Permanent link

Nick Edgar

JAZZ DEVELOPER (6.5k●7●11) Jan 07 '11, 1:49 p.m.

Mark, what you're seeing there is our internal representation of 'included in build' work item references poking through. We include all contributions in the OSLC result, but some are expressed in an RTC-specific way (note that the type here is rtc_build:BuildResultContribution, not an oslc_auto or oslc core type).

The internal representation here is a content blob of work item UUIDs (the OSLC result does not currently surface the link to the content blob for these contributions, just for FileContributions and their subtypes.), but that would not be the best way to surface them in OSLC. It would make more sense to have a contribution type that's specific to OSLC Change Management links, or perhaps use the current LinkContribution type but augmented with extra metadata, such as the content type, so consumers can have a clue that it's a work item / CM link.

The cross-domain linking story still needs a lot of fleshing out in OSLC.
For some earlier discussions, see:
http://open-services.net/bin/view/Main/ScmWorkItemIntegrationStory
http://open-services.net/bin/view/Main/ScmBuildIntegrationStory

0 votes

Comments

Mike Shkolnik

Jul 26 '13, 2:33 p.m.

Any update on this topic in the past two years? I am trying to use the API to create a report that:

1. Lists builds (applying some filters)
2. Lists change sets included in those builds
3. Lists work items associated with the change sets included in those builds.

Permanent link

Nick Edgar

JAZZ DEVELOPER (6.5k●7●11) edited

Jul 29 '13, 2:37 p.m.

Mike, re your question about any updates, there have been no changes since then in our OSLC Automation implementation. You may want to track a related plan item: [CCM] Implement OSLC Automation v2 spec (237822)

It may be possible to use an OSLC CM query to find work items referring to a specific build, via the "included in build" relationship. I tried this on jazz.net, but the query failed for me. See details in OSLC CM query fails with 400: Unexpected symbol: null (274594) I've cc'ed Mark and Mike.

0 votes

Comments

Nick Edgar

JAZZ DEVELOPER Jul 29 '13, 2:41 p.m.

You can use the generateChangeLog Ant task, which can list the change sets and associated work items in a particular build (as well as between two specific builds or snapshots). See the doc for it in the RTC Eclipse client help. You'd still need to list builds using OSLC Automation. Another possibility is to do it all using the Java client API, or a scripting layer on top of that, e.g. I've used JRuby in the past to do this kind of thing.

Nick Edgar

JAZZ DEVELOPER Aug 13 '13, 9:31 p.m.

Mike, were you able to get it going using the fixed query in #274594?

Nick Edgar

JAZZ DEVELOPER Aug 13 '13, 9:32 p.m.

Nm, I see that you did. Good to hear.

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.

Follow this question

By Email:

Once you sign in you will be able to subscribe for any updates here.

By RSS:

Answers

Answers and Comments

Question details

rational-team-concert

× 42,896

Question asked: Dec 13 '10, 10:17 a.m.

Question was seen: 9,775 times

Last updated: Aug 13 '13, 9:32 p.m.

Access Build Information from OSLC

5 answers

9,775 views

1 vote

5 answers

Comments

Comments

Your answer

Follow this question

Question details

Related questions