Stuck on a pytest issue in this repo: https://github.com/BruceEckel/RethinkingObjects The

pytest.ini

in the root directory contains:

[pytest]
minversion = 7.0.1
python_files = *.py
addopts = -rA

The

python_files = *.py

should make pytest look in all files for tests, according to https://docs.pytest.org/en/7.1.x/example/pythoncollection.html#customizing-test-collection, but it doesn't seem to be; it only seems to look in `foo_test.py`:

bruce@groot:~/RethinkingObjects$ ./pants test ::
14:40:42.23 [ERROR] Completed: Run Pytest - test_experiments/foo_test.py:tests failed (exit code 5).
============================= test session starts ==============================
platform linux -- Python 3.10.6, pytest-7.0.1, pluggy-1.0.0
rootdir: /tmp/pants-sandbox-pDDAT5, configfile: pytest.ini
plugins: forked-1.4.0, cov-3.0.0, xdist-2.5.0
collected 0 items

- generated xml file: /tmp/pants-sandbox-pDDAT5/test_experiments.foo_test.py.tests.xml -
============================ no tests ran in 0.02s =============================

Pants tries not to get on the way of the tools you use, but its sandboxing model necessarily gets involved with files and which ones and caching etc. So options like

python_files

are ~never going to work. Looking ...

OK, this is really strange. I have also switched to just using pytest (without Pants). First I hid the

pytest.ini

file. Pytest does not appear to be recursing the directories. To test this I put a couple of test files at the top level:

To be clear, the issue wasn't file collection here, it was test function collection. Your naming convention did not match what pytest expected for a test function.

f1_test.py

and

test_f1.py

. It finds these but only registers test functions if they start with the word "test", not end with "test" as the Pytest documentation seems to say. The output is:

bruce@groot:~/RethinkingObjects$ pytest
================================================= test session starts ==================================================
platform linux -- Python 3.10.6, pytest-7.2.0, pluggy-1.0.0
rootdir: /home/bruce/RethinkingObjects
collected 3 items

f1_test.py F                                                                                                     [ 33%]
test_f1.py F                                                                                                     [ 66%]
test_f2.py .                                                                                                     [100%]

======================================================= FAILURES =======================================================
______________________________________________________ test_f1_b _______________________________________________________

    def test_f1_b():
>     assert False
E     assert False

f1_test.py:5: AssertionError
_______________________________________________________ test_f1 ________________________________________________________

    def test_f1():
>     assert False
E     assert False

test_f1.py:5: AssertionError
=============================================== short test summary info ================================================
FAILED f1_test.py::test_f1_b - assert False
FAILED test_f1.py::test_f1 - assert False
============================================= 2 failed, 1 passed in 0.02s ==============================================

These have been added to https://github.com/BruceEckel/RethinkingObjects

Correct, it sounds like you understand the issue now.

I don't, actually. The Pytest docs say that pytest will recurse subdirectories and that the word "test" can be at the beginning or ending of the function. (I'll go re-look at them now).

See bullet point 4: https://docs.pytest.org/en/7.1.x/explanation/goodpractices.html#conventions-for-python-test-discovery

Just saw that: "test-prefixed..."

Yup.

Thanks

Excellent.

Or at least it seemed to, briefly, but now it seems to work with pytest but not with pants. Can't tell what's happening.

./pants test ::

doesn't produce any results.

The

python_tests

target has its own naming conventions; you're violating them. You want to carefully spell out

sources=[...]

for

python_tests

targets and remove certain

python_sources

targets that would otherwise catch things like

a.py

. You are bucking conventions and being forced to learn what the defaults are in essence. If you're going to do that you have to expect to do a lot of reading and explicit configuration, or get lucky and have someone chime in and save you effort like I've done here

To elaborate: What happens when you run ./pants test ::, say, is that Pants gathers up all the test files, and runs pytest on them. So pytest config doesn't even come into play until Pants finds the test files and executes pytest on them (by default in one process per test file)

Yes, these are the example files exactly as they appear in the book. So each file will contain both regular code, and then the automated tests that have function names ending with

_main

. The

pytest.ini

file which does this is:

[pytest]
minversion = 7.0.1
python_files = *.py  # Discover tests in every python file
python_functions = *_main
addopts = -rA

This works correctly with Pytest and came from following the Pytest docs. (In those docs they just seem to consider it normal configuration options, and not "bucking conventions," so I was a bit surprised at that reference). I'm confused, though --- are you saying I shouldn't/cannot use

pytest.ini

at all, and must do all the configuration inside the

BUILD

file? And it sounds like that configuration looks like this:

python_tests(sources = ["*.py"])

Also, I'm not sure what "subtracting" looks like, or how to know which files to subtract (especially as the goal is to be able to put tests in any

.py

file).

I will say you will be sending your readers down a rocky road when they step away from your book out into the wild. Since the convention you're bucking is pervasive, the readers may get a false impression of what works.

I easily did it in pytest using the

pytest.ini

file shown above. I am indeed doing something different here, and will explain it in the book (which is not a beginner book).

Ah, ok.

Well, if every file can be a test file then

python_tests(sources = ["*.py"])

is correct and subtraction from python_sources is moot, since you'd be subtracting everything, so you would just omit the

python_sources()

entirely.

Ok, dual target "ownership" works as far as I tested it: https://github.com/BruceEckel/RethinkingObjects/pull/1

Well, if this is all for book examples, the issues may not come into play at all? So this may be fine in practice

Thank you! I will study this and get back to you.