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

Reorganize tests to be one file per module and to give more descriptive file names #193

Merged
merged 1 commit into from
Aug 23, 2024

Conversation

CFiggers
Copy link
Contributor

Historically, spork's tests have been organized into numbered suites, such as suite0002.janet. Each suite usually contains tests related to a single module. But some suites mix together tests for unrelated modules (without an apparent intention to doing so).

More recent additions and updates in the spork/test directory have switched to using an (IMHO) much friendlier convention. These newer test files simply name the test file after the module it is primarily focused on testing, prefixed with suite-. This makes test cases for a given module much easier to find. Discoverability of test cases matters because in many cases the tests are the only documentation or usage examples available for a given spork module.

This PR proposes renaming and lightly reorganizing spork's tests to entirely switch over to the more recently-preferred convention. The goal is to improve the discoverability and therefore usefulness of test suites as quasi-documentation. The tests themselves are unmodified and all still pass.

@sogaiu
Copy link
Contributor

sogaiu commented Aug 22, 2024

I tried your branch and tallied the number of tests before and after and the counts seem to match.

LGTM :)

@bakpakin bakpakin merged commit 1c081c7 into janet-lang:master Aug 23, 2024
1 check passed
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.

3 participants