Add a simple reproducibility test command. #13689
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
jpakkane
force-pushed
the
reprotest
branch
2 times, most recently
from
98c0cb5
to
9ba04e5
Compare
| ## Simple tool to test build reproducibility | ||
|
|
||
| Meson now ships with a command for testing whether your project can be | ||
| [built reprodicibly](https://reproducible-builds.org/). It can be used |
There was a problem hiding this comment.
typo: s/reprodicibly/reproducibly
| # Note: when adding arguments, please also add them to the completion | ||
| # scripts in $MESONSRC/data/shell-completions/ |
|
|
||
| Builds the current project with its default settings. | ||
|
|
||
| meson reprotest --intermediates -- --buildtype=debugoptimized |
There was a problem hiding this comment.
typo: it should be --intermediaries
| self.cleanup() | ||
| return len(self.issues) | ||
|
|
||
| def check_ccache(self) -> None: |
There was a problem hiding this comment.
I have /usr/lib/ccache in my PATH
and that makes me currently not abort with sys.exit(1) even though I should.
> $ ccache -z
Statistics zeroed
> $ time ~/git/meson/meson.py reprotest --intermediaries
The Meson build system
Version: 1.5.99
Source dir: /home/fortysixandtwo/git/calls
Build dir: /home/fortysixandtwo/git/calls/buildrepro
Build type: native build
[...]
[422/422] Linking target tests/application
No differences detected.
~/git/meson/meson.py reprotest --intermediaries 94,72s user 21,80s system 491% cpu 23,705 total
> $ ccache -s
Cacheable calls: 550 / 633 (86.89%)
Hits: 550 / 550 (100.0%)
Direct: 548 / 550 (99.64%)
Preprocessed: 2 / 550 ( 0.36%)
Misses: 0 / 550 ( 0.00%)
Uncacheable calls: 83 / 633 (13.11%)
Local storage:
Cache size (GiB): 1.3 / 5.0 (25.31%)
Hits: 550 / 550 (100.0%)
Misses: 0 / 550 ( 0.00%)
There was a problem hiding this comment.
Detecting all ways ccache could be injected is tricky, especially since actual compiler detection code is elsewhere and not easily callable. I guess we could check if PATH contains the string ccache, but that might have false positives.
There was a problem hiding this comment.
Simplest approach is to just use $CCACHE_DISABLE in the environment to tell ccache that even when run, it should simply forward directly to the compiler without performing any actions itself.
There was a problem hiding this comment.
This would also mean we could simply support the ccache users, as their testing would work by telling ccache to bypass the actual cache, instead of just refusing to perform the reproducibility testing at all.
| ) | ||
|
|
||
| class ReproTester: | ||
| def __init__(self, options: T.Any): |
There was a problem hiding this comment.
A Protocol can get rid of the need for Any here, it looks like all it would need is:
if T.TYPE_CHECKING:
from typing_extensions import Protocol
class Arguments(Protocol):
intermediaries: bool
mesonargs: T.List[str]There was a problem hiding this comment.
Eventually I'd like to get to the point that we don't have Any anywhere in the codebase, my experience is that it basically always hides issues.
| subprocess.check_call(setup_command) | ||
| subprocess.check_call(build_command) | ||
| self.builddir.rename(self.storagedir) | ||
| subprocess.check_call(setup_command) | ||
| subprocess.check_call(build_command) |
There was a problem hiding this comment.
Does it make sense to catch the exceptions that check_call would generate, print a more helpful message, and return a non 1 return code?
| for evar in ('CC', 'CXX'): | ||
| evalue = os.environ.get(evar, '') | ||
| if 'ccache' in evalue: | ||
| print(f'Environment variable {evar} set to value "{evalue}".') | ||
| print('This implies using a compiler cache, which is incompatible with reproducible builds.') | ||
| sys.exit(1) |
There was a problem hiding this comment.
This doesn't take into account the approach of linking ln -s ccache gcc. If that's a symlink I guess we can resolve that, though I don't know what to do if it's a hardlink.
Maybe a a better solution is to set CCACHE_DISABLE=1 before calling Meson, which causes ccache to skip reading and writing to the cache?
No description provided.