Skip to content

Adding docs for the testing process for mbed OS 5 #2364

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 2 commits into from
Aug 4, 2016

Conversation

bridadan
Copy link
Contributor

@bridadan bridadan commented Aug 3, 2016

This adds documentation describing how tests are built and ran within mbed OS 5.
This doesn't cover the mbed CLI commands, but rather the underlying build and test runner process that's occurring when making the calls to mbed CLI and the underlying scripts.

It also describes how to debug tests with IDEs in conjunction with the test tools.

Please review @iriark01
FYI @mazimkhan @adbridge

@iriark01
Copy link
Contributor

iriark01 commented Aug 4, 2016

Not sure I'll have time to review today; will transclude it into the handbook if you want (information with typos is better than no information)

@screamerbg
Copy link
Contributor

LGTM. @bridadan happy to link from mbed CLI docs about testing to the testing section in these docs?

@@ -0,0 +1,187 @@
# Testing in mbed OS 5

The way tests are ran and compiled in mbed OS 5 is substantially different than in previous versions of mbed. Previously tests were located in one known location and a python file was kept (`tools/tests.py`) keeping track of their dependencies, capabilities, and configurations. mbed OS 5 has adopted a more distributed approach to testing. Now test code lives alongside the test code, and these are dynamically discovered by the test tools.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"are run"
"different from previous"
"Previously, tests were"
"Python file (tools/tests.py) kept track"
"Test code lives alongside the application code"

@bridadan
Copy link
Contributor Author

bridadan commented Aug 4, 2016

@iriark01 Thanks a lot for looking at this today! I'll get cracking on these fixes

@bridadan
Copy link
Contributor Author

bridadan commented Aug 4, 2016

@iriark01 I've made the changes! Everything I 👍ed I made the change you suggested. There were only a couple ones that I didn't make your exact change. I asked your opinion on those, so if you want me to change em let me know!

@bridadan
Copy link
Contributor Author

bridadan commented Aug 4, 2016

@screamerbg Sure thing, will do when this is merged

@sg- sg- merged commit f8da50f into ARMmbed:master Aug 4, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants