Repository navigation
Expand file tree
/
Copy pathpkgdev_commit.py
More file actions
1000 lines (866 loc) · 35.7 KB
/
Copy pathpkgdev_commit.py
File metadata and controls
1000 lines (866 loc) · 35.7 KB
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
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import argparse
import atexit
import difflib
import os
import re
import shlex
import subprocess
import tarfile
import tempfile
import textwrap
from collections import UserDict, defaultdict, deque
from collections.abc import Iterable
from dataclasses import dataclass
from enum import Enum
from functools import partial
from itertools import chain
from os.path import join as pjoin
from typing import ClassVar
from pkgcheck import reporters, scan
from pkgcore.ebuild.atom import MalformedAtom
from pkgcore.ebuild.atom import atom as atom_cls
from pkgcore.ebuild.repo_objs import RepoConfig
from pkgcore.ebuild.repository import UnconfiguredTree, tree
from pkgcore.operations import observer as observer_mod
from pkgcore.restrictions import packages
from snakeoil.cli import arghparse
from snakeoil.cli.input import userquery
from snakeoil.klass import jit_attr
from snakeoil.mappings import OrderedSet
from .. import cli, git
from ..mangle import GentooMangler, Mangler
from .argparsers import cwd_repo_argparser, git_repo_argparser
class ArgumentParser(cli.ArgumentParser):
"""Parse all known arguments, passing unknown arguments to ``git commit``."""
def parse_known_args(self, args=None, namespace=None):
namespace.footer = OrderedSet()
namespace.git_add_files = []
namespace, args = super().parse_known_args(args, namespace)
if namespace.dry_run:
args.append("--dry-run")
if namespace.verbosity:
args.append("-v")
if namespace.signoff:
args.append("--signoff")
if namespace.edit:
args.append("--edit")
namespace.commit_args = args
namespace.git_args_paths = list(
filter(os.path.exists, (s for s in args if not s.startswith("-")))
)
return namespace, []
class BugTag(argparse.Action):
"""Register bug-related tag to inject into the commit message footer."""
def parse_url(self, value):
try:
url = f"https://bugs.gentoo.org/{int(value)}"
except ValueError:
url = value
if not url.startswith(("https://", "http://")):
raise argparse.ArgumentError(self, f"invalid URL: {url}")
return url
def __call__(self, parser, namespace, value, option_string=None):
url = self.parse_url(value)
namespace.footer.add((self.dest.capitalize(), url))
class CommitTag(argparse.Action):
"""Register commit tag to inject into the commit message footer."""
def __call__(self, parser, namespace, value, option_string=None):
try:
name, val = value.split(":", 1)
if not (name and val):
raise ValueError("empty name or value")
except ValueError:
raise argparse.ArgumentError(self, f"invalid commit tag: {value!r}")
namespace.footer.add((name.capitalize(), val))
class BugzillaAwareBugTag(BugTag):
"""Register bug-related tag and resolution to inject into the commit message footer."""
class Resolution(Enum):
FIXED = "fixed"
OBSOLETE = "obsolete"
PKGREMOVED = "pkgremoved"
def __call__(self, parser, namespace, values, option_string=None):
has_resolution = False
try:
bug, val = values.rsplit(":", 1)
if not bug:
raise argparse.ArgumentError(self, f"invalid commit tag: {values!r}")
if not val.startswith("//"):
has_resolution = True
res = self.Resolution(val.lower()) if val else self.Resolution.FIXED
except ValueError:
if has_resolution:
err = f"{val!r} should be one of: {', '.join([m.value for m in self.Resolution])}"
raise argparse.ArgumentError(self, err)
if not has_resolution:
super().__call__(parser, namespace, values, option_string)
return
url = self.parse_url(bug)
is_bgo = "bugs.gentoo.org" in url
if is_bgo and res is not self.Resolution.FIXED:
url = f"{url} ({res.value})"
namespace.footer.add((self.dest.capitalize(), url))
commit = ArgumentParser(
prog="pkgdev commit",
description="create git commit",
parents=(cwd_repo_argparser, git_repo_argparser),
)
# custom `pkgcheck scan` args used for tests
commit.add_argument("--pkgcheck-scan", help=argparse.SUPPRESS)
commit_opts = commit.add_argument_group("commit options")
commit_opts.add_argument(
"-b", "--bug", action=BugTag, help="add Bug tag for a given Gentoo or upstream bug"
)
commit_opts.add_argument(
"-c",
"--closes",
action=BugzillaAwareBugTag,
metavar="CLOSES[:RESOLUTION]",
help="add Closes tag and optionally a resolution for a given Gentoo bug or upstream PR URL",
docs="""
Indicate that a bug or PR may be closed. The optional resolution string
for Gentoo's Bugzilla describes what happened to a bug. It is
case-insensitive and must be one of FIXED, OBSOLETE or PKGREMOVED.
""",
)
commit_opts.add_argument(
"-T", "--tag", action=CommitTag, metavar="NAME:VALUE", help="add commit tag"
)
commit_opts.add_argument(
"-n",
"--dry-run",
action="store_true",
help="pretend to create commit",
docs="""
Perform all actions without creating a commit.
""",
)
commit_opts.add_argument(
"-s",
"--scan",
nargs="?",
const=True,
action=arghparse.StoreBool,
help="run pkgcheck against staged changes",
docs="""
By default, ``pkgdev commit`` doesn't scan for QA errors. This option
enables using pkgcheck to scan the staged changes for issues, erroring
out if any failures are found.
""",
)
commit_opts.add_argument(
"-A",
"--ask",
nargs="?",
const=True,
action=arghparse.StoreBool,
help="confirm creating commit with QA errors",
docs="""
When running with the -s/--scan option enabled, ``pkgdev commit`` will
ask for confirmation before creating a commit if it detects failure
results.
""",
)
commit_opts.add_argument(
"--mangle",
nargs="?",
const=True,
action=arghparse.StoreBool,
help="forcibly enable/disable file mangling",
docs="""
File mangling automatically modifies the content of relevant staged
files including updating copyright headers and fixing EOF newlines.
This is performed by default for the gentoo repo, but can be forcibly
disabled or enabled as required.
""",
)
commit_opts.add_argument(
"--signoff",
nargs="?",
const=True,
action=arghparse.StoreBool,
help="Add a Signed-off-by at the end of the commit log message",
docs="""
Add a Signed-off-by trailer by the committer at the end of the commit
log message.
For committing to the Gentoo repository, under GLEP-76, the committer
shall certify agreement to the Certificate of Origin by adding
Signed-off-by line containing the committer's legal name.
""",
)
commit_opts.add_argument(
"--gpg-sign",
action=argparse.BooleanOptionalAction,
help="GPG-sign commit",
docs="""
Pass ``--gpg-sign`` or ``--no-gpg-sign`` to the ``git commit`` command.
This option enables to override the default behavior or the behavior
defined by ``sign-commits = true`` in ``metadata/layout.conf`` file.
""",
)
commit_opts.add_argument(
"-d",
"--distdir",
type=arghparse.create_dir,
help="target download directory",
docs="""
Use a specified target directory for downloads instead of the
configured DISTDIR.
""",
)
msg_actions = commit_opts.add_mutually_exclusive_group()
msg_actions.add_argument(
"-m",
"--message",
metavar="MSG",
action="append",
help="specify commit message",
docs="""
Use a given message as the commit message. If multiple -m options are
specified, their values are concatenated as separate paragraphs.
Note that the first value will be used for the commit summary and if
it's empty then a generated summary will be used if available.
""",
)
msg_actions.add_argument(
"-M",
"--message-template",
metavar="FILE",
type=argparse.FileType("r"),
help="use commit message template from specified file",
docs="""
Use content from the given file as a commit message template. The
commit summary prefix '*: ' is automatically replaced by a generated
prefix if one exists for the related staged changes.
""",
)
msg_actions.add_argument("-F", "--file", help=argparse.SUPPRESS)
msg_actions.add_argument("-t", "--template", help=argparse.SUPPRESS)
commit_opts.add_argument(
"-e",
"--edit",
action="store_true",
help="force edit of commit",
docs="""
This option will ask git to open the commit message in an editor before
commit. The git configuration is used to select the editor.
""",
)
add_actions = commit_opts.add_mutually_exclusive_group()
add_actions.add_argument(
"-u",
"--update",
dest="git_add_arg",
const="--update",
action="store_const",
help="stage all changed files",
)
add_actions.add_argument(
"-a",
"--all",
dest="git_add_arg",
const="--all",
action="store_const",
help="stage all changed/new/removed files",
)
class HistoricalRepo(UnconfiguredTree):
"""Repository of historical packages stored in a temporary directory."""
def __init__(self, tmpdir, *args, **kwargs):
# cache tmpdir to delay cleanup until exit
self.__tmpdir = tmpdir
super().__init__(*args, **kwargs)
def _extract_historical(repo, path: str, keys: Iterable[str]):
"""Extract the packages as they are in HEAD into a directory."""
old_files = subprocess.Popen(
["git", "archive", "--end-of-options", "HEAD", *keys],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
cwd=repo.location,
)
if old_files.poll(): # pragma: no cover
error = old_files.stderr.read().decode().strip()
raise RuntimeError(f"failed populating archive repo: {error}")
with tarfile.open(mode="r|", fileobj=old_files.stdout) as tar:
# Whilst we trust git archive, we still leave the basic protections on.
tar.extractall(path=path, filter="data")
# GLEP 81 categories, mapped to what their packages allocate
_ACCT_CATEGORIES = {"acct-user": "user", "acct-group": "group"}
def change(*statuses):
"""Decorator to register change status summary methods."""
class decorator:
"""Decorator with access to the class of a decorated function."""
def __init__(self, func):
self.func = func
def __set_name__(self, owner, name):
owner.status_funcs[frozenset(statuses)] = self.func
setattr(owner, name, self.func)
return decorator
class ChangeSummary:
"""Generic summary generation support for git changes."""
# mapping of handled statuses to functions
status_funcs = None
def __init__(self, options, changes: "Iterable[PkgChange]"):
self.options = options
self.repo = options.repo
self.changes = {x.atom: x for x in changes}
@jit_attr
def old_repo(self):
"""Create a repository of the changed packages as they are in HEAD."""
tmpdir = tempfile.TemporaryDirectory()
repo_dir = tmpdir.name
# set up some basic repo files so pkgcore doesn't complain
os.makedirs(pjoin(repo_dir, "metadata"))
with open(pjoin(repo_dir, "metadata", "layout.conf"), "w") as f:
f.write(f"masters = {' '.join(x.repo_id for x in self.repo.trees)}\n")
os.makedirs(pjoin(repo_dir, "profiles"))
with open(pjoin(repo_dir, "profiles", "repo_name"), "w") as f:
f.write(f"{self.repo.repo_id}-old\n")
_extract_historical(self.repo, repo_dir, {atom.key for atom in self.changes})
repo_config = RepoConfig(repo_dir)
tree_cls = partial(HistoricalRepo, tmpdir)
return tree(self.options.config, repo_config, tree_cls=tree_cls)
def __str__(self):
"""Serialize git changes into commit summary strings."""
statuses = frozenset(x.status for x in self.changes.values())
try:
if s := self.status_funcs[statuses](self):
return s
except KeyError: # pragma: no cover
pass
return ""
class MetadataSummary(ChangeSummary):
"""Summary generation support for metadata.xml changes."""
status_funcs: ClassVar[dict[str, callable]] = {}
@change("M")
def modify(self):
"""Generate summaries for modify actions."""
atom = next(iter(self.changes))
pkgs = self.repo.match(atom)
try:
old_pkg = self.old_repo.match(atom)[0]
new_pkg = pkgs[0]
except IndexError: # pragma: no cover
# broken ebuild should be caught during manifesting or scanning
return
if old_pkg.maintainers != new_pkg.maintainers:
new = {x.email for x in new_pkg.maintainers}
old = {x.email for x in old_pkg.maintainers}
p = git.run("config", "user.email", stdout=subprocess.PIPE)
git_email = p.stdout.strip()
if git_email in new - old:
return "add myself as a maintainer"
if git_email in old - new:
return "drop myself as a maintainer"
if old and not new:
return "drop to maintainer-needed"
return "update maintainers"
elif old_pkg.stabilize_allarches != new_pkg.stabilize_allarches:
status = "mark" if new_pkg.stabilize_allarches else "drop"
return f"{status} ALLARCHES"
elif old_pkg.straight_to_stable != new_pkg.straight_to_stable:
status = "mark" if new_pkg.straight_to_stable else "drop"
return f"{status} straight-to-stable"
elif old_pkg.upstreams != new_pkg.upstreams:
new = set(new_pkg.upstreams)
old = set(old_pkg.upstreams)
added = new - old
removed = old - new
msg = []
for action, data in (("add", added), ("remove", removed)):
if data:
upstreams = ", ".join(sorted(x.type for x in data))
msg.append(f"{action} {upstreams} upstream metadata")
# return action-specific shorter summary if a single type exists
if len(msg) == 1 and len(msg[0]) <= 50:
return msg[0]
return "update upstream metadata"
class PkgSummary(ChangeSummary):
"""Summary generation support for single package ebuild changes."""
status_funcs: ClassVar[dict[str, callable]] = {}
@jit_attr
def versions(self):
"""Tuple of package versions that were changed."""
return tuple(x.fullver for x in sorted(self.changes))
@jit_attr
def revbump(self):
"""Boolean for any package changes involving version revisions."""
return any(x.revision for x in self.changes)
@jit_attr
def existing(self):
"""Existing packages in the tree related to the package."""
return tuple(self.repo.match(next(iter(self.changes)).unversioned_atom))
@jit_attr
def account(self):
"""Identifier a new GLEP 81 user or group package allocates, if any."""
atom = next(iter(self.changes))
if (kind := _ACCT_CATEGORIES.get(atom.category)) is None or len(self.changes) != 1:
return None
# a negative id asks the eclass to allocate dynamically, nothing to name
id_re = re.compile(rf"""ACCT_{kind.upper()}_ID=(?P<quot>['"]?)(?P<id>\d+)(?P=quot)""")
for pkg in self.repo.match(atom):
for line in pkg.ebuild.text_fileobj():
if mo := id_re.match(line):
return f"{kind} {mo.group('id')}"
return None
@change("A")
def add(self):
"""Generate summaries for add actions."""
if len(self.existing) == len(self.changes):
if self.account is not None:
return f"add {self.account}"
msg = f"new package, add {', '.join(self.versions)}"
if len(self.versions) == 1 or len(msg) <= 50:
return msg
return "new package"
elif not self.revbump:
msg = f"add {', '.join(self.versions)}"
if len(self.versions) == 1 or len(msg) <= 50:
return msg
return "add versions"
elif len(self.changes) == 1:
# adding a new revbump
atom = next(iter(self.changes))
# assume revbump was based on the previous version
pkgs = sorted(x for x in self.repo.match(atom.unversioned_atom) if x <= atom)
try:
old_pkg, new_pkg = pkgs[-2:]
except ValueError: # pragma: no cover
# broken ebuild should be caught during manifesting or scanning
return
if old_pkg.eapi in new_pkg.eapi.inherits[1:]:
return f"update EAPI {old_pkg.eapi} -> {new_pkg.eapi}"
@change("D")
def remove(self):
"""Generate summaries for remove actions."""
if self.existing:
msg = f"drop {', '.join(self.versions)}"
if len(self.versions) == 1 or len(msg) <= 50:
return msg
return "drop versions"
return "treeclean"
@change("R")
def rename(self):
"""Generate summaries for rename actions."""
if len(self.changes) == 1:
if not self.revbump:
# single, non-revbump version rename
change = next(iter(self.changes.values()))
return f"add {change.atom.fullver}, drop {change.old.fullver}"
elif len({x.key for x in self.changes}) == 1:
change = next(iter(self.changes.values()))
if change.atom.key != change.old.key:
# package rename
return f"rename {change.old.key}"
@change("M")
def modify(self):
"""Generate summaries for modify actions."""
summaries = set()
for atom in self.changes:
pkgs = self.repo.match(atom)
try:
old_pkg = self.old_repo.match(atom)[0]
new_pkg = pkgs[0]
except IndexError: # pragma: no cover
# broken ebuild should be caught during manifesting or scanning
continue
if old_pkg.eapi in new_pkg.eapi.inherits[1:]:
summaries.add(f"update EAPI {old_pkg.eapi} -> {new_pkg.eapi}")
elif new_pkg.keywords != old_pkg.keywords:
repo_stable = set(self.repo.config.arches_desc["stable"])
new_keywords = set(new_pkg.keywords)
old_keywords = set(old_pkg.keywords)
added = new_keywords - old_keywords
removed = old_keywords - new_keywords
if removed == {f"~{x}" for x in added}:
action = f"stabilize {atom.fullver}"
if (
new_pkg.stabilize_allarches
and repo_stable
and not repo_stable.intersection(
x.lstrip("~") for x in new_keywords - removed if x[0] == "~"
)
):
msg = f"{action} for ALLARCHES"
else:
msg = f"{action} for {', '.join(sorted(added))}"
elif removed == {x.lstrip("~") for x in added}:
action = f"destabilize {atom.fullver}"
msg = f"{action} for {', '.join(sorted(added))}"
elif added:
action = f"keyword {atom.fullver}"
msg = f"{action} for {', '.join(sorted(added))}"
else:
action = f"unkeyword {atom.fullver}"
msg = f"{action} for {', '.join(sorted(removed))}"
if len(msg) <= 50:
summaries.add(msg)
else:
summaries.add(action)
else:
# use sourced bash env diffs to determine summaries
old_env = old_pkg.environment.data.splitlines()
new_env = new_pkg.environment.data.splitlines()
var_drop_re = re.compile(r"^-declare .+ (?P<name>\w+)=(?P<value>.+)$")
var_add_re = re.compile(r"^\+declare .+ (?P<name>\w+)=(?P<value>.+)$")
drop, add = {}, {}
for x in difflib.unified_diff(old_env, new_env):
if mo := var_drop_re.match(x):
drop[mo.group("name")] = mo.group("value")
elif mo := var_add_re.match(x):
add[mo.group("name")] = mo.group("value")
watch_vars = {"HOMEPAGE", "DESCRIPTION", "LICENSE", "SRC_URI"}
array_targets = {"PYTHON_COMPAT", "LUA_COMPAT"}
string_targets = {"USE_RUBY"}
use_expand_mapping = {
"PYTHON_COMPAT": "python_targets",
"LUA_COMPAT": "lua_targets",
"USE_RUBY": "ruby_targets",
}
targets = array_targets | string_targets
updated_vars = {
name for name in drop.keys() & add.keys() if drop[name] != add[name]
}
if updated := sorted(watch_vars & updated_vars):
summaries.add(f"update {', '.join(updated)}")
elif (target := targets & updated_vars) and len(target) == 1:
target = next(iter(target))
py_re = partial(re.sub, r"^python(\d+)_(\d+)$", r"py\1.\2")
use_expand = {
py_re(use[len(target) + 2 :])
for use, _ in self.repo.use_expand_desc[use_expand_mapping[target]]
}
if target in array_targets:
array_re = re.compile(r'\[\d+\]="(?P<val>.+?)"')
old = {py_re(m.group("val")) for m in re.finditer(array_re, drop[target])}
new = {py_re(m.group("val")) for m in re.finditer(array_re, add[target])}
else:
old = set(drop[target].strip('"').split())
new = set(add[target].strip('"').split())
msg = []
if added := sorted(new - old):
msg.append(f"enable {', '.join(added)}")
if dropped := old - new:
if not msg or (dropped := dropped.intersection(use_expand)):
msg.append(f"disable {', '.join(sorted(dropped))}")
msg = " and ".join(msg)
if len(msg) <= 50:
summaries.add(msg)
else:
summaries.add(f"update {target} support")
if len(summaries) == 1:
return next(iter(summaries))
class GitChanges(UserDict):
"""Mapping of change objects for staged git changes."""
# ebuild path regex, validation is handled on instantiation
_ebuild_re = re.compile(r"^(?P<category>[^/]+)/[^/]+/(?P<package>[^/]+)\.ebuild$")
_eclass_re = re.compile(r"^eclass/(?P<name>[^/]+\.eclass)$")
def __init__(self, options):
self._options = options
self._repo = options.repo
super().__init__(self._generate_mapping())
def _generate_mapping(self):
"""Generate mapping for staged changes."""
# stage changes as requested
if self._options.git_add_arg:
git.run("add", self._options.git_add_arg, "--", self._options.cwd)
# determine staged changes forcing rename search
p = git.run(
"diff-index",
"--diff-filter=ARMD",
"--find-renames",
"--name-status",
"--cached",
"-z",
"--end-of-options",
"HEAD",
"--",
*self._options.git_args_paths,
stdout=subprocess.PIPE,
)
# if no changes exist, exit early
if not p.stdout:
commit.error("no staged changes exist")
data = deque(p.stdout.strip("\x00").split("\x00"))
changes = defaultdict(OrderedSet)
while data:
status = data.popleft()
old_path = None
if status.startswith("R"):
status = "R"
old_path = data.popleft()
path = data.popleft()
path_components = path.split(os.sep)
if path_components[0] in self._repo.categories and len(path_components) > 2:
if mo := self._ebuild_re.match(path):
# ebuild changes
try:
atom = atom_cls(f"={mo.group('category')}/{mo.group('package')}")
old = None
if status == "R" and (om := self._ebuild_re.match(old_path)):
old = atom_cls(f"={om.group('category')}/{om.group('package')}")
changes[PkgChange].add(
PkgChange(
self._repo.location, status, path, atom=atom, ebuild=True, old=old
)
)
except MalformedAtom:
continue
else:
# non-ebuild package level changes
atom = atom_cls(os.sep.join(path_components[:2]))
changes[PkgChange].add(
PkgChange(self._repo.location, status, path, atom=atom, ebuild=False)
)
elif mo := self._eclass_re.match(path):
changes[EclassChange].add(
EclassChange(self._repo.location, status, path, name=mo.group("name"))
)
else:
changes[path_components[0]].add(Change(self._repo.location, status, path))
return changes
@jit_attr
def all(self):
"""All change objects, in order, without duplicates."""
return tuple(dict.fromkeys(chain.from_iterable(self.data.values())))
@jit_attr
def pkg_changes(self):
"""All package change objects, in order, without duplicates."""
return tuple(dict.fromkeys(self.data.get(PkgChange, ())))
@jit_attr
def ebuild_changes(self):
"""All ebuild change objects, in order."""
return tuple(x for x in self.pkg_changes if x.ebuild)
@jit_attr
def prefix(self):
"""Determine commit message prefix using GLEP 66 as a guide.
See https://www.gentoo.org/glep/glep-0066.html#commit-messages for
details.
"""
single = len(self.data) == 1
pkg_with_profile_update = len(self.data) == 2 and set(self.data) == {PkgChange, "profiles"}
if single or pkg_with_profile_update:
if single:
change_type, change_objs = next(iter(self.data.items()))
else:
change_type = PkgChange
change_objs = self.data[PkgChange]
if len(change_objs) == 1:
# changes limited to a single object
return change_objs[0].prefix
else:
# multiple changes of the same object type
common_path = os.path.commonpath(x.path for x in change_objs)
if change_type is PkgChange:
if os.sep in common_path:
return f"{common_path}: "
elif common_path:
return f"{common_path}/*: "
return "*/*: "
elif common_path:
return f"{common_path}: "
# no prefix used for global changes
return ""
@jit_attr
def summary(self):
"""Determine commit message summary."""
# all changes made on the same package
if len({x.atom.key for x in self.pkg_changes}) == 1:
if not self.ebuild_changes:
if len(self.pkg_changes) == 1:
if self.pkg_changes[0].path.endswith("/Manifest"):
return "update Manifest"
elif self.pkg_changes[0].path.endswith("/metadata.xml"):
return str(MetadataSummary(self._options, self.pkg_changes))
return str(PkgSummary(self._options, self.ebuild_changes))
return ""
@dataclass(frozen=True)
class Change:
"""Generic file change."""
repo: str
status: str
path: str
@property
def full_path(self):
return pjoin(self.repo, self.path)
def read(self):
"""Read data from the change's file."""
try:
with open(self.full_path, "r", encoding="utf-8") as f:
data = f.read()
except (FileNotFoundError, UnicodeDecodeError):
data = None
object.__setattr__(self, "data", data)
return data
def update(self, data):
"""Update the change's cached file data."""
if data != getattr(self, "data", None):
object.__setattr__(self, "data", data)
return self
def sync(self):
"""Write the change's cached file data back to its file."""
try:
with open(self.full_path, "w", encoding="utf-8") as f:
f.write(self.data)
except AttributeError:
pass
@property
def prefix(self):
if os.sep in self.path:
# use change path's parent directory
return f"{os.path.dirname(self.path)}: "
# use repo root file name
return f"{self.path}: "
@dataclass(frozen=True)
class EclassChange(Change):
"""Eclass change."""
name: str
@property
def prefix(self):
return f"{self.name}: "
@dataclass(frozen=True)
class PkgChange(Change):
"""Package change."""
atom: atom_cls
ebuild: bool
old: atom_cls = None
@property
def prefix(self):
return f"{self.atom.key}: "
def determine_msg_args(options, changes):
"""Determine message-related arguments used with `git commit`."""
args = []
if options.file:
args.extend(["-F", options.file])
elif options.template:
args.extend(["-t", options.template])
else:
if options.message_template:
message: list[str] = options.message_template.read().splitlines()
try:
message[0] = message[0].removeprefix("*: ")
except IndexError:
commit.error(f"empty message template: {options.message_template.name!r}")
else:
message = [] if options.message is None else options.message
# determine commit message
if message:
# ignore generated prefix when using custom prefix
if not re.match(r"^\S+: ", message[0]):
message[0] = changes.prefix + message[0]
elif changes.prefix:
# use generated summary if a generated prefix exists
message.append(changes.prefix + changes.summary)
else:
# use empty string to force user input
message.append("")
tmp = tempfile.NamedTemporaryFile(mode="w")
tmp.write(message[0])
if len(message) > 1:
# wrap body paragraphs at 85 chars
body = ("\n".join(textwrap.wrap(x, width=85)) for x in message[1:])
tmp.write("\n\n" + "\n\n".join(body))
# add footer tags
if options.footer:
tmp.write("\n\n")
for tag, value in options.footer:
tmp.write(f"{tag}: {value}\n")
tmp.flush()
# force `git commit` to open an editor for uncompleted summary
if not message[0] or message[0].endswith(" "):
args.extend(["-t", tmp.name])
else:
args.extend(["-F", tmp.name])
# Explicitly register tempfile removal so the object isn't garbage
# collected and removed when leaving function scope.
atexit.register(tmp.close)
return args
@commit.bind_final_check
def _commit_validate(parser, namespace):
# flag for testing if running under the gentoo repo
namespace.gentoo_repo = namespace.repo.repo_id == "gentoo"
# mangle files in the gentoo repo by default
if namespace.mangle is None and namespace.gentoo_repo:
namespace.mangle = True
# determine `pkgcheck scan` args
namespace.scan_args = ["-v"] * namespace.verbosity
if namespace.pkgcheck_scan:
namespace.scan_args.extend(shlex.split(namespace.pkgcheck_scan))
namespace.scan_args.extend(["--exit", "GentooCI", "--staged"])
if namespace.gpg_sign is False:
namespace.commit_args.append("--no-gpg-sign")
elif namespace.gpg_sign is True or namespace.repo.config.sign_commits:
namespace.commit_args.append("--gpg-sign")
def update_manifests(options, out, err, changes):
"""Update package manifests for any staged ebuild changes."""
repo = options.repo
untracked_ebuild_re = re.compile(r"^\?\? (?P<category>[^/]+)/[^/]+/(?P<package>[^/]+)\.ebuild$")
# update manifests for existing packages
if atoms := {x.atom.unversioned_atom for x in changes.ebuild_changes}:
if pkgs := {x.versioned_atom for x in repo.itermatch(packages.OrRestriction(*atoms))}:
# pull all matches and drop untracked ebuilds
p = git.run(
"status",
"--porcelain=v1",
"-u",
"-z",
"--",
"*.ebuild",
cwd=repo.location,
stdout=subprocess.PIPE,
)
for path in p.stdout.strip("\x00").split("\x00"):
if mo := untracked_ebuild_re.match(path):
try:
untracked = atom_cls(f"={mo.group('category')}/{mo.group('package')}")
pkgs.discard(untracked)
except MalformedAtom:
continue
# manifest all staged or committed packages
failed = repo.operations.manifest(
options.domain,
packages.OrRestriction(*pkgs),
observer=observer_mod.formatter_output(out),
distdir=options.distdir,
)
if any(failed):
return 1
# include existing Manifest files for staging
manifests = (pjoin(repo.location, f"{x.key}/Manifest") for x in pkgs)
options.git_add_files.extend(filter(os.path.exists, manifests))
return 0
@commit.bind_main_func
def _commit(options, out, err):
repo = options.repo
# determine changes from staged files
changes = GitChanges(options)
# update package manifests
if update_manifests(options, out, err, changes):
return 1
# mangle files
if options.mangle:
# don't mangle FILESDIR content
skip_regex = re.compile(rf"^{repo.location}/[^/]+/[^/]+/files/.+$")
mangler = GentooMangler if options.gentoo_repo else Mangler
files = mangler(changes.all, skip_regex=skip_regex)
options.git_add_files.extend(files)
# stage modified files
if options.git_add_files:
git.run("add", "--", *options.git_add_files, cwd=repo.location)
# scan staged changes for QA issues if requested
if options.scan:
pipe = scan(options.scan_args)
with reporters.FancyReporter(out) as reporter:
for result in pipe:
reporter.report(result)
# fail on errors unless they're ignored
if pipe.errors:
with reporters.FancyReporter(out) as reporter:
out.write(out.bold, out.fg("red"), "\nFAILURES", out.reset)
for result in sorted(pipe.errors):
reporter.report(result)
if not (options.ask and userquery("Create commit anyway?", out, err)):
return 1
# determine message-related args
args = determine_msg_args(options, changes)
# create commit
git.run("commit", *args, *options.commit_args)
return 0