-
Story
-
Resolution: Fixed
-
Critical
-
-
frank, christmas
In Scope
- Step should show the "waiting for input" indicator.
- Input form should be shown where the log is usually shown.
- When the user clicks "Submit" the form disappears and the log for that step is shown (Note: progress via karaoke should resume at this point)
- User cannot submit the form unless they have filled in all values.
- We will need to show a form validation message if the user tries to submit the form with empty values.
- The confirmation button label is "Continue"
- The button in the header is "Abort" which aborts the run.
- See https://issues.jenkins-ci.org/browse/JENKINS-35899 for details on the visual design of this and screen shots
Before vivek left he was able to merge the first tranche of support for input.
This is described in this closed PR here: https://github.com/jenkinsci/blueocean-plugin/pull/645 (with a sample pipeline, that will return states waiting for input)
Creating the following pipeline and calling it "paused"
node {
stage("parallelStage"){
parallel left : {
echo "running"
def branchInput = input message: 'Please input branch to test against', parameters: [[$class: 'StringParameterDefinition', defaultValue: 'master', description: '', name: 'branch']]
echo "BRANCH NAME: ${branchInput}"
},
right : {
sh 'sleep 100000'
}
}
}
Run it - and then go to the following URL:
http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/paused/runs/1/steps/
And you will see:
{
"_class": "io.jenkins.blueocean.rest.impl.pipeline.PipelineStepImpl",
"_links": {},
"actions": [],
"displayName": "Wait for interactive input",
"durationInMillis": 124735,
"id": "12",
"input": {
"_class": "io.jenkins.blueocean.rest.impl.pipeline.InputStepImpl",
"_links": {
"self": {
"_class": "io.jenkins.blueocean.rest.hal.Link",
"href": "/blue/rest/organizations/jenkins/pipelines/paused/runs/1/steps/12/input/"
}
},
"id": "C51b52435b43a326d5d4f92c290a64d5",
"message": "Please input branch to test against",
"ok": "Proceed",
"parameters": [
{
"_class": "hudson.model.StringParameterDefinition",
"defaultParameterValue": {
"_class": "hudson.model.StringParameterValue",
"name": "branch",
"value": "master"
},
"description": "",
"name": "branch",
"type": "StringParameterDefinition"
}
],
"submitter": null
},
"result": "UNKNOWN",
"startTime": "2016-12-13T15:32:28.343+1100",
"state": "PAUSED"
}
We can come up with more canonical examples of all input types once familiar with the api:
GET /jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/ should report state==PAUSED, result==UNKNOWN
GET /jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/nodes/ should report state==PAUSED, result==UNKNOWN for nodes parallelStage and right.
GET /jenkins/blue/rest/organizations/jenkins/pipelines/pipeline1/runs/1/steps/ should report state==PAUSED, result==UNKNOWN for step id 12
When you drill into a step for a paused node you can see the input required:
Has an input value of:
"input": {
"_class": "io.jenkins.blueocean.rest.impl.pipeline.InputStepImpl",
"_links": {
"self": {
"_class": "io.jenkins.blueocean.rest.hal.Link",
"href": "/blue/rest/organizations/jenkins/pipelines/paused/runs/1/nodes/6/steps/12/input/"
}
},
"id": "C51b52435b43a326d5d4f92c290a64d5",
"message": "Please input branch to test against",
"ok": "Proceed",
"parameters": [
{
"_class": "hudson.model.StringParameterDefinition",
"defaultParameterValue": {
"_class": "hudson.model.StringParameterValue",
"name": "branch",
"value": "master"
},
"description": "",
"name": "branch",
"type": "StringParameterDefinition"
}
],
"submitter": null
}
which is what the form is rendered from.
- is blocked by
-
-
- Resolved
-
-
-
- Resolved
-
-
JENKINS-39371 Dialog component
-
- Resolved
-
-
-
- Resolved
-
-
-
- Resolved
-
-
-
- Closed
-
- is duplicated by
-
JENKINS-39395 Input cannot be approved on Blue Ocean pipeline UI
-
- Closed
-
[JENKINS-38494] User can see the input form on an input step (UI)
yes you have to have a way to cancel/abort/whatever we call. It halts the run from proceeding. "Abort" is probably fine wording. I think we discussed once that "cancel" was bad wording, as it may imply they are just cancelling the form, not the run. "Continue" is the primary, but the wording can be customised by the author. Lets just leave it as "abort" for now for the secondary, and revisit later to avoid bike-shedding.
michaelneale one observation about the input. In the above input pause the classic UI will display 2 buttons (even if if one is not defined in the above response) 
You find there is only "ok" but no "cancel" should we fix this in the backend for consistency, since I could imagine use cases that have only one button, but we could create a "dummy" cancel button if we have only one button.
current testing pipe:
node {
stage("one"){
input message: 'Another Brother', ok: 'OK-Computer', parameters: [choice(choices: 'die\nby\nmy\nhand', description: '''stirb
durch
meine
hand''', name: 'choose'), booleanParam(defaultValue: false, description: 'aaaa', name: 'boolena')]
}
stage("two"){
def branchInput = input message: 'Please input branch to test against', parameters: [[$class: 'StringParameterDefinition', defaultValue: 'master', description: '', name: 'branch']]
echo "BRANCH NAME: ${branchInput}"
}
}
Input gone wild pipe https://issues.jenkins-ci.org/browse/JENKINS-38494?focusedCommentId=280198&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-280198
tscherler our "Abort" button will be in the header where "stop" and "re-run" usually goes. The "Submit" button should be labeled "Continue".
jamesdumay you are talking about the new design. IMO we should place them correctly when we generally implement the new headers but not in this PR
Just re-read your command. You refer to the dialog where we have the default "cancel" button and the ok which can contain custom caption
tscherler after talking with brody, we think that if there are 5 or less items in a "choice" - use radio button. if there are more than 5, use a drop down.
EDIT: see brody screen shot below.
TODO: brody to confirm colours. Also - no need to add an element for credentials at this stage. Vivek to provide flowNode that can be posted to.
tscherler I had a poke around but didn't find a teal colour in any of the variables.less files on Github.
Either way, they current teal is #24B0D5;
jamesdumay I thought it was required but was confused by Mic's "not continuing does not mean failure necessarily" wording.
So "Continue" is the primary action & there is not secondary?