#
# Copyright 2018 Red Hat, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero 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 Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program. If not, see <https://www.gnu.org/licenses/>.
#
"""OCP service provider implementation to be used by Koku."""
import logging
from django.core.exceptions import ObjectDoesNotExist
from django.core.exceptions import ValidationError
from rest_framework import serializers
from tenant_schemas.utils import tenant_context
from ..provider_interface import ProviderInterface
from api.common import error_obj
from api.provider.models import Provider
from reporting.provider.azure.openshift.models import OCPAzureCostLineItemDailySummary
from reporting.provider.ocp_aws.models import OCPAWSCostLineItemDailySummary
LOG = logging.getLogger(__name__)
class OCPProviderError(Exception):
"""General Exception class for OCPProvider errors."""
def __init__(self, message):
"""Set custom error message for OCPProvider errors."""
self.message = message
class OCPProvider(ProviderInterface):
"""Provider interface definition."""
def name(self):
"""Return name of the provider."""
return Provider.PROVIDER_OCP
def cost_usage_source_is_reachable(self, cluster_id, storage_resource_name):
"""Verify that the cost usage source exists and is reachable."""
if not cluster_id or len(cluster_id) == 0:
key = "authentication.provider_resource_name"
message = "Provider resource name is a required parameter for OCP."
LOG.info(message)
raise serializers.ValidationError(error_obj(key, message))
if storage_resource_name:
key = "billing_source.bucket"
message = "Bucket is an invalid parameter for OCP."
LOG.error(message)
raise serializers.ValidationError(error_obj(key, message))
# TODO: Add storage_resource_name existance check once Insights integration is complete.
message = f"Stub to verify that OCP report for cluster {cluster_id} is accessible."
LOG.info(message)
return True
def _is_on_aws(self, tenant, resource_name):
"""Determine if provider is running on AWS."""
clusters = self._aws_clusters(tenant)
return resource_name in clusters
def _is_on_azure(self, tenant, resource_name):
"""Determine if provider is running on Azure."""
clusters = self._azure_clusters(tenant)
return resource_name in clusters
def infra_type_implementation(self, provider_uuid, tenant):
"""Return infrastructure type."""
try:
provider_model = Provider.objects.get(uuid=provider_uuid)
resource_name = provider_model.authentication.provider_resource_name
except (ObjectDoesNotExist, ValidationError) as e:
raise (OCPProviderError(str(e)))
if self._is_on_aws(tenant, resource_name):
return Provider.PROVIDER_AWS
if self._is_on_azure(tenant, resource_name):
return Provider.PROVIDER_AZURE
return None
def _aws_clusters(self, tenant):
"""Return a list of OCP clusters running on AWS."""
with tenant_context(tenant):
objects = OCPAWSCostLineItemDailySummary.objects.values_list("cluster_id", flat=True)
clusters = list(objects.distinct())
return clusters
def _azure_clusters(self, tenant):
"""Return a list of OCP clusters running on Azure."""
with tenant_context(tenant):
objects = OCPAzureCostLineItemDailySummary.objects.values_list("cluster_id", flat=True)
clusters = list(objects.distinct())
return clusters
def infra_key_list_implementation(self, infrastructure_type, schema_name):
"""Return a list of cluster ids on the given infrastructure type."""
clusters = []
if infrastructure_type == Provider.PROVIDER_AWS:
clusters = self._aws_clusters(schema_name)
if infrastructure_type == Provider.PROVIDER_AZURE:
clusters = self._azure_clusters(schema_name)
return clusters
