[JENKINS-41503] JSON Schema issue: mapArgumentValue not accepting null - Jenkins Jira

XML

Word

Printable

Details

Type: Bug
Status: Closed (View Workflow)
Priority: Minor
Resolution: Fixed
Component/s: pipeline-model-definition-plugin
Labels:
None

Similar Issues:

Show

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

links to

PR #122

Activity

Ascending order - Click to sort in descending order

Keith Zantow created issue - 2017-01-27 04:15

Keith Zantow made changes - 2017-01-27 04:15

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}

Keith Zantow made changes - 2017-01-27 04:16

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}

Andrew Bayer made changes - 2017-02-22 21:40

Status

Open [ 1 ]

In Progress [ 3 ]

Andrew Bayer made changes - 2017-02-22 21:40

Status

In Progress [ 3 ]

In Review [ 10005 ]

Andrew Bayer added a comment - 2017-02-22 21:40

PR up at https://github.com/jenkinsci/pipeline-model-definition-plugin/pull/122

Andrew Bayer added a comment - 2017-02-22 21:40 PR up at https://github.com/jenkinsci/pipeline-model-definition-plugin/pull/122

Andrew Bayer made changes - 2017-02-22 21:40

Remote Link

This issue links to "PR #122 (Web Link)" [ 15481 ]

SCM/JIRA link daemon added a comment - 2017-02-23 20:01

Code changed in jenkins
User: Andrew Bayer
Path:
pipeline-model-api/src/main/resources/ast-schema.json
pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/parser/Converter.groovy
pipeline-model-definition/src/test/java/org/jenkinsci/plugins/pipeline/modeldefinition/AbstractModelDefTest.java
pipeline-model-definition/src/test/resources/json/jsonSchemaNull.json
pipeline-model-definition/src/test/resources/jsonSchemaNull.groovy
http://jenkins-ci.org/commit/pipeline-model-definition-plugin/6e518e32c311d5f80458a1911cbbea6b4da87783
Log:
[FIXED JENKINS-41503] Allow null values in JSON

Also required changing org.json -> Jackson conversion to go through a
string rather than use a mapper due to the mapper not liking nulls at
all.

SCM/JIRA link daemon added a comment - 2017-02-23 20:01 Code changed in jenkins User: Andrew Bayer Path: pipeline-model-api/src/main/resources/ast-schema.json pipeline-model-definition/src/main/groovy/org/jenkinsci/plugins/pipeline/modeldefinition/parser/Converter.groovy pipeline-model-definition/src/test/java/org/jenkinsci/plugins/pipeline/modeldefinition/AbstractModelDefTest.java pipeline-model-definition/src/test/resources/json/jsonSchemaNull.json pipeline-model-definition/src/test/resources/jsonSchemaNull.groovy http://jenkins-ci.org/commit/pipeline-model-definition-plugin/6e518e32c311d5f80458a1911cbbea6b4da87783 Log: [FIXED JENKINS-41503] Allow null values in JSON Also required changing org.json -> Jackson conversion to go through a string rather than use a mapper due to the mapper not liking nulls at all.

Andrew Bayer made changes - 2017-02-24 18:31

Resolution		Fixed [ 1 ]
Status	In Review [ 10005 ]	Resolved [ 5 ]

Liam Newman added a comment - 2019-10-23 03:21

Bulk closing resolved issues.

Liam Newman added a comment - 2019-10-23 03:21 Bulk closing resolved issues.

Liam Newman made changes - 2019-10-23 03:21

Status

Resolved [ 5 ]

Closed [ 6 ]

People

Assignee:: Andrew Bayer

Reporter:: Keith Zantow

Votes:: 0 Vote for this issue

Watchers:: 4 Start watching this issue

Dates

Created:: 2017-01-27 04:15

Updated:: 2019-10-23 03:21

Resolved:: 2017-02-24 18:31