Debian Codegraph @

jenkins_jobs/roots.py

raw
1 # Licensed under the Apache License, Version 2.0 (the "License");
2 # you may not use this file except in compliance with the License.
3 # You may obtain a copy of the License at
4 #
5 # http://www.apache.org/licenses/LICENSE-2.0
6 #
7 # Unless required by applicable law or agreed to in writing, software
8 # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
9 # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
10 # License for the specific language governing permissions and limitations
11 # under the License.
12
13 import logging
14 from collections import defaultdict
15
16 from .errors import Context, JenkinsJobsException
17 from .defaults import Defaults
18 from .job import Job, JobTemplate, JobGroup
19 from .view import View, ViewTemplate, ViewGroup
20 from .project import Project
21 from .macro import macro_adders
22
23 logger = logging.getLogger(__name__)
24
25
26 root_adders = {
27 "defaults": Defaults.add,
28 "job": Job.add,
29 "job-template": JobTemplate.add,
30 "job-group": JobGroup.add,
31 "view": View.add,
32 "view-template": ViewTemplate.add,
33 "view-group": ViewGroup.add,
34 "project": Project.add,
35 **macro_adders,
36 }
37
38
39 class Roots:
40 """Container for root YAML elements - jobs, views, templates, projects and macros"""
41
42 def __init__(self, config):
43 self._allow_duplicates = config.yamlparser["allow_duplicates"]
44 self.defaults = {}
45 self.jobs = {}
46 self.job_templates = {}
47 self.job_groups = {}
48 self.views = {}
49 self.view_templates = {}
50 self.view_groups = {}
51 self.projects = {}
52 self.macros = defaultdict(dict) # type -> name -> Macro
53
54 def generate_jobs(self):
55 expanded_jobs = []
56 for job in self.jobs.values():
57 expanded_jobs += job.top_level_generate_items()
58 for project in self.projects.values():
59 expanded_jobs += project.generate_jobs()
60 return self._remove_duplicates(expanded_jobs, "job")
61
62 def generate_views(self):
63 expanded_views = []
64 for view in self.views.values():
65 expanded_views += view.top_level_generate_items()
66 for project in self.projects.values():
67 expanded_views += project.generate_views()
68 return self._remove_duplicates(expanded_views, "view")
69
70 def assign(self, container, id, value, element_type):
71 if id in container:
72 self._handle_dups(element_type, id, value.pos, container[id].pos)
73 container[id] = value
74
75 def _remove_duplicates(self, job_or_view_list, element_type):
76 seen = {}
77 unique_list = []
78 # Last definition wins.
79 for job_or_view in reversed(job_or_view_list):
80 name = job_or_view.name
81 if name in seen:
82 origin = seen[name]
83 self._handle_dups(
84 element_type,
85 name,
86 job_or_view.data.pos,
87 origin.data.pos,
88 # Skip job context, leave only project context.
89 job_or_view.context[:-1],
90 origin.context[:-1],
91 )
92 else:
93 unique_list.append(job_or_view)
94 seen[name] = job_or_view
95 return unique_list[::-1]
96
97 def _handle_dups(
98 self, element_type, id, pos, origin_pos, ctx=None, origin_ctx=None
99 ):
100 message = f"Duplicate {element_type}: {id!r}"
101 if self._allow_duplicates:
102 logger.warning(message)
103 else:
104 logger.error(message)
105 ctx = [*(ctx or []), Context(message, pos), *(origin_ctx or [])]
106 raise JenkinsJobsException(
107 f"Previous {element_type} definition", origin_pos, ctx
108 )