[JENKINS-72958] expose buildable property on MultiBranchProject to API

[MarkRx]

Exposes the "buildable" field to the REST API indicating if the multi-branch job has been disabled

https://issues.jenkins.io/browse/JENKINS-73425

Testing done

Create a multi-branch pipeline branch. Enable it. Disable it.

http://localhost:8080/jenkins/job/test/job/myprimarybranch/api/xml?tree=property[buildable[*]]

Enabled

<workflowMultiBranchProject _class="org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject">
    <buildable>true</buildable>
</workflowMultiBranchProject>

{
    _class: "org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject",
    buildable: true
}

Disabled

<workflowMultiBranchProject _class="org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject">
    <buildable>false</buildable>
</workflowMultiBranchProject>

{
    _class: "org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject",
    buildable: false
}

Submitter checklist

Beta Give feedback

1. Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
2. Ensure that the pull request title represents the desired changelog entry
3. Please describe what you did
4. Link to relevant issues in GitHub or Jira
5. Link to relevant pull requests, esp. upstream and downstream changes
6. Ensure you have provided tests - that demonstrates feature works or fixes the issue

[MarkRx]

@jglick @strangelookingnerd

[MarkRx]

@basil @jtnord @rsandell someone please review and merge thanks

[jtnord]

I have a feeling this is a bug in Stapler and not this plugin.
The ExportedBean is called out as only needed to be present on the base class and that properties annotated with Exported would be exported.
As the Exported annotation is present on the root of the method definition where the property is defined (not the overriding method) I would expect this to be honored, but https://github.com/jenkinsci/stapler/blob/f3b7f8789e7977a1caec5ba0a293503f00cd89e1/core/src/main/java/org/kohsuke/stapler/export/Model.java#L73-L132 is possibly not doing this (or possibly the annotation processor).

[jtnord]

I am also confused as to why

branch-api-plugin/src/main/java/jenkins/branch/MultiBranchProject.java

Lines 847 to 860 in 46de1e8

	/**
	* {@inheritDoc}
	*/
	@Override
	public String getDisplayName() {
	String displayName = getDisplayNameOrNull();
	if (displayName == null) {
	ObjectMetadataAction action = getAction(ObjectMetadataAction.class);
	if (action != null && StringUtils.isNotBlank(action.getObjectDisplayName())) {
	return action.getObjectDisplayName();
	}
	}
	return super.getDisplayName();
	}

shows up in the API which is not tagged as Exported but overridden...

[jtnord]

I am also confused as to why

branch-api-plugin/src/main/java/jenkins/branch/MultiBranchProject.java

Lines 847 to 860 in 46de1e8

	/**
	* {@inheritDoc}
	*/
	@Override
	public String getDisplayName() {
	String displayName = getDisplayNameOrNull();
	if (displayName == null) {
	ObjectMetadataAction action = getAction(ObjectMetadataAction.class);
	if (action != null && StringUtils.isNotBlank(action.getObjectDisplayName())) {
	return action.getObjectDisplayName();
	}
	}
	return super.getDisplayName();
	}

shows up in the API which is not tagged as Exported but overridden...

Because this is an AbstractItem not a Job (by virtue of extending ComputedFolder) which is not Exported 🤦 AbstractItem does not define isBuildable but does have getDisplayName exported in its class hierachy.

Does it not make sense for all ComputedFolders to expose this rather than just MultiBranch projects?

[jtnord]

@MarkRx jenkinsci/cloudbees-folder-plugin#441 if you would like to try that instead.

[MarkRx]

@jtnord tested works thanks!

http://localhost:8080/jenkins/job/folder1/job/pipeline1/api/json?tree=buildable

Enabled:

{
    _class: "org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject",
    buildable: true
}

Disabled:

{
    _class: "org.jenkinsci.plugins.workflow.multibranch.WorkflowMultiBranchProject",
    buildable: false
}

Note child jobs will have buildable=true even if the parent is disabled (buildable=false). The buildable property doesn't propagate so the parent job needs to be checked. This is existing behavior and unrelated to exposing the buildable property.

[jtnord]

Closed as jenkinsci/cloudbees-folder-plugin#441 merged instead