# Copyright 2020 VEXXHOST, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Base test classes

This module contains the base test classes.
"""

import testtools

import yaml

from openstack_operator import utils


class BaseTestCase(testtools.TestCase):
    """Base test class for the OpenStack operator."""


class KubernetesObjectTestCase(testtools.TestCase):
    """Base class for Kubernetes object tests."""

    SAMPLES_PATH = 'config/samples'
    SAMPLE_FILE = ''
    TEMPLATE_FILE = ''
    TEMPLATE_PARAMS = {}
    PORT_EXPOSED = True
    # If auto generated, or no CR exists
    AUTO_GENERATED = True
    RELEASE_TYPE = ''

    @classmethod
    def setUpClass(cls):
        if cls.AUTO_GENERATED:
            config_path = "%s/%s" % (cls.SAMPLES_PATH, "operator-config.yaml")
            with open(config_path) as config_fd:
                sample = yaml.load(config_fd, Loader=yaml.FullLoader)
            name = sample['metadata']['name']
            config = utils.to_dict(sample['data']['operator-config.yaml'])
            if cls.RELEASE_TYPE in config:
                spec = config[cls.RELEASE_TYPE]
            else:
                spec = {}
            cls.object = utils.render_template(cls.TEMPLATE_FILE,
                                               name=cls.RELEASE_TYPE,
                                               spec=spec,
                                               **cls.TEMPLATE_PARAMS)
        else:
            sample_path = "%s/%s" % (cls.SAMPLES_PATH, cls.SAMPLE_FILE)
            with open(sample_path) as sample_fd:
                sample = yaml.load(sample_fd, Loader=yaml.FullLoader)
            name = sample['metadata']['name']
            spec = sample['spec']

            cls.object = utils.render_template(cls.TEMPLATE_FILE,
                                               name=name, spec=spec)

    def test_metadata_has_correct_namespace(self):
        """Ensure that the metadata for auto-generated releases
        has openstack namespace."""
        if self.object is None:
            return
        if self.AUTO_GENERATED:
            self.assertIn("namespace", self.object["metadata"])
            self.assertEqual("openstack", self.object["metadata"]["namespace"])
        else:
            self.assertNotIn("namespace", self.object["metadata"])


class KubernetesAppTestCaseMixin:
    """Mix-in to be used for tests that involve apps and containers."""

    def test_containers_use_always_image_pull_policy(self):
        """Ensure that all containers use 'Always' as imagePullPolicy."""
        for container in self.object['spec']['template']['spec']['containers']:
            self.assertEqual("Always", container.get('imagePullPolicy'))

    def test_containers_have_liveness_probe(self):
        """Ensure that all containers have liveness probes."""
        if not self.PORT_EXPOSED:
            return
        for container in self.object['spec']['template']['spec']['containers']:
            self.assertIn('livenessProbe', container)

    def test_containers_have_readiness_probe(self):
        """Ensure that all containers have readiness probes."""
        if not self.PORT_EXPOSED:
            return
        for container in self.object['spec']['template']['spec']['containers']:
            self.assertIn('readinessProbe', container)

    def test_container_http_probes_have_no_metrics_path(self):
        """Ensure that http probes (liveness/rediness) of all containers
         don't have metrics path"""
        if not self.PORT_EXPOSED:
            return
        for container in self.object['spec']['template']['spec']['containers']:
            if 'httpGet' in container['readinessProbe']:
                self.assertNotEqual(
                    container['readinessProbe']['httpGet']['path'],
                    '/metrics'
                )
            if 'httpGet' in container['livenessProbe']:
                self.assertNotEqual(
                    container['livenessProbe']['httpGet']['path'],
                    '/metrics'
                )


class DeploymentTestCase(KubernetesObjectTestCase,
                         KubernetesAppTestCaseMixin):
    """Basic tests for Kubernetes Deployments."""


class StatefulSetTestCase(KubernetesObjectTestCase,
                          KubernetesAppTestCaseMixin):
    """Basic tests for Kubernetes StatefulSets."""


class DaemonSetTestCase(KubernetesObjectTestCase,
                        KubernetesAppTestCaseMixin):
    """Basic tests for Kubernetes DaemonSets."""


class ConfigMapTestCase(KubernetesObjectTestCase):
    """Basic tests for Kubernetes ConfigMaps."""


class IngressTestCase(KubernetesObjectTestCase):
    """Basic tests for Kubernetes Ingresses."""


class SecretTestCase(KubernetesObjectTestCase):
    """Basic tests for Kubernetes Secrets."""


class ServiceTestCase(KubernetesObjectTestCase):
    """Basic tests for Kubernetes Services."""