mention tests folder naming scheme in runtests.py and HACKING.md

Technologicat · Technologicat · commit f78ef367d6d7 · 2021-04-27T01:39:59.000+03:00
All unit tests are now contained in subfolders named `tests` (plural).

Only `unpythonic.test.fixtures` lives in a `test` (singular) subfolder, because
that `test` is part of the framework name. This neatly separates the framework
code from the actual unit tests.
diff --git a/HACKING.md b/HACKING.md
@@ -74,11 +74,11 @@
 
 In short: regular code is in `unpythonic`, macros are in `unpythonic.syntax`, and REPL server related stuff is in `unpythonic.net`.
 
-Automated tests are in `test`, under the directory whose modules they test. The test runner is, unsurprisingly, `runtests.py`, at the top level. Yes, I know many developers [prefer to separate](https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure) the `src` and `test` hierarchies at the top level; we currently don't, mostly for historical reasons.
+Automated tests are in `tests` (note plural), under the directory whose modules they test. The test runner is, unsurprisingly, `runtests.py`, at the top level. Yes, I know many developers [prefer to separate](https://blog.ionelmc.ro/2014/05/25/python-packaging/#the-structure) the `src` and `tests` hierarchies at the top level; we currently don't, mostly for historical reasons.
 
 For coverage analysis, [`coverage.py`](https://github.com/nedbat/coveragepy) works fine for analyzing [statement coverage](https://en.wikipedia.org/wiki/Code_coverage#Basic_coverage_criteria). Block macros do cause [some false negatives](https://github.com/nedbat/coveragepy/issues/1004), but this is minor.
 
-We use a custom testing framework, which lives in the modules `unpythonic.test.fixtures` and `unpythonic.syntax.testingtools`. It uses conditions and restarts to communicate between individual tests and the testset, which acts as a reporter.
+We use a custom testing framework, which lives in the modules `unpythonic.test.fixtures` (note singular `test`, part of the framework name) and `unpythonic.syntax.testingtools`. It uses conditions and restarts to communicate between individual tests and the testset, which acts as a reporter.
 
 In retrospect, given that the main aim was compact testing syntax for macro-enabled Python code (without installing another import hook, doing which would disable the macro expander), it might have made more sense to make the testing macros compile to [pytest](https://docs.pytest.org/en/latest/). But hey, it's short, may have applications in teaching... and now we can easily write custom test runners, since the testing framework is just a `mcpyrate` library. It's essentially a *no-framework* (cf. "NoSQL"), which provides the essentials and lets the user define the rest.
 
diff --git a/runtests.py b/runtests.py
@@ -31,10 +31,13 @@ def modname(path, filename):  # some/dir/mod.py --> some.dir.mod
 
 def main():
     with session():
+        # All folders containing unit tests are named `tests` (plural).
+        #
+        # The testing framework is called `unpythonic.test.fixtures`,
+        # so it lives in the only subfolder in the project that is named
+        # `test` (singular).
         testsets = (("regular code", (listtestmodules(os.path.join("unpythonic", "tests")) +
                                       listtestmodules(os.path.join("unpythonic", "net", "tests")))),
-                    # This one is called "tests" to prevent a name shadowing issue;
-                    # a `test` submodule would shadow the `test` macro.
                     ("macros", listtestmodules(os.path.join("unpythonic", "syntax", "tests"))))
         for tsname, modnames in testsets:
             with testset(tsname):
diff --git a/unpythonic/syntax/__init__.py b/unpythonic/syntax/__init__.py
@@ -87,8 +87,6 @@
 # However, 0.15.0 is the initial version that runs on `mcpyrate`, and the focus is to just get this running.
 # Cleanups can be done in a future release.
 
-# TODO: Comment in `runtests.py` and in `HACKING.md`: `test` folders renamed to `tests`; only `fixtures.py` lives in `unpythonic.test`, because the name of the framework is `unpythonic.test.fixtures`. This separates the test framework code from the unit tests.
-
 # TODO: Rename `HACKING.md` to `CONTRIBUTING.md` (modern standard name).
 
 # TODO: Update all tree-walking macros that handle Call nodes to ignore the node (and not recurse!) if it matches `mcpyrate.quotes.is_captured_value`
