mirror of
https://pagure.io/fm-orchestrator.git
synced 2026-02-03 05:03:43 +08:00
This also removes the outdated comments around authorship of each file. If there is still interest in this information, one can just look at the git history.
129 lines
4.1 KiB
Python
129 lines
4.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# SPDX-License-Identifier: MIT
|
|
"""Generic resolver functions."""
|
|
|
|
|
|
import six
|
|
from abc import ABCMeta, abstractmethod
|
|
|
|
import module_build_service.config as cfg
|
|
from module_build_service import conf
|
|
|
|
|
|
class GenericResolver(six.with_metaclass(ABCMeta)):
|
|
"""
|
|
External Api for resolvers
|
|
"""
|
|
|
|
_resolvers = cfg.SUPPORTED_RESOLVERS
|
|
|
|
# Resolver name. Each subclass of GenericResolver must set its own name.
|
|
backend = "generic"
|
|
|
|
# Supported resolver backends registry. Generally, resolver backend is
|
|
# registered by calling :meth:`GenericResolver.register_backend_class`.
|
|
# This is a mapping from resolver name to backend class object
|
|
# For example, {'mbs': MBSResolver}
|
|
backends = {}
|
|
|
|
@classmethod
|
|
def register_backend_class(cls, backend_class):
|
|
GenericResolver.backends[backend_class.backend] = backend_class
|
|
|
|
@classmethod
|
|
def create(cls, db_session, config, backend=None, **extra):
|
|
"""Factory method to create a resolver object
|
|
|
|
:param config: MBS config object.
|
|
:type config: :class:`Config`
|
|
:kwarg str backend: resolver backend name, e.g. 'db'. If omitted,
|
|
system configuration ``resolver`` is used.
|
|
:kwarg extra: any additional arguments are optional extras which can
|
|
be passed along and are implementation-dependent.
|
|
:return: resolver backend object.
|
|
:rtype: corresponding registered resolver class.
|
|
:raises ValueError: if specified resolver backend name is not
|
|
registered.
|
|
"""
|
|
# get the appropriate resolver backend via configuration
|
|
if not backend:
|
|
backend = conf.resolver
|
|
|
|
if backend in GenericResolver.backends:
|
|
return GenericResolver.backends[backend](db_session, config, **extra)
|
|
else:
|
|
raise ValueError("Resolver backend='%s' not recognized" % backend)
|
|
|
|
@classmethod
|
|
def supported_builders(cls):
|
|
if cls is GenericResolver:
|
|
return {k: v["builders"] for k, v in cls._resolvers.items()}
|
|
else:
|
|
try:
|
|
return cls._resolvers[cls.backend]["builders"]
|
|
except KeyError:
|
|
raise RuntimeError(
|
|
"No configuration of builder backends found for resolver {}".format(cls))
|
|
|
|
@classmethod
|
|
def is_builder_compatible(cls, builder):
|
|
"""
|
|
:param backend: a string representing builder e.g. 'koji'
|
|
|
|
Get supported builder backend(s) via configuration
|
|
"""
|
|
if cls is not GenericResolver:
|
|
return builder in cls.supported_builders()
|
|
|
|
return False
|
|
|
|
@abstractmethod
|
|
def get_module(self, name, stream, version, context, state="ready", strict=False):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_module_count(self, **kwargs):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_latest_with_virtual_stream(self, name, virtual_stream):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_module_modulemds(self, name, stream, version=None, context=None, strict=False):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_compatible_base_module_modulemds(
|
|
self, name, stream, stream_version_lte, virtual_streams, states
|
|
):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_buildrequired_modulemds(self, name, stream, base_module_mmd, strict=False):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def resolve_profiles(self, mmd, keys):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_module_build_dependencies(
|
|
self, name=None, stream=None, version=None, mmd=None, context=None, strict=False
|
|
):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def resolve_requires(self, requires):
|
|
raise NotImplementedError()
|
|
|
|
@abstractmethod
|
|
def get_modulemd_by_koji_tag(self, tag):
|
|
"""Get module metadata by module's koji_tag
|
|
|
|
:param str tag: name of module's koji_tag.
|
|
:return: module metadata
|
|
:rtype: Modulemd.Module
|
|
"""
|
|
raise NotImplementedError()
|