BLE: Add cmake unittest fakes for BLE and events #14737

paul-szczepanek-arm · 2021-06-06T11:05:23Z

Summary of changes

This adds fakes for unittests for BLE and events. This requires a change in roles configurations for the roles to default to on so that unittests don't need to manually set the configs.

Impact of changes

Migration actions required

Documentation

none

Pull request type

[x] Patch update (Bug fix / Target update / Docs update / Test update / Refactor)
[] Feature update (New feature / Functionality change / New API)
[] Major update (Breaking change E.g. Return code change / API behaviour change)

Test results

[] No Tests required for this change (E.g docs only update)
[] Covered by existing mbed-os tests (Greentea or Unittest)
[x] Tests / results supplied as part of this PR

Reviewers

paul-szczepanek-arm · 2021-06-06T11:05:37Z

replaces: #14515

paul-szczepanek-arm · 2021-06-06T11:10:26Z

Used by ARMmbed/mbed-os-experimental-ble-services#61 to successfully run unittests, logs available here:
https://github.com/ARMmbed/mbed-os-experimental-ble-services/pull/61/checks?check_run_id=2756965842

ciarmcom · 2021-06-06T11:30:13Z

@paul-szczepanek-arm, thank you for your changes.
@ARMmbed/mbed-os-maintainers please review.

0xc0170

2 styling nits, otherwise looks good to me.

As these are first "fakes", is it worth adding Readme to fakes or everyone knows what is there and how it works? Just wondering as we haven't got these before in the tree.

0xc0170 · 2021-06-07T11:55:35Z

UNITTESTS/fakes/ble/BLE.cpp

+
+}
+
+}


new line missing

0xc0170 · 2021-06-07T11:56:10Z

UNITTESTS/fakes/ble/ble_mocks.h

+
+}
+
+#endif // BLE_MOCKS_H


same here, new line

Pull request has been modified.

paul-szczepanek-arm · 2021-06-07T15:45:42Z

Added newlines and a readme.

0xc0170 · 2021-06-09T10:40:29Z

UNITTESTS/README.md

+
+All the libraries available are in the `CMakeLists.txt` files in `mbed-os/UNITTESTS/stubs` and `mbed-os/UNITTESTS/fakes`.
+
+The most common ones you might need are `mbed-os-fakes-ble` and `mbed-os-fakes-event-queue`.


Suggested change

The most common ones you might need are `mbed-os-fakes-ble` and `mbed-os-fakes-event-queue`.

Shall we just remove this, I would add just that libraries are prefixed with mbed-os-fakes in the next section.

0xc0170 · 2021-06-09T10:40:56Z

UNITTESTS/README.md

+
+### Fakes
+
+While stubs are self explanatory and don't offer anything beyond empty implementations, fakes allow for more complex unittests that can simulate whole subsystems.


Add a note, fakes library should be prefixed with mbed-os-fakes.

UNITTESTS/fakes/events/events/EventQueue.h

chrisswinchatt-arm · 2021-06-10T10:12:33Z

UNITTESTS/fakes/ble/ble_mocks.h

+#include "SecurityManagerImpl_mock.h"
+
+/***
+ * You must use delete_mocks() at the end of the test. BLE::Instance(), ble::gap() etc. inits the mocks. Do not cache


Can the mocks be deleted automatically with RAII (or something else)?

No. Due to how BLE instantiation is done which the mocks replace.

Co-authored-by: Chris Swinchatt <[email protected]>

rajkan01 · 2021-06-10T16:34:14Z

UNITTESTS/README.md

@@ -0,0 +1,65 @@
+## Stubs, mocks and fakes in Mbed OS


Better we move this readme content into our official documentation https://github.com/ARMmbed/mbed-os-5-docs/blob/development/docs/debugging-testing/testing/unit_testing.md page

Note:
Already this PR ARMmbed/mbed-os-5-docs#1427 for updating unit testing content based on new unittest CMake build system

I already have a PR for documentation of ble unit testing: https://github.com/ARMmbed/mbed-os-5-docs/pull/1399/files

I requested Readme to introduce stubs and fakes (I was thinking putting it into stubs/fakes folders). It can contain basic info and reference to our docs pages. Basically if I fetch the repo and start browsing sources, I can read readme and browse files and contribute.

@paul-szczepanek-arm Lets move this readme to your 1399 PR. It contains valuable information.

@rajkan01 Are you proposing to completely remove this readme (move everything to docs) ?

OK, so you don't want the readme in mbed-os?

@0xc0170 @paul-szczepanek-arm Yes, I have only removed the existing Readme from the UNITTESTS directory as part of Refactor unittest cmake PR as content gets duplicated and also official vs local readme content mismatch so better to move this readme content into the official Mbed OS documentation

paul-szczepanek-arm · 2021-06-11T09:45:05Z

OK, I removed the readme, is this good to go now?

0xc0170 · 2021-06-11T11:07:11Z

CI started

mbed-ci · 2021-06-11T11:36:34Z

Jenkins CI Test : ✔️ SUCCESS

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

CLICK for Detailed Summary

jobs	Status
jenkins-ci/mbed-os-ci_unittests	✔️
jenkins-ci/mbed-os-ci_build-cloud-example-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-cloud-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-cloud-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-greentea-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-example-ARM	✔️
jenkins-ci/mbed-os-ci_cmake-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-example-ARM	✔️
jenkins-ci/mbed-os-ci_build-greentea-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_build-example-GCC_ARM	✔️
jenkins-ci/mbed-os-ci_greentea-test	✔️

paul-szczepanek-arm added 4 commits June 6, 2021 11:25

add fake event queue for unittests

3290c94

add fake googlemock BLE API for unittests

2975c7c

add default BLE roles configuration in case no json present

0515408

add missing tuple c++ replacement for unittests

cc0729a

paul-szczepanek-arm mentioned this pull request Jun 6, 2021

Add cmake unittest fakes for BLE and events #14515

Closed

paul-szczepanek-arm requested a review from rajkan01 June 6, 2021 11:06

paul-szczepanek-arm changed the title ~~Add cmake unittest fakes for BLE and events~~ BLE: Add cmake unittest fakes for BLE and events Jun 6, 2021

ciarmcom added the release-type: patch Indentifies a PR as containing just a patch label Jun 6, 2021

ciarmcom requested a review from a team June 6, 2021 11:30

ciarmcom added needs: review component: test component: connectivity labels Jun 6, 2021

0xc0170 requested a review from a team June 7, 2021 10:31

0xc0170 previously requested changes Jun 7, 2021

View reviewed changes

mergify bot added needs: work and removed needs: review labels Jun 7, 2021

missing newlines

8557529

Add a readme to unit tests

3fa7796

paul-szczepanek-arm requested a review from 0xc0170 June 7, 2021 15:45

0xc0170 added needs: review and removed needs: work labels Jun 9, 2021

0xc0170 reviewed Jun 9, 2021

View reviewed changes

chrisswinchatt-arm approved these changes Jun 10, 2021

View reviewed changes

fix typos

36d9b86

Co-authored-by: Chris Swinchatt <[email protected]>

rajkan01 reviewed Jun 10, 2021

View reviewed changes

remove unittest readme

8642610

0xc0170 approved these changes Jun 11, 2021

View reviewed changes

0xc0170 added needs: CI and removed needs: review labels Jun 11, 2021

mergify bot added ready for merge and removed needs: CI labels Jun 11, 2021

0xc0170 merged commit df12718 into ARMmbed:master Jun 11, 2021

mergify bot removed the ready for merge label Jun 11, 2021

mbedmain added release-version: 6.12.0 Release-pending and removed release-type: patch Indentifies a PR as containing just a patch Release-pending labels Jun 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

BLE: Add cmake unittest fakes for BLE and events #14737

BLE: Add cmake unittest fakes for BLE and events #14737

paul-szczepanek-arm commented Jun 6, 2021

paul-szczepanek-arm commented Jun 6, 2021

paul-szczepanek-arm commented Jun 6, 2021 •

edited

Loading

ciarmcom commented Jun 6, 2021

0xc0170 left a comment

0xc0170 Jun 7, 2021

0xc0170 Jun 7, 2021

paul-szczepanek-arm commented Jun 7, 2021

0xc0170 Jun 9, 2021

0xc0170 Jun 9, 2021

chrisswinchatt-arm Jun 10, 2021 •

edited

Loading

paul-szczepanek-arm Jun 10, 2021

rajkan01 Jun 10, 2021 •

edited

Loading

paul-szczepanek-arm Jun 10, 2021

0xc0170 Jun 10, 2021

paul-szczepanek-arm Jun 10, 2021

rajkan01 Jun 11, 2021

paul-szczepanek-arm commented Jun 11, 2021

0xc0170 commented Jun 11, 2021

mbed-ci commented Jun 11, 2021


		All the libraries available are in the `CMakeLists.txt` files in `mbed-os/UNITTESTS/stubs` and `mbed-os/UNITTESTS/fakes`.

		The most common ones you might need are `mbed-os-fakes-ble` and `mbed-os-fakes-event-queue`.


		### Fakes

		While stubs are self explanatory and don't offer anything beyond empty implementations, fakes allow for more complex unittests that can simulate whole subsystems.


		}

		#endif // BLE_MOCKS_H

BLE: Add cmake unittest fakes for BLE and events #14737

BLE: Add cmake unittest fakes for BLE and events #14737

Conversation

paul-szczepanek-arm commented Jun 6, 2021

Summary of changes

Impact of changes

Migration actions required

Documentation

Pull request type

Test results

Reviewers

paul-szczepanek-arm commented Jun 6, 2021

paul-szczepanek-arm commented Jun 6, 2021 • edited Loading

ciarmcom commented Jun 6, 2021

0xc0170 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paul-szczepanek-arm commented Jun 7, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chrisswinchatt-arm Jun 10, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rajkan01 Jun 10, 2021 • 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

paul-szczepanek-arm commented Jun 11, 2021

0xc0170 commented Jun 11, 2021

mbed-ci commented Jun 11, 2021

Jenkins CI Test : ✔️ SUCCESS

Build Number: 1 | 🔒 Jenkins CI Job | 🌐 Logs & Artifacts

paul-szczepanek-arm commented Jun 6, 2021 •

edited

Loading

chrisswinchatt-arm Jun 10, 2021 •

edited

Loading

rajkan01 Jun 10, 2021 •

edited

Loading