summaryrefslogtreecommitdiff
path: root/openstackclient/tests/unit/volume/v3/test_block_storage_cleanup.py
blob: b48ce2f911874026e4b04a43b448a6275d2555d1 (plain)
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
# 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 uuid

from cinderclient import api_versions
from osc_lib import exceptions

from openstackclient.tests.unit.volume.v3 import fakes as volume_fakes
from openstackclient.volume.v3 import block_storage_cleanup


class TestBlockStorage(volume_fakes.TestVolume):

    def setUp(self):
        super().setUp()

        # Get a shortcut to the BlockStorageWorkerManager Mock
        self.worker_mock = self.app.client_manager.volume.workers
        self.worker_mock.reset_mock()


class TestBlockStorageCleanup(TestBlockStorage):

    cleaning, unavailable = volume_fakes.create_cleanup_records()

    def setUp(self):
        super().setUp()

        self.worker_mock.clean.return_value = (self.cleaning, self.unavailable)

        # Get the command object to test
        self.cmd = \
            block_storage_cleanup.BlockStorageCleanup(self.app, None)

    def test_cleanup(self):
        self.app.client_manager.volume.api_version = \
            api_versions.APIVersion('3.24')

        arglist = [
        ]
        verifylist = [
            ('cluster', None),
            ('host', None),
            ('binary', None),
            ('is_up', None),
            ('disabled', None),
            ('resource_id', None),
            ('resource_type', None),
            ('service_id', None),
        ]
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)

        expected_columns = ('ID', 'Cluster Name', 'Host', 'Binary', 'Status')
        cleaning_data = tuple(
            (
                obj.id,
                obj.cluster_name,
                obj.host,
                obj.binary,
                'Cleaning'
            ) for obj in self.cleaning
        )
        unavailable_data = tuple(
            (
                obj.id,
                obj.cluster_name,
                obj.host,
                obj.binary,
                'Unavailable'
            ) for obj in self.unavailable
        )
        expected_data = cleaning_data + unavailable_data
        columns, data = self.cmd.take_action(parsed_args)

        self.assertEqual(expected_columns, columns)
        self.assertEqual(expected_data, tuple(data))

        # checking if proper call was made to cleanup resources
        # Since we ignore all parameters with None value, we don't
        # have any arguments passed to the API
        self.worker_mock.clean.assert_called_once_with()

    def test_block_storage_cleanup_pre_324(self):
        arglist = [
        ]
        verifylist = [
            ('cluster', None),
            ('host', None),
            ('binary', None),
            ('is_up', None),
            ('disabled', None),
            ('resource_id', None),
            ('resource_type', None),
            ('service_id', None),
        ]
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
        exc = self.assertRaises(exceptions.CommandError, self.cmd.take_action,
                                parsed_args)
        self.assertIn(
            '--os-volume-api-version 3.24 or greater is required', str(exc))

    def test_cleanup_with_args(self):
        self.app.client_manager.volume.api_version = \
            api_versions.APIVersion('3.24')

        fake_cluster = 'fake-cluster'
        fake_host = 'fake-host'
        fake_binary = 'fake-service'
        fake_resource_id = str(uuid.uuid4())
        fake_resource_type = 'Volume'
        fake_service_id = 1
        arglist = [
            '--cluster', fake_cluster,
            '--host', fake_host,
            '--binary', fake_binary,
            '--down',
            '--enabled',
            '--resource-id', fake_resource_id,
            '--resource-type', fake_resource_type,
            '--service-id', str(fake_service_id),
        ]
        verifylist = [
            ('cluster', fake_cluster),
            ('host', fake_host),
            ('binary', fake_binary),
            ('is_up', False),
            ('disabled', False),
            ('resource_id', fake_resource_id),
            ('resource_type', fake_resource_type),
            ('service_id', fake_service_id),
        ]
        parsed_args = self.check_parser(self.cmd, arglist, verifylist)

        expected_columns = ('ID', 'Cluster Name', 'Host', 'Binary', 'Status')
        cleaning_data = tuple(
            (
                obj.id,
                obj.cluster_name,
                obj.host,
                obj.binary,
                'Cleaning'
            ) for obj in self.cleaning
        )
        unavailable_data = tuple(
            (
                obj.id,
                obj.cluster_name,
                obj.host,
                obj.binary,
                'Unavailable'
            ) for obj in self.unavailable
        )
        expected_data = cleaning_data + unavailable_data
        columns, data = self.cmd.take_action(parsed_args)

        self.assertEqual(expected_columns, columns)
        self.assertEqual(expected_data, tuple(data))

        # checking if proper call was made to cleanup resources
        self.worker_mock.clean.assert_called_once_with(
            cluster_name=fake_cluster,
            host=fake_host,
            binary=fake_binary,
            is_up=False,
            disabled=False,
            resource_id=fake_resource_id,
            resource_type=fake_resource_type,
            service_id=fake_service_id)