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
|
"""ONAP SDK CPS dataspace module."""
# Copyright 2022 Orange, Deutsche Telekom AG
#
# 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.
from typing import Any, Dict, Iterable
from .anchor import Anchor
from .cps_element import CpsElement
from .schemaset import SchemaSet, SchemaSetModuleReference
class Dataspace(CpsElement):
"""CPS dataspace class."""
def __init__(self, name: str) -> None:
"""Initialize dataspace object.
Args:
name (str): Dataspace name
"""
super().__init__()
self.name: str = name
def __repr__(self) -> str:
"""Human readable representation of the object.
Returns:
str: Human readable string
"""
return f"Dataspace(name={self.name})"
@property
def url(self) -> str:
"""Dataspace url.
Returns:
str: Dataspace url
"""
return f"{self._url}/dataspaces/{self.name}"
@classmethod
def create(cls, dataspace_name: str) -> "Dataspace":
"""Create dataspace with given name.
Args:
dataspace_name (str): Dataspace name
Returns:
Dataspace: Newly created dataspace
"""
cls.send_message(
"POST",
f"Create {dataspace_name} dataspace",
f"{cls._url}/dataspaces?dataspace-name={dataspace_name}",
auth=cls.auth
)
return Dataspace(dataspace_name)
def create_anchor(self, schema_set: SchemaSet, anchor_name: str) -> Anchor:
"""Create anchor.
Args:
schema_set (SchemaSet): Schema set object which is going to be used to create anchor.
anchor_name (str): Anchor name
Returns:
Anchor: Created anchor
"""
self.send_message(
"POST",
"Get all CPS dataspace schemasets",
f"{self.url}/anchors/?schema-set-name={schema_set.name}&anchor-name={anchor_name}",
auth=self.auth
)
return Anchor(name=anchor_name, schema_set=schema_set)
def get_anchors(self) -> Iterable[Anchor]:
"""Get all dataspace's anchors.
Iterable of related with dataspace anchors.
Yields:
Iterator[Anchor]: Anchor object
"""
for anchor_data in self.send_message_json(\
"GET",\
"Get all CPS dataspace anchors",\
f"{self.url}/anchors",\
auth=self.auth\
):
yield Anchor(name=anchor_data["name"],
schema_set=SchemaSet(name=anchor_data["schemaSetName"],
dataspace=self))
def get_anchor(self, anchor_name: str) -> Anchor:
"""Get dataspace anchor by name.
To get anchor there is no need to use `SchemaSet` object, but to create anchor it it.
Args:
anchor_name (str): Anchor name.
Returns:
Anchor: Anchor object
"""
anchor_data: Dict[str, Any] = self.send_message_json(
"GET",
f"Get {anchor_name} anchor",
f"{self.url}/anchors/{anchor_name}",
auth=self.auth
)
return Anchor(name=anchor_data["name"],
schema_set=SchemaSet(name=anchor_data["schemaSetName"],
dataspace=self))
def get_schema_set(self, schema_set_name: str) -> SchemaSet:
"""Get schema set by name.
Args:
schema_set_name (str): Schema set name
Returns:
SchemaSet: Schema set object
"""
schema_set_data: Dict[str, Any] = self.send_message_json(
"GET",
f"Get CPS dataspace {schema_set_name} schemaset",
f"{self._url}/dataspaces/{self.name}/schema-sets/{schema_set_name}",
auth=self.auth
)
return SchemaSet(
name=schema_set_data["name"],
dataspace=self,
module_references=[
SchemaSetModuleReference(
name=module_reference_data.get("name"),
namespace=module_reference_data["namespace"],
revision=module_reference_data["revision"]
) for module_reference_data in schema_set_data["moduleReferences"]
]
)
def create_schema_set(self, schema_set_name: str, schema_set: bytes) -> SchemaSet:
"""Create schema set.
Create CPS schema set in dataspace
Args:
schema_set_name (str): Schema set name
schema_set (bytes): Schema set YANG
Returns:
SchemaSet: Created schema set object
"""
self.send_message(
"POST",
"Create schema set",
f"{self._url}/dataspaces/{self.name}/schema-sets/",
files={"file": schema_set},
data={"schema-set-name": schema_set_name},
headers={}, # Leave headers empty to fill it correctly by `requests` library
auth=self.auth
)
return self.get_schema_set(schema_set_name)
def delete(self) -> None:
"""Delete dataspace."""
self.send_message(
"DELETE",
f"Delete {self.name} dataspace",
f"{self._url}/dataspaces?dataspace-name={self.name}",
auth=self.auth
)
|
