Newer
Older
# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)
#
# 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 common.tools.grpc.Tools import grpc_message_to_json_string
from context.client.ContextClient import ContextClient
from device.client.DeviceClient import DeviceClient
from device.proto.context_pb2 import ConfigActionEnum, Device
from device.service.DeviceService import DeviceService
from device.service.driver_api._Driver import _Driver
from .PrepareTestScenario import ( # pylint: disable=unused-import
# be careful, order of symbols is important here!
mock_service, device_service, context_client, device_client, monitoring_client, test_prepare_environment)
try:
from .Device_Microwave_Template import (
DEVICE_MICROWAVE, DEVICE_MICROWAVE_CONNECT_RULES, DEVICE_MICROWAVE_UUID, DEVICE_MICROWAVE_ID,
DEVICE_MICROWAVE_CONFIG_RULES, DEVICE_MICROWAVE_DECONFIG_RULES)
ENABLE_MICROWAVE = True
except ImportError:
LOGGER = logging.getLogger(__name__)
LOGGER.setLevel(logging.DEBUG)
# ----- Test Device Driver Microwave ------------------------------------------------
def test_device_microwave_add_error_cases(
device_client : DeviceClient): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No TAPI device has been configured')
with pytest.raises(grpc.RpcError) as e:
DEVICE_MICROWAVE_WITH_EXTRA_RULES = copy.deepcopy(DEVICE_MICROWAVE)
DEVICE_MICROWAVE_WITH_EXTRA_RULES['device_config']['config_rules'].extend(DEVICE_MICROWAVE_CONNECT_RULES)
DEVICE_MICROWAVE_WITH_EXTRA_RULES['device_config']['config_rules'].extend(DEVICE_MICROWAVE_CONFIG_RULES)
device_client.AddDevice(Device(**DEVICE_MICROWAVE_WITH_EXTRA_RULES))
assert e.value.code() == grpc.StatusCode.INVALID_ARGUMENT
msg_head = 'device.device_config.config_rules(['
msg_tail = ']) is invalid; RPC method AddDevice only accepts connection Config Rules that should start '\
'with "_connect/" tag. Others should be configured after adding the device.'
except_msg = str(e.value.details())
assert except_msg.startswith(msg_head) and except_msg.endswith(msg_tail)
def test_device_microwave_add_correct(
device_client: DeviceClient, # pylint: disable=redefined-outer-name
device_service: DeviceService): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No MICROWAVE device has been configured')
DEVICE_MICROWAVE_WITH_CONNECT_RULES = copy.deepcopy(DEVICE_MICROWAVE)
DEVICE_MICROWAVE_WITH_CONNECT_RULES['device_config']['config_rules'].extend(DEVICE_MICROWAVE_CONNECT_RULES)
device_client.AddDevice(Device(**DEVICE_MICROWAVE_WITH_CONNECT_RULES))
driver_instance_cache = device_service.device_servicer.driver_instance_cache
driver: _Driver = driver_instance_cache.get(DEVICE_MICROWAVE_UUID)
assert driver is not None
def test_device_microwave_get(
context_client: ContextClient, # pylint: disable=redefined-outer-name
device_client: DeviceClient): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No MICROWAVE device has been configured')
initial_config = device_client.GetInitialConfig(DeviceId(**DEVICE_MICROWAVE_ID))
LOGGER.info('initial_config = {:s}'.format(grpc_message_to_json_string(initial_config)))
device_data = context_client.GetDevice(DeviceId(**DEVICE_MICROWAVE_ID))
LOGGER.info('device_data = {:s}'.format(grpc_message_to_json_string(device_data)))
def test_device_microwave_configure(
context_client: ContextClient, # pylint: disable=redefined-outer-name
device_client: DeviceClient, # pylint: disable=redefined-outer-name
device_service: DeviceService): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No MICROWAVE device has been configured')
driver_instance_cache = device_service.device_servicer.driver_instance_cache
driver : _Driver = driver_instance_cache.get(DEVICE_MICROWAVE_UUID)
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
assert driver is not None
# Requires to retrieve data from device; might be slow. Uncomment only when needed and test does not pass directly.
#driver_config = sorted(driver.GetConfig(), key=operator.itemgetter(0))
#LOGGER.info('driver_config = {:s}'.format(str(driver_config)))
DEVICE_MICROWAVE_WITH_CONFIG_RULES = copy.deepcopy(DEVICE_MICROWAVE)
DEVICE_MICROWAVE_WITH_CONFIG_RULES['device_config']['config_rules'].extend(DEVICE_MICROWAVE_CONFIG_RULES)
device_client.ConfigureDevice(Device(**DEVICE_MICROWAVE_WITH_CONFIG_RULES))
# Requires to retrieve data from device; might be slow. Uncomment only when needed and test does not pass directly.
#driver_config = sorted(driver.GetConfig(), key=operator.itemgetter(0))
#LOGGER.info('driver_config = {:s}'.format(str(driver_config)))
device_data = context_client.GetDevice(DeviceId(**DEVICE_MICROWAVE_ID))
config_rules = [
(ConfigActionEnum.Name(config_rule.action), config_rule.resource_key, config_rule.resource_value)
for config_rule in device_data.device_config.config_rules
]
LOGGER.info('device_data.device_config.config_rules = \n{:s}'.format(
'\n'.join(['{:s} {:s} = {:s}'.format(*config_rule) for config_rule in config_rules])))
for config_rule in DEVICE_MICROWAVE_CONFIG_RULES:
config_rule = (
ConfigActionEnum.Name(config_rule['action']), config_rule['resource_key'], config_rule['resource_value'])
assert config_rule in config_rules
def test_device_microwave_deconfigure(
context_client: ContextClient, # pylint: disable=redefined-outer-name
device_client: DeviceClient, # pylint: disable=redefined-outer-name
device_service: DeviceService): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No MICROWAVE device has been configured')
driver_instance_cache = device_service.device_servicer.driver_instance_cache
driver: _Driver = driver_instance_cache.get(DEVICE_MICROWAVE_UUID)
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
assert driver is not None
# Requires to retrieve data from device; might be slow. Uncomment only when needed and test does not pass directly.
#driver_config = sorted(driver.GetConfig(), key=operator.itemgetter(0))
#LOGGER.info('driver_config = {:s}'.format(str(driver_config)))
DEVICE_MICROWAVE_WITH_DECONFIG_RULES = copy.deepcopy(DEVICE_MICROWAVE)
DEVICE_MICROWAVE_WITH_DECONFIG_RULES['device_config']['config_rules'].extend(DEVICE_MICROWAVE_DECONFIG_RULES)
device_client.ConfigureDevice(Device(**DEVICE_MICROWAVE_WITH_DECONFIG_RULES))
# Requires to retrieve data from device; might be slow. Uncomment only when needed and test does not pass directly.
#driver_config = sorted(driver.GetConfig(), key=operator.itemgetter(0))
#LOGGER.info('driver_config = {:s}'.format(str(driver_config)))
device_data = context_client.GetDevice(DeviceId(**DEVICE_MICROWAVE_ID))
config_rules = [
(ConfigActionEnum.Name(config_rule.action), config_rule.resource_key, config_rule.resource_value)
for config_rule in device_data.device_config.config_rules
]
LOGGER.info('device_data.device_config.config_rules = \n{:s}'.format(
'\n'.join(['{:s} {:s} = {:s}'.format(*config_rule) for config_rule in config_rules])))
for config_rule in DEVICE_MICROWAVE_DECONFIG_RULES:
action_set = ConfigActionEnum.Name(ConfigActionEnum.CONFIGACTION_SET)
config_rule = (action_set, config_rule['resource_key'], config_rule['resource_value'])
assert config_rule not in config_rules
def test_device_microwave_delete(
device_client : DeviceClient, # pylint: disable=redefined-outer-name
device_service : DeviceService): # pylint: disable=redefined-outer-name
if not ENABLE_MICROWAVE: pytest.skip('Skipping test: No MICROWAVE device has been configured')
device_client.DeleteDevice(DeviceId(**DEVICE_MICROWAVE_ID))
driver_instance_cache = device_service.device_servicer.driver_instance_cache
driver : _Driver = driver_instance_cache.get(DEVICE_MICROWAVE_UUID, {})
assert driver is None