|
| 1 | +# (C) Copyright [2020] Hewlett Packard Enterprise Development LP |
| 2 | +# |
| 3 | +# Permission is hereby granted, free of charge, to any person obtaining a |
| 4 | +# copy of this software and associated documentation files (the "Software"), |
| 5 | +# to deal in the Software without restriction, including without limitation |
| 6 | +# the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 7 | +# and/or sell copies of the Software, and to permit persons to whom the |
| 8 | +# Software is furnished to do so, subject to the following conditions: |
| 9 | +# |
| 10 | +# The above copyright notice and this permission notice shall be included |
| 11 | +# in all copies or substantial portions of the Software. |
| 12 | +# |
| 13 | +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 14 | +# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 15 | +# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 16 | +# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
| 17 | +# OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
| 18 | +# ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
| 19 | +# OTHER DEALINGS IN THE SOFTWARE. |
| 20 | + |
| 21 | +from __future__ import absolute_import |
| 22 | +from .logger import Logger |
| 23 | +from .exceptions import ( |
| 24 | + ContainerPlatformClientException, |
| 25 | + APIException, |
| 26 | + APIItemNotFoundException, |
| 27 | + APIItemConflictException, |
| 28 | +) |
| 29 | + |
| 30 | +import json |
| 31 | +from operator import attrgetter |
| 32 | + |
| 33 | +# from tabulate import tabulate |
| 34 | +# from enum import Enum |
| 35 | +# import polling |
| 36 | +import re |
| 37 | +import six |
| 38 | +import sys |
| 39 | + |
| 40 | +try: |
| 41 | + basestring |
| 42 | +except NameError: |
| 43 | + basestring = str |
| 44 | + |
| 45 | + |
| 46 | +class RoleController: |
| 47 | + """This is the main class that users will interact with to work with roles. |
| 48 | +
|
| 49 | + An instance of this class is available in the client.ContainerPlatformClient with the attribute name |
| 50 | + :py:attr:`role <.client.ContainerPlatformClient.role>`. The methods of this class can be |
| 51 | + invoked using `client.role.method()`. See the example below: |
| 52 | +
|
| 53 | + Example:: |
| 54 | +
|
| 55 | + client = ContainerPlatformClient(...).create_session() |
| 56 | + client.role.get() |
| 57 | +
|
| 58 | + """ |
| 59 | + |
| 60 | + def __init__(self, client): |
| 61 | + self.client = client |
| 62 | + |
| 63 | + def get(self, role_id): |
| 64 | + """Retrieve a Role by ID. |
| 65 | +
|
| 66 | + Args: |
| 67 | + role_id: str |
| 68 | + The role ID - format: '/api/v1/role/[0-9]+' |
| 69 | +
|
| 70 | + Returns: |
| 71 | + Role: object representing Role |
| 72 | +
|
| 73 | + Raises: |
| 74 | + APIException |
| 75 | + """ |
| 76 | + assert isinstance( |
| 77 | + role_id, str |
| 78 | + ), "'role_id' must be provided and must be a string" |
| 79 | + assert re.match( |
| 80 | + r"\/api\/v1\/role\/[0-9]+", role_id |
| 81 | + ), "'role_id' must have format '/api/v1/role/[0-9]+'" |
| 82 | + |
| 83 | + response = self.client._request( |
| 84 | + url=role_id, http_method="get", description="role/get" |
| 85 | + ) |
| 86 | + if response.json()["purpose"] != "proxy": |
| 87 | + raise APIItemNotFoundException( |
| 88 | + message="role not found with id: " + role_id, |
| 89 | + request_method="get", |
| 90 | + request_url=role_id, |
| 91 | + ) |
| 92 | + |
| 93 | + return Role(response.json()) |
| 94 | + |
| 95 | + |
| 96 | +class Role: |
| 97 | + """Create an instance of Role from json data returned from the HPE Container Platform API. |
| 98 | +
|
| 99 | + Users of this library are not expected to create an instance of this class. |
| 100 | +
|
| 101 | + Parameters: |
| 102 | + json : str |
| 103 | + The json returned by the API representing a Gateway. |
| 104 | +
|
| 105 | + Returns: |
| 106 | + Gateway: |
| 107 | + An instance of Gateway |
| 108 | + """ |
| 109 | + |
| 110 | + all_fields = [ |
| 111 | + "id", |
| 112 | + "name", |
| 113 | + "description", |
| 114 | + ] |
| 115 | + """All of the fields of Role objects as returned by the HPE Container Platform API""" |
| 116 | + |
| 117 | + default_display_fields = [ |
| 118 | + "id", |
| 119 | + "name", |
| 120 | + "description", |
| 121 | + ] |
| 122 | + """These fields are displayed by default, e.g. in tabulate()""" |
| 123 | + |
| 124 | + def __init__(self, json): |
| 125 | + self.json = json |
| 126 | + self.display_columns = Role.default_display_fields |
| 127 | + |
| 128 | + def __repr__(self): |
| 129 | + return "<Role id:{} description:{}>".format(self.id, self.description) |
| 130 | + |
| 131 | + def __str__(self): |
| 132 | + return "K8sCluster(id={}, description={})".format( |
| 133 | + self.id, self.description |
| 134 | + ) |
| 135 | + |
| 136 | + def __dir__(self): |
| 137 | + return self.display_columns |
| 138 | + |
| 139 | + def __getitem__(self, item): |
| 140 | + return getattr(self, self.display_columns[item]) |
| 141 | + |
| 142 | + def __len__(self): |
| 143 | + return len(dir(self)) |
| 144 | + |
| 145 | + @property |
| 146 | + def id(self): |
| 147 | + """@Field: from json['_links']['self']['href'] - id format: '/api/v1/role/[0-9]+'""" |
| 148 | + return self.json["_links"]["self"]["href"] |
| 149 | + |
| 150 | + @property |
| 151 | + def name(self): |
| 152 | + """@Field: from json['label']['name']""" |
| 153 | + return self.json["label"]["name"] |
| 154 | + |
| 155 | + @property |
| 156 | + def description(self): |
| 157 | + """@Field: from json['label']['description']""" |
| 158 | + return self.json["label"]["description"] |
0 commit comments