Source code for heat.engine.clients.os.mistral

#
#    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.

from keystoneauth1.exceptions import http as ka_exceptions
from mistralclient.api import base as mistral_base
from mistralclient.api import client as mistral_client

from heat.common import exception
from heat.engine.clients import client_plugin
from heat.engine import constraints

CLIENT_NAME = 'mistral'


class MistralClientPlugin(client_plugin.ClientPlugin):

    service_types = [WORKFLOW_V2] = ['workflowv2']

    def _create(self):
        endpoint_type = self._get_client_option(CLIENT_NAME, 'endpoint_type')
        endpoint = self.url_for(service_type=self.WORKFLOW_V2,
                                endpoint_type=endpoint_type)
        args = {
            'mistral_url': endpoint,
            'session': self.context.keystone_session,
            'region_name': self._get_region_name()
        }

        client = mistral_client.client(**args)
        return client

    def is_not_found(self, ex):
        # check for keystoneauth exceptions till requirements change
        # to python-mistralclient > 3.1.2
        ka_not_found = isinstance(ex, ka_exceptions.NotFound)
        mistral_not_found = (isinstance(ex, mistral_base.APIException) and
                             ex.error_code == 404)
        return ka_not_found or mistral_not_found

    def is_over_limit(self, ex):
        # check for keystoneauth exceptions till requirements change
        # to python-mistralclient > 3.1.2
        ka_overlimit = isinstance(ex, ka_exceptions.RequestEntityTooLarge)
        mistral_overlimit = (isinstance(ex, mistral_base.APIException) and
                             ex.error_code == 413)
        return ka_overlimit or mistral_overlimit

    def is_conflict(self, ex):
        # check for keystoneauth exceptions till requirements change
        # to python-mistralclient > 3.1.2
        ka_conflict = isinstance(ex, ka_exceptions.Conflict)
        mistral_conflict = (isinstance(ex, mistral_base.APIException) and
                            ex.error_code == 409)
        return ka_conflict or mistral_conflict

    def get_workflow_by_identifier(self, workflow_identifier):
        try:
            return self.client().workflows.get(
                workflow_identifier)
        except Exception as ex:
            if self.is_not_found(ex):
                raise exception.EntityNotFound(
                    entity="Workflow",
                    name=workflow_identifier)
            raise


class WorkflowConstraint(constraints.BaseCustomConstraint):
    resource_client_name = CLIENT_NAME
    resource_getter_name = 'get_workflow_by_identifier'
    expected_exceptions = (exception.EntityNotFound,)