Source code for thoth.adviser.boots.thoth_s2i

#!/usr/bin/env python3
# thoth-adviser
# Copyright(C) 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 that recommends to use Thoth's s2i if users do not use it."""

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

from thoth.common import get_justification_link as jl

from ..boot import Boot

if TYPE_CHECKING:
    from ..pipeline_builder import PipelineBuilderContext


[docs]class ThothS2IBoot(Boot):
    """A boot that notifies about missing observations."""

    _THOTH_S2I_PREFIX = "quay.io/thoth-station/s2i-thoth-"
    _JUSTIFICATION = [
        {
            "type": "INFO",
            "message": "It is recommended to use Thoth's s2i to have recommendations specific to runtime environment",
            "link": jl("thoth_s2i"),
        }
    ]

[docs]    @classmethod
    def should_include(cls, builder_context: "PipelineBuilderContext") -> Generator[Dict[Any, Any], None, None]:
        """Include this boot in adviser if Thoth s2i is not used.."""
        base_image = builder_context.project.runtime_environment.base_image
        if not builder_context.is_included(cls) and (
            base_image is None or (base_image and not base_image.startswith(cls._THOTH_S2I_PREFIX))
        ):
            yield {}
            return None

        yield from ()
        return None

[docs]    def run(self) -> None:
        """Check for no observations made on the given state."""
        self.context.stack_info.extend(self._JUSTIFICATION)