1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
#!/usr/bin/python3
# Copyright (C) 2012, Benjamin Drung <bdrung@debian.org>
#
# Permission to use, copy, modify, and/or distribute this software for any
# purpose with or without fee is hereby granted, provided that the above
# copyright notice and this permission notice appear in all copies.
#
# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
# pylint: disable=invalid-name
# pylint: enable=invalid-name
"""Validates a given distro-info CSV file."""
import csv
import sys
import typing
from datetime import date, timedelta
from lib.tools import convert_date, get_csv_dict_reader, main
_COLUMNS = {
"debian": (
"version",
"codename",
"series",
"created",
"release",
"eol",
"eol-lts",
"eol-elts",
),
"devuan": ("version", "codename", "series", "created", "release", "eol"),
"elxr": (
"version",
"codename",
"series",
"created",
"release",
"eol",
"eol-lts",
"eol-elts",
),
"ubuntu": (
"version",
"codename",
"series",
"created",
"release",
"eol",
"eol-server",
"eol-esm",
"eol-legacy",
),
}
_DATES = (
"created",
"release",
"eol",
"eol-server",
"eol-esm",
"eol-lts",
"eol-elts",
"eol-legacy",
)
_EARLIER_DATES = (
("created", "release"),
("release", "eol"),
("eol", "eol-server"),
("eol", "eol-esm"),
("eol", "eol-lts"),
("eol-lts", "eol-elts"),
("eol-esm", "eol-legacy"),
)
_STRINGS = {
"debian": ("codename", "series"),
"devuan": ("codename", "series"),
"elxr": ("codename", "series"),
"ubuntu": ("version", "codename", "series"),
}
_DERIVATIVES = {
"devuan": {
"parent": "debian",
"column_map": {"eol": "eol-lts"},
"series_map": {
"daedalus": "bookworm",
"chimaera": "bullseye",
"beowulf": "buster",
"ascii": "stretch",
"jessie": "jessie",
"excalibur": "trixie",
"ceres": "sid",
"experimental": "experimental",
},
}
}
RowDict = dict[str, typing.Union[None, date, str]]
_parent_data_cache = {}
class ErrorLogger: # pylint: disable=too-few-public-methods
"""Print an error message and count failures."""
def __init__(self, csvreader: csv.DictReader, filename: str) -> None:
self.csvreader = csvreader
self.filename = filename
self.failures = 0
def __call__(self, message: str) -> None:
print(f"{self.filename}:{self.csvreader.line_num}: {message}.", file=sys.stderr)
self.failures += 1
def _check_for_missing_columns(row: RowDict, error: ErrorLogger, distro: str) -> None:
for column in _COLUMNS[distro]:
if column not in row:
msg = f"Column `{column}' is missing"
error(msg)
def _check_for_additinal_columns(row: RowDict, error: ErrorLogger, distro: str) -> None:
for column in row:
if column not in _COLUMNS[distro]:
msg = f"Additional column `{column}' is specified"
error(msg)
def _check_required_strings_columns(
row: RowDict, error: ErrorLogger, distro: str
) -> None:
for column in _STRINGS[distro]:
if column in row and not row[column]:
msg = f"Empty column `{column}' specified"
error(msg)
def _convert_dates(row: RowDict, error: ErrorLogger) -> None:
for column in _DATES:
if column in row:
try:
row[column] = convert_date(row[column])
except ValueError:
msg = f"Invalid date `{row[column]}' in column `{column}'"
error(msg)
row[column] = None
def _check_required_date_columns(row: RowDict, error: ErrorLogger) -> None:
column = "created"
if column in row and not row[column]:
msg = f"No date specified in column `{column}'"
error(msg)
def _compare_dates(row: RowDict, error: ErrorLogger) -> None:
for date1_column, date2_column in _EARLIER_DATES:
date2 = row.get(date2_column)
if date2 is None:
continue
date1 = row.get(date1_column)
if date1 is None:
# date1 needs to be specified if date2 is specified
msg = (
f"A date needs to be specified in column `{date1_column}'"
f" due to the given date in column `{date2_column}'"
)
error(msg)
continue
assert isinstance(date1, date)
assert isinstance(date2, date)
# date1 needs to be earlier than date2
if date1 > date2:
msg = (
f"Date {date2.isoformat()} of column"
f" `{date2_column}' needs to be >= than"
f" {date1.isoformat()} of column `{date1_column}'"
)
error(msg)
def _check_that_eol_lands_on_a_weekday(row: RowDict, error: ErrorLogger) -> None:
for column, eol_date in row.items():
if not column.startswith("eol"):
continue
if not eol_date:
continue
assert isinstance(eol_date, date)
if eol_date >= date(2021, 5, 1):
if eol_date.weekday() == 0 or eol_date.weekday() >= 4:
msg = (
f"{column} for {row['codename']}"
f" lands outside Tuesday-Thursday ({eol_date})"
)
error(msg)
def _check_that_esm_has_overlap_period(row: RowDict, error: ErrorLogger) -> None:
version = row.get("version")
release = row.get("release")
assert isinstance(version, str)
assert isinstance(release, date)
if version.endswith("LTS") and release >= date(2018, 1, 1):
eol_date = row["eol"]
assert isinstance(eol_date, date)
assert eol_date == row["eol-server"]
june = eol_date.replace(day=1, month=6)
if june - eol_date > timedelta(days=7):
msg = (
f"eol for {row['codename']}"
f" is missing ESM overlap period ({eol_date})"
)
error(msg)
def _parent_data(distro: str, error: ErrorLogger) -> dict[str, str | date]:
global _parent_data_cache
if distro not in _parent_data_cache:
data = {}
for row in get_csv_dict_reader(f"{distro}.csv"):
_convert_dates(row, error)
data[row["series"]] = row
_parent_data_cache[distro] = data
return _parent_data_cache[distro]
def _check_that_derivative_matches(
row: RowDict, error: ErrorLogger, distro: str
) -> None:
series = row["series"]
parent = _DERIVATIVES[distro]["parent"]
parent_series = _DERIVATIVES[distro]["series_map"].get(series)
if parent_series is None:
error(f"Unknown derivation for {series}")
return
if row["release"] is None:
return
parent_data = _parent_data(parent, error)
for child_col, parent_col in _DERIVATIVES[distro]["column_map"].items():
child_value = row[child_col]
parent_value = parent_data[parent_series][parent_col]
if child_value != parent_value:
error(
f"Expected {child_col} for {series} to match {parent_col} "
f"for {parent} {parent_series}, but {child_value} != "
f"{parent_value}"
)
def validate(filename, distro):
"""Validates a given CSV file.
Returns True if the given CSV file is valid and otherwise False.
"""
csvreader = get_csv_dict_reader(filename)
error = ErrorLogger(csvreader, filename)
for row in csvreader:
_check_for_missing_columns(row, error, distro)
_check_for_additinal_columns(row, error, distro)
_check_required_strings_columns(row, error, distro)
_convert_dates(row, error)
_check_required_date_columns(row, error)
_compare_dates(row, error)
if distro == "devuan":
_check_that_derivative_matches(row, error, distro)
if distro == "ubuntu":
_check_that_eol_lands_on_a_weekday(row, error)
_check_that_esm_has_overlap_period(row, error)
return error.failures == 0
if __name__ == "__main__":
sys.exit(main(validate))
|
