File: object_storage.py

package info (click to toggle)
python-tempestconf 3.5.1-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 964 kB
  • sloc: python: 4,530; makefile: 18; sh: 9
file content (126 lines) | stat: -rw-r--r-- 4,801 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# Copyright 2016, 2018 Red Hat, Inc.
# All Rights Reserved.
#
# 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.

import json

from six.moves import configparser
from tempest.lib import exceptions

from config_tempest.constants import LOG
from config_tempest.services.base import Service


class ObjectStorageService(Service):
    def set_extensions(self):
        if 'v3' not in self.service_url:  # it's not a v3 url
            capabilities = self.get_capabilities('info')
            if not capabilities:
                # Certain deploynments have /info API endpoint for
                # listing active capabilities at /swift/info instead
                # (e.g.: when ceph is on swift)
                capabilities = self.get_capabilities('swift/info')

            # Remove Swift general information from extensions list
            capabilities.pop('swift', {})
            self.extensions = capabilities.keys()
        else:
            self.extensions = []

    def get_capabilities(self, path):
        try:
            body = self.do_get(self.service_url, top_level=True,
                               top_level_path=path)
        except Exception as e:
            body = '{}'
            LOG.warning('Object storage %s API endpoint not discovered. '
                        'Error message: %s', path, e)

        return json.loads(body)

    def list_create_roles(self, conf, client):
        try:
            roles = client.list_roles()['roles']
            for section_key in ["operator_role", "reseller_admin_role"]:
                key_value = conf.get_defaulted("object-storage", section_key)
                if key_value not in [r['name'] for r in roles]:
                    LOG.info("Creating %s role", key_value)
                    try:
                        client.create_role(name=key_value)
                    except exceptions.Conflict:
                        LOG.info("Role %s already exists", key_value)
            conf.set('object-storage', 'operator_role', 'admin')
        except exceptions.Forbidden:
            LOG.info("Roles can't be listed or created. The user doesn't have "
                     "permissions.")
            # If is not admin, we set the operator_role to Member
            # otherwise we set to admin
            conf.set('object-storage', 'operator_role', 'Member')

    def get_feature_name(self):
        return 'object-storage'

    def get_service_extension_key(self):
        return 'discoverable_apis'

    def _check_health_check(self, path):
        try:
            self.client.accounts.skip_path()
            resp, _ = self.client.accounts.get(path, {})
            return resp['status'] == '200'
        except Exception as e:
            LOG.warning('Healthcheck API not discovered giving %s', e)
            return False

    def check_service_status(self, conf):
        """Use healthcheck api to check the service status

        :type conf: TempestConf object
        """
        # Check for swift discoverability if it is False
        # check_service_status returns False
        # Else above is True, then we can check for healthcheck
        # API then we can find the service_status
        try:
            if not conf.get_bool_value(
                conf.get(
                    'object-storage-feature-enabled',
                    'discoverability')):
                return False
            return True
        except (configparser.NoSectionError, configparser.NoOptionError):
            # On swift, healthcheck is under http://.../healthcheck, while in
            # ceph is under http://.../swift/healthcheck, we check both cases
            return_value = self._check_health_check('healthcheck')
            if not return_value:
                return_value = self._check_health_check('swift/healthcheck')
            return return_value

    def set_default_tempest_options(self, conf):
        """Set default values for swift

        :type conf: TempestConf object
        """
        swift_status = self.check_service_status(conf)
        # Set roles based on service status
        if swift_status:
            self.list_create_roles(conf, self.client.roles)

    @staticmethod
    def get_service_type():
        return ['object-store']

    @staticmethod
    def get_codename():
        return 'swift'