Source code for saharaclient.api.plugins

# Copyright (c) 2013 Mirantis 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.

from urllib import parse as urlparse

from saharaclient.api import base


class Plugin(base.Resource):
    resource_name = 'Plugin'

    def __init__(self, manager, info):
        base.Resource.__init__(self, manager, info)

        # Horizon requires each object in table to have an id
        self.id = self.name


class _PluginManager(base.ResourceManager):
    resource_class = Plugin

    def list(self, search_opts=None):
        """Get a list of Plugins."""
        query = base.get_query_string(search_opts)
        return self._list('/plugins%s' % query, 'plugins')

    def get(self, plugin_name):
        """Get information about a Plugin."""
        return self._get('/plugins/%s' % plugin_name, 'plugin')

    def get_version_details(self, plugin_name, hadoop_version):
        """Get version details

        Get the list of Services and Service Parameters for a specified
        Plugin and Plugin Version.
        """
        return self._get('/plugins/%s/%s' % (plugin_name, hadoop_version),
                         'plugin')

    def update(self, plugin_name, values):
        """Update plugin and then return updated result to user

        """
        return self._patch("/plugins/%s" % plugin_name, values, 'plugin')


class PluginManagerV1(_PluginManager):
    def convert_to_cluster_template(self, plugin_name, hadoop_version,
                                    template_name, filecontent):
        """Convert to cluster template

        Create Cluster Template directly, avoiding Cluster Template
        mechanism.
        """
        resp = self.api.post('/plugins/%s/%s/convert-config/%s' %
                             (plugin_name,
                              hadoop_version,
                              urlparse.quote(template_name)),
                             data=filecontent)
        if resp.status_code != 202:
            raise RuntimeError('Failed to upload template file for plugin "%s"'
                               ' and version "%s"' %
                               (plugin_name, hadoop_version))
        else:
            return base.get_json(resp)['cluster_template']


class PluginManagerV2(_PluginManager):
    def get_version_details(self, plugin_name, plugin_version):
        """Get version details

        Get the list of Services and Service Parameters for a specified
        Plugin and Plugin Version.
        """
        return self._get('/plugins/%s/%s' % (plugin_name, plugin_version),
                         'plugin')


# NOTE(jfreud): keep this around for backwards compatibility
PluginManager = PluginManagerV1