Uploaded image for project: 'Jenkins'
  1. Jenkins
  2. JENKINS-38494

User can see the input form on an input step (UI)

    • 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:

      eg:
      http://localhost:8080/jenkins/blue/rest/organizations/jenkins/pipelines/paused/runs/1/nodes/6/steps/12/

      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.

          [JENKINS-38494] User can see the input form on an input step (UI)

          James Dumay created issue -
          James Dumay made changes -
          Epic Link New: JENKINS-38490 [ 174672 ]
          James Dumay made changes -
          Rank New: Ranked higher
          James Dumay made changes -
          Description Original: 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.
          * 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.
          New: 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.
          James Dumay made changes -
          Assignee Original: James Dumay [ jamesdumay ]
          James Dumay made changes -
          Sprint New: next [ 106 ]
          James Dumay made changes -
          Rank New: Ranked lower
          Michael Neale made changes -
          Link New: This issue is blocked by JENKINS-35795 [ JENKINS-35795 ]
          Michael Neale made changes -
          Link New: This issue is blocked by JENKINS-38491 [ JENKINS-38491 ]
          Michael Neale made changes -
          Priority Original: Minor [ 4 ] New: Major [ 3 ]
          Michael Neale made changes -
          Link New: This issue is blocked by JENKINS-35899 [ JENKINS-35899 ]

            tscherler Thorsten Scherler
            jamesdumay James Dumay
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

              Created:
              Updated:
              Resolved: