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

qa-test #2871

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

qa-test #2871

wants to merge 2 commits into from

Conversation

bjoernQ
Copy link
Contributor

@bjoernQ bjoernQ commented Dec 30, 2024

Thank you for your contribution!

We appreciate the time and effort you've put into this pull request.
To help us review it efficiently, please ensure you've gone through the following checklist:

Submission Checklist 📝

  • I have updated existing examples or added new ones (if applicable).
  • I have used cargo xtask fmt-packages command to ensure that all changed code is formatted correctly.
  • My changes were added to the CHANGELOG.md in the proper section.
  • I have added necessary changes to user code to the Migration Guide.
  • My changes are in accordance to the esp-rs API guidelines

Extra:

Pull Request Details 📖

Description

Closes #2566

We have the qa-test folder but running those tests was annoying and error-prone.

While it was always possible to run cargo xtask run-example FOLDER TARGET (i.e. w/o the example name) it always gave an error.

Now it will

  • run all examples / tests for the given chip
  • show the top-level comment - give the user time to attach / prepare whatever is needed
  • let the user decide to run or skip the example (e.g. if the user doesn't have the needed external components at hand)
  • run next example when the example was quit via CTRL-C

Additionally, this introduces a new key TAG which is used to group the examples (i.e. multiple examples needing the same wiring should run after each other)

In future we will move everything from examples over to qa-test (and adapt those examples to better serve as tests) but that is out of scope for this PR.

skip-changelog since this isn't really worth mentioning there

Testing

See above

@bjoernQ bjoernQ added the skip-changelog No changelog modification needed label Dec 30, 2024
@bjoernQ bjoernQ changed the title Qa test qa-test Dec 30, 2024
Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! Also did some testing and now its way more convenient to test all the qa tests! Maybe we should thing if we require any other tag(s), maybe a tag for those qa-tests that dont require any extra-stuff is helpful

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip-changelog No changelog modification needed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Semi-automated tests
2 participants