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
|
# Copyright 2023 The ChromiumOS Authors
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.
"""Provides utilities to read and edit the ChromiumOS Manifest entries.
While this code reads and edits the internal manifest, it should only operate
on toolchain projects (llvm-project, etc.) which are public.
"""
from pathlib import Path
import shutil
import subprocess
from typing import List, Optional, Union
from xml.etree import ElementTree
import atomic_write_file
LLVM_PROJECT_PATH = "src/third_party/llvm-project"
class FormattingError(Exception):
"""Error occurred when formatting the manifest."""
class UpdateManifestError(Exception):
"""Error occurred when updating the manifest."""
class ManifestParseError(Exception):
"""Error occurred when parsing the contents of the manifest."""
def make_xmlparser() -> ElementTree.XMLParser:
"""Return a new xmlparser with custom TreeBuilder."""
return ElementTree.XMLParser(
target=ElementTree.TreeBuilder(insert_comments=True)
)
def _find_llvm_project_in_manifest_tree(
xmlroot: ElementTree.Element,
) -> Optional[ElementTree.Element]:
"""Returns the llvm-project `project` in `xmlroot`, if it exists."""
for child in xmlroot:
if (
child.tag == "project"
and child.attrib.get("path") == LLVM_PROJECT_PATH
):
return child
return None
def extract_current_llvm_hash(src_tree: Path) -> str:
"""Returns the current LLVM SHA for the CrOS tree rooted at `src_tree`.
Raises:
ManifestParseError if the manifest didn't have the expected contents.
"""
xmlroot = ElementTree.parse(
get_chromeos_manifest_path(src_tree), parser=make_xmlparser()
).getroot()
return extract_current_llvm_hash_from_xml(xmlroot)
def extract_current_llvm_hash_from_xml(xmlroot: ElementTree.Element) -> str:
"""Returns the current LLVM SHA for the parsed XML file.
Raises:
ManifestParseError if the manifest didn't have the expected contents.
"""
if xmlroot.tag != "manifest":
raise ManifestParseError(
f"Root tag is {xmlroot.tag}; should be `manifest`."
)
llvm_project = _find_llvm_project_in_manifest_tree(xmlroot)
if llvm_project is None:
raise ManifestParseError("No llvm-project `project` found in manifest.")
revision = llvm_project.attrib.get("revision")
if not revision:
raise ManifestParseError("Toolchain's `project` has no revision.")
return revision
def update_chromeos_manifest(revision: str, src_tree: Path) -> Path:
"""Replaces the manifest project revision with 'revision'.
Notably, this function reformats the manifest file to preserve
the formatting as specified by 'cros format'.
Args:
revision: Revision (git sha) to use in the manifest.
src_tree: Path to the root of the source tree checkout.
Returns:
The manifest path.
Post:
The llvm-project revision info in the chromeos repo manifest
is updated with 'revision'.
Raises:
UpdateManifestError: The manifest could not be changed.
FormattingError: The manifest could not be reformatted.
"""
manifest_path = get_chromeos_manifest_path(src_tree)
parser = make_xmlparser()
xmltree = ElementTree.parse(manifest_path, parser)
update_chromeos_manifest_tree(revision, xmltree.getroot())
with atomic_write_file.atomic_write(manifest_path, mode="wb") as f:
xmltree.write(f, encoding="utf-8")
format_manifest(manifest_path)
return manifest_path
def get_chromeos_manifest_path(src_tree: Path) -> Path:
"""Return the path to the toolchain manifest."""
return src_tree / "manifest-internal" / "_toolchain.xml"
def update_chromeos_manifest_tree(revision: str, xmlroot: ElementTree.Element):
"""Update the revision info for LLVM for a manifest XML root."""
llvm_project_elem = _find_llvm_project_in_manifest_tree(xmlroot)
# Element objects can be falsy, so we need to explicitly check None.
if llvm_project_elem is None:
raise UpdateManifestError("xmltree did not have llvm-project")
llvm_project_elem.attrib["revision"] = revision
def format_manifest(repo_manifest: Path):
"""Use cros format to format the given manifest."""
if not shutil.which("cros"):
raise FormattingError(
"unable to format manifest, 'cros'" " executable not in PATH"
)
cmd: List[Union[str, Path]] = ["cros", "format", repo_manifest]
subprocess.run(cmd, check=True)
|
