Newer
Older
import copy, logging, os, pytest
from typing import Any, Dict, List, Tuple
#from google.protobuf.json_format import MessageToDict
#from common.Constants import DEFAULT_CONTEXT_ID, DEFAULT_TOPOLOGY_ID
from common.orm.Database import Database
from common.orm.Factory import get_database_backend, BackendEnum as DatabaseBackendEnum
from common.message_broker.Factory import get_messagebroker_backend, BackendEnum as MessageBrokerBackendEnum
from common.message_broker.MessageBroker import MessageBroker
#from common.tests.Assertions import validate_device_id, validate_empty
from context.Config import (
GRPC_SERVICE_PORT as CONTEXT_GRPC_SERVICE_PORT, GRPC_MAX_WORKERS as CONTEXT_GRPC_MAX_WORKERS,
GRPC_GRACE_PERIOD as CONTEXT_GRPC_GRACE_PERIOD)
from context.client.ContextClient import ContextClient
from context.proto.context_pb2 import DeviceId
from context.service.grpc_server.ContextService import ContextService
from device.Config import (
GRPC_SERVICE_PORT as DEVICE_GRPC_SERVICE_PORT, GRPC_MAX_WORKERS as DEVICE_GRPC_MAX_WORKERS,
GRPC_GRACE_PERIOD as DEVICE_GRPC_GRACE_PERIOD)
from device.proto.context_pb2 import ConfigActionEnum, Context, Device, Topology
from device.service.DeviceService import DeviceService
from device.service.data_cache.DataCache import DataCache
from device.service.driver_api.DriverFactory import DriverFactory
from device.service.driver_api.DriverInstanceCache import DriverInstanceCache
from device.service.drivers import DRIVERS
from .example_objects import CONTEXT, DEVICE1, DEVICE1_ID, TOPOLOGY, config_rule
Lluis Gifre Renom
committed
Lluis Gifre Renom
committed
LOGGER = logging.getLogger(__name__)
LOGGER.setLevel(logging.DEBUG)
CONTEXT_GRPC_SERVICE_PORT = 10000 + CONTEXT_GRPC_SERVICE_PORT # avoid privileged ports
DEVICE_GRPC_SERVICE_PORT = 10000 + DEVICE_GRPC_SERVICE_PORT # avoid privileged ports
DEFAULT_REDIS_SERVICE_HOST = '127.0.0.1'
DEFAULT_REDIS_SERVICE_PORT = 6379
DEFAULT_REDIS_DATABASE_ID = 0
REDIS_CONFIG = {
'REDIS_SERVICE_HOST': os.environ.get('REDIS_SERVICE_HOST', DEFAULT_REDIS_SERVICE_HOST),
'REDIS_SERVICE_PORT': os.environ.get('REDIS_SERVICE_PORT', DEFAULT_REDIS_SERVICE_PORT),
'REDIS_DATABASE_ID' : os.environ.get('REDIS_DATABASE_ID', DEFAULT_REDIS_DATABASE_ID ),
SCENARIOS = [
('all_inmemory', DatabaseBackendEnum.INMEMORY, {}, MessageBrokerBackendEnum.INMEMORY, {} ),
#('all_redis', DatabaseBackendEnum.REDIS, REDIS_CONFIG, MessageBrokerBackendEnum.REDIS, REDIS_CONFIG),
]
@pytest.fixture(scope='session', ids=[str(scenario[0]) for scenario in SCENARIOS], params=SCENARIOS)
def context_db_mb(request) -> Tuple[Database, MessageBroker]:
name,db_backend,db_settings,mb_backend,mb_settings = request.param
msg = 'Running scenario {:s} db_backend={:s}, db_settings={:s}, mb_backend={:s}, mb_settings={:s}...'
LOGGER.info(msg.format(str(name), str(db_backend.value), str(db_settings), str(mb_backend.value), str(mb_settings)))
_database = Database(get_database_backend(backend=db_backend, **db_settings))
_message_broker = MessageBroker(get_messagebroker_backend(backend=mb_backend, **mb_settings))
yield _database, _message_broker
_message_broker.terminate()
def context_service(context_db_mb : Tuple[Database, MessageBroker]): # pylint: disable=redefined-outer-name
_service = ContextService(
context_db_mb[0], context_db_mb[1], port=CONTEXT_GRPC_SERVICE_PORT, max_workers=CONTEXT_GRPC_MAX_WORKERS,
grace_period=CONTEXT_GRPC_GRACE_PERIOD)
Lluis Gifre Renom
committed
_service.start()
yield _service
_service.stop()
@pytest.fixture(scope='session')
def context_client(context_service : ContextService): # pylint: disable=redefined-outer-name
_client = ContextClient(address='127.0.0.1', port=CONTEXT_GRPC_SERVICE_PORT)
@pytest.fixture(scope='session')
def device_service():
data_cache = DataCache('127.0.0.1', CONTEXT_GRPC_SERVICE_PORT)
driver_factory = DriverFactory(DRIVERS)
driver_instance_cache = DriverInstanceCache(driver_factory)
_service = DeviceService(
data_cache, driver_instance_cache, port=DEVICE_GRPC_SERVICE_PORT, max_workers=DEVICE_GRPC_MAX_WORKERS,
grace_period=DEVICE_GRPC_GRACE_PERIOD)
_service.start()
yield _service
_service.stop()
@pytest.fixture(scope='session')
def device_client(device_service : DeviceService): # pylint: disable=redefined-outer-name
_client = DeviceClient(address='127.0.0.1', port=DEVICE_GRPC_SERVICE_PORT)
yield _client
_client.close()
def test_device_add(context_client : ContextClient, device_client : DeviceClient):
context_client.SetContext(Context(**CONTEXT))
context_client.SetTopology(Topology(**TOPOLOGY))
device_client.AddDevice(Device(**DEVICE1))
initial_config = device_client.GetInitialConfig(DeviceId(**DEVICE1_ID))
LOGGER.info('initial_config = {:s}'.format(str(initial_config)))
DEVICE1_WITH = copy.deepcopy(DEVICE1)
CONFIG_RULES : List[Dict[str, Any]] = DEVICE1_WITH['device_config']['config_rules']
CONFIG_RULES.clear()
CONFIG_RULES.append(config_rule(ConfigActionEnum.CONFIGACTION_DELETE, 'dev/rsrc1/value', 'value1'))
CONFIG_RULES.append(config_rule(ConfigActionEnum.CONFIGACTION_SET, 'dev/rsrc10/value', 'value10'))
CONFIG_RULES.append(config_rule(ConfigActionEnum.CONFIGACTION_SET, 'dev/rsrc11/value', 'value11'))
CONFIG_RULES.append(config_rule(ConfigActionEnum.CONFIGACTION_SET, 'dev/rsrc12/value', 'value12'))
device_client.ConfigureDevice(Device(**DEVICE1_WITH))
device_data = context_client.GetDevice(DeviceId(**DEVICE1_ID))
LOGGER.info('device_data = {:s}'.format(str(device_data)))
device_client.DeleteDevice(DeviceId(**DEVICE1_ID))
Lluis Gifre Renom
committed
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
#def test_add_device_wrong_attributes(device_client : DeviceClient):
# # should fail with device uuid is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_id']['device_id']['uuid'] = ''
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'device.device_id.device_id.uuid() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
# # should fail with device type is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_type'] = ''
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'device.device_type() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
# # should fail with wrong device operational status
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['devOperationalStatus'] = OperationalStatus.KEEP_STATE.value
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Method(AddDevice) does not accept OperationalStatus(KEEP_STATE). '\
# 'Permitted values for Method(AddDevice) are OperationalStatus([\'DISABLED\', \'ENABLED\']).'
# assert e.value.details() == msg
#
#def test_add_device_wrong_endpoint(device_client : DeviceClient):
# # should fail with unsupported endpoint context
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_id']['topoId']['contextId']['contextUuid']['uuid'] = 'wrong-context'
# request = Device(**copy_device)
# device_client.AddDevice(request)
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Context(wrong-context) in Endpoint(#0) of '\
# 'Context(admin)/Topology(admin)/Device(DEV1) mismatches acceptable Contexts({\'admin\'}). '\
# 'Optionally, leave field empty to use predefined Context(admin).'
# assert e.value.details() == msg
#
# # should fail with unsupported endpoint topology
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_id']['topoId']['topoId']['uuid'] = 'wrong-topo'
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Context(admin)/Topology(wrong-topo) in Endpoint(#0) of '\
# 'Context(admin)/Topology(admin)/Device(DEV1) mismatches acceptable Topologies({\'admin\'}). '\
# 'Optionally, leave field empty to use predefined Topology(admin).'
# assert e.value.details() == msg
#
# # should fail with wrong endpoint device
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_id']['dev_id']['device_id']['uuid'] = 'wrong-device'
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Context(admin)/Topology(admin)/Device(wrong-device) in Endpoint(#0) of '\
# 'Context(admin)/Topology(admin)/Device(DEV1) mismatches acceptable Devices({\'DEV1\'}). '\
# 'Optionally, leave field empty to use predefined Device(DEV1).'
# assert e.value.details() == msg
#
# # should fail with endpoint port uuid is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_id']['port_id']['uuid'] = ''
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'endpoint_id[#0].port_id.uuid() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
# # should fail with endpoint port type is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_type'] = ''
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'endpoint[#0].port_type() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
# # should fail with duplicate port in device
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][1]['port_id']['port_id']['uuid'] = 'EP2'
# device_client.AddDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Duplicated Context(admin)/Topology(admin)/Device(DEV1)/Port(EP2) in Endpoint(#1) of '\
# 'Context(admin)/Topology(admin)/Device(DEV1).'
# assert e.value.details() == msg
#
#def test_add_device(device_client : DeviceClient):
# # should work
# validate_device_id(MessageToDict(
# device_client.AddDevice(Device(**DEVICE)),
# including_default_value_fields=True, preserving_proto_field_name=True,
# use_integers_for_enums=False))
#
#def test_add_device_duplicate(device_client : DeviceClient):
# # should fail with device already exists
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# device_client.AddDevice(Device(**DEVICE))
# assert e.value.code() == grpc.StatusCode.ALREADY_EXISTS
# msg = 'Context(admin)/Topology(admin)/Device(DEV1) already exists in the database.'
# assert e.value.details() == msg
#
#def test_delete_device_empty_uuid(device_client : DeviceClient):
# # should fail with device uuid is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device_id = copy.deepcopy(DEVICE_ID)
# copy_device_id['device_id']['uuid'] = ''
# device_client.DeleteDevice(DeviceId(**copy_device_id))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'device_id.device_id.uuid() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
#def test_delete_device_not_found(device_client : DeviceClient):
# # should fail with device not found
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device_id = copy.deepcopy(DEVICE_ID)
# copy_device_id['device_id']['uuid'] = 'wrong-device-id'
# device_client.DeleteDevice(DeviceId(**copy_device_id))
# assert e.value.code() == grpc.StatusCode.NOT_FOUND
# msg = 'Context(admin)/Topology(admin)/Device(wrong-device-id) does not exist in the database.'
# assert e.value.details() == msg
#
#def test_delete_device(device_client : DeviceClient):
# # should work
# validate_empty(MessageToDict(
# device_client.DeleteDevice(DeviceId(**DEVICE_ID)),
# including_default_value_fields=True, preserving_proto_field_name=True,
# use_integers_for_enums=False))
#
#def test_configure_device_empty_device_uuid(device_client : DeviceClient):
# # should fail with device uuid is empty
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_id']['device_id']['uuid'] = ''
# device_client.ConfigureDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'device.device_id.device_id.uuid() is out of range: '\
# 'allow_empty(False) min_length(None) max_length(None) allowed_lengths(None).'
# assert e.value.details() == msg
#
#def test_configure_device_not_found(device_client : DeviceClient):
# # should fail with device not found
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_id']['device_id']['uuid'] = 'wrong-device-id'
# device_client.ConfigureDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.NOT_FOUND
# msg = 'Context(admin)/Topology(admin)/Device(wrong-device-id) does not exist in the database.'
# assert e.value.details() == msg
#
#def test_add_device_default_endpoint_context_topology_device(device_client : DeviceClient):
# # should work
# copy_device = copy.deepcopy(DEVICE)
# copy_device['endpointList'][0]['port_id']['topoId']['contextId']['contextUuid']['uuid'] = ''
# copy_device['endpointList'][0]['port_id']['topoId']['topoId']['uuid'] = ''
# copy_device['endpointList'][0]['port_id']['dev_id']['device_id']['uuid'] = ''
# validate_device_id(MessageToDict(
# device_client.AddDevice(Device(**copy_device)),
# including_default_value_fields=True, preserving_proto_field_name=True,
# use_integers_for_enums=False))
#
#def test_configure_device_wrong_attributes(device_client : DeviceClient):
# # should fail with device type is wrong
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_type'] = 'wrong-type'
# device_client.ConfigureDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# msg = 'Device(DEV1) has Type(ROADM) in the database. Cannot be changed to Type(wrong-type).'
# assert e.value.details() == msg
#
# # should fail with endpoints cannot be modified
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# device_client.ConfigureDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
# assert e.value.details() == 'Endpoints belonging to Device(DEV1) cannot be modified.'
#
# # should fail with any change detected
# with pytest.raises(grpc._channel._InactiveRpcError) as e:
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_config']['device_config'] = ''
# copy_device['devOperationalStatus'] = OperationalStatus.KEEP_STATE.value
# copy_device['endpointList'].clear()
# device_client.ConfigureDevice(Device(**copy_device))
# assert e.value.code() == grpc.StatusCode.ABORTED
# msg = 'Any change has been requested for Device(DEV1). '\
# 'Either specify a new configuration or a new device operational status.'
# assert e.value.details() == msg
#
#def test_configure_device(device_client : DeviceClient):
# # should work
# copy_device = copy.deepcopy(DEVICE)
# copy_device['device_config']['device_config'] = '<new_config/>'
# copy_device['devOperationalStatus'] = OperationalStatus.DISABLED.value
# copy_device['endpointList'].clear()
# validate_device_id(MessageToDict(
# device_client.ConfigureDevice(Device(**copy_device)),
# including_default_value_fields=True, preserving_proto_field_name=True,
# use_integers_for_enums=False))