Unverified Commit 63f7b8c9 authored by davidak's avatar davidak Committed by GitHub
Browse files

Merge pull request #190818 from IvarWithoutBones/testversion-doc 

doc/testers: testVersion -> testers.testVersion, add example
parents 3dc04b3a 6c408721

doc/builders/testers.chapter.md

+11 −5
Original line number Diff line number Diff line
@@ -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";