Skip to content

5.6 update tools links #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/contributing/target/ticker.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ At this point, we should be able to compile a handful of tests:

``mbed test -m BOARD_NAME --compile -t <toolchain>``

To execute the tests, you need to support <a href="https://github.com/armmbed/mbed-ls" target="_blank">`mbed-ls`</a>.
To execute the tests, you need to support <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls" target="_blank">`mbed-ls`</a>.
8 changes: 3 additions & 5 deletions docs/reference/contributing/tools/mbedls.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,12 @@ Mbed-ls needs the following information to correctly detect an Mbed Enabled boar

- A four-digit hexadecimal identifier of a board class.
- A vendor string for detection on Windows.

Further, Mbed-ls only detects devices that meet the following criteria:

- Devices have a mass storage device (MSD) endpoint.
- The MSD endpoint has a FAT file system.

### Implementation

When adding a board to Mbed-ls, you typically need to add a new definition to the platform database. Before you add your board to the Mbed-ls platform database, you need the Unique product code, a four-digit hexadecimal identifier, you obtained through the mbed enabled program. You can add a new board to the platform database by adding an entry mapping from your board's unique product code to the name of the board into the `DEFAULT_PLATFORM_DB` dictionary in <a href="https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/platform_database.py" target="_blank">`mbed_lstools/platform_database.py`</a>.
### Implementation

If your board uses an interface firmware other than J-Link, STLink, DAPLink or OpenSDA, you need to add a new vendor string for detection on windows. If you need to add a new vendor string, add it to the `usb_vendor_list` member of the `MbedLsToolsBase` class in <a href="https://github.com/ARMmbed/mbed-ls/blob/master/mbed_lstools/lstools_base.py" target="_blank">`mbed_lstools/lstools_base.py`</a>.
Please see the [implementation guide](https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls#adding-platform-support) in Mbed LS for more details.
4 changes: 2 additions & 2 deletions docs/tools/testing/greentea.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ _**G**eneric **re**gression **en**vironment for **te**st **a**utomation_

Greentea is the automated testing tool for Arm Mbed OS development. It automates the process of flashing Mbed boards, driving the test and accumulating test results into test reports. Developers use it for local development as well as for automation in a Continuous Integration environment.

This document should help you start using Greentea. Please see the <a href="https://github.com/ARMmbed/htrun" target="_blank">`htrun` documentation</a>, the tool Greentea uses to drive tests, for the technical details of the interactions between the platform and the host machine.
This document should help you start using Greentea. Please see the <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-host-tests" target="_blank">`htrun` documentation</a>, the tool Greentea uses to drive tests, for the technical details of the interactions between the platform and the host machine.

### Prerequisites

Expand Down Expand Up @@ -570,7 +570,7 @@ $ mbedgt --use-tids 02400203C3423E603EBEC3D8,024002031E031E6AE3FFE3D2

Where `02400203C3423E603EBEC3D8` and `024002031E031E6AE3FFE3D` are the target IDs of platforms attached to your system.

You can view target IDs using the <a href="https://github.com/ARMmbed/mbed-ls" target="_blank">`mbed-ls`</a> tool (installed with Greentea).
You can view target IDs using the <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-ls" target="_blank">`mbed-ls`</a> tool (installed with Greentea).

```
$ mbedls
Expand Down
8 changes: 4 additions & 4 deletions docs/tools/testing/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ A test case is named from its position in your project's file structure. For ins

You can build tests through Arm Mbed CLI. For information on using Mbed CLI, please see the <a href="/docs/v5.6/tools/arm-mbed-cli.html" target="_blank">CLI documentation</a>.

When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a "test specification" file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the <a href="https://github.com/ARMmbed/greentea#test-specification-json-formatted-input" target="_blank">Greentea documentation here</a>.
When you build tests for a target and a toolchain, the script first discovers the available tests and then builds them in parallel. You can also create a "test specification" file, which our testing tools can use to run automated hardware tests. For more information on the test specification file, please see the <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-format" target="_blank">Greentea documentation here</a>.

##### Building process

Expand All @@ -71,9 +71,9 @@ If you need to test with multiple configurations, you can use the `--app-config`

You can run automated tests through Mbed CLI.

The testing process requires tests to be built and that a test specification JSON file exist that describes these available tests. See the <a href="https://github.com/ARMmbed/greentea#test-specification-json-formatted-input" target="_blank">test specification format</a>.
The testing process requires tests to be built and that a test specification JSON file exist that describes these available tests. See the <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea#test-specification-json-format" target="_blank">test specification format</a>.

The Greentea tool handles the actual testing process. To read more about this tool, please visit its <a href="https://github.com/ARMmbed/greentea" target="_blank">GitHub repository</a>.
The Greentea tool handles the actual testing process. To read more about this tool, please visit its <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea" target="_blank">GitHub repository</a>.

#### Writing tests

Expand Down Expand Up @@ -148,7 +148,7 @@ Assuming your test was exported correctly to your IDE, build the project, and lo

Bring the target out of reset, and run the program. Your target waits for the test tools to send a synchronizing character string over the serial port. Do not run the `mbed test` commands because that will attempt to flash the device, which you've already done with your IDE.

Instead, you can use the underlying test tools to drive the test. <a href="https://github.com/ARMmbed/htrun" target="_blank">`htrun`</a> is the tool you need to use in this case. Install the requirements for Mbed OS also installs `htrun`. You can also intall `htrun` by running `pip install mbed-host-tests`.
Instead, you can use the underlying test tools to drive the test. <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-host-tests" target="_blank">`htrun`</a> is the tool you need to use in this case. Install the requirements for Mbed OS also installs `htrun`. You can also intall `htrun` by running `pip install mbed-host-tests`.

First, find your target's serial port by running the following command:

Expand Down
2 changes: 1 addition & 1 deletion docs/tools/testing/utest.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ There are six handler types you can, but do not have to, override to customize o
1. `status_t case_teardown_handler_t(const Case *const source, const size_t passed, const size_t failed, const failure_t reason)`: called after execution of each test case and if testing is aborted.
1. `status_t case_failure_handler_t(const Case *const source, const failure_t reason)`: called whenever a failure occurs during the execution of a test case.

All handlers are defaulted for integration with the <a href="https://github.com/ARMmbed/greentea" target="_blank">Greentea testing automation framework</a>.
All handlers are defaulted for integration with the <a href="https://github.com/ARMmbed/mbed-os-tools/tree/master/packages/mbed-greentea" target="_blank">Greentea testing automation framework</a>.

### Test case handlers

Expand Down