Icetea missing test doc #8342

JuhPuur · 2018-10-08T15:52:03Z

Description

Documented icetea testcases. Socket testcases do not differ from greentea testcases except in the way they're executed. Documentation was needed to present how the execution differs.

Added missing documentation for Nanostack MAC tester testcases and comments to testcases.

Pull request type

[x] Fix
[ ] Refactor
[ ] Target update
[ ] Functionality change
[ ] Breaking change

AnttiKauppila · 2018-10-09T05:30:44Z

This is documentation only change -> No CI needed

AnotherButler · 2018-10-09T21:51:38Z

@MelindaWeed Could you please edit the two README files?

melwee01

Many of these are nitpicky.

melwee01 · 2018-10-15T06:25:29Z

TEST_APPS/testcases/README.md

@@ -12,3 +12,4 @@ Current testcases:

 -   [netsocket](https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/testcases/netsocket)
 -   [example](https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/testcases/example)
+-   [nanostack_mac_tester](https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/testcases/nanostack_mac_tester)


Either capitalize these or put them in ``.

melwee01 · 2018-10-15T06:26:19Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

@@ -0,0 +1,294 @@
+Nanostack MAC RF tests


These should be ## headings, not separated out with =====.

melwee01 · 2018-10-15T06:49:13Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

+Nanostack MAC RF tests
+=============
+
+This folder contains nanostack MAC RF tests for Icetea


Check punctuation in file, because there are missing periods.

melwee01 · 2018-10-15T06:53:40Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

+The test located under this folder is dependent of the application [exampleapp](https://github.com/ARMmbed/mbed-os/blob/master/TEST_APPS/device/nanostack_mac_tester)
+The nanostack MAC tester is disabled by default, to be able to run the testcases with the application, either remove the preprocessor macro from main.cpp or add `-DICETEA_MAC_TESTER_ENABLED` to the mbed test command
+
+Icetea testcases are processed by passing commands through the mbed-client-cli command line. Thus testcase steps should be possible to replicate manually with the given commands and instructions.


mbed-client-cli

Clean up the wording here.

melwee01 · 2018-10-15T06:55:46Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

+
+**Description:**
+
+Write addresses to MAC interface, verify successful write.


What's MAC?

Media Access Control(MAC) address is a unique hardware identifier used in networking. MAC interface refers to the Data Link layer interface in Nanostack.
I feel that anybody who doesn't have a clue what it refers to has no business running these tests in the first place.

melwee01 · 2018-10-15T08:03:47Z

TEST_APPS/testcases/netsocket/README.md

-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)
+The test cases under this folder are similar to [Network Socket test plan](https://github.com/ARMmbed/mbed-os/blob/master/TESTS/netsocket/README.md).
+
+Icetea testcases are processed by passing commands through the mbed-client-cli command line. Thus testcase steps should be possible to replicate manually with the given commands and instructions.


mbed-client-cli

melwee01 · 2018-10-15T08:04:15Z

TEST_APPS/testcases/netsocket/README.md

+
+**Preconditions:**
+
+1.  Network interface and stack are initialised


Again, end these with .

Initialized

melwee01 · 2018-10-15T08:05:57Z

TEST_APPS/testcases/netsocket/README.md

+
+**Expected result:**
+
+The test exits with status PASS without timeouts


melwee01 · 2018-10-15T08:17:54Z

TEST_APPS/testcases/netsocket/README.md

+
+**Preconditions:**
+
+1.  Network interface and stack are initialised


initialized

melwee01 · 2018-10-15T08:18:19Z

TEST_APPS/testcases/netsocket/README.md

+
+**Preconditions:**
+
+1.  Network interface and stack are initialised


Initialized

JuhPuur · 2018-10-16T13:30:20Z

I think I fixed all the points. Please re-review.

0xc0170 · 2018-10-24T12:45:17Z

@melwee01 Please review after the update

Comments addressed. Please re-review.

cmonr · 2018-11-09T22:26:41Z

@AnotherButler @melwee01 Re-review? Or are we good to bring this in asis?

AnotherButler

Please fix minor requests.

AnotherButler · 2018-11-14T01:29:11Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

@@ -0,0 +1,298 @@
+##Nanostack MAC RF tests


Please add a space after the pound signs, or this won't render properly.

AnotherButler · 2018-11-14T01:29:30Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

+
+In test cases with more than one device under test(DUT) the target device is given in the instructions as DUT1, DUT2 or DUT3.
+
+##Test cases


Please add a space after the pound signs, or this won't render properly.

AnotherButler · 2018-11-14T01:36:00Z

TEST_APPS/testcases/nanostack_mac_tester/README.md

+
+Icetea test cases are processed by passing commands through the `mbed-client-cli` command line. It is possible to manually replicate most test cases by following the instructions below.
+
+In test cases with more than one device under test(DUT) the target device is given in the instructions as DUT1, DUT2 or DUT3.


Parenthetical expressions require a space on either side of them. Please do a global search of this document to make sure there's a space before the opening parenthesis each time.

AnotherButler · 2018-11-14T15:28:37Z

It looks as though @melwee01 's concerns have been addressed.

adbridge · 2018-11-14T15:41:08Z

@JuhPuur Please address @AnotherButler review comments

JuhPuur · 2018-11-16T08:32:38Z

Comments addressed. I didn't add spaces to parentheses indicating method/function names.

cmonr · 2018-11-16T15:56:31Z

@AnotherButler All good?

0xc0170 · 2018-11-22T10:40:33Z

@OPpuolitaival Please review why exporters are running for this .md changes

mbed-ci · 2018-11-22T11:26:25Z

Test run: SUCCESS

Summary: 3 of 3 test jobs passed
Build number : 5
Build artifacts
Build logs

cmonr requested review from SeppoTakalo and a team October 8, 2018 19:05

cmonr added the needs: review label Oct 8, 2018

cmonr requested a review from AnotherButler October 8, 2018 19:06

AnttiKauppila approved these changes Oct 9, 2018

View reviewed changes

SeppoTakalo approved these changes Oct 9, 2018

View reviewed changes

OPpuolitaival approved these changes Oct 9, 2018

View reviewed changes

AnotherButler requested a review from melwee01 October 9, 2018 21:51

melwee01 previously requested changes Oct 15, 2018

View reviewed changes

0xc0170 added needs: work and removed needs: review labels Oct 15, 2018

Juhani Puurula added 2 commits October 16, 2018 16:29

Added documentation for icetea testcases

a513751

Nanostack mac tester: document testcase steps in testcases

3732f72

0xc0170 added needs: review and removed needs: work labels Oct 24, 2018

cmonr added rollup PR release-version: 5.10.3 and removed rollup PR labels Oct 25, 2018

cmonr added release-version: 5.10.4 and removed release-version: 5.10.3 labels Nov 1, 2018

AnotherButler suggested changes Nov 14, 2018

View reviewed changes

Icetea test documentation: added spaces

93e90f7

adbridge added needs: work and removed needs: review labels Nov 14, 2018

cmonr removed the release-version: 5.10.4 label Nov 15, 2018

AnotherButler approved these changes Nov 16, 2018

View reviewed changes

0xc0170 added needs: CI and removed needs: work labels Nov 22, 2018

0xc0170 added ready for merge release-version: 5.11.0-rc1 and removed needs: CI labels Nov 22, 2018

0xc0170 merged commit 30520c9 into ARMmbed:master Nov 22, 2018

0xc0170 removed the ready for merge label Nov 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Icetea missing test doc #8342

Icetea missing test doc #8342

JuhPuur commented Oct 8, 2018

AnttiKauppila commented Oct 9, 2018

AnotherButler commented Oct 9, 2018

melwee01 left a comment

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

JuhPuur Oct 16, 2018 •

edited

Loading

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

melwee01 Oct 15, 2018

JuhPuur commented Oct 16, 2018

0xc0170 commented Oct 24, 2018

cmonr commented Nov 9, 2018

AnotherButler left a comment

AnotherButler Nov 14, 2018

AnotherButler Nov 14, 2018

AnotherButler Nov 14, 2018

AnotherButler commented Nov 14, 2018

adbridge commented Nov 14, 2018

JuhPuur commented Nov 16, 2018

cmonr commented Nov 16, 2018

0xc0170 commented Nov 22, 2018

mbed-ci commented Nov 22, 2018


		Description:

		Write addresses to MAC interface, verify successful write.


		Preconditions:

		1. Network interface and stack are initialised


		Expected result:

		The test exits with status PASS without timeouts


		In test cases with more than one device under test(DUT) the target device is given in the instructions as DUT1, DUT2 or DUT3.

		##Test cases


		Icetea test cases are processed by passing commands through the `mbed-client-cli` command line. It is possible to manually replicate most test cases by following the instructions below.

		In test cases with more than one device under test(DUT) the target device is given in the instructions as DUT1, DUT2 or DUT3.

Icetea missing test doc #8342

Icetea missing test doc #8342

Conversation

JuhPuur commented Oct 8, 2018

Description

Pull request type

AnttiKauppila commented Oct 9, 2018

AnotherButler commented Oct 9, 2018

melwee01 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JuhPuur Oct 16, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JuhPuur commented Oct 16, 2018

0xc0170 commented Oct 24, 2018

cmonr commented Nov 9, 2018

AnotherButler left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AnotherButler commented Nov 14, 2018

adbridge commented Nov 14, 2018

JuhPuur commented Nov 16, 2018

cmonr commented Nov 16, 2018

0xc0170 commented Nov 22, 2018

mbed-ci commented Nov 22, 2018

JuhPuur Oct 16, 2018 •

edited

Loading