Tools/git-repo
1
0
Fork 0
Code Activity

manifest: Improve diagnostic on base-rev mismatch errors

Browse source 
* Improve formatting of message, making it more clear which
  revision belongs to which element.
* Include a trail of where the element was defined. In larger projects,
  with multiple includes, multiple alternative default-xmls, or when
  using local_manifests, it is not always immediately obvious
  which files that are included and in which order,
  without much manual traversing of the xml files.
  This will also make it clear if the parent definition is already
  an <extend-project>, in the rare event of chaining multiple
  <extend-project>.
* Ensure formatting persists when passed into ManifestParseError.
  Previously the raw list was passed as second argument
  which caused newlines to be printed like raw "\n".

Example new message:
    extend-project mismatch for name 'platform/bionic'
        ├──Mismatching base-rev="64078752f5cc0c5fe33e1e9cc49b0736aa2f93e8" (included via ../manifest.xml -> default.xml -> project_a.xml -> project_a_aosp_patches.xml)
        └──Previous definition: <project ... revision="a93577f6224a53c0987e0deb3d6101c22ce83018" /> (included via ../manifest.xml -> -> default.xml -> aosp.xml)

Example old message:
    ('revision base check failed, rebase patches and update base revs for: ', ['extend-project name platform/bionic mismatch base 64078752f5cc0c5fe33e1e9cc49b0736aa2f93e8 vs revision a93577f6224a53c0987e0deb3d6101c22ce83018'])

Change-Id: I7f0105a01445fdced916186a88f221d7097ef769
This commit is contained in:
Erik Elmeke 2025-04-22 12:20:22 +02:00
parent 8539cb5a11
commit ec2ad830f0
2 changed files with 57 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

85
manifest_xml.py
View file

@ -1390,11 +1390,13 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
tree: List[IncludeTree],
parent_groups="",
parent_node=None,
include_chain=None,
) -> List[Element]:
"""Recursivelly convert tree of includes into a flat list of Nodes.
This step forwards attributes inherited from the parent <include>
to the affected child projects, such as "groups" and "revision".
to the affected child projects, such as "groups", "revision" and
"includechain".
Note that this is not a full canonicalization of the manifest (for
that see ToXml), this meerly adds the required information that
should be inheretied from a parent <include>.
@ -1413,9 +1415,11 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
List of XML nodes.
"""
include_chain = include_chain or []
nodes: List[Element] = []
for elemtype, node, path, children in tree:
chain = [*include_chain, path]
if elemtype == "include":
include_groups = ""
if parent_groups:
@ -1424,9 +1428,14 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
include_groups = (
node.getAttribute("groups") + "," + include_groups
)
nodes.extend(self._FlattenIncludes(
children, include_groups, parent_node=node
))
nodes.extend(
self._FlattenIncludes(
children,
include_groups,
parent_node=node,
include_chain=chain,
)
)
else:
if parent_groups and node.nodeName == "project":
nodeGroups = parent_groups
@ -1443,6 +1452,7 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
node.setAttribute(
"revision", parent_node.getAttribute("revision")
)
node.includechain = chain
nodes.append(node)
return nodes
@ -1611,6 +1621,23 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
for subproject in project.subprojects:
recursively_add_projects(subproject)
def format_base_rev_error(orig_project, extend_node, base_rev):
prev_incchain = " -> ".join(
orig_project.prev_definition.includechain
)
curr_includechain = " -> ".join(extend_node.includechain)
project_fragment = (
f"<{orig_project.prev_definition.nodeName} ... "
f'"revision="{orig_project.revisionExpr}" />'
)
curr_incmsg = f"(included via {curr_includechain})"
prev_incmsg = f"(included via {prev_incchain})"
return (
f"{extend_node.nodeName} mismatch for name '{name}'\n"
f' ├──Mismatching base-rev="{base_rev}" {curr_incmsg}\n'
f" └──Previous definition: {project_fragment} {prev_incmsg}"
)
repo_hooks_project = None
enabled_repo_hooks = None
failed_revision_changes = []
@ -1654,14 +1681,12 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
if groups:
p.groups.extend(groups)
if revision:
if base_revision:
if p.revisionExpr != base_revision:
failed_revision_changes.append(
"extend-project name %s mismatch base "
"%s vs revision %s"
% (name, base_revision, p.revisionExpr)
)
p.SetRevision(revision)
if base_revision and p.revisionExpr != base_revision:
failed_revision_changes.append(
format_base_rev_error(p, node, base_revision)
)
p.SetRevision(revision, prev_definition=node)
if remote_name:
p.remote = remote.ToRemoteSpec(name)
@ -1749,13 +1774,15 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
for projname, projects in list(self._projects.items()):
for p in projects:
if name == projname and not path:
if base_revision:
if p.revisionExpr != base_revision:
failed_revision_changes.append(
"remove-project name %s mismatch base "
"%s vs revision %s"
% (name, base_revision, p.revisionExpr)
if (
base_revision
and p.revisionExpr != base_revision
):
failed_revision_changes.append(
format_base_rev_error(
p, node, base_revision
)
)
del self._paths[p.relpath]
if not removed_project:
del self._projects[name]
@ -1763,17 +1790,15 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
elif path == p.relpath and (
name == projname or not name
):
if base_revision:
if p.revisionExpr != base_revision:
failed_revision_changes.append(
"remove-project path %s mismatch base "
"%s vs revision %s"
% (
p.relpath,
base_revision,
p.revisionExpr,
)
if (
base_revision
and p.revisionExpr != base_revision
):
failed_revision_changes.append(
format_base_rev_error(
p, node, base_revision
)
)
self._projects[projname].remove(p)
del self._paths[p.relpath]
removed_project = p.name
@ -1796,8 +1821,7 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
if failed_revision_changes:
raise ManifestParseError(
"revision base check failed, rebase patches and update "
"base revs for: ",
failed_revision_changes,
"base-rev for:\n" + "\n".join(failed_revision_changes),
)
# Store repo hooks project information.
@ -2132,6 +2156,7 @@ https://gerrit.googlesource.com/git-repo/+/HEAD/docs/manifest-format.md
use_git_worktrees=use_git_worktrees,
**extra_proj_attrs,
)
project.prev_definition = node
for n in node.childNodes:
if n.nodeName == "copyfile":

3
project.py
View file

@ -658,13 +658,14 @@ class Project:
return self.relpath
return os.path.join(self.manifest.path_prefix, self.relpath)
def SetRevision(self, revisionExpr, revisionId=None):
def SetRevision(self, revisionExpr, revisionId=None, prev_definition=None):
"""Set revisionId based on revision expression and id"""
self.revisionExpr = revisionExpr
if revisionId is None and revisionExpr and IsId(revisionExpr):
self.revisionId = self.revisionExpr
else:
self.revisionId = revisionId
self.prev_definition = prev_definition
def UpdatePaths(self, relpath, worktree, gitdir, objdir):
"""Update paths used by this project"""