This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Buildbots fail when new files are added
Type: Stage:
Components: Tests Versions: Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: Nosy List: barry, jaraco, zach.ware
Priority: normal Keywords:

Created on 2019-05-25 13:14 by jaraco, last changed 2022-04-11 14:59 by admin.

Messages (4)
msg343478 - (view) Author: Jason R. Coombs (jaraco) * (Python committer) Date: 2019-05-25 13:14
As [reported here](https://bugs.python.org/issue34632#msg343445), I submitted a pull request that passed all tests locally and in CI, but when accepted, build bots started to fail as a result of new files having been added to the project. It seems it's necessary in Makefile.pre.in to duplicate the git manifest to declare those directories... but only for buildbot builds. I don't fully understand why that is the case, but it would be nicer if there were protections from this footgun, especially since this issue may manifest several times in the same PR.

I can think of some ways to prevent this undesirable behavior:

- Include buildbot builds in the GitHub merge request checks.
- Add a GitHub bot that checks merge requests that create directories and alert the review of directories created if Makefile.pre.in doesn't include changes reflecting those directories.
- Remove the reliance on a separate directory listing in Makefile.pre.in.
msg343482 - (view) Author: Jason R. Coombs (jaraco) * (Python committer) Date: 2019-05-25 14:08
In GH-13565, @yan12125 provides [this reference](https://github.com/python/buildmaster-config/blob/master/master/custom/factories.py) to the buildbot code that copies the code and thus imposes the requirement to declare source directories.
msg343487 - (view) Author: Zachary Ware (zach.ware) * (Python committer) Date: 2019-05-25 15:34
The issue here is not with buildbots, but with installation on POSIX platforms.  We do now have a couple of buildbots that install Python to a local location before running the tests, which is what flushes this out (see https://github.com/python/buildmaster-config/blob/master/master/custom/factories.py#L134-L147; they simply run `make install` before running the tests).

Adding these buildbots as pre-merge CI is not currently an option due to security implications (I don't want unreviewed code running on my home network).  I have plans to eventually allow certain builders to be run pre-merge iff the `awaiting merge` label is present on the PR, but I haven't had time to work on that yet.

It might be possible to adjust one of the Travis builds to install before running tests, but that leaves some other tests un-run, which just relocates the problem.

Removing reliance on an explicit listing of directories sounds nice, but does open up the possibility of installing more than expected if run from a dirty checkout.

What about adding a "new directories added to Makefile.pre.in" check to Tools/scripts/patchcheck.py?
msg409403 - (view) Author: Jason R. Coombs (jaraco) * (Python committer) Date: 2021-12-31 03:37
I encountered this issue again today in issue46118.

I started looking into creating the patchcheck, but I realize it may be a little tricky to detect the introduction of a new folder, because `git diff` doesn't actually report new folders, and my initial research indicates it's [far from straightforward](https://stackoverflow.com/a/36293191/70170).

I thought maybe git diff --dirstat might help, but it doesn't. It reports 100% different for a new file in a new folder and same for a new file in an existing folder.
History
Date User Action Args
2022-04-11 14:59:15adminsetgithub: 81224
2021-12-31 03:37:01jaracosetmessages: + msg409403
2019-05-25 17:53:01barrysetnosy: + barry
2019-05-25 15:34:09zach.waresetnosy: + zach.ware
messages: + msg343487
2019-05-25 14:08:41jaracosetmessages: + msg343482
2019-05-25 13:14:10jaracocreate