-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathassert_news.html
551 lines (508 loc) · 29.2 KB
/
assert_news.html
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
<!--
-- Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
-- SPDX-License-Identifier: Apache-2.0
-->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.10.0" />
<title>continuous_delivery_scripts.assert_news API documentation</title>
<meta name="description" content="Checks if valid news files are created for changes in the project." />
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/highlight.min.js" integrity="sha256-Uv3H6lx7dJmRfRvH8TH6kJD1TSK1aFcwgx+mdg3epi8=" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => hljs.initHighlighting())</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>continuous_delivery_scripts.assert_news</code></h1>
</header>
<section id="section-intro">
<p>Checks if valid news files are created for changes in the project.</p>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">#
# Copyright (C) 2020-2025 Arm Limited or its affiliates and Contributors. All rights reserved.
# SPDX-License-Identifier: Apache-2.0
#
"""Checks if valid news files are created for changes in the project."""
import argparse
import logging
import pathlib
import re
import sys
from typing import Union, Optional, Iterable, Any, List
from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
from continuous_delivery_scripts.utils.git_helpers import ProjectTempClone, LocalProjectRepository, GitWrapper
from continuous_delivery_scripts.utils.logging import log_exception, set_log_level
from continuous_delivery_scripts.utils.news_file import create_news_file
logger = logging.getLogger(__name__)
NEWS_FILE_NAME_REGEX = r"^[0-9]+.(misc|doc|removal|bugfix|feature|major)$"
class NewsFileValidator:
"""Verifies individual news files."""
def __init__(self, absolute_path: Union[pathlib.Path, str]) -> None:
"""Creates a new instance of NewsFileValidator.
Args:
absolute_path: the absolute path to the news file
"""
self._news_file_path = pathlib.Path(absolute_path)
self._basename = self._news_file_path.name
def validate_file_name(self) -> None:
"""Ensures the news file follows the naming rules."""
if re.match(NEWS_FILE_NAME_REGEX, self._basename) is None:
raise ValueError(
f'Incorrect news file name "{self._basename}".'
f' It doesn\'t match the following regex: "{NEWS_FILE_NAME_REGEX}".'
)
def validate_file_contents(self) -> None:
"""Ensures the news file is not empty and not longer than one line."""
file_content = self._news_file_path.read_text()
if file_content.strip() == "":
raise ValueError(f'Empty news file "{self._basename}".')
if len(file_content.splitlines()) > 1:
raise ValueError(f'News file "{self._basename}" contains more than one line.')
def validate(self) -> None:
"""Runs all validators."""
logger.info(f"Verifying {self._basename}")
self.validate_file_name()
self.validate_file_contents()
def validate_news_file(absolute_path: Union[pathlib.Path, str]) -> None:
"""Applies NewsFileValidator validation logic to news file."""
NewsFileValidator(absolute_path).validate()
def find_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> List[str]:
"""Determines a list of all the news files which were added as part of the PR.
Args:
git: Instance of GitWrapper.
root_dir: Root directory of the project.
news_dir: Relative path to news directory.
Returns:
list: list of absolute paths to news files
"""
files_changed = git.list_files_added_to_current_commit()
# To speed up the process, we first look at files added to the current commit.
# If no news files were added, then we check for addition on the branch.
# Relies on the fact GitWrapper returns paths that are always relative
# to the project root.
added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
if len(added_news_files) == 0:
files_changed = git.list_files_added_on_current_branch()
added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]
def validate_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> None:
"""Checks that news files exist and pass validation checks.
Args:
git: Instance of GitWrapper.
root_dir: Root directory of the project.
news_dir: Relative path to news directory.
"""
added_news_files = find_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
if not added_news_files:
raise FileNotFoundError(f"PR must contain a news file in {news_dir}. See README.md.")
for absolute_file_path in added_news_files:
validate_news_file(absolute_file_path)
def _convert_to_string_iter(list: Optional[List[Any]]) -> Iterable[str]:
if list is None:
return []
return [str(item) for item in list]
def generate_news_file(git: GitWrapper, news_dir: pathlib.Path) -> pathlib.Path:
"""Adds a news file if the branch corresponds to an dependency update.
Args:
git: Instance of GitWrapper.
news_dir: path to news directory.
"""
current_branch = str(git.get_current_branch())
is_dependency_update, groups = git.is_current_branch_of_type(
str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_BRANCH_PATTERN))
)
if not is_dependency_update:
raise EnvironmentError(f"Branch {current_branch} must contain a news file.")
if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
raise EnvironmentError(f"Branch {current_branch} must contain a news file.")
list_groups = _convert_to_string_iter(groups)
message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
message=", ".join(list_groups)
)
logger.info(f"Generating a news file with content: {message}...")
return create_news_file(
str(news_dir),
None,
message,
configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
)
def _commit_news_file(git: GitWrapper, news_file: pathlib.Path, local: bool) -> None:
logger.info(f"Committing news file {str(news_file)}...")
if not local:
git.configure_for_github()
git.add(news_file)
git.commit("📰 Automatic changes ⚙ Adding news file")
if not local:
git.push()
git.pull()
def main() -> None:
"""Asserts the new PR comprises at least one news file and it adheres to the required standard."""
parser = argparse.ArgumentParser(description="Check correctly formatted news files exist on feature branch.")
parser.add_argument("-b", "--current-branch", help="Name of the current branch", nargs="?")
parser.add_argument("-l", "--local", action="store_true", help="perform checks directly on local repository")
parser.add_argument("-v", "--verbose", action="count", default=0, help="Verbosity, by default errors are reported.")
args = parser.parse_args()
set_log_level(args.verbose)
with (
LocalProjectRepository() # type: ignore
if args.local
else ProjectTempClone(desired_branch_name=args.current_branch)
) as git:
if git.is_current_branch_feature():
root_dir = configuration.get_value(ConfigurationVariable.PROJECT_ROOT)
absolute_news_dir = configuration.get_value(ConfigurationVariable.NEWS_DIR)
news_dir = str(pathlib.Path(absolute_news_dir).relative_to(root_dir))
try:
validate_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
except Exception as e:
log_exception(logger, e)
try:
news_file = generate_news_file(git, git.get_corresponding_path(pathlib.Path(news_dir)))
_commit_news_file(git, news_file, args.local)
except Exception as e2:
log_exception(logger, e2)
sys.exit(1)
if __name__ == "__main__":
main()</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="continuous_delivery_scripts.assert_news.find_news_files"><code class="name flex">
<span>def <span class="ident">find_news_files</span></span>(<span>git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, root_dir: str, news_dir: str) ‑> List[str]</span>
</code></dt>
<dd>
<div class="desc"><p>Determines a list of all the news files which were added as part of the PR.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>git</code></strong></dt>
<dd>Instance of GitWrapper.</dd>
<dt><strong><code>root_dir</code></strong></dt>
<dd>Root directory of the project.</dd>
<dt><strong><code>news_dir</code></strong></dt>
<dd>Relative path to news directory.</dd>
</dl>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>list</code></dt>
<dd>list of absolute paths to news files</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def find_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> List[str]:
"""Determines a list of all the news files which were added as part of the PR.
Args:
git: Instance of GitWrapper.
root_dir: Root directory of the project.
news_dir: Relative path to news directory.
Returns:
list: list of absolute paths to news files
"""
files_changed = git.list_files_added_to_current_commit()
# To speed up the process, we first look at files added to the current commit.
# If no news files were added, then we check for addition on the branch.
# Relies on the fact GitWrapper returns paths that are always relative
# to the project root.
added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
if len(added_news_files) == 0:
files_changed = git.list_files_added_on_current_branch()
added_news_files = [file_path for file_path in files_changed if file_path.startswith(news_dir)]
return [str(pathlib.Path(root_dir, file_path)) for file_path in added_news_files]</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.generate_news_file"><code class="name flex">
<span>def <span class="ident">generate_news_file</span></span>(<span>git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, news_dir: pathlib.Path) ‑> pathlib.Path</span>
</code></dt>
<dd>
<div class="desc"><p>Adds a news file if the branch corresponds to an dependency update.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>git</code></strong></dt>
<dd>Instance of GitWrapper.</dd>
<dt><strong><code>news_dir</code></strong></dt>
<dd>path to news directory.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def generate_news_file(git: GitWrapper, news_dir: pathlib.Path) -> pathlib.Path:
"""Adds a news file if the branch corresponds to an dependency update.
Args:
git: Instance of GitWrapper.
news_dir: path to news directory.
"""
current_branch = str(git.get_current_branch())
is_dependency_update, groups = git.is_current_branch_of_type(
str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_BRANCH_PATTERN))
)
if not is_dependency_update:
raise EnvironmentError(f"Branch {current_branch} must contain a news file.")
if not configuration.get_value(ConfigurationVariable.AUTOGENERATE_NEWS_FILE_ON_DEPENDENCY_UPDATE):
raise EnvironmentError(f"Branch {current_branch} must contain a news file.")
list_groups = _convert_to_string_iter(groups)
message = str(configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_MESSAGE)).format(
message=", ".join(list_groups)
)
logger.info(f"Generating a news file with content: {message}...")
return create_news_file(
str(news_dir),
None,
message,
configuration.get_value(ConfigurationVariable.DEPENDENCY_UPDATE_NEWS_TYPE),
)</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.main"><code class="name flex">
<span>def <span class="ident">main</span></span>(<span>) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Asserts the new PR comprises at least one news file and it adheres to the required standard.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def main() -> None:
"""Asserts the new PR comprises at least one news file and it adheres to the required standard."""
parser = argparse.ArgumentParser(description="Check correctly formatted news files exist on feature branch.")
parser.add_argument("-b", "--current-branch", help="Name of the current branch", nargs="?")
parser.add_argument("-l", "--local", action="store_true", help="perform checks directly on local repository")
parser.add_argument("-v", "--verbose", action="count", default=0, help="Verbosity, by default errors are reported.")
args = parser.parse_args()
set_log_level(args.verbose)
with (
LocalProjectRepository() # type: ignore
if args.local
else ProjectTempClone(desired_branch_name=args.current_branch)
) as git:
if git.is_current_branch_feature():
root_dir = configuration.get_value(ConfigurationVariable.PROJECT_ROOT)
absolute_news_dir = configuration.get_value(ConfigurationVariable.NEWS_DIR)
news_dir = str(pathlib.Path(absolute_news_dir).relative_to(root_dir))
try:
validate_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
except Exception as e:
log_exception(logger, e)
try:
news_file = generate_news_file(git, git.get_corresponding_path(pathlib.Path(news_dir)))
_commit_news_file(git, news_file, args.local)
except Exception as e2:
log_exception(logger, e2)
sys.exit(1)</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.validate_news_file"><code class="name flex">
<span>def <span class="ident">validate_news_file</span></span>(<span>absolute_path: Union[pathlib.Path, str]) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Applies NewsFileValidator validation logic to news file.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_news_file(absolute_path: Union[pathlib.Path, str]) -> None:
"""Applies NewsFileValidator validation logic to news file."""
NewsFileValidator(absolute_path).validate()</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.validate_news_files"><code class="name flex">
<span>def <span class="ident">validate_news_files</span></span>(<span>git: <a title="continuous_delivery_scripts.utils.git_helpers.GitWrapper" href="utils/git_helpers.html#continuous_delivery_scripts.utils.git_helpers.GitWrapper">GitWrapper</a>, root_dir: str, news_dir: str) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Checks that news files exist and pass validation checks.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>git</code></strong></dt>
<dd>Instance of GitWrapper.</dd>
<dt><strong><code>root_dir</code></strong></dt>
<dd>Root directory of the project.</dd>
<dt><strong><code>news_dir</code></strong></dt>
<dd>Relative path to news directory.</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_news_files(git: GitWrapper, root_dir: str, news_dir: str) -> None:
"""Checks that news files exist and pass validation checks.
Args:
git: Instance of GitWrapper.
root_dir: Root directory of the project.
news_dir: Relative path to news directory.
"""
added_news_files = find_news_files(git=git, news_dir=news_dir, root_dir=root_dir)
if not added_news_files:
raise FileNotFoundError(f"PR must contain a news file in {news_dir}. See README.md.")
for absolute_file_path in added_news_files:
validate_news_file(absolute_file_path)</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator"><code class="flex name class">
<span>class <span class="ident">NewsFileValidator</span></span>
<span>(</span><span>absolute_path: Union[pathlib.Path, str])</span>
</code></dt>
<dd>
<div class="desc"><p>Verifies individual news files.</p>
<p>Creates a new instance of NewsFileValidator.</p>
<h2 id="args">Args</h2>
<dl>
<dt><strong><code>absolute_path</code></strong></dt>
<dd>the absolute path to the news file</dd>
</dl></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class NewsFileValidator:
"""Verifies individual news files."""
def __init__(self, absolute_path: Union[pathlib.Path, str]) -> None:
"""Creates a new instance of NewsFileValidator.
Args:
absolute_path: the absolute path to the news file
"""
self._news_file_path = pathlib.Path(absolute_path)
self._basename = self._news_file_path.name
def validate_file_name(self) -> None:
"""Ensures the news file follows the naming rules."""
if re.match(NEWS_FILE_NAME_REGEX, self._basename) is None:
raise ValueError(
f'Incorrect news file name "{self._basename}".'
f' It doesn\'t match the following regex: "{NEWS_FILE_NAME_REGEX}".'
)
def validate_file_contents(self) -> None:
"""Ensures the news file is not empty and not longer than one line."""
file_content = self._news_file_path.read_text()
if file_content.strip() == "":
raise ValueError(f'Empty news file "{self._basename}".')
if len(file_content.splitlines()) > 1:
raise ValueError(f'News file "{self._basename}" contains more than one line.')
def validate(self) -> None:
"""Runs all validators."""
logger.info(f"Verifying {self._basename}")
self.validate_file_name()
self.validate_file_contents()</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate"><code class="name flex">
<span>def <span class="ident">validate</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Runs all validators.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate(self) -> None:
"""Runs all validators."""
logger.info(f"Verifying {self._basename}")
self.validate_file_name()
self.validate_file_contents()</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_contents"><code class="name flex">
<span>def <span class="ident">validate_file_contents</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Ensures the news file is not empty and not longer than one line.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_file_contents(self) -> None:
"""Ensures the news file is not empty and not longer than one line."""
file_content = self._news_file_path.read_text()
if file_content.strip() == "":
raise ValueError(f'Empty news file "{self._basename}".')
if len(file_content.splitlines()) > 1:
raise ValueError(f'News file "{self._basename}" contains more than one line.')</code></pre>
</details>
</dd>
<dt id="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_name"><code class="name flex">
<span>def <span class="ident">validate_file_name</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<div class="desc"><p>Ensures the news file follows the naming rules.</p></div>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def validate_file_name(self) -> None:
"""Ensures the news file follows the naming rules."""
if re.match(NEWS_FILE_NAME_REGEX, self._basename) is None:
raise ValueError(
f'Incorrect news file name "{self._basename}".'
f' It doesn\'t match the following regex: "{NEWS_FILE_NAME_REGEX}".'
)</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="continuous_delivery_scripts" href="index.html">continuous_delivery_scripts</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="continuous_delivery_scripts.assert_news.find_news_files" href="#continuous_delivery_scripts.assert_news.find_news_files">find_news_files</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.generate_news_file" href="#continuous_delivery_scripts.assert_news.generate_news_file">generate_news_file</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.main" href="#continuous_delivery_scripts.assert_news.main">main</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.validate_news_file" href="#continuous_delivery_scripts.assert_news.validate_news_file">validate_news_file</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.validate_news_files" href="#continuous_delivery_scripts.assert_news.validate_news_files">validate_news_files</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator" href="#continuous_delivery_scripts.assert_news.NewsFileValidator">NewsFileValidator</a></code></h4>
<ul class="">
<li><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator.validate" href="#continuous_delivery_scripts.assert_news.NewsFileValidator.validate">validate</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_contents" href="#continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_contents">validate_file_contents</a></code></li>
<li><code><a title="continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_name" href="#continuous_delivery_scripts.assert_news.NewsFileValidator.validate_file_name">validate_file_name</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
</footer>
</body>
</html>