From 3a924e7d426db2e7e63af9475b294f05b65c3dd0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Wojtek=20Cicho=C5=84?= Date: Tue, 1 Dec 2020 10:21:47 +0100 Subject: [PATCH] [EGD-4576] doc: linked to integration tests article (#1111) Add references to Test harness README article Added references to Test harness README in two places: - Documentation table of contents - Development workflow article --- doc/README.md | 1 + doc/development_workflow.md | 2 ++ test/README.md | 6 ++++-- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/doc/README.md b/doc/README.md index 61739f3e7bd941b09a924992f4f021cfcd53d34d..ee67072ccd95e2e98229078191f95ba17ba569a0 100644 --- a/doc/README.md +++ b/doc/README.md @@ -33,6 +33,7 @@ firefox build/doc/html/index.html - [Super dirty quickstart on the phone](quickstart.md#super-dirty-quickstart-on-the-phone) - [Preparing packages](quickstart.md#preparing-packages) - [Setting up integrated development environment](setup_ide.md) +- [Testing framework](../test/README.md) - [Running MuditaOS on a phone](running_on_phone.md) - [GUI](../module-gui/README.md) - [Keybindings on Linux](host_keyboard_bindings.md) diff --git a/doc/development_workflow.md b/doc/development_workflow.md index c3fa6446ba573acce51aef3be815300069185da1..8dcb9f276b24a3f1026ee7e319bfaad5c90dba38 100644 --- a/doc/development_workflow.md +++ b/doc/development_workflow.md @@ -48,6 +48,8 @@ Before submitting a Pull Request please go through some basic checks: - run unit tests (`make check`), - check if your code formatting complies with [`.clang-format`](../clang-format). +As a part of our continuous integration proccess we will be soon introducing our own [test harness](../test/README.md). + ## Submit a Pull Request Submit a Pull Request. You can add labels that will help people who know the part of the code you are modifying in spotting the changes you are submitting and do a code review. diff --git a/test/README.md b/test/README.md index f62682ae8b97344d9f231e25d2d1b5c4c7310dd8..f384fe7b67894c83c241273488d22bede0cde9b7 100644 --- a/test/README.md +++ b/test/README.md @@ -1,6 +1,8 @@ -# Test framework +# Test harness -Test harness makes use of USB-CDC serial (on RT1051 target) or pseudo-tty (on Linux) to communicate +The aim of this [test harness](https://en.wikipedia.org/wiki/Test_harness) is to enable tests automation and facilitate integration testing. + +Mudita Pure test harness makes use of USB-CDC serial (on RT1051 target) or pseudo-tty (on Linux) to communicate with `service-desktop` service in the operating system and get data from the internal database and device status. Both `service-desktop` and functional tests are using [`pyTest`](https://github.com/pytest-dev/pytest/) -