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

JSON Schema issue: mapArgumentValue not accepting null

    XMLWordPrintable

Details

    Description

      Arguments with

      { isLiteral: true, "value": null }

      fail schema validation.

      I think this needs to allow null values: https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-api/src/main/resources/ast-schema.json#L50 or alternately, don't include those args in the JSON during conversion? Not sure if they are necessarily equivalent.

      Took this valid pipeline:

      pipeline {
          agent {
              docker {
                  image "httpd:2.4.12"
                  args null
              }
          }
          stages {
              stage("foo") {
                  steps {
                      sh 'cat /usr/local/apache2/conf/extra/httpd-userdir.conf'
                      sh 'echo "The answer is 42"'
                  }
              }
          }
      }
      

      which converts to the corresponding JSON, that no longer passes schema validation due to agent docker args null value:

      {
          "pipeline": {
              "agent": {
                  "type": "docker",
                  "arguments": [
                      {
                          "key": "image",
                          "value": {
                              "isLiteral": true,
                              "value": "httpd:2.4.12"
                          }
                      },
                      {
                          "key": "args",
                          "value": {
                              "isLiteral": true,
                              "value": null
                          }
                      }
                  ]
              },
              "stages": [
                  {
                      "name": "foo",
                      "branches": [
                          {
                              "name": "default",
                              "steps": [
                                  {
                                      "name": "sh",
                                      "arguments": [
                                          {
                                              "key": "script",
                                              "value": {
                                                  "isLiteral": true,
                                                  "value": "cat /usr/local/apache2/conf/extra/httpd-userdir.conf"
                                              }
                                          }
                                      ]
                                  },
                                  {
                                      "name": "sh",
                                      "arguments": [
                                          {
                                              "key": "script",
                                              "value": {
                                                  "isLiteral": true,
                                                  "value": "echo \"The answer is 42\""
                                              }
                                          }
                                      ]
                                  }
                              ]
                          }
                      ]
                  }
              ]
          }
      }
      

      Attachments

        Issue Links

          Activity

            kzantow Keith Zantow created issue -
            kzantow Keith Zantow made changes -
            Field Original Value New Value
            Description Arguments with _{ isLiteral: true, "value": null }_ fail schema validation.

            I think this needs to allow null values: https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-api/src/main/resources/ast-schema.json#L50

            Took this valid pipeline:

            {code}
            pipeline {
                agent {
                    docker {
                        image "httpd:2.4.12"
                        args null
                    }
                }
                stages {
                    stage("foo") {
                        steps {
                            sh 'cat /usr/local/apache2/conf/extra/httpd-userdir.conf'
                            sh 'echo "The answer is 42"'
                        }
                    }
                }
            }
            {code}

            which converts to the corresponding JSON, that no longer passes schema validation due to agent docker args null value:

            {code}
            {
                "pipeline": {
                    "agent": {
                        "type": "docker",
                        "arguments": [
                            {
                                "key": "image",
                                "value": {
                                    "isLiteral": true,
                                    "value": "httpd:2.4.12"
                                }
                            },
                            {
                                "key": "args",
                                "value": {
                                    "isLiteral": true,
                                    "value": null
                                }
                            }
                        ]
                    },
                    "stages": [
                        {
                            "name": "foo",
                            "branches": [
                                {
                                    "name": "default",
                                    "steps": [
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "cat /usr/local/apache2/conf/extra/httpd-userdir.conf"
                                                    }
                                                }
                                            ]
                                        },
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "echo \"The answer is 42\""
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
            {code}
            Arguments with { isLiteral: true, "value": null } fail schema validation.

            I think this needs to allow null values: https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-api/src/main/resources/ast-schema.json#L50

            Took this valid pipeline:

            {code}
            pipeline {
                agent {
                    docker {
                        image "httpd:2.4.12"
                        args null
                    }
                }
                stages {
                    stage("foo") {
                        steps {
                            sh 'cat /usr/local/apache2/conf/extra/httpd-userdir.conf'
                            sh 'echo "The answer is 42"'
                        }
                    }
                }
            }
            {code}

            which converts to the corresponding JSON, that no longer passes schema validation due to agent docker args null value:

            {code}
            {
                "pipeline": {
                    "agent": {
                        "type": "docker",
                        "arguments": [
                            {
                                "key": "image",
                                "value": {
                                    "isLiteral": true,
                                    "value": "httpd:2.4.12"
                                }
                            },
                            {
                                "key": "args",
                                "value": {
                                    "isLiteral": true,
                                    "value": null
                                }
                            }
                        ]
                    },
                    "stages": [
                        {
                            "name": "foo",
                            "branches": [
                                {
                                    "name": "default",
                                    "steps": [
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "cat /usr/local/apache2/conf/extra/httpd-userdir.conf"
                                                    }
                                                }
                                            ]
                                        },
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "echo \"The answer is 42\""
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
            {code}
            kzantow Keith Zantow made changes -
            Description Arguments with { isLiteral: true, "value": null } fail schema validation.

            I think this needs to allow null values: https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-api/src/main/resources/ast-schema.json#L50

            Took this valid pipeline:

            {code}
            pipeline {
                agent {
                    docker {
                        image "httpd:2.4.12"
                        args null
                    }
                }
                stages {
                    stage("foo") {
                        steps {
                            sh 'cat /usr/local/apache2/conf/extra/httpd-userdir.conf'
                            sh 'echo "The answer is 42"'
                        }
                    }
                }
            }
            {code}

            which converts to the corresponding JSON, that no longer passes schema validation due to agent docker args null value:

            {code}
            {
                "pipeline": {
                    "agent": {
                        "type": "docker",
                        "arguments": [
                            {
                                "key": "image",
                                "value": {
                                    "isLiteral": true,
                                    "value": "httpd:2.4.12"
                                }
                            },
                            {
                                "key": "args",
                                "value": {
                                    "isLiteral": true,
                                    "value": null
                                }
                            }
                        ]
                    },
                    "stages": [
                        {
                            "name": "foo",
                            "branches": [
                                {
                                    "name": "default",
                                    "steps": [
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "cat /usr/local/apache2/conf/extra/httpd-userdir.conf"
                                                    }
                                                }
                                            ]
                                        },
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "echo \"The answer is 42\""
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
            {code}
            Arguments with { isLiteral: true, "value": null } fail schema validation.

            I think this needs to allow null values: https://github.com/jenkinsci/pipeline-model-definition-plugin/blob/master/pipeline-model-api/src/main/resources/ast-schema.json#L50 or alternately, don't include those args in the JSON during conversion? Not sure if they are necessarily equivalent.

            Took this valid pipeline:

            {code}
            pipeline {
                agent {
                    docker {
                        image "httpd:2.4.12"
                        args null
                    }
                }
                stages {
                    stage("foo") {
                        steps {
                            sh 'cat /usr/local/apache2/conf/extra/httpd-userdir.conf'
                            sh 'echo "The answer is 42"'
                        }
                    }
                }
            }
            {code}

            which converts to the corresponding JSON, that no longer passes schema validation due to agent docker args null value:

            {code}
            {
                "pipeline": {
                    "agent": {
                        "type": "docker",
                        "arguments": [
                            {
                                "key": "image",
                                "value": {
                                    "isLiteral": true,
                                    "value": "httpd:2.4.12"
                                }
                            },
                            {
                                "key": "args",
                                "value": {
                                    "isLiteral": true,
                                    "value": null
                                }
                            }
                        ]
                    },
                    "stages": [
                        {
                            "name": "foo",
                            "branches": [
                                {
                                    "name": "default",
                                    "steps": [
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "cat /usr/local/apache2/conf/extra/httpd-userdir.conf"
                                                    }
                                                }
                                            ]
                                        },
                                        {
                                            "name": "sh",
                                            "arguments": [
                                                {
                                                    "key": "script",
                                                    "value": {
                                                        "isLiteral": true,
                                                        "value": "echo \"The answer is 42\""
                                                    }
                                                }
                                            ]
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
            {code}
            abayer Andrew Bayer made changes -
            Status Open [ 1 ] In Progress [ 3 ]
            abayer Andrew Bayer made changes -
            Status In Progress [ 3 ] In Review [ 10005 ]
            abayer Andrew Bayer made changes -
            Remote Link This issue links to "PR #122 (Web Link)" [ 15481 ]
            abayer Andrew Bayer made changes -
            Resolution Fixed [ 1 ]
            Status In Review [ 10005 ] Resolved [ 5 ]
            bitwiseman Liam Newman made changes -
            Status Resolved [ 5 ] Closed [ 6 ]

            People

              abayer Andrew Bayer
              kzantow Keith Zantow
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: