2021-03-14 10:12:02 +03:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js light" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Tests - devos docs< / title >
2021-06-09 04:47:26 +03:00
2021-03-14 10:12:02 +03:00
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2021-06-09 04:47:26 +03:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-06-09 04:47:26 +03:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2021-03-14 10:12:02 +03:00
<!-- Fonts -->
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2021-06-09 04:47:26 +03:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2021-03-14 10:12:02 +03:00
<!-- Highlight.js Stylesheets -->
2021-04-19 06:33:12 +03:00
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
2021-03-14 10:12:02 +03:00
<!-- Custom theme stylesheets -->
2021-06-09 04:47:26 +03:00
< / head >
2021-03-14 10:12:02 +03:00
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
2021-04-19 06:33:12 +03:00
var path_to_root = "";
2021-03-14 10:12:02 +03:00
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2021-08-02 00:40:04 +03:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "../index.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "start/index.html" > < strong aria-hidden = "true" > 2.< / strong > Quick Start< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "start/iso.html" > < strong aria-hidden = "true" > 2.1.< / strong > ISO< / a > < / li > < li class = "chapter-item expanded " > < a href = "start/bootstrapping.html" > < strong aria-hidden = "true" > 2.2.< / strong > Bootstrapping< / a > < / li > < li class = "chapter-item expanded " > < a href = "start/from-nixos.html" > < strong aria-hidden = "true" > 2.3.< / strong > From NixOS< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "concepts/index.html" > < strong aria-hidden = "true" > 3.< / strong > Key Concepts< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "concepts/hosts.html" > < strong aria-hidden = "true" > 3.1.< / strong > Hosts< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/overrides.html" > < strong aria-hidden = "true" > 3.2.< / strong > Overrides< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/profiles.html" > < strong aria-hidden = "true" > 3.3.< / strong > Profiles< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/suites.html" > < strong aria-hidden = "true" > 3.4.< / strong > Suites< / a > < / li > < li class = "chapter-item expanded " > < a href = "concepts/users.html" > < strong aria-hidden = "true" > 3.5.< / strong > Users< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "outputs/index.html" > < strong aria-hidden = "true" > 4.< / strong > Outputs< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "outputs/modules.html" > < strong aria-hidden = "true" > 4.1.< / strong > Modules< / a > < / li > < li class = "chapter-item expanded " > < a href = "outputs/overlays.html" > < strong aria-hidden = "true" > 4.2.< / strong > Overlays< / a > < / li > < li class = "chapter-item expanded " > < a href = "outputs/pkgs.html" > < strong aria-hidden = "true" > 4.3.< / strong > Packages< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < div > < strong aria-hidden = "true" > 5.< / strong > Concerns< / div > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "secrets.html" > < strong aria-hidden = "true" > 5.1.< / strong > Secrets< / a > < / li > < li class = "chapter-item expanded " > < a href = "tests.html" class = "active" > < strong aria-hidden = "true" > 5.2.< / strong > Tests< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "bud/index.html" > < strong aria-hidden = "true" > 6.< / strong > Helper Script – < / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "bud/get.html" > < strong aria-hidden = "true" > 6.1.< / strong > get< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "integrations/index.html" > < strong aria-hidden = "true" > 7.< / strong > Integrations< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "integrations/cachix.html" > < strong aria-hidden = "true" > 7.1.< / strong > Cachix< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/deploy.html" > < strong aria-hidden = "true" > 7.2.< / strong > Deploy RS< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/nvfetcher.html" > < strong aria-hidden = "true" > 7.3.< / strong > NvFetcher< / a > < / li > < li class = "chapter-item expanded " > < a href = "integrations/hercules.html" > < strong aria-hidden = "true" > 7.4.< / strong > Hercules CI< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "CONTRIBUTING.html" > < strong aria-hidden = "true" > 8.< / strong > Contributing< / a > < / li > < / ol > < / div >
2021-03-14 10:12:02 +03:00
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
2021-06-09 04:47:26 +03:00
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
2021-03-14 10:12:02 +03:00
< i class = "fa fa-search" > < / i >
< / button >
2021-06-09 04:47:26 +03:00
< / div >
2021-03-14 10:12:02 +03:00
< h1 class = "menu-title" > devos docs< / h1 >
< div class = "right-buttons" >
2021-06-09 04:47:26 +03:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2021-03-14 10:12:02 +03:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2021-06-09 04:47:26 +03:00
2021-03-14 10:12:02 +03:00
< / div >
< / div >
2021-06-09 04:47:26 +03:00
< div id = "search-wrapper" class = "hidden" >
2021-03-14 10:12:02 +03:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-05-15 07:26:00 +03:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2021-03-14 10:12:02 +03:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2021-04-19 06:33:12 +03:00
< h1 id = "testing" > < a class = "header" href = "#testing" > Testing< / a > < / h1 >
< p > Testing is always an important aspect of any software development project, and
NixOS offers some incredibly powerful tools to write tests for your
configuration, and, optionally, run them in
< a href = "./integrations/hercules.html" > CI< / a > .< / p >
< h2 id = "unit-tests" > < a class = "header" href = "#unit-tests" > Unit Tests< / a > < / h2 >
2021-06-09 04:47:26 +03:00
< p > Unit tests can be created from regular derivations, and they can do
2021-04-19 06:33:12 +03:00
almost anything you can imagine. By convention, it is best to test your
packages during their < a href = "https://nixos.org/manual/nixpkgs/stable/#ssec-check-phase" > check phase< / a > . All packages and their tests will
be built during CI.< / p >
< h2 id = "integration-tests" > < a class = "header" href = "#integration-tests" > Integration Tests< / a > < / h2 >
2021-06-09 04:47:26 +03:00
< p > All your profiles defined in suites will be tested in a NixOS VM.< / p >
2021-04-19 06:33:12 +03:00
< p > You can write integration tests for one or more NixOS VMs that can,
optionally, be networked together, and yes, it's as awesome as it sounds!< / p >
2021-06-09 04:47:26 +03:00
< p > Be sure to use the < code > mkTest< / code > function from digga, < code > digga.lib.pkgs-lib.mkTest< / code >
2021-04-19 06:33:12 +03:00
which wraps the official < a href = "https://github.com/NixOS/nixpkgs/tree/master/nixos/lib/testing-python.nix" > testing-python< / a > function to ensure
that the system is setup exactly as it is for a bare DevOS system. There are
already great resources for learning how to use these tests effectively,
including the official < a href = "https://nixos.org/manual/nixos/stable/index.html#sec-nixos-tests" > docs< / a > , a fantastic < a href = "https://www.haskellforall.com/2020/11/how-to-use-nixos-for-lightweight.html" > blog post< / a > ,
and the examples in < a href = "https://github.com/NixOS/nixpkgs/tree/master/nixos/tests" > nixpkgs< / a > .< / p >
2021-03-14 10:12:02 +03:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2021-06-09 04:47:26 +03:00
< a rel = "prev" href = "secrets.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-03-14 10:12:02 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-08-02 00:40:04 +03:00
< a rel = "next" href = "bud/index.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-03-14 10:12:02 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2021-06-09 04:47:26 +03:00
< a rel = "prev" href = "secrets.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
2021-03-14 10:12:02 +03:00
< i class = "fa fa-angle-left" > < / i >
< / a >
2021-08-02 00:40:04 +03:00
< a rel = "next" href = "bud/index.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-03-14 10:12:02 +03:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-06-09 04:47:26 +03:00
< / nav >
2021-03-14 10:12:02 +03:00
< / div >
2021-06-09 04:47:26 +03:00
< script type = "text/javascript" >
2021-03-14 10:12:02 +03:00
window.playground_copyable = true;
< / script >
2021-06-09 04:47:26 +03:00
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-04-19 06:33:12 +03:00
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-03-14 10:12:02 +03:00
2021-04-19 06:33:12 +03:00
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-03-14 10:12:02 +03:00
<!-- Custom JS scripts -->
< / body >
< / html >
