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
96 lines
3.0 KiB
Python
96 lines
3.0 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.
|
|
|
|
import logging
|
|
from collections import defaultdict
|
|
|
|
from .errors import JenkinsJobsException
|
|
from .defaults import Defaults
|
|
from .job import Job, JobTemplate, JobGroup
|
|
from .view import View, ViewTemplate, ViewGroup
|
|
from .project import Project
|
|
from .macro import macro_adders
|
|
|
|
logger = logging.getLogger(__name__)
|
|
|
|
|
|
root_adders = {
|
|
"defaults": Defaults.add,
|
|
"job": Job.add,
|
|
"job-template": JobTemplate.add,
|
|
"job-group": JobGroup.add,
|
|
"view": View.add,
|
|
"view-template": ViewTemplate.add,
|
|
"view-group": ViewGroup.add,
|
|
"project": Project.add,
|
|
**macro_adders,
|
|
}
|
|
|
|
|
|
class Roots:
|
|
"""Container for root YAML elements - jobs, views, templates, projects and macros"""
|
|
|
|
def __init__(self, config):
|
|
self._allow_duplicates = config.yamlparser["allow_duplicates"]
|
|
self.defaults = {}
|
|
self.jobs = {}
|
|
self.job_templates = {}
|
|
self.job_groups = {}
|
|
self.views = {}
|
|
self.view_templates = {}
|
|
self.view_groups = {}
|
|
self.projects = {}
|
|
self.macros = defaultdict(dict) # type -> name -> Macro
|
|
|
|
def generate_jobs(self):
|
|
expanded_jobs = []
|
|
for job in self.jobs.values():
|
|
expanded_jobs += job.top_level_generate_items()
|
|
for project in self.projects.values():
|
|
expanded_jobs += project.generate_jobs()
|
|
return self._remove_duplicates(expanded_jobs)
|
|
|
|
def generate_views(self):
|
|
expanded_views = []
|
|
for view in self.views.values():
|
|
expanded_views += view.top_level_generate_items()
|
|
for project in self.projects.values():
|
|
expanded_views += project.generate_views()
|
|
return self._remove_duplicates(expanded_views)
|
|
|
|
def assign(self, container, id, value, title):
|
|
if id in container:
|
|
self._handle_dups(f"Duplicate {title}: {id}")
|
|
container[id] = value
|
|
|
|
def _remove_duplicates(self, job_list):
|
|
seen = set()
|
|
unique_list = []
|
|
# Last definition wins.
|
|
for job in reversed(job_list):
|
|
name = job["name"]
|
|
if name in seen:
|
|
self._handle_dups(
|
|
f"Duplicate definitions for job {name!r} specified",
|
|
)
|
|
else:
|
|
unique_list.append(job)
|
|
seen.add(name)
|
|
return unique_list[::-1]
|
|
|
|
def _handle_dups(self, message):
|
|
if self._allow_duplicates:
|
|
logger.warning(message)
|
|
else:
|
|
logger.error(message)
|
|
raise JenkinsJobsException(message)
|