<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>TESTING.md - fork/eza @ main</title>
<meta name="description" content="TESTING.md in fork/eza at main.">
<meta property="og:title" content="TESTING.md - fork/eza @ main">
<meta property="og:description" content="TESTING.md in fork/eza at main.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="main" data-tip="8fbaca892254d78a1944b40b2dbc72ce18e6a27d">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/eza</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/eza</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">MartinFillon</span><span class="commit-message" data-commit="7edce99d810bb0448d7bbb810c51336bd02e816b">docs: adding a testing infos file to guide everyone through tests</span><span class="snapshot-sha sha" data-commit="7edce99d810bb0448d7bbb810c51336bd02e816b">7edce99d</span><time datetime="2024-05-06T17:59:25+02:00" title="2024-05-06 17:59:25 +0200">2024-05-06</time></p>
<header class="topbar"><details class="switcher"><summary>main</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/eza/ref/main/">main</a><strong>tags</strong><a href="/fork/eza/ref/v0.14.1/">v0.14.1</a><a href="/fork/eza/ref/v0.14.2/">v0.14.2</a><a href="/fork/eza/ref/v0.15.0/">v0.15.0</a><a href="/fork/eza/ref/v0.15.1/">v0.15.1</a><a href="/fork/eza/ref/v0.15.2/">v0.15.2</a><a href="/fork/eza/ref/v0.15.3/">v0.15.3</a><a href="/fork/eza/ref/v0.16.0/">v0.16.0</a><a href="/fork/eza/ref/v0.16.1/">v0.16.1</a><a class="all" href="/fork/eza/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/eza/">eza</a> / <span class="cur">TESTING.md</span></nav>
<span class="view-stats"><span>956 B</span><span>34 lines</span></span><span class="actions"><a class="raw" href="/fork/eza/raw/db0faa5afdb26334cf05108c46480af85718dc18/TESTING.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!--
SPDX-FileCopyrightText: 2024 Christina Sørensen, Martin Fillon
SPDX-FileContributor: Christina Sørensen

SPDX-License-Identifier: EUPL-1.2
--&gt;
<h1>Testing eza</h1>
<h2>Running tests</h2>
<p>In order to run the tests in eza you need:</p>
<ul>
<li><a href="https://github.com/casey/just">just</a></li>
<li><a href="https://nixos.org">nix</a></li>
</ul>
<p>then either run:</p>
<ul>
<li><code>just itest</code></li>
<li><code>nix build -L trycmd-local</code></li>
</ul>
<h2>Modifying tests</h2>
<p>In order to test your changes on eza, you will need to do one or multiple things in different cases.
You will need the additional tool</p>
<ul>
<li><a href="https://github.com/eza-community/powertest">powertest</a></li>
</ul>
<p>You will also need to modify the <code>devtools/dir-generator.sh</code> file if you want to add some test cases</p>
<h3>You added/modified an option</h3>
<p>Please run <code>just regen</code> to regenerate powertesting. Then look into <code>tests/gen</code> or <code>tests/cmd</code> for any tests not passing</p>
<h3>You changed the output of eza</h3>
<p>Please run <code>nix build -L trydump</code> or <code>just idump</code>
And lookout for any test no longer passing</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!--</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-p>SPDX-FileCopyrightText: 2024 Christina Sørensen, Martin Fillon</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"><a-p>SPDX-FileContributor: Christina Sørensen</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>SPDX-License-Identifier: EUPL-1.2</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>--&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p># </a-p><a-tt>Testing eza</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>## </a-p><a-tt>Running tests</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>In order to run the tests in eza you need:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>- [just](https://github.com/casey/just)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>- [nix](https://nixos.org)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>then either run:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>- `just itest`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>- `nix build -L trycmd-local`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>## </a-p><a-tt>Modifying tests</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>In order to test your changes on eza, you will need to do one or multiple things in different cases.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>You will need the additional tool</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>- [powertest](https://github.com/eza-community/powertest)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>You will also need to modify the `devtools/dir-generator.sh` file if you want to add some test cases</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>### </a-p><a-tt>You added/modified an option</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>Please run `just regen` to regenerate powertesting. Then look into `tests/gen` or `tests/cmd` for any tests not passing</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>### </a-p><a-tt>You changed the output of eza</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text">Please run `nix build -L trydump` or `just idump`</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text">And lookout for any test no longer passing</span></span></pre></div></div>
</main>
</body>
</html>
