|
| 1 | +""" |
| 2 | +Extract macro-expanded tag value (e.g., BuildArch) from given specfile. |
| 3 | +""" |
| 4 | + |
| 5 | +import logging |
| 6 | +import os |
| 7 | +import tempfile |
| 8 | + |
| 9 | +from copr_common.request import SafeRequest |
| 10 | + |
| 11 | +from norpm.macrofile import system_macro_registry |
| 12 | +from norpm.specfile import specfile_expand, ParserHooks |
| 13 | +from norpm.overrides import override_macro_registry |
| 14 | +from norpm.exceptions import NorpmError |
| 15 | + |
| 16 | +DEFAULT_OVERRIDE_URL = "https://raw.githubusercontent.com/praiskup/norpm-macro-overrides/refs/heads/main/distro-arch-specific.json" |
| 17 | + |
| 18 | +DEFAULT_TAG_MAP = { |
| 19 | + # TODO: extract rhel+epel into the datafile |
| 20 | + "epel-7": "rhel-7", |
| 21 | + "epel-8": "rhel-8", |
| 22 | + "epel-9": "rhel-9", |
| 23 | + "epel-10": "centos-stream+epel-10", |
| 24 | + # what do we do about custom-* chroots? |
| 25 | + "custom-0": "fedora-rawhide", |
| 26 | + "custom-1": "fedora-rawhide", |
| 27 | +} |
| 28 | + |
| 29 | +class _TagHooks(ParserHooks): |
| 30 | + """ Gather access to spec tags """ |
| 31 | + def __init__(self, expanded_tags): |
| 32 | + self.expanded_tags = set(expanded_tags) |
| 33 | + self.tags = {} |
| 34 | + |
| 35 | + def tag_found(self, name, value, _tag_raw): |
| 36 | + """ |
| 37 | + Parser hook that gathers the tags' values, if defined. |
| 38 | + """ |
| 39 | + if name not in self.expanded_tags: |
| 40 | + return |
| 41 | + if name not in self.tags: |
| 42 | + self.tags[name] = [] |
| 43 | + # tags may be specified multiple times within a single spec file |
| 44 | + self.tags[name] += [value] |
| 45 | + |
| 46 | + |
| 47 | +def collapse_tag_values_cb(array_of_tag_values): |
| 48 | + """ |
| 49 | + Process tags that represent sets of strings (e.g., ExcludeArch). |
| 50 | +
|
| 51 | + If a tag is specified multiple times within the specfile, this function |
| 52 | + performs a union of all encountered values. The resulting set contains |
| 53 | + every unique string defined across all instances of the tag. |
| 54 | +
|
| 55 | + Returns: |
| 56 | + set: A set of all unique strings extracted from the tag definitions. |
| 57 | + """ |
| 58 | + concat = " ".join(array_of_tag_values) |
| 59 | + return list(set(concat.split())) |
| 60 | + |
| 61 | + |
| 62 | +def extract_tags_from_specfile(specfile, extract_tags, override_database=None, |
| 63 | + target=None, tag_cb=None): |
| 64 | + """ |
| 65 | + Parse the given SPECFILE against system macros and optionally TARGET macros. |
| 66 | +
|
| 67 | + If TARGET is specified, OVERRIDE_DATABASE (a file path) must also be |
| 68 | + provided. If TARGET is omitted, the local system macros are used by |
| 69 | + default. |
| 70 | +
|
| 71 | + Args: |
| 72 | + specfile (str): Path to the specfile to be parsed. |
| 73 | + target (str, optional): Target distribution (e.g., "rhel-7"). |
| 74 | + override_database (str, optional): Database file path required if target |
| 75 | + is set. |
| 76 | + tag_cb (callable, optional): A callback function used to transform the |
| 77 | + list of values for each tag. If provided, each item in the return |
| 78 | + dictionary is passed through this function. A common choice is |
| 79 | + `collapse_tag_values_cb`, which collapses the list into a set of |
| 80 | + unique strings. |
| 81 | +
|
| 82 | + Returns: |
| 83 | + dict: A mapping of lowercase tagnames to their processed values. |
| 84 | + Default format: {'excludearch': ['ppc64 ppc64le', 's390x i386']} |
| 85 | + With tag_cb: The value type is determined by the callback's return. |
| 86 | + With tag_cb=collapse_tag_values_cb: |
| 87 | + {'excludearch': {'ppc64', 'ppc64le', 's390x', 'i386'}} |
| 88 | + Note: |
| 89 | + Since RPM tags are case-insensitive, all tagnames are normalized |
| 90 | + using .lower(). |
| 91 | + """ |
| 92 | + registry = system_macro_registry() |
| 93 | + if override_database: |
| 94 | + registry = override_macro_registry(registry, override_database, target) |
| 95 | + |
| 96 | + # %dist definition contains %lua mess, it's safer to clear it (since we |
| 97 | + # don't necessarily need it) |
| 98 | + registry["dist"] = "" |
| 99 | + |
| 100 | + # norpm maintains a few tricks to ease the spec file parsing |
| 101 | + registry.known_norpm_hacks() |
| 102 | + |
| 103 | + tags = _TagHooks(extract_tags) |
| 104 | + try: |
| 105 | + with open(specfile, "r", encoding="utf8") as fd: |
| 106 | + specfile_expand(fd.read(), registry, tags) |
| 107 | + except NorpmError as err: |
| 108 | + print("WARNING: Building for all architectures since " |
| 109 | + f"the spec file parser: failed: {err}") |
| 110 | + |
| 111 | + if not tag_cb: |
| 112 | + return tags.tags |
| 113 | + |
| 114 | + processed = {} |
| 115 | + for tag, values in tags.tags.items(): |
| 116 | + processed[tag] = tag_cb(values) |
| 117 | + |
| 118 | + return processed |
| 119 | + |
| 120 | + |
| 121 | +def get_architecture_specific_tags(specfile, extract_tags, targets, |
| 122 | + override_database=DEFAULT_OVERRIDE_URL, |
| 123 | + log=logging): |
| 124 | + """ |
| 125 | + A high-level tool for Copr, working with temporary files, etc. |
| 126 | + """ |
| 127 | + architecture_tags = {} |
| 128 | + request = SafeRequest(log=log) |
| 129 | + response = request.get(override_database) |
| 130 | + with tempfile.NamedTemporaryFile(mode='wb', delete=False) as temp: |
| 131 | + temp_path = temp.name |
| 132 | + temp.write(response.content) |
| 133 | + |
| 134 | + try: |
| 135 | + for distro in targets: |
| 136 | + ask = DEFAULT_TAG_MAP.get(distro, distro) |
| 137 | + log.info("Extracting arch-specific tags for %s", distro) |
| 138 | + architecture_tags[distro] = extract_tags_from_specfile( |
| 139 | + specfile, |
| 140 | + extract_tags, |
| 141 | + override_database=temp_path, |
| 142 | + target=ask, |
| 143 | + tag_cb=collapse_tag_values_cb |
| 144 | + ) |
| 145 | + finally: |
| 146 | + try: |
| 147 | + os.unlink(temp_path) |
| 148 | + except OSError: |
| 149 | + pass |
| 150 | + return architecture_tags |
0 commit comments