af9e03ec08
Rewrite YAML parser, YAML objects and parameters expansion logic to
enable better control over expansion logic.
Broken backward compatilibity:
* More agressive parameter expansion. This may lead to parameters
expanded in places where they were not expanded before.
* Top-level elements, which is not known to parser (such as 'job',
'view', 'project' etc), are now lead to parse failures.
Prepend them with underscore to be ignored by parser.
* Files included using '!include-raw:' elements and having formatting in
it's path ('lazy-loaded' in previous implementation) are now expanded
too.
Use '!include-raw-escape:' for them instead.
See changes in these tests for examples:
tests/yamlparser/job_fixtures/lazy-load-jobs-multi001.yaml
tests/yamlparser/job_fixtures/lazy-load-jobs-multi002.yaml
tests/yamlparser/job_fixtures/lazy-load-jobs001.yaml
* Parameters with template value using itself were substituted as is.
For example: "timer: '{timer}'" was expanded to "{timer}". Now it
leads to recursive parameter error.
See changes in this test for example:
tests/yamlparser/job_fixtures/parameter_name_reuse_default.*
->
tests/yamlparser/error_fixtures/parameter_name_reuse_default.*
* When job group includes a job which was never declared, it was just
ignored. Now it fails: job is missing.
See changes in this test for example:
tests/yamlparser/job_fixtures/job_group_includes_missing_job.*
->
tests/yamlparser/error_fixtures/job_group_includes_missing_job.*
Change-Id: Ief4e515f065a1b9e0f74fe06d7e94fa77d69f273
57 lines
1.7 KiB
Python
57 lines
1.7 KiB
Python
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
from dataclasses import dataclass
|
|
from functools import partial
|
|
|
|
from .errors import JenkinsJobsException
|
|
|
|
|
|
macro_specs = [
|
|
# type_name, elements_name (aka component_type, component_list_type for Registry).
|
|
("parameter", "parameters"),
|
|
("property", "properties"),
|
|
("builder", "builders"),
|
|
("wrapper", "wrappers"),
|
|
("trigger", "triggers"),
|
|
("publisher", "publishers"),
|
|
("scm", "scm"),
|
|
("pipeline-scm", "pipeline-scm"),
|
|
("reporter", "reporters"),
|
|
]
|
|
|
|
|
|
@dataclass
|
|
class Macro:
|
|
name: str
|
|
elements: list
|
|
|
|
@classmethod
|
|
def add(
|
|
cls, type_name, elements_name, config, roots, expander, params_expander, data
|
|
):
|
|
d = {**data}
|
|
name = d.pop("name")
|
|
elements = d.pop(elements_name)
|
|
if d:
|
|
raise JenkinsJobsException(
|
|
f"Macro {type_name} {name!r}: unexpected elements: {','.join(d.keys())}"
|
|
)
|
|
macro = cls(name, elements or [])
|
|
roots.assign(roots.macros[type_name], name, macro, "macro")
|
|
|
|
|
|
macro_adders = {
|
|
macro_type: partial(Macro.add, macro_type, elements_name)
|
|
for macro_type, elements_name in macro_specs
|
|
}
|