Source code for thoth.adviser.boots.fully_specified_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 fully specified environment."""

import logging
from typing import Any
from typing import Dict
from typing import Generator
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 FullySpecifiedEnvironment(Boot): """A boot to check for fully specified environment."""
[docs] @classmethod def should_include(cls, builder_context: "PipelineBuilderContext") -> Generator[Dict[str, Any], None, None]: """Register self, always.""" if builder_context.is_adviser_pipeline() 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 not self.context.project.runtime_environment.is_fully_specified(): msg = f"Software environment supplied is not fully specified, OS name " f"is {self.context.project.runtime_environment.operating_system.name!r} " f"in version {self.context.project.runtime_environment.operating_system.version!r} " f"using Python {self.context.project.runtime_environment.python_version!r}" self.context.stack_info.append({"message": msg, "type": "ERROR", "link": jl("fully_specified_env")}) raise NotAcceptable(msg)