Add documentation about icetea testcases #8073
Conversation
|
@OPpuolitaival @SeppoTakalo @MarceloSalazar @0xc0170 please review |
| This folder contains netsocket tests for Icetea | ||
| The tests located under this folder are dependent of the application [socket_app](https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/device/socket_app) | ||
|
|
||
| The test cases under this folder are defined in [Network Socket test plan](https://github.com/ARMmbed/mbed-os/blob/master/TESTS/netsocket/README.md) |
There was a problem hiding this comment.
@SeppoTakalo , can you help us to review this please?
The "Network Socket test plan" does not have references to Icetea, so I don't see the relationship with doc.
There was a problem hiding this comment.
Originally it did not refer to any testing tool, but since then I have added instructions of how to build existing test cases.
Icetea release was pending, so I could not add reference to this.
However, testcases are exactly same, so this sentence here is correct.
Only the test plan needs updating, but that is ongoing maintaining work for us to keep it up to date.
There was a problem hiding this comment.
As a user, I still don't understand how to run the Icetea test cases with the network sockets.
@jarlamsa @SeppoTakalo can we add a line explaining how to run the test cases?
We have this today (greentea):
mbed test --compile -t <toolchain> -m <target> -n mbed-os-tests-network-*,mbed-os-tests-netsocket*
I assume this is the corresponding command to use icetea but I'm not 100% sure.
mbed test --compile -t <toolchain> -m <target> -n mbed-os-tests-network-*,mbed-os-tests-netsocket* --icetea
There was a problem hiding this comment.
There is already a readme about running the icetea tests in the root of TEST_APPS -folder
https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/readme.md
There was a problem hiding this comment.
Ok, that's good.
@SeppoTakalo , I assume every test case (mbed-os-tests-network-*,mbed-os-tests-netsocket*) can be used with Icetea. If that's the case, I'd be happy to close this item.
There was a problem hiding this comment.
Only test cases done with Icetea can be used with Icetea, those are located under TEST_APPS/testcases, test cases done with Greentea can be used with Greentea, those are located under TESTS. The test plan needs information about used test framework for each test.
There was a problem hiding this comment.
Yes.
Some testcases exist only in Greentea, some exist only in Icetea.
All testcases exist in the test plan, and the selection of tool is based on requirement of the testcase.
For demonstration purposes some testcases exist on both, so that the differences can be studied.
|
@jarlamsa thanks for the PR. It's looking good. |
Taking this as an equivalent of a review checkmark. /morph build |
Build : SUCCESSBuild number : 3054 Triggering tests/morph test |
Exporter Build : SUCCESSBuild number : 2669 |
jarlamsa
force-pushed
the
icetea_test_docs
branch
from
e9dea47
to
0e4ae40
Compare
|
Added information about the disabled exampleapp and how to enable it if wanted to. |
Test : SUCCESSBuild number : 2833 |
|
@jarlamsa @SeppoTakalo @MarceloSalazar Is this now good to go? As a reminder, CI results are invalidated if the commit hash changes. And we're aware of how silly it is to run CI on a docs-only PR, but that's what we do for now. |
|
I think it is, @MarceloSalazar @SeppoTakalo @OPpuolitaival do you have anything to add? |
|
@jarlamsa , all, |
Making sure, this superceedes #8065 correct? |
cmonr
added
release-version: 5.10.1
needs: CI
and removed
release-version: 5.10.0-rc3
needs: review
labels
|
/morph build |
Build : SUCCESSBuild number : 3125 Triggering tests/morph test |
Test : SUCCESSBuild number : 2926 |
Exporter Build : SUCCESSBuild number : 2733 |
Description
Add test case descriptions to mbed-os for Icetea tests.
These were asked here: #8065
Pull request type