docs/Nixpkgs/Build-Helpers/testers.chapter/index.html

2505 lines
65 KiB
HTML
Raw Permalink Normal View History

2024-07-24 19:14:02 +00:00
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Aux Documentation">
<meta name="author" content="Nixpkgs Aux, and Lix Contributors">
<link rel="canonical" href="https://docs.auxolotl.org/Nixpkgs/Build-Helpers/testers.chapter/">
<link rel="prev" href="../special/">
<link rel="next" href="../trivial-build-helpers.chapter/">
<link rel="icon" href="../../../assets/aux-logo.svg">
<meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.29">
<title>Testers - Aux Docs</title>
<link rel="stylesheet" href="../../../assets/stylesheets/main.76a95c52.min.css">
<link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.bunny.net/css?family=IBM+Plex+Sans:300,300i,400,400i,700,700i%7CIBM+Plex+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"IBM Plex Sans";--md-code-font:"IBM Plex Mono"}</style>
<script>__md_scope=new URL("../../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Testers {#chap-testers} - Aux Docs" >
<meta property="og:description" content="Aux Documentation" >
<meta property="og:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Build-Helpers/testers.chapter.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://docs.auxolotl.org/Nixpkgs/Build-Helpers/testers.chapter/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Testers {#chap-testers} - Aux Docs" >
<meta name="twitter:description" content="Aux Documentation" >
<meta name="twitter:image" content="https://docs.auxolotl.org/assets/images/social/Nixpkgs/Build-Helpers/testers.chapter.png" >
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#chap-testers" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../../.." title="Aux Docs" class="md-header__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Aux Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Testers
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Dark Mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Dark Mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3 3.19.09m3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95 2.06.05m-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31Z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="blue" aria-label="Light Mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Light Mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 3 0 0 0-3 3 3 3 0 0 0 3 3 3 3 0 0 0 3-3 3 3 0 0 0-3-3m0-7 2.39 3.42C13.65 5.15 12.84 5 12 5c-.84 0-1.65.15-2.39.42L12 2M3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29L3.34 7m.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14L3.36 17M20.65 7l-1.77 3.79a7.023 7.023 0 0 0-2.38-4.15l4.15.36m-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29L20.64 17M12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44L12 22Z"/></svg>
</label>
</form>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../../.." class="md-tabs__link">
Aux Documentation Hub
</a>
</li>
<li class="md-tabs__item">
<a href="../../../TODO/" class="md-tabs__link">
TODO
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Aux/" class="md-tabs__link">
Aux
</a>
</li>
<li class="md-tabs__item">
<a href="../../../Lix/" class="md-tabs__link">
Lix
</a>
</li>
<li class="md-tabs__item">
<a href="../../../NixOS/appstream/" class="md-tabs__link">
NixOS
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../../" class="md-tabs__link">
Nixpkgs
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../../.." title="Aux Docs" class="md-nav__button md-logo" aria-label="Aux Docs" data-md-component="logo">
<img src="../../../assets/aux-logo.svg" alt="logo">
</a>
Aux Docs
</label>
<div class="md-nav__source">
<a href="https://git.auxolotl.org/auxolotl/docs" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</div>
<div class="md-source__repository">
auxolotl/docs
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../.." class="md-nav__link">
<span class="md-ellipsis">
Aux Documentation Hub
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../../TODO/" class="md-nav__link">
<span class="md-ellipsis">
TODO
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Aux/" class="md-nav__link">
<span class="md-ellipsis">
Aux
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../Lix/" class="md-nav__link">
<span class="md-ellipsis">
Lix
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../../NixOS/appstream/" class="md-nav__link">
<span class="md-ellipsis">
NixOS
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" checked>
<div class="md-nav__link md-nav__container">
<a href="../../" class="md-nav__link ">
<span class="md-ellipsis">
Nixpkgs
</span>
</a>
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Nixpkgs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../options/" class="md-nav__link">
<span class="md-ellipsis">
Options
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6_3" checked>
<div class="md-nav__link md-nav__container">
<a href="../" class="md-nav__link ">
<span class="md-ellipsis">
Build Helpers
</span>
</a>
<label class="md-nav__link " for="__nav_6_3" id="__nav_6_3_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_6_3_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_6_3">
<span class="md-nav__icon md-icon"></span>
Build Helpers
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../dev-shell-tools.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Development Shell helpers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../fetchers.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Fetchers
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../images/" class="md-nav__link">
<span class="md-ellipsis">
Images
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../special/" class="md-nav__link">
<span class="md-ellipsis">
Special build helpers
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Testers
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Testers
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#tester-hasPkgConfigModules" class="md-nav__link">
<span class="md-ellipsis">
hasPkgConfigModules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck" class="md-nav__link">
<span class="md-ellipsis">
lycheeLinkCheck
</span>
</a>
<nav class="md-nav" aria-label="lycheeLinkCheck">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck-return" class="md-nav__link">
<span class="md-ellipsis">
Return value
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck-inputs" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#tester-testVersion" class="md-nav__link">
<span class="md-ellipsis">
testVersion
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testBuildFailure" class="md-nav__link">
<span class="md-ellipsis">
testBuildFailure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testEqualContents" class="md-nav__link">
<span class="md-ellipsis">
testEqualContents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testEqualDerivation" class="md-nav__link">
<span class="md-ellipsis">
testEqualDerivation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-invalidateFetcherByDrvHash" class="md-nav__link">
<span class="md-ellipsis">
invalidateFetcherByDrvHash
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-runNixOSTest" class="md-nav__link">
<span class="md-ellipsis">
runNixOSTest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-nixosTest" class="md-nav__link">
<span class="md-ellipsis">
nixosTest
</span>
</a>
<nav class="md-nav" aria-label="nixosTest">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tester-nixosTest-parameter" class="md-nav__link">
<span class="md-ellipsis">
Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-nixosTest-result" class="md-nav__link">
<span class="md-ellipsis">
Result
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../trivial-build-helpers.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Trivial build helpers
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../images/appimagetools.section/" class="md-nav__link">
<span class="md-ellipsis">
Images
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../special/checkpoint-build.section/" class="md-nav__link">
<span class="md-ellipsis">
Special
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Functions/" class="md-nav__link">
<span class="md-ellipsis">
Functions
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Hooks/" class="md-nav__link">
<span class="md-ellipsis">
Hooks
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Languages-And-Frameworks/" class="md-nav__link">
<span class="md-ellipsis">
Languages And Frameworks
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Library-Reference/asserts/" class="md-nav__link">
<span class="md-ellipsis">
Library Reference
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Module-System/module-system.chapter/" class="md-nav__link">
<span class="md-ellipsis">
Module System
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Packages/" class="md-nav__link">
<span class="md-ellipsis">
Packages
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Standard-Environment/" class="md-nav__link">
<span class="md-ellipsis">
Standard Environment
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
<a href="../../Using-Nixpkgs/" class="md-nav__link">
<span class="md-ellipsis">
Using Nixpkgs
</span>
<span class="md-nav__icon md-icon"></span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#tester-hasPkgConfigModules" class="md-nav__link">
<span class="md-ellipsis">
hasPkgConfigModules
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck" class="md-nav__link">
<span class="md-ellipsis">
lycheeLinkCheck
</span>
</a>
<nav class="md-nav" aria-label="lycheeLinkCheck">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck-return" class="md-nav__link">
<span class="md-ellipsis">
Return value
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-lycheeLinkCheck-inputs" class="md-nav__link">
<span class="md-ellipsis">
Inputs
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#tester-testVersion" class="md-nav__link">
<span class="md-ellipsis">
testVersion
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testBuildFailure" class="md-nav__link">
<span class="md-ellipsis">
testBuildFailure
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testEqualContents" class="md-nav__link">
<span class="md-ellipsis">
testEqualContents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-testEqualDerivation" class="md-nav__link">
<span class="md-ellipsis">
testEqualDerivation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-invalidateFetcherByDrvHash" class="md-nav__link">
<span class="md-ellipsis">
invalidateFetcherByDrvHash
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-runNixOSTest" class="md-nav__link">
<span class="md-ellipsis">
runNixOSTest
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-nixosTest" class="md-nav__link">
<span class="md-ellipsis">
nixosTest
</span>
</a>
<nav class="md-nav" aria-label="nixosTest">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tester-nixosTest-parameter" class="md-nav__link">
<span class="md-ellipsis">
Parameter
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#tester-nixosTest-result" class="md-nav__link">
<span class="md-ellipsis">
Result
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="chap-testers">Testers</h1>
<p>This chapter describes several testing builders which are available in the <code>testers</code> namespace.</p>
<h2 id="tester-hasPkgConfigModules"><code>hasPkgConfigModules</code></h2>
<!-- Old anchor name so links still work -->
<p>[]{#tester-hasPkgConfigModule}
Checks whether a package exposes a given list of <code>pkg-config</code> modules.
If the <code>moduleNames</code> argument is omitted, <code>hasPkgConfigModules</code> will use <code>meta.pkgConfigModules</code>.</p>
<div class="admonition example">
<p class="admonition-title">Check that <code>pkg-config</code> modules are exposed using default values</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
passthru<span class="o">.</span>tests<span class="o">.</span><span class="ss">pkg-config</span> <span class="o">=</span> testers<span class="o">.</span>hasPkgConfigModules <span class="p">{</span>
<span class="ss">package</span> <span class="o">=</span> finalAttrs<span class="o">.</span>finalPackage<span class="p">;</span>
<span class="p">};</span>
meta<span class="o">.</span><span class="ss">pkgConfigModules</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;libfoo&quot;</span> <span class="p">];</span>
<span class="p">}</span>
</code></pre></div>
</div>
<div class="admonition example">
<p class="admonition-title">Check that <code>pkg-config</code> modules are exposed using explicit module names</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
passthru<span class="o">.</span>tests<span class="o">.</span><span class="ss">pkg-config</span> <span class="o">=</span> testers<span class="o">.</span>hasPkgConfigModules <span class="p">{</span>
<span class="ss">package</span> <span class="o">=</span> finalAttrs<span class="o">.</span>finalPackage<span class="p">;</span>
<span class="ss">moduleNames</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">&quot;libfoo&quot;</span> <span class="p">];</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h2 id="tester-lycheeLinkCheck"><code>lycheeLinkCheck</code></h2>
<p>Check a packaged static site's links with the <a href="https://search.nixos.org/packages?show=lychee&amp;type=packages&amp;query=lychee"><code>lychee</code> package</a>.</p>
<p>You may use Nix to reproducibly build static websites, such as for software documentation.
Some packages will install documentation in their <code>out</code> or <code>doc</code> outputs, or maybe you have dedicated package where you've made your static site reproducible by running a generator, such as <a href="https://gohugo.io/">Hugo</a> or <a href="https://rust-lang.github.io/mdBook/">mdBook</a>, in a derivation.</p>
<p>If you have a static site that can be built with Nix, you can use <code>lycheeLinkCheck</code> to check that the hyperlinks in your site are correct, and do so as part of your Nix workflow and CI.</p>
<div class="admonition example">
<p class="admonition-title">Check hyperlinks in the <code>nix</code> documentation</p>
<div class="highlight"><pre><span></span><code>testers<span class="o">.</span>lycheeLinkCheck <span class="p">{</span>
<span class="ss">site</span> <span class="o">=</span> nix<span class="o">.</span>doc <span class="o">+</span> <span class="s2">&quot;/share/doc/nix/manual&quot;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h3 id="tester-lycheeLinkCheck-return">Return value</h3>
<p>This tester produces a package that does not produce useful outputs, but only succeeds if the hyperlinks in your site are correct. The build log will list the broken links.</p>
<p>It has two modes:</p>
<ul>
<li>
<p>Build the returned derivation; its build process will check that internal hyperlinks are correct. This runs in the sandbox, so it will not check external hyperlinks, but it is quick and reliable.</p>
</li>
<li>
<p>Invoke the <code>.online</code> attribute with <a href="https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-run"><code>nix run</code></a> (<a href="https://nixos.org/manual/nix/stable/contributing/experimental-features#xp-feature-nix-command">experimental</a>). This runs outside the sandbox, and checks that both internal and external hyperlinks are correct.
Example:</p>
</li>
</ul>
<div class="highlight"><pre><span></span><code>nix<span class="w"> </span>run<span class="w"> </span>nixpkgs#lychee.tests.ok.online
</code></pre></div>
<h3 id="tester-lycheeLinkCheck-inputs">Inputs</h3>
<p><code>site</code> (path or derivation) {#tester-lycheeLinkCheck-param-site}</p>
<p>: The path to the files to check.</p>
<p><code>remap</code> (attribe set, optional) {#tester-lycheeLinkCheck-param-remap}</p>
<p>: An attribute set where the attribute names are regular expressions.
The values should be strings, derivations, or path values.</p>
<p>In the returned check's default configuration, external URLs are only checked when you run the <code>.online</code> attribute.</p>
<p>By adding remappings, you can check offline that URLs to external resources are correct, by providing a stand-in from the file system.</p>
<p>Before checking the existence of a URL, the regular expressions are matched and replaced by their corresponding values.</p>
<p>Example:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="s2">&quot;https://nix</span><span class="se">\\</span><span class="s2">.dev/manual/nix/[a-z0-9.-]*&quot;</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">${</span>nix<span class="o">.</span>doc<span class="si">}</span><span class="s2">/share/doc/nix/manual&quot;</span><span class="p">;</span>
<span class="s2">&quot;https://nixos</span><span class="se">\\</span><span class="s2">.org/manual/nix/(un)?stable&quot;</span> <span class="o">=</span> <span class="s2">&quot;</span><span class="si">${</span>emptyDirectory<span class="si">}</span><span class="s2">/placeholder-to-disallow-old-nix-docs-urls&quot;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<p>Store paths in the attribute values are automatically prefixed with <code>file://</code>, because lychee requires this for paths in the file system.
If this is a problem, or if you need to control the order in which replacements are performed, use <code>extraConfig.remap</code> instead.</p>
<p><code>extraConfig</code> (attribute set) {#tester-lycheeLinkCheck-param-extraConfig}</p>
<p>: Extra configuration to pass to <code>lychee</code> in its <a href="https://github.com/lycheeverse/lychee/blob/master/lychee.example.toml">configuration file</a>.
It is automatically <a href="https://nixos.org/manual/nixos/stable/index.html#sec-settings-nix-representable">translated</a> to TOML.</p>
<p>Example: <code>{ "include_verbatim" = true; }</code></p>
<p><code>lychee</code> (derivation, optional) {#tester-lycheeLinkCheck-param-lychee}</p>
<p>: The <code>lychee</code> package to use.</p>
<h2 id="tester-testVersion"><code>testVersion</code></h2>
<p>Checks that the output from running a command contains the specified version string in it as a whole word.</p>
<p>NOTE: In most cases, <a href="#versioncheckhook"><code>versionCheckHook</code></a> should be preferred, but this function is provided and documented here anyway. The motivation for adding either tests would be:</p>
<ul>
<li>Catch dynamic linking errors and such and missing environment variables that should be added by wrapping.</li>
<li>Probable protection against accidentally building the wrong version, for example when using an "old" hash in a fixed-output derivation.</li>
</ul>
<p>By default, the command to be run will be inferred from the given <code>package</code> attribute:
it will check <code>meta.mainProgram</code> first, and fall back to <code>pname</code> or <code>name</code>.
The default argument to the command is <code>--version</code>, and the version to be checked will be inferred from the given <code>package</code> attribute as well.</p>
<div class="admonition example">
<p class="admonition-title">Check a program version using all the default values</p>
<p>This example will run the command <code>hello --version</code>, and then check that the version of the <code>hello</code> package is in the output of the command.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
passthru<span class="o">.</span>tests<span class="o">.</span><span class="ss">version</span> <span class="o">=</span> testers<span class="o">.</span>testVersion <span class="p">{</span> <span class="ss">package</span> <span class="o">=</span> hello<span class="p">;</span> <span class="p">};</span>
<span class="p">}</span>
</code></pre></div>
</div>
<div class="admonition example">
<p class="admonition-title">Check the program version using a specified command and expected version string</p>
<p>This example will run the command <code>leetcode -V</code>, and then check that <code>leetcode 0.4.2</code> is in the output of the command as a whole word (separated by whitespaces).
This means that an output like "leetcode 0.4.21" would fail the tests, and an output like "You're running leetcode 0.4.2" would pass the tests.</p>
<p>A common usage of the <code>version</code> attribute is to specify <code>version = "v${version}"</code>.</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="ss">version</span> <span class="o">=</span> <span class="s2">&quot;0.4.2&quot;</span><span class="p">;</span>
passthru<span class="o">.</span>tests<span class="o">.</span><span class="ss">version</span> <span class="o">=</span> testers<span class="o">.</span>testVersion <span class="p">{</span>
<span class="ss">package</span> <span class="o">=</span> leetcode-cli<span class="p">;</span>
<span class="ss">command</span> <span class="o">=</span> <span class="s2">&quot;leetcode -V&quot;</span><span class="p">;</span>
<span class="ss">version</span> <span class="o">=</span> <span class="s2">&quot;leetcode </span><span class="si">${</span>version<span class="si">}</span><span class="s2">&quot;</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h2 id="tester-testBuildFailure"><code>testBuildFailure</code></h2>
<p>Make sure that a build does not succeed. This is useful for testing testers.</p>
<p>This returns a derivation with an override on the builder, with the following effects:</p>
<ul>
<li>Fail the build when the original builder succeeds</li>
<li>Move <code>$out</code> to <code>$out/result</code>, if it exists (assuming <code>out</code> is the default output)</li>
<li>Save the build log to <code>$out/testBuildFailure.log</code> (same)</li>
</ul>
<p>While <code>testBuildFailure</code> is designed to keep changes to the original builder's environment to a minimum, some small changes are inevitable:</p>
<ul>
<li>The file <code>$TMPDIR/testBuildFailure.log</code> is present. It should not be deleted.</li>
<li><code>stdout</code> and <code>stderr</code> are a pipe instead of a tty. This could be improved.</li>
<li>One or two extra processes are present in the sandbox during the original builder's execution.</li>
<li>The derivation and output hashes are different, but not unusual.</li>
<li>The derivation includes a dependency on <code>buildPackages.bash</code> and <code>expect-failure.sh</code>, which is built to include a transitive dependency on <code>buildPackages.coreutils</code> and possibly more.
These are not added to <code>PATH</code> or any other environment variable, so they should be hard to observe.</li>
</ul>
<div class="admonition example">
<p class="admonition-title">Check that a build fails, and verify the changes made during build</p>
<div class="highlight"><pre><span></span><code>runCommand <span class="s2">&quot;example&quot;</span> <span class="p">{</span>
<span class="ss">failed</span> <span class="o">=</span> testers<span class="o">.</span>testBuildFailure <span class="p">(</span>runCommand <span class="s2">&quot;fail&quot;</span> <span class="p">{}</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> echo ok-ish &gt;$out</span>
<span class="s s-Multiline"> echo failing though</span>
<span class="s s-Multiline"> exit 3</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">);</span>
<span class="p">}</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> grep -F &#39;ok-ish&#39; $failed/result</span>
<span class="s s-Multiline"> grep -F &#39;failing though&#39; $failed/testBuildFailure.log</span>
<span class="s s-Multiline"> [[ 3 = $(cat $failed/testBuildFailure.exit) ]]</span>
<span class="s s-Multiline"> touch $out</span>
<span class="s s-Multiline">&#39;&#39;</span>
</code></pre></div>
</div>
<h2 id="tester-testEqualContents"><code>testEqualContents</code></h2>
<p>Check that two paths have the same contents.</p>
<div class="admonition example">
<p class="admonition-title">Check that two paths have the same contents</p>
<div class="highlight"><pre><span></span><code>testers<span class="o">.</span>testEqualContents <span class="p">{</span>
<span class="ss">assertion</span> <span class="o">=</span> <span class="s2">&quot;sed -e performs replacement&quot;</span><span class="p">;</span>
<span class="ss">expected</span> <span class="o">=</span> writeText <span class="s2">&quot;expected&quot;</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> foo baz baz</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="ss">actual</span> <span class="o">=</span> runCommand <span class="s2">&quot;actual&quot;</span> <span class="p">{</span>
<span class="c1"># not really necessary for a package that&#39;s in stdenv</span>
<span class="ss">nativeBuildInputs</span> <span class="o">=</span> <span class="p">[</span> gnused <span class="p">];</span>
<span class="ss">base</span> <span class="o">=</span> writeText <span class="s2">&quot;base&quot;</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> foo bar baz</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="p">}</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> sed -e &#39;s/bar/baz/g&#39; $base &gt;$out</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h2 id="tester-testEqualDerivation"><code>testEqualDerivation</code></h2>
<p>Checks that two packages produce the exact same build instructions.</p>
<p>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.</p>
<p>When the derivations are equal, the return value is an empty file.
Otherwise, the build log explains the difference via <code>nix-diff</code>.</p>
<div class="admonition example">
<p class="admonition-title">Check that two packages produce the same derivation</p>
<div class="highlight"><pre><span></span><code>testers<span class="o">.</span>testEqualDerivation
<span class="s2">&quot;The hello package must stay the same when enabling checks.&quot;</span>
hello
<span class="p">(</span>hello<span class="o">.</span>overrideAttrs<span class="p">(</span>o<span class="p">:</span> <span class="p">{</span> <span class="ss">doCheck</span> <span class="o">=</span> <span class="no">true</span><span class="p">;</span> <span class="p">}))</span>
</code></pre></div>
</div>
<h2 id="tester-invalidateFetcherByDrvHash"><code>invalidateFetcherByDrvHash</code></h2>
<p>Use the derivation hash to invalidate the output via name, for testing.</p>
<p>Type: <code>(a@{ name, ... } -&gt; Derivation) -&gt; a -&gt; Derivation</code></p>
<p>Normally, fixed output derivations can and should be cached by their output hash only, but for testing we want to re-fetch everytime the fetcher changes.</p>
<p>Changes to the fetcher become apparent in the drvPath, which is a hash of how to fetch, rather than a fixed store path.
By inserting this hash into the name, we can make sure to re-run the fetcher every time the fetcher changes.</p>
<p>This relies on the assumption that Nix isn't clever enough to reuse its database of local store contents to optimize fetching.</p>
<p>You might notice that the "salted" name derives from the normal invocation, not the final derivation.
<code>invalidateFetcherByDrvHash</code> has to invoke the fetcher function twice:
once to get a derivation hash, and again to produce the final fixed output derivation.</p>
<div class="admonition example">
<p class="admonition-title">Prevent nix from reusing the output of a fetcher</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
tests<span class="o">.</span><span class="ss">fetchgit</span> <span class="o">=</span> testers<span class="o">.</span>invalidateFetcherByDrvHash fetchgit <span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;nix-source&quot;</span><span class="p">;</span>
<span class="ss">url</span> <span class="o">=</span> <span class="s2">&quot;https://github.com/NixOS/nix&quot;</span><span class="p">;</span>
<span class="ss">rev</span> <span class="o">=</span> <span class="s2">&quot;9d9dbe6ed05854e03811c361a3380e09183f4f4a&quot;</span><span class="p">;</span>
<span class="ss">hash</span> <span class="o">=</span> <span class="s2">&quot;sha256-7DszvbCNTjpzGRmpIVAWXk20P0/XTrWZ79KSOGLrUWY=&quot;</span><span class="p">;</span>
<span class="p">};</span>
<span class="p">}</span>
</code></pre></div>
</div>
<h2 id="tester-runNixOSTest"><code>runNixOSTest</code></h2>
<p>A helper function that behaves exactly like the NixOS <code>runTest</code>, except it also assigns this Nixpkgs package set as the <code>pkgs</code> of the test and makes the <code>nixpkgs.*</code> options read-only.</p>
<p>If your test is part of the Nixpkgs repository, or if you need a more general entrypoint, see <a href="https://nixos.org/manual/nixos/stable/index.html#sec-calling-nixos-tests">"Calling a test" in the NixOS manual</a>.</p>
<div class="admonition example">
<p class="admonition-title">Run a NixOS test using <code>runNixOSTest</code></p>
<div class="highlight"><pre><span></span><code>pkgs<span class="o">.</span>testers<span class="o">.</span>runNixOSTest <span class="p">({</span> lib<span class="p">,</span> <span class="o">...</span> <span class="p">}:</span> <span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;hello&quot;</span><span class="p">;</span>
nodes<span class="o">.</span><span class="ss">machine</span> <span class="o">=</span> <span class="p">{</span> pkgs<span class="p">,</span> <span class="o">...</span> <span class="p">}:</span> <span class="p">{</span>
environment<span class="o">.</span><span class="ss">systemPackages</span> <span class="o">=</span> <span class="p">[</span> pkgs<span class="o">.</span>hello <span class="p">];</span>
<span class="p">};</span>
<span class="ss">testScript</span> <span class="o">=</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> machine.succeed(&quot;hello&quot;)</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="p">})</span>
</code></pre></div>
</div>
<h2 id="tester-nixosTest"><code>nixosTest</code></h2>
<p>Run a NixOS VM network test using this evaluation of Nixpkgs.</p>
<p>NOTE: This function is primarily for external use. NixOS itself uses <code>make-test-python.nix</code> directly. Packages defined in Nixpkgs <a href="#ssec-nixos-tests-linking">reuse NixOS tests via <code>nixosTests</code>, plural</a>.</p>
<p>It is mostly equivalent to the function <code>import ./make-test-python.nix</code> from the <a href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">NixOS manual</a>, except that the current application of Nixpkgs (<code>pkgs</code>) will be used, instead of letting NixOS invoke Nixpkgs anew.</p>
<p>If a test machine needs to set NixOS options under <code>nixpkgs</code>, it must set only the <code>nixpkgs.pkgs</code> option.</p>
<h3 id="tester-nixosTest-parameter">Parameter</h3>
<p>A <a href="https://nixos.org/nixos/manual/index.html#sec-nixos-tests">NixOS VM test network</a>, or path to it. Example:</p>
<div class="highlight"><pre><span></span><code><span class="p">{</span>
<span class="ss">name</span> <span class="o">=</span> <span class="s2">&quot;my-test&quot;</span><span class="p">;</span>
<span class="ss">nodes</span> <span class="o">=</span> <span class="p">{</span>
<span class="ss">machine1</span> <span class="o">=</span> <span class="p">{</span> lib<span class="p">,</span> pkgs<span class="p">,</span> nodes<span class="p">,</span> <span class="o">...</span> <span class="p">}:</span> <span class="p">{</span>
environment<span class="o">.</span><span class="ss">systemPackages</span> <span class="o">=</span> <span class="p">[</span> pkgs<span class="o">.</span>hello <span class="p">];</span>
services<span class="o">.</span>foo<span class="o">.</span><span class="ss">enable</span> <span class="o">=</span> <span class="no">true</span><span class="p">;</span>
<span class="p">};</span>
<span class="c1"># machine2 = ...;</span>
<span class="p">};</span>
<span class="ss">testScript</span> <span class="o">=</span> <span class="s s-Multiline">&#39;&#39;</span>
<span class="s s-Multiline"> start_all()</span>
<span class="s s-Multiline"> machine1.wait_for_unit(&quot;foo.service&quot;)</span>
<span class="s s-Multiline"> machine1.succeed(&quot;hello | foo-send&quot;)</span>
<span class="s s-Multiline"> &#39;&#39;</span><span class="p">;</span>
<span class="p">}</span>
</code></pre></div>
<h3 id="tester-nixosTest-result">Result</h3>
<p>A derivation that runs the VM test.</p>
<p>Notable attributes:</p>
<ul>
<li>
<p><code>nodes</code>: the evaluated NixOS configurations. Useful for debugging and exploring the configuration.</p>
</li>
<li>
<p><code>driverInteractive</code>: a script that launches an interactive Python session in the context of the <code>testScript</code>.</p>
</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Licenced MIT
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://git.auxolotl.org/auxolotl/docs" target="_blank" rel="noopener" title="Aux Docs Repo" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M16.777 0a2.9 2.9 0 1 1-2.529 4.322H12.91a4.266 4.266 0 0 0-4.265 4.195v2.118a7.076 7.076 0 0 1 4.147-1.42l.118-.002h1.338a2.9 2.9 0 0 1 5.43 1.422 2.9 2.9 0 0 1-5.43 1.422H12.91a4.266 4.266 0 0 0-4.265 4.195v2.319A2.9 2.9 0 0 1 7.222 24 2.9 2.9 0 0 1 5.8 18.57V8.589a7.109 7.109 0 0 1 6.991-7.108l.118-.001h1.338A2.9 2.9 0 0 1 16.778 0ZM7.223 19.905a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Zm9.554-10.464a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.39Zm0-7.735a1.194 1.194 0 1 0 0 2.389 1.194 1.194 0 0 0 0-2.389Z"/></svg>
</a>
<a href="https://forum.aux.computer/" target="_blank" rel="noopener" title="Aux Forum" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12.103 0C18.666 0 24 5.485 24 11.997c0 6.51-5.33 11.99-11.9 11.99L0 24V11.79C0 5.28 5.532 0 12.103 0zm.116 4.563a7.395 7.395 0 0 0-6.337 3.57 7.247 7.247 0 0 0-.148 7.22L4.4 19.61l4.794-1.074a7.424 7.424 0 0 0 8.136-1.39 7.256 7.256 0 0 0 1.737-7.997 7.375 7.375 0 0 0-6.84-4.585h-.008z"/></svg>
</a>
<a href="https://wiki.auxolotl.org/" target="_blank" rel="noopener" title="Aux Wiki" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.801 13.557c.148.098.288.202.417.313 1.854 1.6 3.127 4.656 2.582 7.311-1.091-.255-5.747-1.055-7.638-3.383-.91-1.12-1.366-2.081-1.569-2.885a5.65 5.65 0 0 0 .034-.219c.089.198.197.35.313.466.24.24.521.335.766.372.304.046.594-.006.806-.068l.001.001c.05-.015.433-.116.86-.342.325-.173 2.008-.931 3.428-1.566Zm-7.384 1.435C9.156 16.597 6.6 18.939.614 18.417c.219-1.492 1.31-3.019 2.51-4.11.379-.345.906-.692 1.506-1.009.286.168.598.332.939.486 2.689 1.221 3.903 1.001 4.89.573a1.3 1.3 0 0 0 .054-.025 6.156 6.156 0 0 0-.096.66Zm4.152-.462c.38-.341.877-.916 1.383-1.559-.389-.15-.866-.371-1.319-.591-.598-.29-1.305-.283-2.073-.315a4.685 4.685 0 0 1-.804-.103c.014-.123.027-.246.038-.369.062.104.673.057.871.057.354 0 1.621.034 3.074-.574 1.452-.608 2.55-1.706 3.022-3.225.474-1.52.22-3.091-.168-3.952-.169.709-1.453 2.381-1.926 2.871-.473.489-2.381 2.296-2.972 2.921-.7.74-.688.793-1.332 1.302-.202.19-.499.402-.563.53.027-.338.039-.675.027-.997a7.653 7.653 0 0 0-.032-.523c.322-.059.567-.522.567-.861 0-.224-.106-.247-.271-.229.075-.894.382-3.923 1.254-4.281.218.109.831.068.649-.295-.182-.364-.825-.074-1.081.266-.28.374-.956 2.046-.92 4.324-.113.014-.174.033-.322.033-.171 0-.321-.04-.433-.05.034-2.275-.714-3.772-.84-4.169-.12-.375-.491-.596-.781-.596-.146 0-.272.056-.333.179-.182.363.459.417.677.308.706.321 1.156 3.519 1.254 4.277-.125-.006-.199.035-.199.233 0 .311.17.756.452.843a.442.442 0 0 0-.007.03s-.287.99-.413 2.189a4.665 4.665 0 0 1-.718-.225c-.714-.286-1.355-.583-2.019-.566-.664.018-1.366.023-1.804-.036-.438-.058-.649-.15-.649-.15s-.234.365.257 1.075c.42.607 1.055 1.047 1.644 1.18.589.134 1.972.18 2.785-.377.16-.109.317-.228.459-.34a8.717 8.717 0 0 0-.013.626c-.289.753-.571 1.993-.268 3.338 0-.001.701-.842.787-2.958.006-.144.009-.271.01-.383.052-.248.103-.518.148-.799.072.135.151.277.234.413.511.842 1.791 1.37 2.383 1.49.091.019.187.032.285.038Zm-1.12.745c-.188.055-.445.1-.713.059-.21-.031-.45-.11-.655-.316-.169-.168-.312-.419-.401-.789a9.837 9.837 0 0 0 .039-.82l.049-.243c.563.855 1.865 1.398 2.476 1.522.036.008.072.014.109.02l-.013.009c-.579.415-.76.503-.891.558Zm6.333-2.818c-.257.114-4.111 1.822-5.246 2.363.98-.775 3.017-3.59 3.699-4.774 1.062.661 1.468 1.109 1.623 1.441.101.217.09.38.096.515a.57.57 0 0 1-.172.455Zm-9.213 1.62a1.606 1.606 0 0 1-.19.096c-.954.414-2.126.61-4.728-.571-2.023-.918-3.024-2.157-3.371-2.666.476.161 1.471.473 2.157.524.282.021.703.068 1.167.125.021.209.109.486.345.829l.001.001c.451.651 1.134 1.119 1.765 1.262.622.141 2.083.182 2.942-.407a3.12 3.12 0 0 0 .132-.093l.001.179a6.052 6.052 0 0 0-.221.721Zm5.512-1.271a17.49 17.49 0 0 1-1.326-.589c.437.042 1.054.083 1.692.108-.121.162-.244.323-.366.481Zm.932-1.26c-.12.17-.245.343-.373.517-.241.018-.478.03-.709.038a29.05 29.05 0 0 1-.741-.048c.608-.065 1.228-.252 1.823-.507Zm.22-.315c-.809.382-1.679.648-2.507.648-.472 0-.833.018-1.139.039v.001c-.324-.031-.665-.039-1.019-.054a3.555 3.555 0 0 1-.152-.009c.102-.002.192-.006.249-.006.363 0 1.662.034 3.151-.589 1.508-.632 2.645-1.773 3.136-3.351.37-1.186.31-2.402.086-3.312.458-.336.86-.651 1.147-.91.501-.451.743-.733.848-.869.199.206.714.864.685 2.138-.036 1.611-.606 3.187-1.501 4.154a9.099 9.099 0 0 1-1.321 1.132 11.978 11.978 0 0 0-.644-.422l-.089-.055-.051.091c-.184.332-.5.825-.879 1.374ZM4.763 5.817c-.157 1.144.113 2.323.652 3.099.539.776 2.088 2.29 3.614 2.505.991.14 2.055.134 2.055.134s-.593-.576-1.114-1.66c-.521-1.085-.948-2.104-1.734-2.786-.785-.681-1.601-1.416-2.045-1.945-.444-.53-.59-.86-.59-.86s-.656.175-.838 1.513Zm14.301 4.549a9.162 9.162 0 0 0 1.3-1.12c.326-.352.611-.782.845-1.265 1.315.145 2.399.371 2.791.434 0 0-.679 1.971-3.945 3.022l-.016-.035c-.121-.26-.385-.594-.975-1.036Zm-11.634.859a8.537 8.537 0 0 1-.598-.224c-1.657-.693-2.91-1.944-3.449-3.678-.498-1.601-.292-3.251.091-4.269.225.544.758 1.34 1.262 2.01a3.58 3.58 0 0 0-.172.726c-.163 1.197.123 2.428.687 3.24.416.599 1.417 1.62 2.555 2.193-.128.002-.253.003-.376.002Zm-1.758-.077c-.958-.341-1.901-.787-2.697-1.368C-.07 7.559 0 6.827 0 6.827s1.558-.005 3.088.179c.03.126.065.
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../../..", "features": ["content.tooltips", "search.highlight", "navigation.tabs", "navigation.indexes", "navigation.prune"], "search": "../../../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../../assets/javascripts/bundle.fe8b6f2b.min.js"></script>
</body>
</html>