mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-10-21 11:43:11 -04:00
02e1f00ffd
Rationale --------- Currently, tests are hard to discover. For instance, someone updating `dovecot` might not notice that the interaction of `dovecot` with `opensmtpd` is handled in the `opensmtpd.nix` test. And even for someone updating `opensmtpd`, it requires manual work to go check in `nixos/tests` whether there is actually a test, especially given not so many packages in `nixpkgs` have tests and this is thus most of the time useless. Finally, for the reviewer, it is much easier to check that the “Tested via one or more NixOS test(s)” has been checked if the file modified already includes the list of relevant tests. Implementation -------------- Currently, this commit only adds the metadata in the package. Each element of the `meta.tests` attribute is a derivation that, when it builds successfully, means the test has passed (ie. following the same convention as NixOS tests). Future Work ----------- In the future, the tools could be made aware of this `meta.tests` attribute, and for instance a `--with-tests` could be added to `nix-build` so that it also builds all the tests. Or a `--without-tests` to build without all the tests. @Profpatsch described in his NixCon talk such systems. Another thing that would help in the future would be the possibility to reasonably easily have cross-derivation nix tests without the whole NixOS VM stack. @7c6f434c already proposed such a system. This RFC currently handles none of these concerns. Only the addition of `meta.tests` as metadata to be used by maintainers to remember to run relevant tests. |
||
|---|---|---|
| .. | ||
| functions | ||
| languages-frameworks | ||
| old | ||
| .gitignore | ||
| coding-conventions.xml | ||
| configuration.xml | ||
| contributing.xml | ||
| cross-compilation.xml | ||
| default.nix | ||
| functions.xml | ||
| introduction.chapter.md | ||
| lib-function-locations.nix | ||
| Makefile | ||
| manual.xml | ||
| meta.xml | ||
| multiple-output.xml | ||
| overlays.xml | ||
| overrides.css | ||
| package-notes.xml | ||
| platform-notes.xml | ||
| quick-start.xml | ||
| release-notes.xml | ||
| reviewing-contributions.xml | ||
| shell.nix | ||
| stdenv.xml | ||
| style.css | ||
| submitting-changes.xml | ||