File: action_shell.py

package info (click to toggle)
python-watcherclient 4.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 852 kB
  • sloc: python: 8,569; makefile: 29; sh: 2
file content (203 lines) | stat: -rw-r--r-- 7,186 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
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# Copyright (c) 2016 b<>com
#
# 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 copy

from osc_lib import utils
from oslo_utils import uuidutils

from watcherclient._i18n import _
from watcherclient.common import api_versioning
from watcherclient.common import command
from watcherclient.common import utils as common_utils
from watcherclient import exceptions
from watcherclient.v1 import resource_fields as res_fields


def drop_unsupported_field(app_args, fields, field_labels):
    fields = copy.copy(fields)
    field_labels = copy.copy(field_labels)
    api_ver = app_args.os_infra_optim_api_version
    if not api_versioning.action_update_supported(api_ver):
        fields.remove('status_message')
        field_labels.remove('Status Message')
    return fields, field_labels


class ShowAction(command.ShowOne):
    """Show detailed information about a given action."""

    def get_parser(self, prog_name):
        parser = super(ShowAction, self).get_parser(prog_name)
        parser.add_argument(
            'action',
            metavar='<action>',
            help=_('UUID of the action'),
        )
        return parser

    def take_action(self, parsed_args):
        client = getattr(self.app.client_manager, "infra-optim")

        try:
            action = client.action.get(parsed_args.action)
        except exceptions.HTTPNotFound as exc:
            raise exceptions.CommandError(str(exc))

        columns = res_fields.ACTION_FIELDS
        column_headers = res_fields.ACTION_FIELD_LABELS
        columns, column_headers = drop_unsupported_field(
            self.app_args, columns, column_headers)

        return column_headers, utils.get_item_properties(action, columns)


class ListAction(command.Lister):
    """List information on retrieved actions."""

    def get_parser(self, prog_name):
        parser = super(ListAction, self).get_parser(prog_name)
        parser.add_argument(
            '--action-plan',
            metavar='<action-plan>',
            help=_('UUID of the action plan used for filtering.'))
        parser.add_argument(
            '--audit',
            metavar='<audit>',
            help=_(' UUID of the audit used for filtering.'))
        parser.add_argument(
            '--detail',
            dest='detail',
            action='store_true',
            default=False,
            help=_("Show detailed information about actions."))
        parser.add_argument(
            '--limit',
            metavar='<limit>',
            type=int,
            help=_('Maximum number of actions to return per request, '
                   '0 for no limit. Default is the maximum number used '
                   'by the Watcher API Service.'))
        parser.add_argument(
            '--sort-key',
            metavar='<field>',
            help=_('Action field that will be used for sorting.'))
        parser.add_argument(
            '--sort-dir',
            metavar='<direction>',
            choices=['asc', 'desc'],
            help=_('Sort direction: "asc" (the default) or "desc".'))
        parser.add_argument(
            '--marker',
            dest='marker',
            metavar='<marker>',
            default=None,
            help=_('UUID of the last action in the previous page; '
                   'displays list of actions after "marker".'))

        return parser

    def take_action(self, parsed_args):
        client = getattr(self.app.client_manager, "infra-optim")

        params = {}
        if parsed_args.action_plan is not None:
            params['action_plan'] = parsed_args.action_plan
        if parsed_args.audit is not None:
            params['audit'] = parsed_args.audit
        if parsed_args.detail:
            fields = res_fields.ACTION_FIELDS
            field_labels = res_fields.ACTION_FIELD_LABELS
            fields, field_labels = drop_unsupported_field(
                self.app_args, fields, field_labels)
        else:
            fields = res_fields.ACTION_SHORT_LIST_FIELDS
            field_labels = res_fields.ACTION_SHORT_LIST_FIELD_LABELS

        params.update(
            common_utils.common_params_for_list(
                parsed_args, fields, field_labels))

        try:
            data = client.action.list(**params)
        except exceptions.HTTPNotFound as ex:
            raise exceptions.CommandError(str(ex))

        return (field_labels,
                (utils.get_item_properties(item, fields) for item in data))


class UpdateAction(command.ShowOne):
    """Update action command."""

    def get_parser(self, prog_name):
        parser = super(UpdateAction, self).get_parser(prog_name)
        parser.add_argument(
            'action',
            metavar='<action>',
            help=_('UUID of the action'))
        parser.add_argument(
            '--state',
            metavar='<state>',
            help=_('New state for the action (e.g., SKIPPED)'))
        parser.add_argument(
            '--reason',
            metavar='<reason>',
            help=_('Reason for the state change'))
        return parser

    def take_action(self, parsed_args):
        client = getattr(self.app.client_manager, "infra-optim")

        # Check if action update is supported in the requested API version
        api_ver = self.app_args.os_infra_optim_api_version
        if not api_versioning.action_update_supported(api_ver):
            raise exceptions.CommandError(
                _("Action update is not supported in API version %s. "
                  "Minimum required version is 1.5.") % api_ver)

        if not parsed_args.state and not parsed_args.reason:
            raise exceptions.CommandError(
                _("At least one field update is required for this operation"))

        if not uuidutils.is_uuid_like(parsed_args.action):
            raise exceptions.ValidationError()

        patch = []
        if parsed_args.state:
            patch.append({
                'op': 'replace',
                'path': '/state',
                'value': parsed_args.state
            })

        if parsed_args.reason:
            patch.append({
                'op': 'replace',
                'path': '/status_message',
                'value': parsed_args.reason
            })

        try:
            action = client.action.update(parsed_args.action, patch)
        except exceptions.HTTPNotFound as exc:
            raise exceptions.CommandError(str(exc))

        columns = res_fields.ACTION_FIELDS
        column_headers = res_fields.ACTION_FIELD_LABELS
        columns, column_headers = drop_unsupported_field(
            self.app_args, columns, column_headers)

        return column_headers, utils.get_item_properties(action, columns)