diff options
author | davidak <davidak@users.noreply.github.com> | 2022-09-15 23:48:56 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-15 23:48:56 +0200 |
commit | 63f7b8c945992fffb310e1123152e7c7d35c292a (patch) | |
tree | d95bff9fe5696ef75d612bb0fe0218cb958e938d /doc | |
parent | 3dc04b3a040565bc05ab02723e3a6def77885073 (diff) | |
parent | 6c40872147f3159634e7c9db64229e9ae1f76090 (diff) |
Merge pull request #190818 from IvarWithoutBones/testversion-doc
doc/testers: testVersion -> testers.testVersion, add example
Diffstat (limited to 'doc')
-rw-r--r-- | doc/builders/testers.chapter.md | 16 |
1 files changed, 11 insertions, 5 deletions
diff --git a/doc/builders/testers.chapter.md b/doc/builders/testers.chapter.md index c6fb71de01807..ad1e1036d5086 100644 --- a/doc/builders/testers.chapter.md +++ b/doc/builders/testers.chapter.md @@ -14,19 +14,25 @@ for example when using an 'old' hash in a fixed-output derivation. Examples: ```nix -passthru.tests.version = testVersion { package = hello; }; +passthru.tests.version = testers.testVersion { package = hello; }; -passthru.tests.version = testVersion { +passthru.tests.version = testers.testVersion { package = seaweedfs; command = "weed version"; }; -passthru.tests.version = testVersion { +passthru.tests.version = testers.testVersion { package = key; command = "KeY --help"; # Wrong '2.5' version in the code. Drop on next version. version = "2.5"; }; + +passthru.tests.version = testers.testVersion { + package = ghr; + # The output needs to contain the 'version' string without any prefix or suffix. + version = "v${version}"; +}; ``` ## `testEqualDerivation` {#tester-testEqualDerivation} @@ -42,7 +48,7 @@ Otherwise, the build log explains the difference via `nix-diff`. Example: ```nix -testEqualDerivation +testers.testEqualDerivation "The hello package must stay the same when enabling checks." hello (hello.overrideAttrs(o: { doCheck = true; })) @@ -73,7 +79,7 @@ fixed output derivation. Example: ```nix -tests.fetchgit = invalidateFetcherByDrvHash fetchgit { +tests.fetchgit = testers.invalidateFetcherByDrvHash fetchgit { name = "nix-source"; url = "https://github.com/NixOS/nix"; rev = "9d9dbe6ed05854e03811c361a3380e09183f4f4a"; |