Accessing BuildResult files from "Request Rebuild..." action
I have been able to create a BuildResultPage contributor/provider which displays the files that were published via the build engine.
What I would like to do is also be able to reference those file(s) from within the "Request Rebuild..." action for our custom dialog section. In the Rebuild Dialog there is a reference to the BuildResult, which is not null. What I can't figure out is how to get a IBuildResultContext, which best I can tell is what the ResultPage uses to get access to the files associated with the BuildResult. This is passed to the ResultPage when it is constructed from how I am understanding the build source.
Is it possible to do want I am attempting?
If yes, what object/methods do I need to get the IBuildResultContext so I can get the contributions using getContributions or is this even necessary?
Is there another way of doing what I want too do?
What I would like to do is also be able to reference those file(s) from within the "Request Rebuild..." action for our custom dialog section. In the Rebuild Dialog there is a reference to the BuildResult, which is not null. What I can't figure out is how to get a IBuildResultContext, which best I can tell is what the ResultPage uses to get access to the files associated with the BuildResult. This is passed to the ResultPage when it is constructed from how I am understanding the build source.
Is it possible to do want I am attempting?
If yes, what object/methods do I need to get the IBuildResultContext so I can get the contributions using getContributions or is this even necessary?
Is there another way of doing what I want too do?
Accepted answer
Steve, re the comments from earlier today, yes you want to get the properties from the build request corresponding to the build result. It has a copy of the properties from the build definition (plus any overrides) at request time.
It's a common idiom in the RTC APIs to have to fetch an item holding the actual data (e.g. IBuildRequest) given its handle which is essentially a pointer to a given item + optionally a specific state of the item (e.g. IBuildRequestHandle). For client-side code, use the fetch methods on IItemManager, obtained from ITeamRepository.itemManager().
But it turns out that you don't need to in the context of a build result page contribution. The contribution provider's site has that info, and you can pass it along to your page when you create it. The relevant code for our Properties page is in /com.ibm.team.build.ui/src/com/ibm/team/build/internal/ui/editors/result/properties/BuildPropertiesContributionProvider.java:
@Override
public void initializeContributionProvider(IProgressMonitor monitor) throws Exception {
IBuildRequest request = getStartRequest(getBuildResultContext().getBuildResultRecord().getBuildRequests());
if (request != null) {
fBuildProperties = request.getBuildDefinitionInstance().getProperties();
} else {
fBuildProperties = new ArrayList<IBuildProperty>();
}
}
private IBuildRequest getStartRequest(IBuildRequest[] allRequests) {
for (IBuildRequest currentRequest : allRequests) {
if (currentRequest.getBuildAction().getAction().equals(IBuildAction.REQUEST_BUILD)) {
return currentRequest;
}
}
// Log a message, but don't treat this as an error. It is unexpected,
// but we can handle it.
BuildUIPlugin.log(NLS.bind(Messages.BuildPropertiesContributionProvider_NO_REQUEST,
BuildResultTextHelper.getLabel(getBuildResultContext().getBuildResult())));
return null;
}
@Override
public AbstractBuildResultPage getBuildResultPage() {
return new BuildPropertiesPage(getBuildResultEditor(), getExtensionId(),
Messages.BuildPropertiesContributionProvider_TAB_TEXT, getExtendedContributionIds(),
getBuildResultContext(), fBuildProperties);
}
Comments
2 other answers
Hi Steve. In the request dialog, sections are contributed via the requestBuildDialogSections extension point.
The built in ones are defined with:
<extension
point="com.ibm.team.build.ui.requestBuildDialogSections">
<requestBuildDialogSection
class="com.ibm.team.build.internal.ui.dialogs.ScmOptionsSection$Factory"
order="100"/>
<requestBuildDialogSection
class="com.ibm.team.build.internal.ui.dialogs.PropertiesSection$Factory"
order="200"/>
</extension>
The class given must implement com.ibm.team.build.ui.dialogs.requestbuild.IRequestBuildSectionFactory, and its create method is passed a com.ibm.team.build.ui.dialogs.requestbuild.RequestBuildSectionSite. RequestBuildSectionSite has getTeamRepository(), getBuildResult(), isRebuild() and other methods.
RequestBuildSectionSite is similar to IBuildResultContext in that it provides contextual info from the containing UI, but IBuildResultContext is specific to the build result editor context.
Comments
showing 5 of 8
show 3 more comments
Hi Steve, re your July 11 comment, there's no way to add/change properties on an existing build (the only opportunity to override them is when issuing the build request). However, it should be possible to use build result contributions to do what you want.
From the Ant script, I suggest using the linkPublisher Ant task to publish a link to the FTP file (you might well want this traceability anyway). Then, in the (re)build dialog, you can retrieve that contribution and its corresponding URL. It basically comes down to:
- query for link type contributions using com.ibm.team.build.client.ITeamBuildClient.getBuildResultContributions(IBuildResultHandle, String, IProgressMonitor), using constant com.ibm.team.build.common.model.IBuildResultContribution.LINK_EXTENDED_CONTRIBUTION_ID as the link type id
- select the one that corresponds to your custom build object, since there may be more than one link (e.g. by matching label on the IBuildResultContribution), or checking for "ftp:" prefix, or both
- you can extract the URL using com.ibm.team.build.common.model.IBuildResultContribution.getExtendedContributionProperty(String), using property name constant com.ibm.team.build.common.model.IBuildResultContribution.PROPERTY_NAME_URL
See also forum thread: https://jazz.net/forum/questions/116496/retrieve-build-log
for the case where the content is uploaded to the jazz repo, not an external reference.
Comments