Skip to content

Update testing intro doc #4735

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 3 commits into from
Jul 2, 2025
Merged

Update testing intro doc #4735

merged 3 commits into from
Jul 2, 2025

Conversation

mwichmann
Copy link
Collaborator

This does not affect SCons at all - only updates the document (which is eventually duplicated on the Wiki) about making use of the SCons test framework.

It's not going to be easy to review in the classical way, maybe just scan through the full doc and see if it makes sense this way?

https://scons.org/guidelines.html

Contributor Checklist:

  • I have created a new test or updated the unit tests to cover the new/changed functionality.
  • I have updated CHANGES.txt and RELEASE.txt (and read the README.rst).
  • I have updated the appropriate documentation

Signed-off-by: Mats Wichmann <mats@linux.com>
@mwichmann mwichmann added the testsuite Things that only affect the SCons testing. Do not use just because a PR has tests. label Jun 10, 2025
the unit tests for the ``Builder.py`` module are in the
``BuilderTests.py`` script. Unit tests tend to be based on assertions.
``SCons/`` subdirectory (that is alongside the code they are testing)
and use the Python ``unittest`` module to perform assertion-based
Copy link
Contributor

Choose a reason for hiding this comment

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

Should include that files have to be named *Tests.py to be found.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I thought that's what that section was saying?

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't see it in this section.. it's much later in the doc..

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm not seeing the reason for the fuss here. This is an "about" section, not a "how to" section. I can add these but it seems like extra noise.

Copy link
Contributor

Choose a reason for hiding this comment

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

You removed it from the original, which I think is useful information to have up front.

Signed-off-by: Mats Wichmann <mats@linux.com>
Signed-off-by: Mats Wichmann <mats@linux.com>
@bdbaddog bdbaddog merged commit c67193f into SCons:master Jul 2, 2025
@mwichmann mwichmann deleted the doc/fw-again branch July 2, 2025 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
testsuite Things that only affect the SCons testing. Do not use just because a PR has tests.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants