Skip to content
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

Document test infrastructure somewhere on web site #256

Open
stevegt opened this issue Apr 7, 2022 · 0 comments
Open

Document test infrastructure somewhere on web site #256

stevegt opened this issue Apr 7, 2022 · 0 comments

Comments

@stevegt
Copy link

stevegt commented Apr 7, 2022

This description of the test infrastructure from @dkegel-fastly is worth gold -- is it already documented somewhere on the web site, and if not, where should it go?

I first looked for it in the "testing" section of the Contributing page and would expect to see it near there -- right below that would be my vote.

Build-only tests for all small targets:
The "make smoketest" at the end of .github/workflows/linux.yml make sure that at least one example compiles for each target. 

Emulated tests for small targets:
The "make tinygo-baremetal" at the end of .github/workflows/linux.yml makes sure that very small set of tests (currently just encoding/hex) passes on a very small set of emulated targets (currently cortex-m-qemu). 

Real hardware tests for small targets:
Look at the test results for the tip of dev and release.  
The "TinyHCI" test results are from https://github.com/tinygo-org/tinyhci, which runs on real hardware.
I haven't looked at that at all, but I think it only tests hardware functions.

All of the above could probably stand some expansion.  In particular, tinygo-baremetal could make sure a simple smoke test of fmt passes.  ( Once reflect improves, perhaps after https://github.com/tinygo-org/tinygo/pull/2640 lands, we could even make sure "tinygo test fmt" passes.)

Originally posted by @dkegel-fastly in #254 (comment)

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

No branches or pull requests

1 participant