def test_forwarder_sends_pv_updates_single_pv_double(docker_compose):
"""
Test the forwarder pushes new PV value when the value is updated.
:param docker_compose: Test fixture
:return: None
"""
data_topic = "TEST_forwarderData_double_pv_update"
pvs = [PVDOUBLE]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(2)
cons = create_consumer()
cons.subscribe([data_topic])
# Update value
change_pv_value(PVDOUBLE, 5)
# Wait for PV to be updated
sleep(5)
first_msg = poll_for_valid_message(cons)
check_expected_values(first_msg, Value.Double, PVDOUBLE, 0.0)
second_msg = poll_for_valid_message(cons)
check_expected_values(second_msg, Value.Double, PVDOUBLE, 5.0)
cons.close()
def test_forwarder_sends_pv_updates_single_pv_string(docker_compose):
"""
Test the forwarder pushes new PV value when the value is updated.
:param docker_compose: Test fixture
:return: None
"""
data_topic = "TEST_forwarderData_string_pv_update"
pvs = [PVSTR]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(2)
cons = create_consumer()
# Update value
change_pv_value(PVSTR, "stop")
# Wait for PV to be updated
sleep(5)
cons.subscribe([data_topic])
# Poll for empty update - initial value of PVSTR is nothing
poll_for_valid_message(cons)
# Poll for message which should contain forwarded PV update
data_msg = poll_for_valid_message(cons)
check_expected_values(data_msg, Value.String, PVSTR, b'stop')
cons.close()
def test_forwarder_sends_pv_updates_single_pv_enum(docker_compose):
"""
Test the forwarder pushes new PV value when the value is updated.
NOTE: Enums are converted to Ints in the forwarder.
:param docker_compose: Test fixture
:return: None
"""
data_topic = "TEST_forwarderData_enum_pv_update"
pvs = [PVENUM]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(5)
cons = create_consumer()
# Update value
change_pv_value(PVENUM, "START")
# Wait for PV to be updated
sleep(5)
cons.subscribe([data_topic])
first_msg = poll_for_valid_message(cons)
check_expected_values(first_msg, Value.Int, PVENUM, 0)
second_msg = poll_for_valid_message(cons)
check_expected_values(second_msg, Value.Int, PVENUM, 1)
cons.close()
def test_forwarder_updates_pv_when_config_changed_from_two_pvs(docker_compose):
data_topic = "TEST_forwarderData_change_config"
pvs = [PVSTR, PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
sleep(2)
prod.add_config([PVDOUBLE])
sleep(2)
cons = create_consumer()
sleep(2)
cons.subscribe([data_topic])
sleep(2)
poll_for_valid_message(cons)
poll_for_valid_message(cons)
expected_values = {
PVSTR: (Value.String, b''),
PVLONG: (Value.Int, 0),
PVDOUBLE: (Value.Double, 0.0)
}
messages = [
poll_for_valid_message(cons),
poll_for_valid_message(cons),
poll_for_valid_message(cons)
]
check_multiple_expected_values(messages, expected_values)
cons.close()
def test_forwarder_sends_pv_updates_single_pv_enum(docker_compose_no_command,
start_ioc):
"""
GIVEN PV of enum type is configured to be forwarded
WHEN PV value is updated
THEN Forwarder publishes the update to Kafka
NOTE: Enums are converted to Ints in the forwarder.
"""
data_topic = "TEST_forwarderData_enum_pv_update"
pvs = [PVENUM]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(5)
cons = create_consumer()
# Update value
change_pv_value(PVENUM, "START")
# Wait for PV to be updated
cons.subscribe([data_topic])
sleep(5)
first_msg, _ = poll_for_valid_message(cons)
check_expected_values(first_msg, Value.Int, PVENUM, 0)
second_msg, _ = poll_for_valid_message(cons)
check_expected_values(second_msg, Value.Int, PVENUM, 1)
cons.close()
def test_forwarder_sends_pv_updates_single_pv_long(docker_compose):
"""
Test the forwarder pushes new PV value when the value is updated.
NOTE: longs are converted to ints in the forwarder as they will fit in a 32 bit integer
:param docker_compose: Test fixture
:return: None
"""
data_topic = "TEST_forwarderData_long_pv_update"
pvs = [PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(2)
cons = create_consumer()
# Set initial PV value
change_pv_value(PVLONG, 0)
sleep(2)
# Update value
change_pv_value(PVLONG, 5)
# Wait for PV to be updated
sleep(2)
cons.subscribe([data_topic])
first_msg = poll_for_valid_message(cons)
check_expected_values(first_msg, Value.Int, PVLONG, 0)
second_msg = poll_for_valid_message(cons)
check_expected_values(second_msg, Value.Int, PVLONG, 5)
cons.close()
def test_forwarder_sends_pv_updates_single_floatarray(
docker_compose_no_command):
"""
GIVEN PV of enum type is configured to be forwarded
WHEN PV value is updated
THEN Forwarder publishes the update to Kafka
"""
data_topic = "TEST_forwarderData_floatarray_pv_update"
pvs = [PVFLOATARRAY]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(5)
cons = create_consumer()
# Wait for PV to be updated
cons.subscribe([data_topic])
sleep(5)
first_msg, _ = poll_for_valid_message(cons)
expectedarray = [1.1, 2.2, 3.3]
check_expected_array_values(first_msg, Value.ArrayFloat, PVFLOATARRAY,
expectedarray)
cons.close()
def test_connection_status_messages(docker_compose_no_command):
"""
GIVEN PV is configured to be forwarded
WHEN Connection status changes
THEN Forwarder publishes ep00 message with connection status
NOTE: Enums are converted to Ints in the forwarder.
"""
data_topic = "TEST_forwarderData_connection_status"
pvs = [PVENUM]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
# Wait for config to be pushed
sleep(5)
cons = create_consumer()
# Update value
change_pv_value(PVENUM, "START")
# Wait for PV to be updated
sleep(5)
cons.subscribe([data_topic])
first_msg = poll_for_connection_status_message(cons)
check_expected_connection_status_values(first_msg, EventType.CONNECTED)
cons.close()
def test_forwarder_updates_pv_when_config_change_add_two_pvs(
docker_compose_no_command):
"""
GIVEN A PV (double type) is already being forwarded
WHEN A message configures two additional PV (str and long types) to be forwarded
THEN Forwarder publishes initial values for added PVs
"""
data_topic = "TEST_forwarderData_change_config"
pvs = [PVSTR, PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
sleep(2)
cons = create_consumer()
sleep(2)
cons.subscribe([data_topic])
sleep(2)
poll_for_valid_message(cons)
poll_for_valid_message(cons)
expected_values = {PVSTR: (Value.String, b""), PVLONG: (Value.Int, 0)}
messages = [
poll_for_valid_message(cons)[0],
poll_for_valid_message(cons)[0]
]
check_multiple_expected_values(messages, expected_values)
cons.close()
def test_forwarder_updates_multiple_pvs(docker_compose_no_command):
"""
GIVEN multiple PVs (string and long types) are configured to be forwarded
WHEN PV value is updated
THEN Forwarder publishes the updates to Kafka
"""
data_topic = "TEST_forwarderData_multiple"
pvs = [PVSTR, PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
sleep(2)
cons = create_consumer()
sleep(2)
cons.subscribe([data_topic])
sleep(4)
expected_values = {PVSTR: (Value.String, b""), PVLONG: (Value.Int, 0)}
first_msg, _ = poll_for_valid_message(cons)
second_msg, _ = poll_for_valid_message(cons)
messages = [first_msg, second_msg]
check_multiple_expected_values(messages, expected_values)
cons.close()
def test_forwarder_status_shows_added_pvs(docker_compose_no_command):
"""
GIVEN A PV (double type) is already being forwarded
WHEN A message configures two additional PV (str and long types) to be forwarded
THEN Forwarder status message lists new PVs
"""
data_topic = "TEST_forwarderData_change_config"
status_topic = "TEST_forwarderStatus"
pvs = [PVSTR, PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
sleep(5)
cons = create_consumer()
sleep(2)
cons.assign([TopicPartition(status_topic, partition=0)])
sleep(2)
# Get the last available status message
partitions = cons.assignment()
_, hi = cons.get_watermark_offsets(partitions[0],
cached=False,
timeout=2.0)
last_msg_offset = hi - 1
cons.assign(
[TopicPartition(status_topic, partition=0, offset=last_msg_offset)])
status_msg, _ = poll_for_valid_message(cons, expected_file_identifier=None)
status_json = json.loads(status_msg)
names_of_channels_being_forwarded = {
stream["channel_name"]
for stream in status_json["streams"]
}
expected_names_of_channels_being_forwarded = {PVSTR, PVLONG}
assert (
expected_names_of_channels_being_forwarded ==
names_of_channels_being_forwarded
), (f"Expect these channels to be configured as forwarded: {expected_names_of_channels_being_forwarded}, "
f"but status message report these as forwarded: {names_of_channels_being_forwarded}"
)
cons.close()
def test_forwarder_updates_pv_when_config_changed_from_one_pv(docker_compose):
data_topic = "TEST_forwarderData_change_config"
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config([PVLONG])
prod.add_config([PVDOUBLE])
sleep(2)
cons = create_consumer()
sleep(2)
cons.subscribe([data_topic])
sleep(2)
expected_values = {PVLONG: (Value.Int, 0), PVDOUBLE: (Value.Double, 0.0)}
first_msg = poll_for_valid_message(cons)
second_msg = poll_for_valid_message(cons)
messages = [first_msg, second_msg]
check_multiple_expected_values(messages, expected_values)
cons.close()
def test_forwarder_updates_multiple_pvs(docker_compose):
data_topic = "TEST_forwarderData_multiple"
pvs = [PVSTR, PVLONG]
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, data_topic)
prod.add_config(pvs)
sleep(2)
cons = create_consumer()
sleep(2)
cons.subscribe([data_topic])
sleep(4)
expected_values = {PVSTR: (Value.String, b''), PVLONG: (Value.Int, 0)}
first_msg = poll_for_valid_message(cons)
second_msg = poll_for_valid_message(cons)
messages = [first_msg, second_msg]
check_multiple_expected_values(messages, expected_values)
cons.close()
def teardown_function(function):
"""
Stops forwarder pv listening and resets any values in EPICS
"""
print("Resetting PVs", flush=True)
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, "")
prod.stop_all_pvs()
defaults = {
PVDOUBLE: 0.0,
# We have to use this as the second parameter for caput gets parsed as empty so does not change the value of
# the PV
PVSTR: '""',
PVLONG: 0,
PVENUM: "INIT",
}
for key, value in defaults.items():
change_pv_value(key, value)
change_array_pv_value(PVFLOATARRAY, "3 1.1 2.2 3.3")
sleep(3)
def teardown_function(function):
"""
Stops forwarder pv listening and resets any values in EPICS
:param docker_compose: test fixture to apply to
:return:
"""
print("Resetting PVs", flush=True)
prod = ProducerWrapper("localhost:9092", CONFIG_TOPIC, "")
prod.stop_all_pvs()
defaults = {
PVDOUBLE: 0.0,
# We have to use this as the second parameter for caput gets parsed as empty so does not change the value of
# the PV
PVSTR: "\"\"",
PVLONG: 0,
PVENUM: "INIT"
}
for key, value in defaults.items():
change_pv_value(key, value)
sleep(3)