From 41808d42d21f685e3fd3cdb2c9f04082f0818e30 Mon Sep 17 00:00:00 2001 From: Artturin Date: Wed, 20 Apr 2022 21:26:52 +0300 Subject: doc: move testers to their own chapter --- pkgs/build-support/testers/default.nix | 41 +--------------------------------- 1 file changed, 1 insertion(+), 40 deletions(-) (limited to 'pkgs/build-support/testers/default.nix') diff --git a/pkgs/build-support/testers/default.nix b/pkgs/build-support/testers/default.nix index e5a8dbc7960..8b79843b833 100644 --- a/pkgs/build-support/testers/default.nix +++ b/pkgs/build-support/testers/default.nix @@ -1,47 +1,8 @@ { pkgs, lib, callPackage, runCommand }: +# Documentation is in doc/builders/testers.chapter.md { - - /* Checks that two packages produce the exact same build instructions. - - This can be used to make sure that a certain difference of configuration, - such as the presence of an overlay does not cause a cache miss. - - When the derivations are equal, the return value is an empty file. - Otherwise, the build log explains the difference via `nix-diff`. - - Example: - - testEqualDerivation - "The hello package must stay the same when enabling checks." - hello - (hello.overrideAttrs(o: { doCheck = true; })) - */ testEqualDerivation = callPackage ./test-equal-derivation.nix { }; - /* Checks the command output contains the specified version - - Although simplistic, this test assures that the main program - can run. While there's no substitute for a real test case, - it does catch dynamic linking errors and such. It also provides - some protection against accidentally building the wrong version, - for example when using an 'old' hash in a fixed-output derivation. - - Examples: - - passthru.tests.version = testVersion { package = hello; }; - - passthru.tests.version = testVersion { - package = seaweedfs; - command = "weed version"; - }; - - passthru.tests.version = testVersion { - package = key; - command = "KeY --help"; - # Wrong '2.5' version in the code. Drop on next version. - version = "2.5"; - }; - */ testVersion = { package, command ? "${package.meta.mainProgram or package.pname or package.name} --version", -- cgit 1.4.1