Icetea added #659

OPpuolitaival · 2018-08-13T09:02:10Z

No description provided.

AnotherButler

I'm not yet finished editing these files, but I've left some comments for you to resolve. Please address these across all files.

AnotherButler · 2018-08-13T19:46:41Z

docs/tools/testing/testing_icetea.md

+
+You can run automated tests through Mbed CLI with the `--icetea` option. You can find more information about this in the [Mbed CLI test documentation] (/docs/tools/offline/cli-test-debug.md).
+
+The testing process requires tests to be built and that a test specification JSON file exist that describes these available tests. See the [test specification format](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).


Note: We try not to link to GitHub. Is there another link we can use, instead? Maybe Doxygen?

@jupe do you know another place to link?

for some specific greentea documentation? No idea

AnotherButler · 2018-08-13T19:47:06Z

docs/tools/testing/testing_icetea.md

+
+The test specification JSON is similar for the Greentea and Icetea tests.
+
+The Icetea tool handles the actual testing process. To read more about this tool, please visit its [GitHub repository](https://github.com/ARMmbed/icetea).


Note: We try not to link to GitHub. Is there another link we can use, instead? Maybe Doxygen?

At the moment we doesn't have any other place where icetea documentation are available. We can generate html documentation using Sphinx - all configurations are already in place - just need some place which could share them. Suggestions ?

The docs site can build Sphinx

AnotherButler · 2018-08-13T19:47:13Z

docs/tools/testing/testing_icetea.md

+
+##### Writing test cases
+
+For writing your own Python test scripts, you can read further information from [Icetea Test Case API](https://github.com/ARMmbed/icetea/blob/master/doc/tc_api.md).


Note: We try not to link to GitHub. Is there another link we can use, instead? Maybe Doxygen?

AnotherButler · 2018-08-13T19:47:19Z

docs/tools/testing/testing_icetea.md

+
+##### Writing CLI applications
+
+To be able to run the commands given to the DUT, you need to provide a CLI application that runs on the DUT. There is a library that you can use to create your own CLI application; it is called [mbed-client-cli](https://github.com/ARMmbed/mbed-client-cli). You can also find example Mbed CLI applications from the `mbed-os` repository TODO: Update before publishing [test applications](https://github.com/ARMmbed/mbed-os-icetea-integration/tree/feature-icetea/TEST_APPS/device).


Note: We try not to link to GitHub. Is there another link we can use, instead? Maybe Doxygen?

Please resolve this TODO.

I think that in this case github link is what we need. @jarlamsa do you know any other place to link?

No I do not. @jupe do you store generated docs of icetea somewhere else than github?

not at the moment. Maybe we should eventually.

AnotherButler · 2018-08-20T17:05:00Z

docs/tools/testing/icetea.md

+
+### Documentation
+
+You can build HTML documentation for Icetea using sphinx. The source for the documentation is located in [doc-source](https://github.com/ARMmbed/icetea/tree/master/doc-source). For installation of sphinx, please see the [installation instructions](#installation).


Is this right? None of our other tools build documentation like this.

I just don't understand why they need to build it. Why don't we publish it?

This file is copied from icetea repository. There is separated issue about reviewing it IOTDOCS-459

AnotherButler

Please address my comments before I continue reviewing.

AnotherButler · 2018-08-20T17:05:29Z

docs/tools/testing/icetea.md

+
+To debug DUT locally with [GDB](https://www.gnu.org/software/gdb/):
+
+**Note:** You have to install [GDB](https://www.gnu.org/software/gdb/) first (`apt-get install gdb`).


If this must happen first, we should mention it first.

AnotherButler · 2018-08-20T17:05:46Z

docs/tools/testing/icetea.md

+
+To analyze memory leaks with valgrind:
+
+**Note:** You have to install [valgrind](http://valgrind.org) first (`apt-get install valgrind`):


If this must happen first, we should mention it first.

AnotherButler · 2018-08-20T17:06:12Z

docs/tools/testing/icetea.md

+
+#### Dependencies
+
+Unit tests depend on mock, coverage and netifaces.


What are these? This is the only time we mention them.

Python modules required by unit tests of Icetea

@jonikula it is better to move this kind of information in some contribution guideline? I think that icetea unit testing is irrelevant for people who are just using it.

Perhaps. Something to discuss at least, for phase 2 of Icetea development. Not really a pressing issue now, I guess.

AnotherButler · 2018-08-20T17:06:51Z

docs/tools/testing/icetea.md

+
+### License
+
+See the [license](https://github.com/ARMmbed/icetea/blob/master/LICENSE) agreement.


Does this have a different license than the rest of our tools? Can we add its information to the contributing section with the rest of our licensing content?

AnotherButler · 2018-08-20T17:07:28Z

docs/tools/testing/icetea.md

+
+### Examples
+
+**Note:** The following examples use the [`dummyDut`](https://github.com/ARMmbed/icetea/blob/master/test/dut/dummyDut.c) application. It works in unix systems. To run the following examples, please compile `dummyDut` using Make:


Can we make this a proper example in teams instead of linking to GH?

AnotherButler · 2018-08-20T17:08:00Z

docs/tools/testing/icetea.md

+
+
+```
+dut[number]             #dut index (1..)


Could you please add more context to this code snippet? I'm not sure what it does.

They're args for the execute_command/command function.

AnotherButler · 2018-08-20T17:08:24Z

docs/tools/testing/icetea.md

+
+`icetea --help`
+
+All CLI parameters are described in [icetea.md](https://github.com/ARMmbed/icetea/blob/master/doc/Icetea.md)


We don't like to link to GH. Is there somewhere in the documentation we can link, instead?

bridadan

A few change requests, but otherwise looks good!

bridadan · 2018-08-27T20:39:21Z

docs/reference/contributing/connectivity/MeshInterface.md

-1. Verify the functionality of your implementation using the [Nanostack RF driver test application](https://github.com/ARMmbed/nanostack-rf-driver-tester). (This is currently only available to Mbed OS Partners.)
+1. Verify the functionality of your implementation by running the Nanostack RF driver testcase set in the Mbed OS repository:
+
+   `mbed test --clean --compile --run --icetea -t <toolchain> -m <platform> --test-config MAC_TESTER -n address_read_and_write,send_data,send_data_indirect,send_large_payloads,create_and_join_PAN,ED_scan`


nit: it'd be simpler to omit --compile --run since that is the default behavior.

bridadan · 2018-08-27T21:21:44Z

docs/tools/offline/cli-test-debug.md

@@ -2,6 +2,10 @@

 Use the `mbed test` command to compile and run tests.

+There are two testing frameworks, Greentea and Icetea. Greentea offers tests designed for driver porting and target verification.
+Icetea offers and manages tests that can contain multiple devices under test (DUTs) at the same time. In example you can test a network setup with a server and multiple


Seems like a funky new line here.

bridadan · 2018-08-27T21:24:07Z

docs/tools/offline/cli-test-debug.md

@@ -99,6 +145,12 @@ You can specify to only **build** the tests by using the `--compile` option:
 $ mbed test -m K64F -t GCC_ARM --compile
 ```

+In case of icetea the tests itself is not build but the tests requiring application is build


I would suggest the phrasing to be a bit simpler here: "In case of icetea, only the test applications are built:"

bridadan · 2018-08-27T21:27:59Z

docs/tools/testing/icetea.md

+
+# TODO:
+#    1. Finalize https://github.com/ARMmbed/icetea/blob/master/README.md
+#    2. Copy https://github.com/ARMmbed/icetea/blob/master/README.md here when ready


Does this need to be here?

bridadan · 2018-08-27T21:33:07Z

docs/tools/testing/testing_icetea.md

+
+##### Writing CLI applications
+
+To be able to run the commands given to the DUT, you need to provide a CLI application that runs on the DUT. There is a library that you can use to create your own CLI application; it is called [mbed-client-cli](https://github.com/ARMmbed/mbed-client-cli). You can also find example Mbed CLI applications from the `mbed-os` repository [test applications](https://github.com/ARMmbed/mbed-os/tree/master/TEST_APPS/device).


mbed-client-cli will now be present in Mbed OS. Perhaps we should link to that folder instead of the old repo?

The repository contains documentation for it. It is not included in the mbed-os.

I see, are there any plans to add that documentation to Mbed OS? Seems like it'd still be useful there.

I don't actually know. @jupe do you know about this better?

bridadan · 2018-08-27T21:36:24Z

docs/tools/testing/testing_icetea.md

+mbed export -i <IDE name>
+```
+
+You can find your exported project in `projectfiles/<IDE>_<target>`.


This isn't correct anymore. It should be removed from the greentea document as well, though that can be a separate change.

Should this be "You can find your exported project files in the same folder you ran the export command" or totally removed?

I would say "You can find your exported project in the root project directory." to match the patches I just pushed: #688

jen3andruska · 2018-08-28T12:31:24Z

docs/tools/offline/cli-test-debug.md

@@ -2,6 +2,8 @@

 Use the `mbed test` command to compile and run tests.

+There are two testing frameworks: Greentea and Icetea. Greentea provides tests designed for driver porting and target verification. Icetea provides and manages tests for multiple devices under the test (DUTs) at the same time. For example, you can test the network setup for a server and multiple clients, and simultaneously control them from the test environment.
+


What do you mean by 'devices under the test (DUTs)'? Is this just what devices that are currently being tested are called? The sentence is repetitive, so I would remove this or make a new sentence explaining this. So: "Icetea provides and manages tests for multiple devices at the same time. Devices being tested are referred to as devices under test (DUTs)."

DUT is acronym for device under test. I don't see the sentence being repetitive.

You're saying it's testing devices under test - that's repetitive. That's why I think it would help to break it into two sentence.

Ok, but the second sentence is similarly repetitive now, I don't see the point.

The point it to spread out how many times you're repeating 'testing' in the same sentence. If you want to explain the acronym DUTs it would be better in a separate sentence.

I agree with @jen3andruska. Also, the DUT acronym isn't used later in this document, so how about we just leave that out? So just shorten it to "Icetea provides and manages tests for multiple devices at the same time."

True, it is defined mostly because the icetea tool itself uses the acronym.

jen3andruska · 2018-08-28T12:36:01Z

docs/tools/offline/cli-test-debug.md

 The arguments to `test` are:
-* `-m <MCU>` to select a target for the compilation. If `detect` or `auto` parameter is passed, then Mbed CLI will attempt to detect the connected target and compile against it.
-* `-t <TOOLCHAIN>` to select a toolchain (of those defined in `mbed_settings.py`, see above), where `toolchain` can be either `ARM` (Arm Compiler 5), `GCC_ARM` (GNU Arm Embedded), or `IAR` (IAR Embedded Workbench for Arm).


Above where? I don't see anything above this talking about mbed_settings.py

jen3andruska · 2018-08-28T13:32:56Z

docs/tools/offline/cli-test-debug.md

@@ -79,6 +86,32 @@ Test Case:
    Path: .\TESTS\functional\test3
 ```

+And in case of icetea:


What do you mean by "in case of icetea"? Do you mean to 'to find the tests that are available' for it, as in the previous example?

melwee01 · 2018-08-28T13:34:24Z

I made a comment on the same section in my review, Jen, with a suggested change--would love to get your input once I actually submit it :)

jen3andruska · 2018-08-28T13:38:16Z

@MelindaWeed Sounds good, I'll take a look when you submit it ;)

jen3andruska · 2018-08-28T13:41:30Z

docs/tools/offline/cli-test-debug.md

@@ -91,6 +124,17 @@ mbedgt: available tests for built 'K64F-ARM', location '.\build\tests\K64F\ARM'
        test 'TESTS-functional-test3'
 ```

+In case of icetea:


Same ? as above: what do you mean by "in case of icetea"? Do you mean to 'to find the tests that are available' for it, as in the previous example?

melwee01 · 2018-08-28T13:30:15Z

docs/tools/offline/cli-test-debug.md

@@ -79,6 +86,32 @@ Test Case:
    Path: .\TESTS\functional\test3
 ```

+And in case of icetea:


"In case of" usually means "if _____ happens".

"In the case of" (without emphasis) would be more correct here. However, I'd just go with "For icetea:"

melwee01 · 2018-08-28T13:31:44Z

docs/tools/offline/cli-test-debug.md

@@ -99,6 +143,12 @@ You can specify to only **build** the tests by using the `--compile` option:
 $ mbed test -m K64F -t GCC_ARM --compile
 ```

+In case of icetea only the test applications are built


Please phrase sentences preceding code snippets so you can end them with :

For icetea, only the test applications are built:

your code here

melwee01 · 2018-08-28T13:33:02Z

docs/tools/offline/cli-test-debug.md

+    test 'TCPSERVER_ACCEPT'
+    test 'TCPSOCKET_ECHOTEST_BURST_SHORT'
+```
+
 ### Compiling and running tests

 You can specify to only **build** the tests by using the `--compile` option:


"by using" -> with

This is nitpicky, admittedly. "By using" isn't wrong, just a little wordy.

melwee01 · 2018-08-28T13:33:46Z

docs/tools/testing/icetea.md

@@ -0,0 +1,188 @@
+## Icetea test framework
+


What sort of line endings do you have here? They look like they're displaying a bit oddly.

melwee01 · 2018-08-28T13:35:25Z

docs/tools/testing/icetea.md

+automation in a Continuous Integration Environment.
+
+When testing [`Mbed OS`](https://www.mbed.com/en/platform/mbed-os/)
+Icetea allows you to execute commands remotely via


Don't use via; go for non-Latin terms like through, with, or using.

melwee01 · 2018-08-28T13:36:06Z

docs/tools/testing/icetea.md

+
+**Using metadata filters**
+
+To run all test cases with testtype regression in the metadata:


Put testtype in bunny ears since it's a parameter (or whatever the correct word is), so it doesn't look like a typo.

melwee01 · 2018-08-28T13:41:14Z

docs/tools/testing/icetea.md

+
+#### Optional
+
+* If you wish to decorate your console log with all kinds of colors,


"All kinds of" is a bit too informal.

I already changed this once, apparently some commit since reverted that.

melwee01 · 2018-08-28T13:41:45Z

docs/tools/testing/icetea.md

+#### Optional
+
+* If you wish to decorate your console log with all kinds of colors,
+install the coloredlogs module using pip. `pip install coloredlogs`


I'd recommend putting module names in `` but I'm not sure what our protocol is for that, or if we have one.

melwee01 · 2018-08-28T13:42:40Z

docs/tools/testing/icetea.md

+* If you wish to decorate your console log with all kinds of colors,
+install the coloredlogs module using pip. `pip install coloredlogs`
+    * There have been issues with coloredlogs installation on Windows.
+     We might switch to a different module at some point to enable


Don't make promises, especially if there's no set time for the solution.

melwee01 · 2018-08-28T13:43:28Z

docs/tools/testing/icetea.md

+
+`icetea --list --tcdir examples`
+
+To print Icetea version:


icetea has been lowercase in other places and is uppercase in this doc.

Of course, it's capitalized if it's the first word of the sentence, but how is it officially styled otherwise?

melwee01 · 2018-08-28T13:44:43Z

I've put some of my comments through but am not done quite yet.

melwee01 · 2018-08-28T13:44:54Z

Might not be able to finish before I have to leave for the day.

melwee01 · 2018-08-28T13:54:44Z

docs/tools/offline/cli-test-debug.md

-* `-vv` or `--very_verbose` for very verbose diagnostic output.
-
-Invoke `mbed test`:
+* `-m <MCU>`: to select a target for the compilation. If the `detect` or `auto` parameter is passed, then Mbed CLI will attempt to detect the connected target and compile against it.


I need to review these in Atom's Markdown preview to make sure these render as a list and not on a single line.

Atom is a different flavour of MD from our engine. As best practice we always add an empty line.

melwee01 · 2018-08-28T13:55:39Z

docs/tools/testing/icetea.md

+It automates the process of flashing Mbed boards, running tests
+and accumulating test results into reports.
+Developers use it for local development as well as for
+automation in a Continuous Integration Environment.


as well as automation -- you can leave out "for"

melwee01 · 2018-08-28T13:56:08Z

docs/tools/testing/icetea.md

+
+When testing [`Mbed OS`](https://www.mbed.com/en/platform/mbed-os/)
+Icetea allows you to execute commands remotely via
+the command line interface (`CLI`) in a device under test (`DUT`).


I don't think these terms need to be in bunny ears ``

melwee01 · 2018-08-28T13:58:11Z

docs/tools/testing/icetea.md

+* Linux
+    * python-dev and python-lxml
+        `sudo apt-get install python-dev python-lxml`
+    * In order to run test cases with hardware in Linux without sudo rights:


Sudo rights is jargony.

melwee01 · 2018-08-28T13:58:48Z

docs/tools/testing/icetea.md

+        `STATIC_DEPS=true sudo pip install lxml`
+
+* Windows
+    * python-lxml installation is problematic on Windows since


Capitalize Python unless it's the name of a module, in which case I'd put it in ``

melwee01 · 2018-08-28T13:59:00Z

docs/tools/testing/icetea.md

+install the coloredlogs module using pip. `pip install coloredlogs`
+    * There have been issues with coloredlogs installation on Windows.
+     We might switch to a different module at some point to enable
+     colored logging on Windows as well.


color-coded

melwee01 · 2018-08-28T14:01:02Z

docs/tools/testing/icetea.md

+
+### Installation
+
+`> pip install icetea`


Have you pointed out already that you need pip installed?

I already changed this once, apparently some commit since then reverted that.

jen3andruska · 2018-08-28T14:02:32Z

docs/tools/offline/cli-test-debug.md

@@ -99,6 +143,12 @@ You can specify to only **build** the tests by using the `--compile` option:
 $ mbed test -m K64F -t GCC_ARM --compile
 ```

+In case of icetea only the test applications are built


Again, what do you mean by "In case of Icetea..."? If you mean regarding or concerning Icetea, then you need 'the':" in [the] case of... ", but this is still not the best way to say this. "In case" is only use without 'the' when saying something like "In case you were wondering..." (it's followed by a noun/subject).
So, are you saying that: 1) if you use the same compile option as above, only the test applications will build in Icetea? Or, 2) If they want to specify that only the test applications build in Icetea, then they should use the following command? (Is this elaborating on the previous command, or is it its own separate instruction).

There are 2 distinct tools, greentea and icetea. Greentea is used by default and to run some commands for icetea you need to use some command line arguments for that.

melwee01 · 2018-08-28T14:02:42Z

docs/tools/testing/icetea.md

+
+### Usage
+
+To print the help page:


I'd say display instead of print, even though "print" is the codeish for that functionality.

I already changed this once, apparently some commit since then reverted that.

I changed it again for you. Hopefully that commit will stick.

melwee01 · 2018-08-28T14:04:06Z

docs/tools/testing/icetea.md

+
+**Running an example test case with hardware**
+
+In this example, we assume that a compatible board has been connected


passive -> active, please

"We assume you have connected a compatible board..."

I already changed this once, apparently some commit since then reverted that.

That's weird. I changed it again, so hopefully that commit will stick.

Btw, are you both editing directly on github or do you have a local copy on your PC?

bridadan · 2018-08-28T14:44:04Z

I'm happy to go through this again when all of the updates are completed. Would you mind mentioning me in a comment if you'd like me to review this again?

AnotherButler · 2018-08-28T21:13:40Z

FYI @MarceloSalazar @ashok-rao

jen3andruska · 2018-08-29T09:36:10Z

docs/tools/testing/icetea.md

+
+#### Typical use
+
+All of the commands described below might also need other options,


"Options" is the wrong word here and sounds awkward (commands don't have options). When you say "other options," do you mean other adjustments, commands, compilations...? I think we need a better word here.

jen3andruska · 2018-08-29T09:43:49Z

docs/tools/testing/icetea.md

+
+**Running a pre-made suite**
+
+Icetea supports a suite-file that describes a number of test cases


A "suite-file that describes a suite..." is very repetitive, so I changed the second 'suite' to 'number.'

jen3andruska · 2018-08-29T09:51:22Z

docs/tools/testing/icetea.md

+
+**Further details**
+
+For further details on any of these features, see our documentation.


This should include a link to our documentation, so: "...see our [documentation](link to our documentation).

There used to be a link here. I was told to remove it since the link is already at the top of the file.

Who said to remove it? Whenever we say "see our documentation," we always link. Unless...is this the documentation (this page)? Or was it linking to another page?

@peknis01 . I can add the links if needed.

Copy edit file, mostly for formatting.

Copy edit file, mostly for consistent branding and formatting.

Make remaining requested changes from comments.

Make requested changes, and make a few other copy edits.

OPpuolitaival · 2018-09-04T09:13:28Z

Rebased and I made quick look and looks good. Did not have time to read fully now

AnotherButler · 2018-09-04T11:21:40Z

@OPpuolitaival Thanks. I'll merge for OOB. If you see anything that needs tweaking, please let me know or put up a PR.

AnotherButler suggested changes Aug 13, 2018

View reviewed changes

AnotherButler reviewed Aug 20, 2018

View reviewed changes

AnotherButler suggested changes Aug 20, 2018

View reviewed changes

AnotherButler requested a review from iriark01 August 22, 2018 15:20

0xc0170 mentioned this pull request Aug 24, 2018

Icetea support ARMmbed/mbed-os#7745

Merged

bridadan suggested changes Aug 27, 2018

View reviewed changes

jen3andruska reviewed Aug 28, 2018

View reviewed changes

melwee01 suggested changes Aug 28, 2018

View reviewed changes

melwee01 reviewed Aug 28, 2018

View reviewed changes

jen3andruska reviewed Aug 28, 2018

View reviewed changes

melwee01 reviewed Aug 28, 2018

View reviewed changes

jen3andruska reviewed Aug 29, 2018

View reviewed changes

jen3andruska and others added 24 commits September 4, 2018 09:56

Update icetea.md

622ff0f

Update icetea.md

ff04613

Update icetea.md

46897ac

Update icetea.md

881ccbd

Update icetea.md

f2b6db3

update cli-test-debug.md

59a858f

Update testing_icetea.md

95a9aac

Updated Icetea.md

8d1b6a3

Update testing_greentea.md

ef3e502

Update testing_greentea.md

03b9602

Update testing_greentea.md

f329c00

Update testing_greentea.md

60908f4

Update testing_greentea.md

5f59df6

Update testing_greentea.md

8c973fa

Update testing_greentea.md

d7ebf45

Update testing_greentea.md

e0d4907

Update testing_greentea.md

90ef9e3

Update testing_greentea.md

0e826d8

Update testing_icetea.md

2c47f44

Update testing_icetea.md

12bf038

Copy edit icetea.md

e05475e

Copy edit file, mostly for formatting.

Copy edit cli-test-debug.md

8411229

Copy edit file, mostly for consistent branding and formatting.

Make changes from comments in icetea.md

f2a2532

Make remaining requested changes from comments.

Make changes from comments to cli-test-debug.md

2bc593c

Make requested changes, and make a few other copy edits.

OPpuolitaival force-pushed the icetea branch from e535e38 to 2bc593c Compare September 4, 2018 08:56

AnotherButler added the 5.10 urgent label Sep 4, 2018

AnotherButler merged commit a20f16e into ARMmbed:development Sep 4, 2018

bridadan mentioned this pull request Sep 6, 2018

[5.10 OOB] Cellular porting fixes #712

Merged


		You can run automated tests through Mbed CLI with the `--icetea` option. You can find more information about this in the [Mbed CLI test documentation] (/docs/tools/offline/cli-test-debug.md).

		The testing process requires tests to be built and that a test specification JSON file exist that describes these available tests. See the [test specification format](https://github.com/ARMmbed/greentea#test-specification-json-formatted-input).


		The test specification JSON is similar for the Greentea and Icetea tests.

		The Icetea tool handles the actual testing process. To read more about this tool, please visit its [GitHub repository](https://github.com/ARMmbed/icetea).


		##### Writing test cases

		For writing your own Python test scripts, you can read further information from [Icetea Test Case API](https://github.com/ARMmbed/icetea/blob/master/doc/tc_api.md).


		##### Writing CLI applications

		To be able to run the commands given to the DUT, you need to provide a CLI application that runs on the DUT. There is a library that you can use to create your own CLI application; it is called [mbed-client-cli](https://github.com/ARMmbed/mbed-client-cli). You can also find example Mbed CLI applications from the `mbed-os` repository TODO: Update before publishing [test applications](https://github.com/ARMmbed/mbed-os-icetea-integration/tree/feature-icetea/TEST_APPS/device).


		### Documentation

		You can build HTML documentation for Icetea using sphinx. The source for the documentation is located in [doc-source](https://github.com/ARMmbed/icetea/tree/master/doc-source). For installation of sphinx, please see the [installation instructions](#installation).


		To debug DUT locally with [GDB](https://www.gnu.org/software/gdb/):

		Note: You have to install [GDB](https://www.gnu.org/software/gdb/) first (`apt-get install gdb`).


		To analyze memory leaks with valgrind:

		Note: You have to install [valgrind](http://valgrind.org) first (`apt-get install valgrind`):


		#### Dependencies

		Unit tests depend on mock, coverage and netifaces.


		### License

		See the [license](https://github.com/ARMmbed/icetea/blob/master/LICENSE) agreement.


		### Examples

		Note: The following examples use the [`dummyDut`](https://github.com/ARMmbed/icetea/blob/master/test/dut/dummyDut.c) application. It works in unix systems. To run the following examples, please compile `dummyDut` using Make:


		`icetea --help`

		All CLI parameters are described in [icetea.md](https://github.com/ARMmbed/icetea/blob/master/doc/Icetea.md)

		@@ -2,6 +2,8 @@

		Use the `mbed test` command to compile and run tests.

		There are two testing frameworks: Greentea and Icetea. Greentea provides tests designed for driver porting and target verification. Icetea provides and manages tests for multiple devices under the test (DUTs) at the same time. For example, you can test the network setup for a server and multiple clients, and simultaneously control them from the test environment.


		Using metadata filters

		To run all test cases with testtype regression in the metadata:


		#### Optional

		* If you wish to decorate your console log with all kinds of colors,


		Running an example test case with hardware

		In this example, we assume that a compatible board has been connected


		#### Typical use

		All of the commands described below might also need other options,


		Running a pre-made suite

		Icetea supports a suite-file that describes a number of test cases


		Further details

		For further details on any of these features, see our documentation.

Icetea added #659

Icetea added #659

Conversation

OPpuolitaival commented Aug 13, 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

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

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 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

jonikula Aug 24, 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

bridadan 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

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

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

Choose a reason for hiding this comment

melwee01 commented Aug 28, 2018

jen3andruska commented Aug 28, 2018

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

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

melwee01 commented Aug 28, 2018

melwee01 commented Aug 28, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jonikula Aug 24, 2018 •

edited

Loading