# -*- coding: utf-8 -*- # SPDX-License-Identifier: MIT import copy import logging import os import koji import tempfile import glob import datetime import time import dogpile.cache import random import string import kobo.rpmlib import threading import six.moves.xmlrpc_client as xmlrpclib import munch import locale from itertools import chain from OpenSSL.SSL import SysCallError import textwrap from module_build_service import log, conf, models import module_build_service.scm import module_build_service.utils from module_build_service.builder.utils import execute_cmd from module_build_service.db_session import db_session from module_build_service.errors import ProgrammingError from module_build_service.builder.base import GenericBuilder from module_build_service.builder.KojiContentGenerator import KojiContentGenerator from module_build_service.utils import get_reusable_components, get_reusable_module, set_locale logging.basicConfig(level=logging.DEBUG) def koji_multicall_map(koji_session, koji_session_fnc, list_of_args=None, list_of_kwargs=None): """ Calls the `koji_session_fnc` using Koji multicall feature N times based on the list of arguments passed in `list_of_args` and `list_of_kwargs`. Returns list of responses sorted the same way as input args/kwargs. In case of error, the error message is logged and None is returned. For example to get the package ids of "httpd" and "apr" packages: ids = koji_multicall_map(session, session.getPackageID, ["httpd", "apr"]) # ids is now [280, 632] :param KojiSessions koji_session: KojiSession to use for multicall. :param object koji_session_fnc: Python object representing the KojiSession method to call. :param list list_of_args: List of args which are passed to each call of koji_session_fnc. :param list list_of_kwargs: List of kwargs which are passed to each call of koji_session_fnc. """ if list_of_args is None and list_of_kwargs is None: raise ProgrammingError("One of list_of_args or list_of_kwargs must be set.") if ( type(list_of_args) not in [type(None), list] or type(list_of_kwargs) not in [type(None), list] ): raise ProgrammingError("list_of_args and list_of_kwargs must be list or None.") if list_of_kwargs is None: list_of_kwargs = [{}] * len(list_of_args) if list_of_args is None: list_of_args = [[]] * len(list_of_kwargs) if len(list_of_args) != len(list_of_kwargs): raise ProgrammingError("Length of list_of_args and list_of_kwargs must be the same.") koji_session.multicall = True for args, kwargs in zip(list_of_args, list_of_kwargs): if type(args) != list: args = [args] if type(kwargs) != dict: raise ProgrammingError("Every item in list_of_kwargs must be a dict") koji_session_fnc(*args, **kwargs) try: responses = koji_session.multiCall(strict=True) except Exception: log.exception( "Exception raised for multicall of method %r with args %r, %r:", koji_session_fnc, args, kwargs, ) return None if not responses: log.error("Koji did not return response for multicall of %r", koji_session_fnc) return None if type(responses) != list: log.error( "Fault element was returned for multicall of method %r: %r", koji_session_fnc, responses ) return None results = [] # For the response specification, see # https://web.archive.org/web/20060624230303/http://www.xmlrpc.com/discuss/msgReader$1208?mode=topic # Relevant part of this: # Multicall returns an array of responses. There will be one response for each call in # the original array. The result will either be a one-item array containing the result value, # or a struct of the form found inside the standard element. for response, args, kwargs in zip(responses, list_of_args, list_of_kwargs): if type(response) == list: if not response: log.error( "Empty list returned for multicall of method %r with args %r, %r", koji_session_fnc, args, kwargs ) return None results.append(response[0]) else: log.error( "Unexpected data returned for multicall of method %r with args %r, %r: %r", koji_session_fnc, args, kwargs, response ) return None return results @module_build_service.utils.retry(wait_on=(xmlrpclib.ProtocolError, koji.GenericError)) def koji_retrying_multicall_map(*args, **kwargs): """ Retrying version of koji_multicall_map. This tries to retry the Koji call in case of koji.GenericError or xmlrpclib.ProtocolError. Please refer to koji_multicall_map for further specification of arguments. """ return koji_multicall_map(*args, **kwargs) class KojiModuleBuilder(GenericBuilder): """ Koji specific builder class """ backend = "koji" _build_lock = threading.Lock() region = dogpile.cache.make_region().configure("dogpile.cache.memory") @module_build_service.utils.validate_koji_tag("tag_name") def __init__(self, db_session, owner, module, config, tag_name, components): """ :param db_session: SQLAlchemy session object. :param owner: a string representing who kicked off the builds :param module: module_build_service.models.ModuleBuild instance. :param config: module_build_service.config.Config instance :param tag_name: name of tag for given module """ self.db_session = db_session self.owner = owner self.module_str = module.name self.module = module self.mmd = module.mmd() self.config = config self.tag_name = tag_name self.__prep = False log.debug("Using koji profile %r" % config.koji_profile) log.debug("Using koji_config: %s" % config.koji_config) self.koji_session = self.get_session(config) self.arches = sorted(arch.name for arch in self.module.arches) # Allow KojiModuleBuilder to be initialized if no arches are set but the module is in # a failed set. This will allow the clean up of old module builds. if not self.arches and module.state not in models.FAILED_STATES: raise ValueError("No arches specified in module build.") # These eventually get populated by calling _connect and __prep is set to True self.module_tag = None # string # A dict containing tag info returned from Koji API getTag. self.module_build_tag = None self.module_target = None # A koji target dict self.build_priority = config.koji_build_priority self.components = components def __repr__(self): return "" % (self.module_str, self.tag_name) @region.cache_on_arguments() def getPerms(self): return dict([(p["name"], p["id"]) for p in self.koji_session.getAllPerms()]) @module_build_service.utils.retry(wait_on=(IOError, koji.GenericError)) def buildroot_ready(self, artifacts=None): """ :param artifacts=None - list of nvrs Returns True or False if the given artifacts are in the build root. """ assert self.module_target, "Invalid build target" tag_id = self.module_target["build_tag"] repo = self.koji_session.getRepo(tag_id) builds = [self.koji_session.getBuild(a, strict=True) for a in artifacts or []] log.info( "%r checking buildroot readiness for repo: %r, tag_id: %r, artifacts: %r, builds: %r" % (self, repo, tag_id, artifacts, builds) ) if not repo: log.info("Repo is not generated yet, buildroot is not ready yet.") return False ready = bool( koji.util.checkForBuilds( self.koji_session, tag_id, builds, repo["create_event"], latest=True) ) if ready: log.info("%r buildroot is ready" % self) else: log.info("%r buildroot is not yet ready.. wait." % self) return ready @staticmethod def _get_filtered_rpms_on_self_dep(module_build, filtered_rpms_of_dep): """Remove built RPMs of reusable components from filtered RPMs :param module_build: find out reusable components' built RPMs from the reusable module build of this one. :type module_build: :class:`ModuleBuild` :param filtered_rpms_of_dep: list of RPMs' NVRs. Every built RPMs included in reusable components will be removed from this list. The result is modified inside a copy of this list. :type filtered_rpms_of_dep: list[str] :return: a list of RPMs without those included in reusable components. :rtype: list[str] """ # filtered_rpms will contain the NVRs of non-reusable component's RPMs filtered_rpms = list(set(filtered_rpms_of_dep)) # Get a module build that can be reused, which will likely be the # build dep that is used since it relies on itself reusable_module = get_reusable_module(module_build) if not reusable_module: return filtered_rpms koji_session = KojiModuleBuilder.get_session(conf, login=False) # Get all the RPMs and builds of the reusable module in Koji rpms, builds = koji_session.listTaggedRPMS(reusable_module.koji_tag, latest=True) # Convert the list to a dict where each key is the build_id builds = {build["build_id"]: build for build in builds} # Create a mapping of package (SRPM) to the RPMs in NVR format package_to_rpms = {} for rpm in rpms: package = builds[rpm["build_id"]]["name"] package_to_rpms.setdefault(package, []).append(kobo.rpmlib.make_nvr(rpm)) components_in_module = [c.package for c in module_build.component_builds] reusable_components = get_reusable_components( module_build, components_in_module, previous_module_build=reusable_module, ) # Loop through all the reusable components to find if any of their RPMs are # being filtered for reusable_component in reusable_components: # reusable_component will be None if the component can't be reused if not reusable_component: continue # We must get the component name from the NVR and not from # reusable_component.package because macros such as those used # by SCLs can change the name of the underlying build component_name = kobo.rpmlib.parse_nvr(reusable_component.nvr)["name"] if component_name not in package_to_rpms: continue # Loop through the RPMs associated with the reusable component for nvr in package_to_rpms[component_name]: parsed_nvr = kobo.rpmlib.parse_nvr(nvr) # Don't compare with the epoch parsed_nvr["epoch"] = None # Loop through all the filtered RPMs to find a match with the reusable # component's RPMs. for nvr2 in list(filtered_rpms): parsed_nvr2 = kobo.rpmlib.parse_nvr(nvr2) # Don't compare with the epoch parsed_nvr2["epoch"] = None # Only remove the filter if we are going to reuse a component with # the same exact NVR if parsed_nvr == parsed_nvr2: filtered_rpms.remove(nvr2) # Since filtered_rpms was cast to a set and then back # to a list above, we know there won't be duplicate RPMS, # so we can just break here. break return filtered_rpms @staticmethod def format_conflicts_line(nevr): """Helper method to format a Conflicts line with a RPM N-E:V-R""" parsed_nvr = kobo.rpmlib.parse_nvr(nevr) return "Conflicts: {name} = {epoch}:{version}-{release}".format(**parsed_nvr) @staticmethod def get_disttag_srpm(disttag, module_build): # Taken from Karsten's create-distmacro-pkg.sh # - however removed any provides to system-release/redhat-release name = "module-build-macros" version = "0.1" release = "1" with set_locale(locale.LC_TIME, "C"): today = datetime.date.today().strftime("%a %b %d %Y") mmd = module_build.mmd() # Generate "Conflicts: name = version-release". This is workaround for # Koji build system, because it does not filter out RPMs from the # build-requires based on their "mmd.filter.rpms". So we set the # module-build-macros to conflict with these filtered RPMs to ensure # they won't be installed to buildroot. filter_conflicts = [] for req_name, req_data in mmd.get_xmd()["mbs"]["buildrequires"].items(): if req_data["filtered_rpms"]: filter_conflicts.append("# Filtered rpms from %s module:" % req_name) # Check if the module depends on itself if req_name == module_build.name: filtered_rpms = KojiModuleBuilder._get_filtered_rpms_on_self_dep( module_build, req_data["filtered_rpms"]) else: filtered_rpms = req_data["filtered_rpms"] filter_conflicts.extend(map(KojiModuleBuilder.format_conflicts_line, filtered_rpms)) if req_name in conf.base_module_names and "ursine_rpms" in req_data: comments = ( ("# Filter out RPMs from stream collision modules found from ursine content" " for base module {}:".format(req_name)), "# " + ", ".join(req_data["stream_collision_modules"]), ) filter_conflicts.extend( chain( comments, map(KojiModuleBuilder.format_conflicts_line, req_data["ursine_rpms"]), ) ) # These are generated from handle_collisions_with_base_module_rpms and are different than # the stream collision modules ursine_rpms = mmd.get_xmd()["mbs"].get("ursine_rpms") if ursine_rpms: log.debug("Adding %d ursine RPM(s) to the conflicts", len(ursine_rpms)) filter_conflicts.append( "\n# Filter out base module RPMs that overlap with the RPMs in the buildrequired " "modules" ) for ursine_rpm in ursine_rpms: filter_conflicts.append(KojiModuleBuilder.format_conflicts_line(ursine_rpm)) spec_content = textwrap.dedent(""" %global dist {disttag} %global modularitylabel {module_name}:{module_stream}:{module_version}:{module_context} %global _module_name {module_name} %global _module_stream {module_stream} %global _module_version {module_version} %global _module_context {module_context} Name: {name} Version: {version} Release: {release}%dist Summary: Package containing macros required to build generic module BuildArch: noarch Group: System Environment/Base License: MIT URL: http://fedoraproject.org Source1: macros.modules {filter_conflicts} %description This package is used for building modules with a different dist tag. It provides a file /usr/lib/rpm/macros.d/macro.modules and gets read after macro.dist, thus overwriting macros of macro.dist like %%dist It should NEVER be installed on any system as it will really mess up updates, builds, .... %build %install mkdir -p %buildroot/etc/rpm 2>/dev/null |: cp %SOURCE1 %buildroot/etc/rpm/macros.zz-modules chmod 644 %buildroot/etc/rpm/macros.zz-modules %files /etc/rpm/macros.zz-modules %changelog * {today} Fedora-Modularity - {version}-{release}{disttag} - autogenerated macro by Module Build Service (MBS) """).format( disttag=disttag, today=today, name=name, version=version, release=release, module_name=module_build.name, module_stream=module_build.stream, module_version=module_build.version, module_context=module_build.context, filter_conflicts="\n".join(filter_conflicts), ) modulemd_macros = "" buildopts = mmd.get_buildopts() if buildopts: modulemd_macros = buildopts.get_rpm_macros() or "" macros_content = textwrap.dedent(""" # General macros set by MBS %dist {disttag} %modularitylabel {module_name}:{module_stream}:{module_version}:{module_context} %_module_build 1 %_module_name {module_name} %_module_stream {module_stream} %_module_version {module_version} %_module_context {module_context} # Macros set by module author: {modulemd_macros} """).format( disttag=disttag, module_name=module_build.name, module_stream=module_build.stream, module_version=module_build.version, module_context=module_build.context, modulemd_macros=modulemd_macros, ) td = tempfile.mkdtemp(prefix="module_build_service-build-macros") fd = open(os.path.join(td, "%s.spec" % name), "w") fd.write(spec_content) fd.close() sources_dir = os.path.join(td, "SOURCES") os.mkdir(sources_dir) fd = open(os.path.join(sources_dir, "macros.modules"), "w") fd.write(macros_content) fd.close() log.debug("Building %s.spec" % name) # We are not interested in the rpmbuild stdout... null_fd = open(os.devnull, "w") execute_cmd( [ "rpmbuild", "-bs", "%s.spec" % name, "--define", "_topdir %s" % td, "--define", "_sourcedir %s" % sources_dir, ], cwd=td, stdout=null_fd, ) null_fd.close() sdir = os.path.join(td, "SRPMS") srpm_paths = glob.glob("%s/*.src.rpm" % sdir) assert len(srpm_paths) == 1, "Expected exactly 1 srpm in %s. Got %s" % (sdir, srpm_paths) log.debug("Wrote srpm into %s" % srpm_paths[0]) return srpm_paths[0] @staticmethod @module_build_service.utils.retry(wait_on=(xmlrpclib.ProtocolError, koji.GenericError)) def get_session(config, login=True): """Create and return a koji.ClientSession object :param config: the config object returned from :meth:`init_config`. :type config: :class:`Config` :param bool login: whether to log into the session. To login if True is passed, otherwise not to log into session. :return: the Koji session object. :rtype: :class:`koji.ClientSession` """ koji_config = munch.Munch( koji.read_config(profile_name=config.koji_profile, user_config=config.koji_config)) # Timeout after 10 minutes. The default is 12 hours. koji_config["timeout"] = 60 * 10 address = koji_config.server log.info("Connecting to koji %r.", address) koji_session = koji.ClientSession(address, opts=koji_config) if not login: return koji_session authtype = koji_config.authtype log.info("Authenticate session with %r.", authtype) if authtype == "kerberos": try: import krbV # We want to create a context per thread to avoid Kerberos cache corruption ctx = krbV.Context() except ImportError: # If no krbV, we can assume GSSAPI auth is available ctx = None keytab = getattr(config, "krb_keytab", None) principal = getattr(config, "krb_principal", None) if not keytab and principal: raise ValueError( "The Kerberos keytab and principal aren't set for Koji authentication") log.debug(" keytab: %r, principal: %r" % (keytab, principal)) # We want to use the thread keyring for the ccache to ensure we have one cache per # thread to avoid Kerberos cache corruption ccache = "KEYRING:thread:mbs" koji_session.krb_login(principal=principal, keytab=keytab, ctx=ctx, ccache=ccache) elif authtype == "ssl": koji_session.ssl_login( os.path.expanduser(koji_config.cert), None, os.path.expanduser(koji_config.serverca) ) else: raise ValueError("Unrecognized koji authtype %r" % authtype) return koji_session def buildroot_connect(self, groups): log.info("%r connecting buildroot." % self) # Check if the build_tag exists, because there are Koji calls later which must be called # only if we are creating the build_tag for first time. build_tag_exists = self.koji_session.getTag(self.tag_name + "-build") tag_perm = self.config.koji_tag_permission # Create or update individual tags # the main tag needs arches so pungi can dump it self.module_tag = self._koji_create_tag(self.tag_name, self.arches, perm=tag_perm) self.module_build_tag = self._koji_create_tag( self.tag_name + "-build", self.arches, perm=tag_perm) buildopts = self.mmd.get_buildopts() if buildopts and buildopts.get_rpm_whitelist(): rpm_whitelist = buildopts.get_rpm_whitelist() else: rpm_whitelist = self.components self._koji_whitelist_packages(rpm_whitelist) # If we have just created the build tag in this buildroot_connect call, block all # the components in `blocked_packages` list. We want to do that just once, because # there might be some unblocked packages later and we would block them again... if not build_tag_exists: xmd = self.mmd.get_xmd() mbs_opts = xmd.get("mbs_options", {}) if "blocked_packages" in mbs_opts: self._koji_block_packages(mbs_opts["blocked_packages"]) @module_build_service.utils.retry(wait_on=SysCallError, interval=5) def add_groups(): return self._koji_add_groups_to_tag(dest_tag=self.module_build_tag, groups=groups) add_groups() # Koji targets can only be 50 characters long, but the generate_koji_tag function # checks the length with '-build' at the end, but we know we will never append '-build', # so we can safely have the name check be more characters target_length = 50 + len("-build") target = module_build_service.utils.generate_koji_tag( self.module.name, self.module.stream, self.module.version, self.module.context, target_length, scratch=self.module.scratch, scratch_id=self.module.id, ) # Add main build target. self.module_target = self._koji_add_target(target, self.module_build_tag, self.module_tag) self.__prep = True log.info("%r buildroot successfully connected." % self) def buildroot_add_repos(self, dependencies): koji_tags = dependencies.keys() log.info("%r adding deps on %r" % (self, koji_tags)) self._koji_add_many_tag_inheritance(self.module_build_tag, koji_tags) def _get_tagged_nvrs(self, tag): """ Returns set of NVR strings tagged in tag `tag`. """ tagged = self.koji_session.listTagged(tag) tagged_nvrs = set(build["nvr"] for build in tagged) return tagged_nvrs def buildroot_add_artifacts(self, artifacts, install=False): """Add list of artifacts to buildroot If any artifact is listed as a blocked package, it will be unblocked. Module build tag will be applied to artifacts. This method is safe to call multiple times. :param artifacts: list of artifacts to add to buildroot. Each of them is represented by a string NVR. :type artifacts: list[str] :kwarg bool install: force install artifact (if it's not dragged in as dependency). Defaults to False. :raises: error derived from ``koji.GenericError`` if any underlying Koji API fails. """ log.info("%r adding artifacts %r", self, artifacts) self.unblock_artifacts(artifacts) self.tag_artifacts(artifacts, dest_tag=False) if install: self.add_artifacts_to_groups(artifacts) def tag_artifacts(self, artifacts, dest_tag=True): """Tag the provided artifacts to the module tag :param artifacts: a list of NVRs to tag :kwarg bool dest_tag: a boolean determining if the destination or build tag should be used. Default is True to apply the destination tag. :raises: error derived from ``koji.GenericError`` if any tagBuild call fails. """ if dest_tag: tag = self._get_tag(self.module_tag)["id"] tagged_nvrs = self._get_tagged_nvrs(self.module_tag["name"]) else: tag = self._get_tag(self.module_build_tag)["id"] tagged_nvrs = self._get_tagged_nvrs(self.module_build_tag["name"]) self.koji_session.multicall = True for nvr in artifacts: if nvr in tagged_nvrs: continue log.info("%r tagging %r into %r" % (self, nvr, tag)) self.koji_session.tagBuild(tag, nvr) self.koji_session.multiCall(strict=True) def untag_artifacts(self, artifacts): """ Untag the provided artifacts from the module destination and build tag :param artifacts: a list of NVRs to untag :raises: error derived from ``koji.GenericError`` if any untagBuild call fails. """ build_tag_name = self.tag_name + "-build" dest_tag = self._get_tag(self.tag_name, strict=False) build_tag = self._get_tag(build_tag_name, strict=False) # Get the NVRs in the tags to make sure the builds exist and they're tagged before # untagging them if dest_tag: dest_tagged_nvrs = self._get_tagged_nvrs(dest_tag["name"]) else: log.info('The tag "{0}" doesn\'t exist'.format(self.tag_name)) dest_tagged_nvrs = [] if build_tag: build_tagged_nvrs = self._get_tagged_nvrs(build_tag["name"]) else: log.info('The tag "{0}" doesn\'t exist'.format(build_tag_name)) build_tagged_nvrs = [] # If there is nothing to untag, then just return if not dest_tagged_nvrs and not build_tagged_nvrs: return self.koji_session.multicall = True for nvr in artifacts: if nvr in dest_tagged_nvrs: log.info("%r untagging %r from %r" % (self, nvr, dest_tag["id"])) self.koji_session.untagBuild(dest_tag["id"], nvr) if nvr in build_tagged_nvrs: log.info("%r untagging %r from %r" % (self, nvr, build_tag["id"])) self.koji_session.untagBuild(build_tag["id"], nvr) self.koji_session.multiCall(strict=True) def wait_task(self, task_id): """ :param task_id :return - task result object """ log.info("Waiting for task_id=%s to finish" % task_id) timeout = 60 * 60 # 60 minutes @module_build_service.utils.retry(timeout=timeout, wait_on=koji.GenericError) def get_result(): log.debug("Waiting for task_id=%s to finish" % task_id) task = self.koji_session.getTaskResult(task_id) log.info("Done waiting for task_id=%s to finish" % task_id) return task return get_result() def recover_orphaned_artifact(self, component_build): """ Searches for a complete build of an artifact belonging to the module and sets the component_build in the MBS database to the found build. This usually returns nothing since these builds should *not* exist. :param component_build: a ComponentBuild object :return: a list of msgs that MBS needs to process """ opts = {"latest": True, "package": component_build.package, "inherit": False} build_tagged = self.koji_session.listTagged(self.module_build_tag["name"], **opts) dest_tagged = None # Only check the destination tag if the component is not a build_time_only component if not component_build.build_time_only: dest_tagged = self.koji_session.listTagged(self.module_tag["name"], **opts) for rv in [build_tagged, dest_tagged]: if rv and len(rv) != 1: raise ValueError("Expected exactly one item in list. Got %s" % rv) build = None if build_tagged: build = build_tagged[0] elif dest_tagged: build = dest_tagged[0] if not build: # If the build cannot be found in the tags, it may be untagged as a result # of some earlier inconsistent situation. Let's find the task_info # based on the list of untagged builds release = module_build_service.utils.get_rpm_release(self.db_session, self.module) untagged = self.koji_session.untaggedBuilds(name=component_build.package) for untagged_build in untagged: if untagged_build["release"].endswith(release): nvr = "{name}-{version}-{release}".format(**untagged_build) build = self.koji_session.getBuild(nvr) break further_work = [] # If the build doesn't exist, then return if not build: return further_work # Start setting up MBS' database to use the existing build log.info('Skipping build of "{0}" since it already exists.'.format(build["nvr"])) # Set it to COMPLETE so it doesn't count towards the concurrent component threshold component_build.state = koji.BUILD_STATES["COMPLETE"] component_build.nvr = build["nvr"] component_build.task_id = build["task_id"] component_build.state_reason = "Found existing build" nvr_dict = kobo.rpmlib.parse_nvr(component_build.nvr) # Trigger a completed build message further_work.append( module_build_service.messaging.KojiBuildChange( "recover_orphaned_artifact: fake message", build["build_id"], build["task_id"], koji.BUILD_STATES["COMPLETE"], component_build.package, nvr_dict["version"], nvr_dict["release"], component_build.module_build.id, ) ) component_tagged_in = [] if build_tagged: component_tagged_in.append(self.module_build_tag["name"]) elif component_build.package == "module-build-macros": # module-build-macros need to be added to # "build" and "srpm-build" koji tag groups self.buildroot_add_artifacts( [component_build.nvr], install=component_build.build_time_only) else: # Tag it in the build tag if it's not there self.tag_artifacts([component_build.nvr], dest_tag=False) if dest_tagged: component_tagged_in.append(self.module_tag["name"]) for tag in component_tagged_in: log.info( 'The build being skipped isn\'t tagged in the "{0}" tag. Will send a message to ' "the tag handler".format(tag) ) further_work.append( module_build_service.messaging.KojiTagChange( "recover_orphaned_artifact: fake message", tag, component_build.package, component_build.nvr, ) ) return further_work def build(self, artifact_name, source): """ :param artifact_name: a string of the name of the artifact :param source: a string of the scmurl to the spec repository :return: 4-tuple of the form (koji build task id, state, reason, nvr) """ # TODO: If we are sure that this method is thread-safe, we can just # remove _build_lock locking. with KojiModuleBuilder._build_lock: # This code supposes that artifact_name can be built within the component # Taken from /usr/bin/koji def _unique_path(prefix): """ Create a unique path fragment by appending a path component to prefix. The path component will consist of a string of letter and numbers that is unlikely to be a duplicate, but is not guaranteed to be unique. """ # Use time() in the dirname to provide a little more information when # browsing the filesystem. # For some reason repr(time.time()) includes 4 or 5 # more digits of precision than str(time.time()) # Unnamed Engineer: Guido v. R., I am disappoint return "%s/%r.%s" % ( prefix, time.time(), "".join([random.choice(string.ascii_letters) for i in range(8)]), ) if not self.__prep: raise RuntimeError("Buildroot is not prep-ed") self._koji_whitelist_packages([artifact_name]) if source.startswith("cli-build/"): # treat source as a custom srpm that has already been uploaded to koji pass elif "://" not in source: # treat source as an srpm and upload it serverdir = _unique_path("cli-build") callback = None self.koji_session.uploadWrapper(source, serverdir, callback=callback) source = "%s/%s" % (serverdir, os.path.basename(source)) # When "koji_build_macros_target" is set, we build the # module-build-macros in this target instead of the self.module_target. # The reason is that it is faster to build this RPM in # already existing shared target, because Koji does not need to do # repo-regen. if artifact_name == "module-build-macros" and self.config.koji_build_macros_target: module_target = self.config.koji_build_macros_target else: module_target = self.module_target["name"] build_opts = { "skip_tag": True, "mbs_artifact_name": artifact_name, "mbs_module_target": module_target, } # disabled by default, wouldn't work until Koji issue #1158 is done if conf.allow_arch_override: build_opts["arch_override"] = self.mmd.get_rpm_component(artifact_name).get_arches() task_id = self.koji_session.build( source, module_target, build_opts, priority=self.build_priority) log.info("submitted build of %s (task_id=%s), via %s" % (source, task_id, self)) if task_id: state = koji.BUILD_STATES["BUILDING"] reason = "Submitted %s to Koji" % (artifact_name) else: state = koji.BUILD_STATES["FAILED"] reason = "Failed to submit artifact %s to Koji" % (artifact_name) return task_id, state, reason, None def cancel_build(self, task_id): try: self.koji_session.cancelTask(task_id) except Exception as error: log.error( "Failed to cancel task ID {0} in Koji. The error " "message was: {1}".format(task_id, str(error)) ) @classmethod def repo_from_tag(cls, config, tag_name, arch): """ :param config: instance of module_build_service.config.Config :param tag_name: Tag for which the repository is returned :param arch: Architecture for which the repository is returned Returns URL of repository containing the built artifacts for the tag with particular name and architecture. """ return "%s/%s/latest/%s" % (config.koji_repository_url, tag_name, arch) @module_build_service.utils.validate_koji_tag("tag", post="") def _get_tag(self, tag, strict=True): if isinstance(tag, dict): tag = tag["name"] taginfo = self.koji_session.getTag(tag) if not taginfo: if strict: raise SystemError("Unknown tag: %s" % tag) return taginfo @module_build_service.utils.validate_koji_tag(["tag_name"], post="") def _koji_add_many_tag_inheritance(self, tag_name, parent_tags): tag = self._get_tag(tag_name) # highest priority num is at the end inheritance_data = sorted( self.koji_session.getInheritanceData(tag["name"]) or [], key=lambda k: k["priority"]) # Set initial priority to last record in inheritance data or 0 priority = 0 if inheritance_data: priority = inheritance_data[-1]["priority"] + 10 def record_exists(parent_id, data): for item in data: if parent_id == item["parent_id"]: return True return False for parent in parent_tags: # We expect that they're sorted parent = self._get_tag(parent) if record_exists(parent["id"], inheritance_data): continue inheritance_data.append({ "parent_id": parent["id"], "priority": priority, "maxdepth": None, "intransitive": False, "noconfig": False, "pkg_filter": "", }) priority += 10 if inheritance_data: self.koji_session.setInheritanceData(tag["id"], inheritance_data) @module_build_service.utils.validate_koji_tag("dest_tag") def _koji_add_groups_to_tag(self, dest_tag, groups): """Add groups to a tag as well as packages listed by group :param dest_tag: the tag groups will be added to. This argument could be a string representing tag name, or a mapping containing tag info which must have name at least. :type dest_tag: str or dict :param dict groups: A dict ``{'group' : [package, ...]}``. If one of the groups has been added to the tag, the group is skipped. """ log.debug("Adding groups=%s to tag=%s" % (list(groups), dest_tag)) if groups and not isinstance(groups, dict): raise ValueError("Expected dict {'group' : [str(package1), ...]") dest_tag = self._get_tag(dest_tag)["name"] existing_groups = dict([ (p["name"], p["group_id"]) for p in self.koji_session.getTagGroups(dest_tag, inherit=False) ]) for group, packages in groups.items(): group_id = existing_groups.get(group, None) if group_id is not None: log.debug( "Group %s already exists for tag %s. Skipping creation." % (group, dest_tag)) continue self.koji_session.groupListAdd(dest_tag, group) log.debug("Adding %d packages into group=%s tag=%s" % (len(packages), group, dest_tag)) # This doesn't fail in case that it's already present in the group. This should be safe for pkg in packages: self.koji_session.groupPackageListAdd(dest_tag, group, pkg) @module_build_service.utils.validate_koji_tag("tag_name") def _koji_create_tag(self, tag_name, arches=None, perm=None): """Create a tag in Koji This call is safe to call multiple times. :param str tag_name: name of koji tag :kwarg list arches: list of architectures for the tag :kwarg str perm: permissions for the tag (used in lock-tag) :return: a mapping containing raw tag info returned from Koji. :rtype: dict """ log.debug("Ensuring existence of tag='%s'." % tag_name) taginfo = self.koji_session.getTag(tag_name) if not taginfo: self.koji_session.createTag(tag_name) taginfo = self._get_tag(tag_name) opts = {} if arches: if not isinstance(arches, list): raise ValueError("Expected list or None on input got %s" % type(arches)) current_arches = [] if taginfo["arches"]: # None if none current_arches = taginfo["arches"].split() # string separated by empty spaces if set(arches) != set(current_arches): opts["arches"] = " ".join(arches) if perm: if taginfo["locked"]: raise SystemError( "Tag %s: master lock already set. Can't edit tag" % taginfo["name"]) perm_ids = self.getPerms() if perm not in perm_ids: raise ValueError("Unknown permissions %s" % perm) perm_id = perm_ids[perm] if taginfo["perm"] not in (perm_id, perm): # check either id or the string opts["perm"] = perm_id # Create deepcopy of conf dict, because we are going to change it later. opts["extra"] = copy.deepcopy(conf.koji_tag_extra_opts) xmd = self.mmd.get_xmd() mbs_opts = xmd.get("mbs_options", {}) if "repo_include_all" in mbs_opts: opts["extra"]["repo_include_all"] = mbs_opts["repo_include_all"] if "dynamic_buildrequires" in mbs_opts: opts["extra"]["dynamic_buildrequires"] = mbs_opts["dynamic_buildrequires"] # edit tag with opts self.koji_session.editTag2(tag_name, **opts) return self._get_tag(tag_name) # Return up2date taginfo def _koji_whitelist_packages(self, packages, tags=None): if not tags: tags = [self.module_tag, self.module_build_tag] # This will help with potential resubmitting of failed builds pkglists = {} for tag in tags: pkglists[tag["id"]] = dict([ (p["package_name"], p["package_id"]) for p in self.koji_session.listPackages(tagID=tag["id"]) ]) self.koji_session.multicall = True for tag in tags: pkglist = pkglists[tag["id"]] for package in packages: if pkglist.get(package, None): log.debug("%s Package %s is already whitelisted." % (self, package)) continue self.koji_session.packageListAdd(tag["name"], package, self.owner) self.koji_session.multiCall(strict=True) def _koji_block_packages(self, packages): """ Blocks the `packages` for the module_build_tag. """ log.info("Blocking packages in tag %s: %r", self.module_build_tag["name"], packages) args = [[self.module_build_tag["name"], package] for package in packages] koji_multicall_map(self.koji_session, self.koji_session.packageListBlock, args) def unblock_artifacts(self, artifacts): """ Unblocks the `packages` for the module_build_tag. """ xmd = self.mmd.get_xmd() blocked_packages = xmd.get("mbs_options", {}).get("blocked_packages") if blocked_packages is None: log.debug("No blocked_packages is set under xmd/mbs_options. No " "package will be unblocked.") return if not blocked_packages: log.debug("No package is listed in xmd/mbs_options/blocked_packages." " No package will be unblocked.") return packages = (kobo.rpmlib.parse_nvr(nvr)["name"] for nvr in artifacts) packages = [package for package in packages if package in blocked_packages] if not packages: log.debug("None of %r is listed in xmd/mbs_options/blocked_packages." " No one will be unblocked.") return build_tag_name = self.module_build_tag["name"] log.info("Unblocking packages in tag %s: %r", build_tag_name, packages) args = [[build_tag_name, package] for package in packages] koji_multicall_map(self.koji_session, self.koji_session.packageListUnblock, args) @module_build_service.utils.validate_koji_tag(["build_tag", "dest_tag"]) def _koji_add_target(self, name, build_tag, dest_tag): """Add build target if it doesn't exist or validate the existing one This call is safe to call multiple times. Raises SystemError() if the existing target doesn't match params. The reason not to touch existing target, is that we don't want to accidentally alter a target which was already used to build some artifacts. :param str name: target name. :param dict build_tag: build tag info, which must have name at least. :param dict dest_tag: dest tag info, which must have name at least. :return: a mapping containing raw build target info returned from Koji. If a new build target is created, it is the new one. Otherwise, existing build target is returned. :rtype: dict :raises SystemError: if existing build target does not have build_tag name or dest_tag name. """ build_tag = self._get_tag(build_tag) dest_tag = self._get_tag(dest_tag) target_info = self.koji_session.getBuildTarget(name) barches = build_tag.get("arches", None) assert barches, "Build tag %s has no arches defined." % build_tag["name"] if not target_info: target_info = self.koji_session.createBuildTarget( name, build_tag["name"], dest_tag["name"]) else: # verify whether build and destination tag matches if build_tag["name"] != target_info["build_tag_name"]: raise SystemError( "Target references unexpected build_tag_name. " "Got '%s', expected '%s'. Please contact administrator." % (target_info["build_tag_name"], build_tag["name"]) ) if dest_tag["name"] != target_info["dest_tag_name"]: raise SystemError( "Target references unexpected dest_tag_name. " "Got '%s', expected '%s'. Please contact administrator." % (target_info["dest_tag_name"], dest_tag["name"]) ) return self.koji_session.getBuildTarget(name) def list_tasks_for_components(self, component_builds=None, state="active"): """ :param component_builds: list of component builds which we want to check :param state: limit the check only for Koji tasks in the given state :return: list of Koji tasks List Koji tasks ('active' by default) for component builds. """ component_builds = component_builds or [] if state == "active": states = [ koji.TASK_STATES["FREE"], koji.TASK_STATES["OPEN"], koji.TASK_STATES["ASSIGNED"], ] elif state.upper() in koji.TASK_STATES: states = [koji.TASK_STATES[state.upper()]] else: raise ValueError("State {} is not valid within Koji task states.".format(state)) tasks = [] for task in self.koji_session.listTasks( opts={"state": states, "decode": True, "method": "build"} ): task_opts = task["request"][-1] assert isinstance(task_opts, dict), "Task options shall be a dict." if "scratch" in task_opts and task_opts["scratch"]: continue if "mbs_artifact_name" not in task_opts: task_opts["mbs_artifact_name"] = None if "mbs_module_target" not in task_opts: task_opts["mbs_module_target"] = None for c in component_builds: # TODO: https://pagure.io/fm-orchestrator/issue/397 # Subj: Do not mix target/tag when looking for component builds if ( c.package == task_opts["mbs_artifact_name"] and c.module_build.koji_tag == task_opts["mbs_module_target"] ): tasks.append(task) return tasks @classmethod def get_average_build_time(cls, component): """ Get the average build time of the component from Koji :param component: a ComponentBuild object :return: a float of the average build time in seconds """ # If the component has not been built before, then None is returned. Instead, let's # return 0.0 so the type is consistent koji_session = KojiModuleBuilder.get_session(conf, login=False) return koji_session.getAverageBuildDuration(component) or 0.0 @classmethod def get_build_weights(cls, components): """ Returns a dict with component name as a key and float number representing the overall Koji weight of a component build. The weight is sum of weights of all tasks in a previously done modular build of a component. :param list components: List of component names. :rtype: dict :return: {component_name: weight_as_float, ...} """ koji_session = KojiModuleBuilder.get_session(conf) # Get our own userID, so we can limit the builds to only modular builds user_info = koji_session.getLoggedInUser() if not user_info or "id" not in user_info: log.warning("Koji.getLoggedInUser() failed while getting build weight.") return cls.compute_weights_from_build_time(components) mbs_user_id = user_info["id"] # Get the Koji PackageID for every component in single Koji call. # If some package does not exist in Koji, component_ids will be None. component_ids = koji_retrying_multicall_map( koji_session, koji_session.getPackageID, list_of_args=components) if not component_ids: return cls.compute_weights_from_build_time(components) # Prepare list of queries to call koji_session.listBuilds build_queries = [] for component_id in component_ids: build_queries.append({ "packageID": component_id, "userID": mbs_user_id, "state": koji.BUILD_STATES["COMPLETE"], "queryOpts": {"order": "-build_id", "limit": 1}, }) # Get the latest Koji build created by MBS for every component in single Koji call. builds_per_component = koji_retrying_multicall_map( koji_session, koji_session.listBuilds, list_of_kwargs=build_queries) if not builds_per_component: return cls.compute_weights_from_build_time(components) # Get list of task_ids associated with the latest build in builds. # For some packages, there may not be a build done by MBS yet. # We store such packages in `components_without_build` and later # compute the weight by compute_weights_from_build_time(). # For others, we will continue by examining weights of all tasks # belonging to that build later. task_ids = [] components_with_build = [] components_without_build = [] for builds, component_name in zip(builds_per_component, components): if not builds: # No build for this component. components_without_build.append(component_name) continue latest_build = builds[0] task_id = latest_build["task_id"] if not task_id: # No task_id for this component, this can happen for imported # component builds. components_without_build.append(component_name) continue components_with_build.append(component_name) task_ids.append(task_id) weights = {} # For components without any build, fallback to weights computation based on # the average time to build. weights.update(cls.compute_weights_from_build_time(components_without_build)) # For components with a build, get the list of tasks associated with this build # and compute the weight for each component build as sum of weights of all tasks. tasks_per_latest_build = koji_retrying_multicall_map( koji_session, koji_session.getTaskDescendents, list_of_args=task_ids) if not tasks_per_latest_build: return cls.compute_weights_from_build_time(components_with_build) for tasks, component_name in zip(tasks_per_latest_build, components_with_build): # Compute overall weight of this build. This is sum of weights # of all tasks in a build. weight = 0 for task in tasks.values(): weight += sum([t["weight"] for t in task]) weights[component_name] = weight return weights @classmethod def get_built_rpms_in_module_build(cls, mmd): """ :param Modulemd mmd: Modulemd to get the built RPMs from. :return: list of NVRs """ build = models.ModuleBuild.get_build_from_nsvc( db_session, mmd.get_module_name(), mmd.get_stream_name(), mmd.get_version(), mmd.get_context() ) koji_session = KojiModuleBuilder.get_session(conf, login=False) rpms = koji_session.listTaggedRPMS(build.koji_tag, latest=True)[0] nvrs = set(kobo.rpmlib.make_nvr(rpm, force_epoch=True) for rpm in rpms) return list(nvrs) def finalize(self, succeeded=True): # Only import to koji CG if the module is "build" and not scratch. if ( not self.module.scratch and self.config.koji_enable_content_generator and self.module.state == models.BUILD_STATES["build"] ): cg = KojiContentGenerator(self.module, self.config) cg.koji_import() if conf.koji_cg_devel_module: cg.koji_import(devel=True) @staticmethod def get_rpm_module_tag(rpm): """ Returns koji tag of a given rpm filename. :param str rpm: the *.rpm filename of a rpm :rtype: str :return: koji tag """ session = KojiModuleBuilder.get_session(conf, login=False) rpm_md = session.getRPM(rpm) if not rpm_md: return None tags = [] koji_tags = session.listTags(rpm_md["build_id"]) for t in koji_tags: if ( not t["name"].endswith("-build") and t["name"].startswith(tuple(conf.koji_tag_prefixes)) ): tags.append(t["name"]) return tags @classmethod def get_module_build_arches(cls, module): """ :param ModuleBuild module: Get the list of architectures associated with the module build in the build system. :return: list of architectures """ if not module.koji_tag: log.warning("No Koji tag associated with module %r", module) return [] koji_session = KojiModuleBuilder.get_session(conf, login=False) tag = koji_session.getTag(module.koji_tag) if not tag: raise ValueError("Unknown Koji tag %r." % module.koji_tag) if not tag["arches"]: return [] return tag["arches"].split(" ") def add_artifacts_to_groups(self, artifacts, groups=None): """Add artifacts to groups :param artifacts: list of NVRs to add to groups. :type artifacts: list[str] :param groups: list of groups to contain specified artifacts. Defaults to srpm-build and build. :type groups: list[str] :raises: error derived from ``koji.GenericError`` if any groupPackageListAdd call fails. """ build_tag = self._get_tag(self.module_build_tag)["id"] self.koji_session.multicall = True for nvr in artifacts: for group in groups or ("srpm-build", "build"): name = kobo.rpmlib.parse_nvr(nvr)["name"] log.info("%r adding %s to group %s", self, name, group) self.koji_session.groupPackageListAdd(build_tag, group, name) self.koji_session.multiCall(strict=True)