Add tests for ocs_agent.py #227
Conversation
There was a problem hiding this comment.
My one high-level comment is that I'm slightly uncomfortable testing for the exact text returned (e.g. assert res[1] == 'No task or process called "test_task"') since this text is sort of meant to just be helpful to a human and is not necessarily an unchanging part of the API.
Related, it is probably better to use the enums/constants in base rather for res[0] and res[2]['op_code']. One could argue that we want the enums to never change... but then that should be a separate test :)
| mock_agent.register_task('test_task', tfunc, startup=True) | ||
|
|
||
| print(mock_agent.startup_ops) | ||
| assert mock_agent.startup_ops == [('task', 'test_task', True)] |
There was a problem hiding this comment.
If you're bothering to test this, you should probably also test the cases of startup=False (should not add to startup_ops!) and startup={'arg1': 12}.
There was a problem hiding this comment.
Good point, added two tests for each register function. This also makes me realize that while startup should be a bool or dict there is nothing stopping one from passing say a list. This hasn't really been run into though, I'm not sure startup is used other than to pass a bool anywhere.
Yeah, I totally agree, great feedback as I figure out how to write good tests. I changed these to just check that Perfect, I also updated the op_code and response_code checks to be against those Enums. |
op_type isn't used, but startupops that are processes were being labeled as tasks.
checkdata, client_cli, and ocsbow are never imported during testing. These bare test files now do that, and provide a place for contributors to add tests in the future.
BrianJKoopman
force-pushed
the
test-ocs-agent
branch
from
6f5e846
to
a681dc2
Compare
|
Rebased. Will merge when checks finish. |
Description
This PR adds some tests for ocs_agent.py. Perhaps the most interesting part is the introduction of pytest-twisted, for testing methods with
@inlineCallbacks, like 'wait'.This doesn't cover everything in
ocs_agent.py, but is a good start. I focused on 'start', 'wait', 'stop', 'abort', and 'status'. Naturally that led to coveringregister_taskandregister_processas well.One thing I wasn't sure how to get to was this exception in 'wait':
ocs/ocs/ocs_agent.py
Line 672 in e9eb428
There's an attempted test ('test_wait_timeout_w_error'), but it doesn't hit that exception for some reason. Any insight on that would be appreciated.
I also add some very bare test files for modules within ocs that aren't currently imported at all by the tests, namely ocsbow, ocs-cli, and checkdata.
Motivation and Context
Related to #28. Also, I like to see the test coverage number meaningfully increase.
How Has This Been Tested?
I ran the tests, usually just
$ python3 -m pytest -m 'not integtest' --cov=ocs --cov-report=htmlTypes of changes
Checklist:
developbranch.