Source code for thoth.adviser.boots.solved_software_environment

#!/usr/bin/env python3
# thoth-adviser
# Copyright(C) 2020 - 2021 Fridolin Pokorny
#
# This program is free software: you can redistribute it and / or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.

"""A boot to check for solved software environment before running any resolution."""

import logging
from typing import Generator
from typing import Dict
from typing import Any
from typing import TYPE_CHECKING

import attr
from thoth.common import get_justification_link as jl

from ..boot import Boot
from ..exceptions import NotAcceptable

if TYPE_CHECKING:
    from ..pipeline_builder import PipelineBuilderContext

_LOGGER = logging.getLogger(__name__)


[docs]@attr.s(slots=True) class SolvedSoftwareEnvironmentBoot(Boot): """A boot to check for solved software environment before running any resolution.""" _JUSTIFICATION_LINK = jl("solved_sw_env")
[docs] @classmethod def should_include(cls, builder_context: "PipelineBuilderContext") -> Generator[Dict[str, Any], None, None]: """Register self, always.""" if builder_context.project.runtime_environment.is_fully_specified() and not builder_context.is_included(cls): yield {} return None yield from () return None
[docs] def run(self) -> None: """Check for version clash in packages.""" if self.context.graph.solved_software_environment_exists( os_name=self.context.project.runtime_environment.operating_system.name, os_version=self.context.project.runtime_environment.operating_system.version, python_version=self.context.project.runtime_environment.python_version, ): return runtime_environment = self.context.project.runtime_environment msg = ( f"No observations found for {runtime_environment.operating_system.name!r} in " f"version {runtime_environment.operating_system.version!r} using " f"Python {runtime_environment.python_version!r}" ) self.context.stack_info.append( { "type": "ERROR", "message": msg, "link": self._JUSTIFICATION_LINK, } ) _LOGGER.warning("%s - %s", msg, self._JUSTIFICATION_LINK) _LOGGER.warning("Available configurations:") configurations = self.context.graph.get_solved_python_package_versions_software_environment_all() _LOGGER.warning("{:<16} {:<16} {:<8}".format("OS name", "OS version", "Python version")) for conf in sorted( configurations, key=lambda i: (i["os_name"], i["os_version"], i["python_version"]), ): self.context.stack_info.append( { "message": f"Consider using {conf['os_name']!r} in version {conf['os_version']!r} " f"with Python {conf['python_version']}", "type": "ERROR", "link": self._JUSTIFICATION_LINK, } ) _LOGGER.warning("{:<16} {:<16} {:<8}".format(conf["os_name"], conf["os_version"], conf["python_version"])) raise NotAcceptable(msg)