Add shell management #4
Conversation
|
@petrovichkr Hi, thanks so much for this contribution! I have been slow to add docs here and now it is slowing you down 😢 To lint: Or run without the envr alias: |
There was a problem hiding this comment.
Great! I will create a ticket to improve the _do_test function. Now that I'm looking at my own _do_test code again it looks too "magic" to me and I want it to be easier for contributors. I'd love your advice!
In order to test these with a device, I'll bump smpclient and smpmgr to implement the shell management group that you've added. Very useful (and dangerous), especially over BLE!
tests/test_shell_management.py
Outdated
| def test_ExecuteRequest() -> None: | ||
| _do_test( | ||
| smpshell.ExecuteRequest, | ||
| smphdr.OP.WRITE, | ||
| shellcmd.EXECUTE, | ||
| {"argv": ["echo", "Hello"]}, | ||
| ) |
There was a problem hiding this comment.
Let's update to:
def test_ExecuteRequest() -> None:
r = _do_test(
smpshell.ExecuteRequest,
smphdr.OP.WRITE,
shellcmd.EXECUTE,
{"argv": ["echo", "Hello"]},
)
assert r.argv == ["echo", "Hello"]so that anyone looking at the tests can see usage a bit more clearly.
That _do_test function I made looks confusing and I'll create an issue to make it better and prevent us from copying it for every group of tests.
tests/test_shell_management.py
Outdated
| def test_ExecuteResponse() -> None: | ||
| _do_test( | ||
| smpshell.ExecuteResponse, | ||
| smphdr.OP.WRITE_RSP, | ||
| shellcmd.EXECUTE, | ||
| {"o": "Hello", "ret": 0}, | ||
| ) |
There was a problem hiding this comment.
Same idea:
def test_ExecuteResponse() -> None:
r = _do_test(
smpshell.ExecuteResponse,
smphdr.OP.WRITE_RSP,
shellcmd.EXECUTE,
{"o": "Hello", "ret": 0},
)
assert r.o == "Hello"
assert r.ret == 0Signed-off-by: Petr Sharshavin <[email protected]>
Signed-off-by: Petr Sharshavin <[email protected]>
Done fixing lint issues. This is my first contribution to the Python project, so sorry too :) |
My test writing skills are about zero, so I'm a bad advisor :) I created these tests based on your test_os_management.
Overall these tools will be a good replacement for the existing newtmgr/mcumgr. BLE transport is much more stable and doesn't require root rights. I'm going to use the smpclient package to develop automation utilities for testing Zephyr based hardware over BLE. By the way, I've already implemented the shell group in smpclient. I can do PR to smpclient after the release of this project. |
That's the goal, but there's a lot of work and testing to be done! While there are still only a few people using these tools, breaking changes may be frequent to arrive at a consensus API. You can trust the semantic versioning and release notes to indicate these breaking changes. |
Add shell management group based on Zephyr Docs.