jjb/jenkins-job-builder
Code Issues Proposed changes

Add tags: '!include-raw-verbatim:' and '!include-raw-expand:'

Browse Source 
Use '!include-raw-expand:' instead of '!include-raw:'
and '!include-raw-verbatim:' instead of '!include-raw-escape:'.
Tags '!include-raw:' and '!include-raw-escape:' are now deprecated.

Change-Id: I3cc5ab9f73d03de1ba09cbc4568366a3bb464a08
This commit is contained in:
Vsevolod Fedorov 2024-02-06 11:49:10 +03:00
parent 3cf741985f
commit 36b9d8bfca
76 changed files with 296 additions and 202 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
jenkins_jobs/expander.py
View File

@ -23,8 +23,8 @@ from .yaml_objects import (
YamlInclude,
YamlListJoin,
IncludeJinja2,
IncludeRaw,
IncludeRawEscape,
IncludeRawExpand,
IncludeRawVerbatim,
)
@ -92,14 +92,16 @@ yaml_classes_list = [
YamlInclude,
YamlListJoin,
IncludeJinja2,
IncludeRaw,
IncludeRawEscape,
IncludeRawExpand,
IncludeRawVerbatim,
]
deprecated_yaml_tags = [
("!include", YamlInclude),
("!include-raw", IncludeRaw),
("!include-raw-escape", IncludeRawEscape),
("!include-raw", IncludeRawExpand),
("!include-raw:", IncludeRawExpand),
("!include-raw-escape", IncludeRawVerbatim),
("!include-raw-escape:", IncludeRawVerbatim),
]

28
jenkins_jobs/yaml_objects.py
View File

@ -78,34 +78,34 @@ Example:
.. literalinclude:: /../../tests/loader/fixtures/include001.yaml.inc
The tag ``!include-raw:`` will treat the given string or list of strings as
filenames to be opened as one or more data blob, which should be read into
The tag ``!include-raw-expand:`` will treat the given string or list of strings
as filenames to be opened as one or more data blob, which should be read into
the calling yaml construct without any further parsing. Any data in a file
included through this tag, will be treated as string data.
It will expand variables inside the file. If your file contains curly braces,
you should double them. Or, you can use tag ``!include-raw-escape``, which
you should double them. Or, you can use tag ``!include-raw-verbatim:``, which
does not substitute variables.
Examples:
.. literalinclude::
/../../tests/loader/fixtures/include-raw-escaped001-template.yaml
/../../tests/loader/fixtures/include-raw-verbatim-template.yaml
contents of include-raw001-hello-world.sh:
contents of include-raw-hello-world.sh:
.. literalinclude::
/../../tests/loader/fixtures/include-raw001-hello-world.sh
/../../tests/loader/fixtures/include-raw-hello-world.sh
contents of include-raw001-vars.sh:
contents of include-raw-vars.sh:
.. literalinclude::
/../../tests/loader/fixtures/include-raw001-vars.sh
/../../tests/loader/fixtures/include-raw-vars.sh
using a list of files:
Using a list of files:
.. literalinclude::
/../../tests/loader/fixtures/include-raw-escaped-multi001.yaml
/../../tests/loader/fixtures/include-raw-verbatim-multi-template.yaml
For all the multi file includes, the files are simply appended using a newline
@ -400,8 +400,8 @@ class IncludeRawBase(IncludeBaseObject):
return "\n".join(self._expand_path_list(self._path_list, params))
class IncludeRaw(IncludeRawBase):
yaml_tag = "!include-raw:"
class IncludeRawExpand(IncludeRawBase):
yaml_tag = "!include-raw-expand:"
def _expand_path(self, rel_path_template, pos, params):
rel_path = self._formatter.format(rel_path_template, **params)
@ -413,8 +413,8 @@ class IncludeRaw(IncludeRawBase):
raise x.with_context(f"In included file {str(full_path)!r}", pos=self._pos)
class IncludeRawEscape(IncludeRawBase):
yaml_tag = "!include-raw-escape:"
class IncludeRawVerbatim(IncludeRawBase):
yaml_tag = "!include-raw-verbatim:"
def _expand_path(self, rel_path_template, pos, params):
rel_path = self._formatter.format(rel_path_template, **params)

11
tests/loader/fixtures/include-raw-escaped-multi001.json
View File

@ -1,11 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml include-raw tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n\n#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

14
tests/loader/fixtures/include-raw-escaped001-job.json
View File

@ -1,14 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml include-raw tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n"
},
{
"shell": "#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw"
}
]

8
tests/loader/fixtures/include-raw-escaped001-job.yaml
View File

@ -1,8 +0,0 @@
# Using include-raw-escape inside job works the same way as inside job template.
- job:
name: test-job-include-raw
builders:
- shell:
!include-raw-escape: include-raw001-hello-world.sh
- shell:
!include-raw-escape: include-raw001-vars.sh

14
tests/loader/fixtures/include-raw-escaped001-template.json
View File

@ -1,14 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml include-raw tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n"
},
{
"shell": "#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

11
tests/loader/fixtures/include-raw-expand-template.json Normal file
View File

@ -0,0 +1,11 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# sample script to check that variables are expanded\n# when using the !include-raw-expand: application yaml tag\n\nVAR1=\"1\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

4
tests/loader/fixtures/include-raw001-template.xml → tests/loader/fixtures/include-raw-expand-template.xml
View File

@ -13,8 +13,8 @@
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that variables are expanded
# when using the !include-raw-expand: application yaml tag
VAR1=&quot;1&quot;
VAR2=&quot;world&quot;

2
tests/loader/fixtures/include-raw001-template.yaml → tests/loader/fixtures/include-raw-expand-template.yaml
View File

@ -2,7 +2,7 @@
name: test-job-include-raw-{num}
builders:
- shell:
!include-raw: include-raw001-parameterized.sh
!include-raw-expand: include-raw-parameterized.sh
- project:
name: test-job-template

9
tests/loader/fixtures/include-raw-hello-world.sh Normal file
View File

@ -0,0 +1,9 @@
#!/bin/bash
#
# Sample script showing how the yaml !include-raw-verbatim: tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
echo "hello world"
exit 0

11
tests/loader/fixtures/include-raw-multi001.json
View File

@ -1,11 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml include-raw tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n\n#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

7
tests/loader/fixtures/include-raw-multi001.yaml
View File

@ -1,7 +0,0 @@
- job:
name: test-job-include-raw-1
builders:
- shell:
!include-raw-escape:
- include-raw001-hello-world.sh
- include-raw001-vars.sh

14
tests/loader/fixtures/include-raw-parameterized.sh Normal file
View File

@ -0,0 +1,14 @@
#!/bin/bash
#
# sample script to check that variables are expanded
# when using the !include-raw-expand: application yaml tag
VAR1="{num}"
VAR2="world"
VAR3="${{VAR1}} ${{VAR2}}"
[[ -n "${{VAR3}}" ]] && {{
# this next section is executed as one
echo "${{VAR3}}"
exit 0
}}

14
tests/loader/fixtures/include-raw-vars.sh Normal file
View File

@ -0,0 +1,14 @@
#!/bin/bash
#
# sample script to check that variables aren't expanded
# when using the !include-raw-verbatim: application yaml tag
VAR1="hello"
VAR2="world"
VAR3="${VAR1} ${VAR2}"
[[ -n "${VAR3}" ]] && {
# this next section is executed as one
echo "${VAR3}"
exit 0
}

14
tests/loader/fixtures/include-raw-verbatim-job.json Normal file
View File

@ -0,0 +1,14 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml !include-raw-verbatim: tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n"
},
{
"shell": "#!/bin/bash\n#\n# sample script to check that variables aren't expanded\n# when using the !include-raw-verbatim: application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-include-raw-verbatim-job"
}
]

6
tests/loader/fixtures/include-raw-escaped001-template.xml → tests/loader/fixtures/include-raw-verbatim-job.xml
View File

@ -13,7 +13,7 @@
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# Sample script showing how the yaml include-raw tag can be used
# Sample script showing how the yaml !include-raw-verbatim: tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
@ -25,8 +25,8 @@ exit 0
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that variables aren't expanded
# when using the !include-raw-verbatim: application yaml tag
VAR1=&quot;hello&quot;
VAR2=&quot;world&quot;

8
tests/loader/fixtures/include-raw-verbatim-job.yaml Normal file
View File

@ -0,0 +1,8 @@
# Using !include-raw-verbatim: inside job works the same way as inside job template.
- job:
name: test-include-raw-verbatim-job
builders:
- shell:
!include-raw-verbatim: include-raw-hello-world.sh
- shell:
!include-raw-verbatim: include-raw-vars.sh

11
tests/loader/fixtures/include-raw-verbatim-multi-job.json Normal file
View File

@ -0,0 +1,11 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml !include-raw-verbatim: tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n\n#!/bin/bash\n#\n# sample script to check that variables aren't expanded\n# when using the !include-raw-verbatim: application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-verbatim-multi-001"
}
]

6
tests/loader/fixtures/include-raw-escaped-multi001.xml → tests/loader/fixtures/include-raw-verbatim-multi-job.xml
View File

@ -13,7 +13,7 @@
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# Sample script showing how the yaml include-raw tag can be used
# Sample script showing how the yaml !include-raw-verbatim: tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
@ -23,8 +23,8 @@ exit 0
#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that variables aren't expanded
# when using the !include-raw-verbatim: application yaml tag
VAR1=&quot;hello&quot;
VAR2=&quot;world&quot;

7
tests/loader/fixtures/include-raw-verbatim-multi-job.yaml Normal file
View File

@ -0,0 +1,7 @@
- job:
name: test-job-include-raw-verbatim-multi-001
builders:
- shell:
!include-raw-verbatim:
- include-raw-hello-world.sh
- include-raw-vars.sh

11
tests/loader/fixtures/include-raw-verbatim-multi-template.json Normal file
View File

@ -0,0 +1,11 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml !include-raw-verbatim: tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n\n#!/bin/bash\n#\n# sample script to check that variables aren't expanded\n# when using the !include-raw-verbatim: application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

6
tests/loader/fixtures/include-raw-multi001.xml → tests/loader/fixtures/include-raw-verbatim-multi-template.xml
View File

@ -13,7 +13,7 @@
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# Sample script showing how the yaml include-raw tag can be used
# Sample script showing how the yaml !include-raw-verbatim: tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
@ -23,8 +23,8 @@ exit 0
#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that variables aren't expanded
# when using the !include-raw-verbatim: application yaml tag
VAR1=&quot;hello&quot;
VAR2=&quot;world&quot;

6
tests/loader/fixtures/include-raw-escaped-multi001.yaml → tests/loader/fixtures/include-raw-verbatim-multi-template.yaml
View File

@ -2,9 +2,9 @@
name: test-job-include-raw-{num}
builders:
- shell:
!include-raw-escape:
- include-raw001-hello-world.sh
- include-raw001-vars.sh
!include-raw-verbatim:
- include-raw-hello-world.sh
- include-raw-vars.sh
- project:
name: test-job-template-1

14
tests/loader/fixtures/include-raw-verbatim-template.json Normal file
View File

@ -0,0 +1,14 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml !include-raw-verbatim: tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n"
},
{
"shell": "#!/bin/bash\n#\n# sample script to check that variables aren't expanded\n# when using the !include-raw-verbatim: application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-include-raw-verbatim-job-1"
}
]

45
tests/loader/fixtures/include-raw-verbatim-template.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<project>
<actions/>
<description>&lt;!-- Managed by Jenkins Job Builder --&gt;</description>
<keepDependencies>false</keepDependencies>
<blockBuildWhenDownstreamBuilding>false</blockBuildWhenDownstreamBuilding>
<blockBuildWhenUpstreamBuilding>false</blockBuildWhenUpstreamBuilding>
<concurrentBuild>false</concurrentBuild>
<canRoam>true</canRoam>
<properties/>
<scm class="hudson.scm.NullSCM"/>
<builders>
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# Sample script showing how the yaml !include-raw-verbatim: tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
echo &quot;hello world&quot;
exit 0
</command>
</hudson.tasks.Shell>
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# sample script to check that variables aren't expanded
# when using the !include-raw-verbatim: application yaml tag
VAR1=&quot;hello&quot;
VAR2=&quot;world&quot;
VAR3=&quot;${VAR1} ${VAR2}&quot;
[[ -n &quot;${VAR3}&quot; ]] &amp;&amp; {
# this next section is executed as one
echo &quot;${VAR3}&quot;
exit 0
}
</command>
</hudson.tasks.Shell>
</builders>
<publishers/>
<buildWrappers/>
</project>

13
tests/loader/fixtures/include-raw-verbatim-template.yaml Normal file
View File

@ -0,0 +1,13 @@
- job-template:
name: test-include-raw-verbatim-job-{num}
builders:
- shell:
!include-raw-verbatim: include-raw-hello-world.sh
- shell:
!include-raw-verbatim: include-raw-vars.sh
- project:
name: test-job-template-1
num: 1
jobs:
- 'test-include-raw-verbatim-job-{num}'

14
tests/loader/fixtures/include-raw001-job.json
View File

@ -1,14 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# Sample script showing how the yaml include-raw tag can be used\n# to inline scripts that are maintained outside of the jenkins\n# job yaml configuration.\n\necho \"hello world\"\n\nexit 0\n"
},
{
"shell": "#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"hello\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

7
tests/loader/fixtures/include-raw001-job.yaml
View File

@ -1,7 +0,0 @@
- job:
name: test-job-include-raw-1
builders:
- shell:
!include-raw-escape: include-raw001-hello-world.sh
- shell:
!include-raw-escape: include-raw001-vars.sh

11
tests/loader/fixtures/include-raw001-template.json
View File

@ -1,11 +0,0 @@
[
{
"builders": [
{
"shell": "#!/bin/bash\n#\n# sample script to check that brackets aren't escaped\n# when using the include-raw application yaml tag\n\nVAR1=\"1\"\nVAR2=\"world\"\nVAR3=\"${VAR1} ${VAR2}\"\n\n[[ -n \"${VAR3}\" ]] && {\n # this next section is executed as one\n echo \"${VAR3}\"\n exit 0\n}\n"
}
],
"description": "<!-- Managed by Jenkins Job Builder -->",
"name": "test-job-include-raw-1"
}
]

9
tests/yamlparser/error_fixtures/include_raw_escape_missing_path.error
View File

@ -1,9 +0,0 @@
include_raw_escape_missing_path.yaml:7:3: In project 'sample-project'
- project:
^
include_raw_escape_missing_path.yaml:1:3: In job template 'sample-job'
- job-template:
^
include_raw_escape_missing_path.yaml:5:11: File missing-file.sh does not exist in any of include directories: .,fixtures-dir
!include-raw-escape: missing-file.sh
^

9
tests/yamlparser/error_fixtures/include_raw_expand_missing_path.error Normal file
View File

@ -0,0 +1,9 @@
include_raw_expand_missing_path.yaml:7:3: In project 'sample-project'
- project:
^
include_raw_expand_missing_path.yaml:1:3: In job template 'sample-job'
- job-template:
^
include_raw_expand_missing_path.yaml:5:11: File missing-file.sh does not exist in any of include directories: .,fixtures-dir
!include-raw-expand: missing-file.sh
^

2
tests/yamlparser/error_fixtures/include_raw_missing_path.yaml → tests/yamlparser/error_fixtures/include_raw_expand_missing_path.yaml
View File

@ -2,7 +2,7 @@
name: sample-job
builders:
- shell:
!include-raw: missing-file.sh
!include-raw-expand: missing-file.sh
- project:
name: sample-project

9
tests/yamlparser/error_fixtures/include_raw_missing_path.error
View File

@ -1,9 +0,0 @@
include_raw_missing_path.yaml:7:3: In project 'sample-project'
- project:
^
include_raw_missing_path.yaml:1:3: In job template 'sample-job'
- job-template:
^
include_raw_missing_path.yaml:5:11: File missing-file.sh does not exist in any of include directories: .,fixtures-dir
!include-raw: missing-file.sh
^

9
tests/yamlparser/error_fixtures/include_raw_verbatim_missing_path.error Normal file
View File

@ -0,0 +1,9 @@
include_raw_verbatim_missing_path.yaml:7:3: In project 'sample-project'
- project:
^
include_raw_verbatim_missing_path.yaml:1:3: In job template 'sample-job'
- job-template:
^
include_raw_verbatim_missing_path.yaml:5:11: File missing-file.sh does not exist in any of include directories: .,fixtures-dir
!include-raw-verbatim: missing-file.sh
^

2
tests/yamlparser/error_fixtures/include_raw_escape_missing_path.yaml → tests/yamlparser/error_fixtures/include_raw_verbatim_missing_path.yaml
View File

@ -2,7 +2,7 @@
name: sample-job
builders:
- shell:
!include-raw-escape: missing-file.sh
!include-raw-verbatim: missing-file.sh
- project:
name: sample-project

10
tests/yamlparser/error_fixtures/missing_param_in_include_raw.error
View File

@ -1,10 +0,0 @@
missing_param_in_include_raw.yaml:6:3: In project 'sample-project'
- project:
^
missing_param_in_include_raw.yaml:1:3: In job template 'sample-job'
- job-template:
^
missing_param_in_include_raw.yaml:4:16: In included file 'missing_param_in_include_raw.inc'
- shell: !include-raw: missing_param_in_include_raw.inc
^
While formatting string '#!/bin/bash\necho "This one is {missing}!"\n...': Missing parameter: 'missing'

10
tests/yamlparser/error_fixtures/missing_param_in_include_raw_expand.error Normal file
View File

@ -0,0 +1,10 @@
missing_param_in_include_raw_expand.yaml:6:3: In project 'sample-project'
- project:
^
missing_param_in_include_raw_expand.yaml:1:3: In job template 'sample-job'
- job-template:
^
missing_param_in_include_raw_expand.yaml:4:16: In included file 'missing_param_in_include_raw_expand.inc'
- shell: !include-raw-expand: missing_param_in_include ...
^
While formatting string '#!/bin/bash\necho "This one is {missing}!"\n...': Missing parameter: 'missing'

0
tests/yamlparser/error_fixtures/missing_param_in_include_raw.inc → tests/yamlparser/error_fixtures/missing_param_in_include_raw_expand.inc
View File

2
tests/yamlparser/error_fixtures/missing_param_in_include_raw.yaml → tests/yamlparser/error_fixtures/missing_param_in_include_raw_expand.yaml
View File

@ -1,7 +1,7 @@
- job-template:
name: sample-job
builders:
- shell: !include-raw: missing_param_in_include_raw.inc
- shell: !include-raw-expand: missing_param_in_include_raw_expand.inc
- project:
name: sample-project

2
tests/yamlparser/error_fixtures/nested_brace_in_variable.yaml
View File

@ -1,5 +1,5 @@
# Check braces inside variable does not cause parser to fail.
# This may happen when tag !include-raw: is used instead of !include-raw-escape:
# This may happen when tag !include-raw-expand: is used instead of !include-raw-verbatim:
# and there are nested blocks of groovy code inside included file.
- job-template:

9
tests/yamlparser/job_fixtures/deprecated-include-raw-escaped002.hello-world.sh Normal file
View File

@ -0,0 +1,9 @@
#!/bin/bash
#
# Sample script showing how the yaml include-raw-escape tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
echo "hello world"
exit 0

4
tests/loader/fixtures/include-raw001-vars.sh → tests/yamlparser/job_fixtures/deprecated-include-raw-escaped002.vars.sh
View File

@ -1,7 +1,7 @@
#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that brackets aren't expanded
# when using the include-raw-escape application yaml tag
VAR1="hello"
VAR2="world"

6
tests/loader/fixtures/include-raw001-job.xml → tests/yamlparser/job_fixtures/deprecated-include-raw-escaped002.xml
View File

@ -13,7 +13,7 @@
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# Sample script showing how the yaml include-raw tag can be used
# Sample script showing how the yaml include-raw-escape tag can be used
# to inline scripts that are maintained outside of the jenkins
# job yaml configuration.
@ -25,8 +25,8 @@ exit 0
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# sample script to check that brackets aren't escaped
# when using the include-raw application yaml tag
# sample script to check that brackets aren't expanded
# when using the include-raw-escape application yaml tag
VAR1=&quot;hello&quot;
VAR2=&quot;world&quot;

4
tests/loader/fixtures/include-raw-escaped001-template.yaml → tests/yamlparser/job_fixtures/deprecated-include-raw-escaped002.yaml
View File

@ -2,9 +2,9 @@
name: test-job-include-raw-{num}
builders:
- shell:
!include-raw-escape: include-raw001-hello-world.sh
!include-raw-escape: deprecated-include-raw-escaped002.hello-world.sh
- shell:
!include-raw-escape: include-raw001-vars.sh
!include-raw-escape: deprecated-include-raw-escaped002.vars.sh
- project:
name: test-job-template-1

0
tests/loader/fixtures/include-raw001-hello-world.sh → tests/yamlparser/job_fixtures/deprecated-include-raw002.hello-world.sh
View File

4
tests/loader/fixtures/include-raw001-parameterized.sh → tests/yamlparser/job_fixtures/deprecated-include-raw002.vars.sh
View File

@ -1,9 +1,9 @@
#!/bin/bash
#
# sample script to check that brackets aren't escaped
# sample script to check that brackets aren't expanded
# when using the include-raw application yaml tag
VAR1="{num}"
VAR1="hello"
VAR2="world"
VAR3="${{VAR1}} ${{VAR2}}"

2
tests/loader/fixtures/include-raw-escaped001-job.xml → tests/yamlparser/job_fixtures/deprecated-include-raw002.xml
View File

@ -25,7 +25,7 @@ exit 0
<hudson.tasks.Shell>
<command>#!/bin/bash
#
# sample script to check that brackets aren't escaped
# sample script to check that brackets aren't expanded
# when using the include-raw application yaml tag
VAR1=&quot;hello&quot;

7
tests/yamlparser/job_fixtures/deprecated-include-raw002.yaml Normal file
View File

@ -0,0 +1,7 @@
- job:
name: test-job-include-raw-1
builders:
- shell:
!include-raw: deprecated-include-raw002.hello-world.sh
- shell:
!include-raw: deprecated-include-raw002.vars.sh

2
tests/yamlparser/job_fixtures/include-raw-expand-cool.sh Normal file
View File

@ -0,0 +1,2 @@
#!/bin/bash
echo "Doing somethiung cool"

0
tests/yamlparser/job_fixtures/include-raw002-cool.zsh → tests/yamlparser/job_fixtures/include-raw-expand-cool.zsh
View File

0
tests/yamlparser/job_fixtures/include-rawunicode001-cool.sh → tests/yamlparser/job_fixtures/include-raw-expand-unicode-cool.sh
View File

0
tests/yamlparser/job_fixtures/include-rawunicode001.xml → tests/yamlparser/job_fixtures/include-raw-expand-unicode.xml
View File

2
tests/yamlparser/job_fixtures/include-rawunicode001.yaml → tests/yamlparser/job_fixtures/include-raw-expand-unicode.yaml
View File

@ -4,7 +4,7 @@
- pre-scm-buildstep:
buildsteps:
- shell:
!include-raw: include-rawunicode001-cool.sh
!include-raw-expand: include-raw-expand-unicode-cool.sh
- job:
name: test-unicode-raw-include-wrapper

0
tests/yamlparser/job_fixtures/include-raw001.xml → tests/yamlparser/job_fixtures/include-raw-expand.xml
View File

4
tests/yamlparser/job_fixtures/include-raw001.yaml → tests/yamlparser/job_fixtures/include-raw-expand.yaml
View File

@ -14,9 +14,9 @@
- pre-scm-buildstep:
buildsteps:
- shell:
!include-raw: include-raw002-cool.sh
!include-raw-expand: include-raw-expand-cool.sh
- shell:
!include-raw: include-raw002-cool.zsh
!include-raw-expand: include-raw-expand-cool.zsh
- ant:
targets: "target1 target2"
ant-name: "Standard Ant"

2
tests/yamlparser/job_fixtures/include-raw-escape001-echo-vars.sh → tests/yamlparser/job_fixtures/include-raw-verbatim-echo-vars.sh
View File

@ -1,7 +1,7 @@
#!/bin/bash
#
# test script containing some variables to show how you can include scripts
# into job template definitions provided you use the include-raw-escaped tag
# into job template definitions provided you use the !include-raw-verbatim: tag
MSG="hello world"

0
tests/yamlparser/job_fixtures/include-raw-escape001.conf → tests/yamlparser/job_fixtures/include-raw-verbatim.conf
View File

2
tests/yamlparser/job_fixtures/include-raw-escape001.xml → tests/yamlparser/job_fixtures/include-raw-verbatim.xml
View File

@ -30,7 +30,7 @@
<command>#!/bin/bash
#
# test script containing some variables to show how you can include scripts
# into job template definitions provided you use the include-raw-escaped tag
# into job template definitions provided you use the !include-raw-verbatim: tag
MSG=&quot;hello world&quot;

2
tests/yamlparser/job_fixtures/include-raw-escape001.yaml → tests/yamlparser/job_fixtures/include-raw-verbatim.yaml
View File

@ -11,7 +11,7 @@
keep-system-variables: true
builders:
- shell:
!include-raw-escape: include-raw-escape001-echo-vars.sh
!include-raw-verbatim: include-raw-verbatim-echo-vars.sh
- project:

4
tests/yamlparser/job_fixtures/jinja-yaml03.yaml
View File

@ -1,13 +1,13 @@
# the purpose of this test is to check if the piece of YAML generated by
# !j2-yaml is deep-formatted properly; if not then double quotes introduced by
# !include-raw-escape would be left untouched and passed down to the output XML
# !include-raw-verbatim: would be left untouched and passed down to the output XML
# file, which would simply be wrong...
- job-template:
name: 'test-job-template'
publishers: !j2-yaml: |
- groovy-postbuild:
script: !include-raw-escape: ./jinja-yaml03.groovy
script: !include-raw-verbatim: ./jinja-yaml03.groovy
- project:
name: test-project

12
tests/yamlparser/job_fixtures/job-and-macro-expansions.yaml
View File

@ -10,7 +10,7 @@
builders:
- shell: |
echo Should not be expanded: {{param}}
- shell: !include-raw-escape: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw-verbatim: job-and-macro-expansions.yaml.no-expand.inc
- builder:
name: builder-with-params
@ -19,8 +19,8 @@
echo Should not be expanded: {{param}}
- shell: |
echo Should be expanded: {param}
- shell: !include-raw-escape: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw: job-and-macro-expansions.yaml.expand.inc
- shell: !include-raw-verbatim: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw-expand: job-and-macro-expansions.yaml.expand.inc
- job:
name: sample-job
@ -28,7 +28,7 @@
builders:
- shell: |
echo Should not be expanded: {{param}}
- shell: !include-raw-escape: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw-verbatim: job-and-macro-expansions.yaml.no-expand.inc
- job-template:
name: sample-job-template
@ -41,8 +41,8 @@
echo Should not be expanded: {{param}}
- shell: |
echo Should be expanded: {param}
- shell: !include-raw-escape: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw: job-and-macro-expansions.yaml.expand.inc
- shell: !include-raw-verbatim: job-and-macro-expansions.yaml.no-expand.inc
- shell: !include-raw-expand: job-and-macro-expansions.yaml.expand.inc
- project:
name: sample-project

2
tests/yamlparser/job_fixtures/lazy-load-jobs-multi001.yaml
View File

@ -15,6 +15,6 @@
!include: lazy-load-wrappers-{version}.yaml.inc
builders:
- shell:
!include-raw-escape:
!include-raw-verbatim:
- lazy-load-scripts/echo_vars_{version}.sh
- include-raw{num}-cool.sh

2
tests/yamlparser/job_fixtures/lazy-load-jobs-multi002.yaml
View File

@ -2,7 +2,7 @@
name: "test-job-{job_name}"
builders:
- shell:
!include-raw-escape: 'lazy-load-scripts/echo_vars_{job_name}.sh'
!include-raw-verbatim: 'lazy-load-scripts/echo_vars_{job_name}.sh'
- project:
name: 'test-project'

2
tests/yamlparser/job_fixtures/lazy-load-jobs001.yaml
View File

@ -14,4 +14,4 @@
!include: lazy-load-wrappers-{version}.yaml.inc
builders:
- shell:
!include-raw-escape: echo_vars_{version}.sh
!include-raw-verbatim: echo_vars_{version}.sh

2
tests/yamlparser/job_fixtures/lazy-load-jobs002.yaml
View File

@ -20,4 +20,4 @@
!include lazy-load-wrappers-{version}.yaml.inc
builders:
- shell:
!include-raw-escape: lazy-load-scripts/echo_vars_{version}.sh
!include-raw-verbatim: lazy-load-scripts/echo_vars_{version}.sh

2
tests/yamlparser/job_fixtures/lazy-load-with-variables.yaml
View File

@ -5,7 +5,7 @@
name: 'sample-job-{version}'
builders:
- shell:
!include-raw: lazy-load-scripts/subst_vars_{version}.sh
!include-raw-expand: lazy-load-scripts/subst_vars_{version}.sh
- project:
name: sample-project

2
tests/yamlparser/job_fixtures/regression-2006254.yaml
View File

@ -25,7 +25,7 @@
- timed: "H 14 * * *"
builders:
- shell: !include-raw-escape: regression-2006254.inc
- shell: !include-raw-verbatim: regression-2006254.inc
parameters:
- bool:

4
tests/yamlparser/job_fixtures/regression-2007227.yaml
View File

@ -1,10 +1,10 @@
# https://storyboard.openstack.org/#!/story/2007227
# with Python 3 there is TypeError when include-raw with property replacement is used in defaults
# with Python 3 there is TypeError when !include-raw-expand: with property replacement is used in defaults
- defaults:
name: 'test-defaults'
prop: 'regression-2007227.description'
description: !include-raw:
description: !include-raw-expand:
- '{prop}.html'
- project:

2
tests/yamlparser/job_fixtures/regression-2010711/job_1/job_1.yaml
View File

@ -5,7 +5,7 @@
name: sample-job-1
description: sample-job-1
builders:
- shell: !include-raw-escape: sample_file.sh
- shell: !include-raw-verbatim: sample_file.sh
- project:
name: sample-project-1

2
tests/yamlparser/job_fixtures/regression-2010711/job_2/job_2.yaml
View File

@ -5,7 +5,7 @@
name: sample-job-2
description: sample-job-2
builders:
- shell: !include-raw-escape: sample_file.sh
- shell: !include-raw-verbatim: sample_file.sh
- project:
name: sample-project-2

0
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-escape.inc.txt → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-expand.inc.txt
View File

0
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-escape.xml → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-expand.xml
View File

4
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-escape.yaml → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-expand.yaml
View File

@ -1,8 +1,8 @@
# !include-raw-escape: tag in a variable.
# !include-raw-expand: tag in a variable.
- job-template:
name: sample-job
var: !include-raw-escape: tag_in_parameter-include-raw-escape.inc.txt
var: !include-raw-expand: tag_in_parameter-include-raw-expand.inc.txt
builders:
- shell: |
echo {var}

0
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw.inc.txt → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-verbatim.inc.txt
View File

0
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw.xml → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-verbatim.xml
View File

4
tests/yamlparser/job_fixtures/tag_in_parameter-include-raw.yaml → tests/yamlparser/job_fixtures/tag_in_parameter-include-raw-verbatim.yaml
View File

@ -1,8 +1,8 @@
# !include-raw: tag in a variable.
# !include-raw-verbatim: tag in a variable.
- job-template:
name: sample-job
var: !include-raw: tag_in_parameter-include-raw.inc.txt
var: !include-raw-verbatim: tag_in_parameter-include-raw-verbatim.inc.txt
builders:
- shell: |
echo {var}