1 |
|
# |
2 |
|
# Copyright 2018 Telefonica Investigacion y Desarrollo S.A.U. |
3 |
|
# |
4 |
|
# All Rights Reserved. |
5 |
|
# |
6 |
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may |
7 |
|
# not use this file except in compliance with the License. You may obtain |
8 |
|
# a copy of the License at |
9 |
|
# |
10 |
|
# http://www.apache.org/licenses/LICENSE-2.0 |
11 |
|
# |
12 |
|
# Unless required by applicable law or agreed to in writing, software |
13 |
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
14 |
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
15 |
|
# License for the specific language governing permissions and limitations |
16 |
|
# under the License. |
17 |
|
|
18 |
1 |
""" |
19 |
|
OSM project mgmt API |
20 |
|
""" |
21 |
|
|
22 |
1 |
from osmclient.common import utils |
23 |
1 |
from osmclient.common.exceptions import ClientException |
24 |
1 |
from osmclient.common.exceptions import NotFound |
25 |
1 |
import json |
26 |
1 |
import logging |
27 |
|
|
28 |
|
|
29 |
1 |
class Project(object): |
30 |
1 |
def __init__(self, http=None, client=None): |
31 |
0 |
self._http = http |
32 |
0 |
self._client = client |
33 |
0 |
self._logger = logging.getLogger("osmclient") |
34 |
0 |
self._apiName = "/admin" |
35 |
0 |
self._apiVersion = "/v1" |
36 |
0 |
self._apiResource = "/projects" |
37 |
0 |
self._apiBase = "{}{}{}".format( |
38 |
|
self._apiName, self._apiVersion, self._apiResource |
39 |
|
) |
40 |
|
|
41 |
1 |
def create(self, name, project): |
42 |
|
"""Creates a new OSM project""" |
43 |
0 |
self._logger.debug("") |
44 |
0 |
self._client.get_token() |
45 |
0 |
http_code, resp = self._http.post_cmd( |
46 |
|
endpoint=self._apiBase, postfields_dict=project, skip_query_admin=True |
47 |
|
) |
48 |
|
# print('HTTP CODE: {}'.format(http_code)) |
49 |
|
# print('RESP: {}'.format(resp)) |
50 |
|
# if http_code in (200, 201, 202, 204): |
51 |
0 |
if resp: |
52 |
0 |
resp = json.loads(resp) |
53 |
0 |
if not resp or "id" not in resp: |
54 |
0 |
raise ClientException("unexpected response from server - {}".format(resp)) |
55 |
0 |
print(resp["id"]) |
56 |
|
# else: |
57 |
|
# msg = "" |
58 |
|
# if resp: |
59 |
|
# try: |
60 |
|
# msg = json.loads(resp) |
61 |
|
# except ValueError: |
62 |
|
# msg = resp |
63 |
|
# raise ClientException("failed to create project {} - {}".format(name, msg)) |
64 |
|
|
65 |
1 |
def update(self, project, project_changes): |
66 |
|
"""Updates an OSM project identified by name""" |
67 |
0 |
self._logger.debug("") |
68 |
0 |
self._client.get_token() |
69 |
0 |
proj = self.get(project) |
70 |
0 |
http_code, resp = self._http.patch_cmd( |
71 |
|
endpoint="{}/{}".format(self._apiBase, proj["_id"]), |
72 |
|
postfields_dict=project_changes, |
73 |
|
skip_query_admin=True, |
74 |
|
) |
75 |
|
# print('HTTP CODE: {}'.format(http_code)) |
76 |
|
# print('RESP: {}'.format(resp)) |
77 |
0 |
if http_code in (200, 201, 202): |
78 |
0 |
if resp: |
79 |
0 |
resp = json.loads(resp) |
80 |
0 |
if not resp or "id" not in resp: |
81 |
0 |
raise ClientException( |
82 |
|
"unexpected response from server - {}".format(resp) |
83 |
|
) |
84 |
0 |
print(resp["id"]) |
85 |
0 |
elif http_code == 204: |
86 |
0 |
print("Updated") |
87 |
|
# else: |
88 |
|
# msg = "" |
89 |
|
# if resp: |
90 |
|
# try: |
91 |
|
# msg = json.loads(resp) |
92 |
|
# except ValueError: |
93 |
|
# msg = resp |
94 |
|
# raise ClientException("failed to update project {} - {}".format(project, msg)) |
95 |
|
|
96 |
1 |
def delete(self, name, force=False): |
97 |
|
"""Deletes an OSM project identified by name""" |
98 |
0 |
self._logger.debug("") |
99 |
0 |
self._client.get_token() |
100 |
0 |
project = self.get(name) |
101 |
0 |
querystring = "" |
102 |
0 |
if force: |
103 |
0 |
querystring = "?FORCE=True" |
104 |
0 |
http_code, resp = self._http.delete_cmd( |
105 |
|
"{}/{}{}".format(self._apiBase, project["_id"], querystring), |
106 |
|
skip_query_admin=True, |
107 |
|
) |
108 |
|
# print('HTTP CODE: {}'.format(http_code)) |
109 |
|
# print('RESP: {}'.format(resp)) |
110 |
0 |
if http_code == 202: |
111 |
0 |
print("Deletion in progress") |
112 |
0 |
elif http_code == 204: |
113 |
0 |
print("Deleted") |
114 |
0 |
elif resp and "result" in resp: |
115 |
0 |
print("Deleted") |
116 |
|
else: |
117 |
0 |
msg = resp or "" |
118 |
|
# if resp: |
119 |
|
# try: |
120 |
|
# msg = json.loads(resp) |
121 |
|
# except ValueError: |
122 |
|
# msg = resp |
123 |
0 |
raise ClientException("failed to delete project {} - {}".format(name, msg)) |
124 |
|
|
125 |
1 |
def list(self, filter=None): |
126 |
|
"""Returns the list of OSM projects""" |
127 |
0 |
self._logger.debug("") |
128 |
0 |
self._client.get_token() |
129 |
0 |
filter_string = "" |
130 |
0 |
if filter: |
131 |
0 |
filter_string = "?{}".format(filter) |
132 |
0 |
_, resp = self._http.get2_cmd( |
133 |
|
"{}{}".format(self._apiBase, filter_string), skip_query_admin=True |
134 |
|
) |
135 |
|
# print('RESP: {}'.format(resp)) |
136 |
0 |
if resp: |
137 |
0 |
return json.loads(resp) |
138 |
0 |
return list() |
139 |
|
|
140 |
1 |
def get(self, name): |
141 |
|
"""Returns a specific OSM project based on name or id""" |
142 |
0 |
self._logger.debug("") |
143 |
0 |
self._client.get_token() |
144 |
0 |
if utils.validate_uuid4(name): |
145 |
0 |
for proj in self.list(): |
146 |
0 |
if name == proj["_id"]: |
147 |
0 |
return proj |
148 |
|
else: |
149 |
0 |
for proj in self.list(): |
150 |
0 |
if name == proj["name"]: |
151 |
0 |
return proj |
152 |
0 |
raise NotFound("Project {} not found".format(name)) |