test_get_version_for_package and test_log_versions_unresolvable_version_logs_unknown are flaky

[sanvila]

Hello. This was reported to Debian here:

https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=1143373

Summary: The Debian package for version 2026.6.24 fails to build randomly due to this failing tests:

=================================== FAILURES ===================================
_________________________ test_get_version_for_package _________________________

    def test_get_version_for_package():
        """should track version if package is a module"""
        import numpy as np
    
        got = get_version_for_package(np)
        assert got == np.__version__
        # one with a callable
        pyfile = TEST_ROOTDIR / "delme.py"
        pyfile.write_text("def version():\n  return 'my-version'")
        sys.path.append(TEST_ROOTDIR)
>       import delme
E       ModuleNotFoundError: No module named 'delme'

tests/test_logging.py:342: ModuleNotFoundError

It looks like the test writes delme.py to a directory in the python import path and expects it to be immediately available, which may or may not happen due to caching issues.

Sometimes the failing test is this other one:

=================================== FAILURES ===================================
_____________ test_log_versions_unresolvable_version_logs_unknown ______________

logfile = PosixPath('/tmp/pytest-of-sbuild/pytest-1/test_log_versions_unresolvable0/delme.log')

    def test_log_versions_unresolvable_version_logs_unknown(logfile):
        # a module with no version attribute -> version None normalised to UNKNOWN
        pyfile = TEST_ROOTDIR / "delme_nover.py"
        pyfile.write_text("answer = 42\n")
        sys.path.append(str(TEST_ROOTDIR))
>       import delme_nover
E       ModuleNotFoundError: No module named 'delme_nover'

tests/test_logging.py:377: ModuleNotFoundError

The test failures happen randomly, but I can offer a VM to reproduce this randomness if required.

Thanks.

[GavinHuttley]

Hi @sanvila ,

Thanks for the report. I've made a PR that (I hope) addresses this issue, can you try it out and report back? If not, please provide the VM.

[sanvila]

Hi. I confirm that after applying the above patch, the reported problem does not happen anymore.

I tried to build the package 100 times. It build ok 99 times, and the one time that it failed, it did so in this way:

=================================== FAILURES ===================================
________________________________ test_appending ________________________________

logfile = PosixPath('/tmp/pytest-of-buildd/pytest-1/test_appending0/delme.log')

    def test_appending(logfile):
        """appending to an existing logfile should work"""
        LOGGER = CachingLogger(create_dir=True)
        LOGGER.log_file_path = logfile
        LOGGER.input_file(TEST_ROOTDIR / "sample-lf.fasta")
        LOGGER.shutdown()
        records = Counter()
        for line in logfile.read_text().splitlines():
            records[line] += 1
        vals = set(records.values())
        assert vals == {1}
        LOGGER = CachingLogger(create_dir=True)
        LOGGER.mode = "a"
        LOGGER.log_file_path = logfile
        LOGGER.input_file(TEST_ROOTDIR / "sample-lf.fasta")
        LOGGER.shutdown()
    
        records = Counter()
        for line in logfile.read_text().splitlines():
            records[line] += 1
        vals = set(records.values())
    
>       assert vals == {2}
E       assert {1, 2} == {2}
E         
E         Extra items in the left set:
E         1
E         
E         Full diff:
E           {
E         +     1,
E               2,
E           }

tests/test_logging.py:640: AssertionError

but I guess this is not related at all with the issue I reported.

Thanks.