Add tests for derived signal #850
Conversation
#846) * Add test that checks to make sure put completion works for PVA signals * Use pytest.approx for timing * Adjust tolerance * Even tighter tolerance * Parametrize put completion test by protocol, make put completion wait 0.5 seconds instead of 5
|
@coretl I think i got rid of all private imports, however I still have to get to certain methods addressing _methods in tests, I am not sure how to avoid it tbh. |
| def derived_signal_backend() -> SignalBackend[SignalDatatype]: | ||
| signal_r = soft_signal_rw(int, initial_value=4) | ||
|
|
||
| def _get(ts: int) -> float: | ||
| return ts | ||
|
|
||
| async def _put(value: float) -> None: | ||
| pass | ||
|
|
||
| derived = derived_signal_rw(_get, _put, ts=signal_r) | ||
| return derived._get_cache().backend |
There was a problem hiding this comment.
Continuing with the theme of testing the public interface, can we make this return the whole signal instead of the backend?
...
| async def test_derived_signal_backend_connect_pass( | ||
| derived_signal_backend: SignalBackend, | ||
| ): | ||
| result = await derived_signal_backend.connect(0.1) | ||
| assert result is None |
There was a problem hiding this comment.
Then this would be
| async def test_derived_signal_backend_connect_pass( | |
| derived_signal_backend: SignalBackend, | |
| ): | |
| result = await derived_signal_backend.connect(0.1) | |
| assert result is None | |
| async def test_derived_signal_backend_connect_pass( | |
| derived_signal: SignalRW, | |
| ): | |
| result = await derived_signal.connect() | |
| assert result is None |
| async def test_derived_signal_backend_put_wait_fails( | ||
| derived_signal_backend: SignalBackend, | ||
| ) -> None: | ||
| with pytest.raises(RuntimeError): | ||
| await derived_signal_backend.put(value=None, wait=False) |
There was a problem hiding this comment.
And this would be
| async def test_derived_signal_backend_put_wait_fails( | |
| derived_signal_backend: SignalBackend, | |
| ) -> None: | |
| with pytest.raises(RuntimeError): | |
| await derived_signal_backend.put(value=None, wait=False) | |
| async def test_derived_signal_backend_put_wait_fails( | |
| derived_signal: SignalRW, | |
| ) -> None: | |
| with pytest.raises(RuntimeError): | |
| await derived_signal.set(value=None, wait=False) |
| def test_derived_signal_backend_set_value( | ||
| derived_signal_backend: SignalBackend, | ||
| ) -> None: | ||
| with pytest.raises(RuntimeError): | ||
| derived_signal_backend.set_value(1.0) # type: ignore |
There was a problem hiding this comment.
This is a bit trickier to test, but still possible with the public interface
| def test_derived_signal_backend_set_value( | |
| derived_signal_backend: SignalBackend, | |
| ) -> None: | |
| with pytest.raises(RuntimeError): | |
| derived_signal_backend.set_value(1.0) # type: ignore | |
| def test_derived_signal_backend_set_value( | |
| derived_signal: SignalRW, | |
| ) -> None: | |
| await derived_signal.connect(mock=True) | |
| with pytest.raises(RuntimeError): | |
| set_mock_value(derived_signal, 1.0) |
| ValueError, | ||
| match=re.escape("Must define a set_derived method to support derived"), | ||
| ): | ||
| factory._make_signal(signal_cls=SignalRW, datatype=Table, name="") |
There was a problem hiding this comment.
Public interface is
| factory._make_signal(signal_cls=SignalRW, datatype=Table, name="") | |
| factory.derived_signal_rw(datatype=Table, name="") |
There was a problem hiding this comment.
I think all of these are possible without using patch or MagicMock or referring to private members of the variable, but let me know if any of them are difficult and I'll have a think how...
There was a problem hiding this comment.
have to say am really struggling trying to find the way around using public interface without mock for e.g. ?
async def test_set_derived_not_initialized(derived_signal_backend: SignalBackend):
with patch.object(
derived_signal_backend.transformer, # type: ignore
"_set_derived",
None,
):
with pytest.raises(RuntimeError):
await derived_signal_backend.put("name", True)
any ideas on that one?
There was a problem hiding this comment.
Yeah, I don't think you can test that one with the public interface. Best I can do is:
async def test_set_derived_not_initialized():
def _get(ts: int) -> float:
return ts
sig = derived_signal_r(_get, ts=soft_signal_rw(int, initial_value=4))
with pytest.raises(
RuntimeError,
match="Cannot put as no set_derived method given",
):
await sig._connector.backend.put(1.0, True)If you've tried using the public interface and it's not possible then I'm happy with patches or private member variables
| return filter_by_type(self._raw_devices | self._transform_devices, Subscribable) | ||
| return validate_by_type( | ||
| self._raw_devices | self._transform_devices, Subscribable | ||
| ) # noqa: E501 |
There was a problem hiding this comment.
| ) # noqa: E501 | |
| ) |
Added tests to improve coverage for
_derived_signal_backendand_derived_signal.It looks like I shouldn't have done a rebase locally as now there are files from main branch which I didn't change but they have been merged already, sorry about it.