#!/usr/bin/env python3
# thoth-adviser
# Copyright(C) 2019, 2020 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 generic unit representatives used for testing.."""

from typing import Any
from typing import Dict
from typing import List
from typing import Optional
from typing import Tuple
from typing import TYPE_CHECKING
from thoth.python import PackageVersion

from thoth.adviser.state import State
from thoth.adviser.step import Step
from voluptuous import Required
from voluptuous import Schema

if TYPE_CHECKING:
    from thoth.adviser.pipeline_builder import PipelineBuilderContext


class Step1(Step):
    """A testing step implementation."""

    CONFIGURATION_DEFAULT = {"guido_retirement": 2019, "package_name": "tensorflow", "multi_package_resolution": False}
    CONFIGURATION_SCHEMA: Schema = Schema(
        {Required("package_name"): str, Required("guido_retirement"): int, Required("multi_package_resolution"): bool}
    )

    @classmethod
    def should_include(cls, builder_context: "PipelineBuilderContext") -> Optional[Dict[str, Any]]:
        """Check if this pipeline unit should be included in the pipeline configuration."""

    def run(
        self, state: State, package_version: PackageVersion
    ) -> Optional[Tuple[Optional[float], Optional[List[Dict[str, str]]]]]:
        """Run noop method."""


class Step2(Step):
    """A testing step implementation."""

    CONFIGURATION_DEFAULT = {
        "lyrics": ".. drifting further everyday...",
        "package_name": "thoth-adviser",
        "multi_package_resolution": False,
    }
    CONFIGURATION_SCHEMA: Schema = Schema(
        {Required("package_name"): str, Required("lyrics"): str, Required("multi_package_resolution"): bool}
    )

    @classmethod
    def should_include(cls, builder_context: "PipelineBuilderContext") -> Optional[Dict[str, Any]]:
        """Check if this pipeline unit should be included in the pipeline configuration."""

    def run(
        self, state: State, package_version: PackageVersion
    ) -> Optional[Tuple[Optional[float], Optional[List[Dict[str, str]]]]]:
        """Run noop method."""


__all__ = ["Step1", "Step2"]
