Skip to content

Commit

Permalink
deploy: 605f311
Browse files Browse the repository at this point in the history
  • Loading branch information
dottorblaster committed Aug 19, 2024
1 parent 16c0686 commit 614b79e
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
6 changes: 3 additions & 3 deletions Wanda.DataCase.html
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,9 @@ <h1 class="signature" translate="no">errors_on(changeset)</h1>

<section class="docstring">

<p>A helper that transforms changeset errors into a map of messages.</p><pre><code class="makeup elixir" translate="no"><span class="n">assert</span><span class="w"> </span><span class="p" data-group-id="0180192818-1">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="n">changeset</span><span class="p" data-group-id="0180192818-1">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Accounts</span><span class="o">.</span><span class="n">create_user</span><span class="p" data-group-id="0180192818-2">(</span><span class="p" data-group-id="0180192818-3">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;short&quot;</span><span class="p" data-group-id="0180192818-3">}</span><span class="p" data-group-id="0180192818-2">)</span><span class="w">
</span><span class="n">assert</span><span class="w"> </span><span class="s">&quot;password is too short&quot;</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">errors_on</span><span class="p" data-group-id="0180192818-4">(</span><span class="n">changeset</span><span class="p" data-group-id="0180192818-4">)</span><span class="o">.</span><span class="n">password</span><span class="w">
</span><span class="n">assert</span><span class="w"> </span><span class="p" data-group-id="0180192818-5">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0180192818-6">[</span><span class="s">&quot;password is too short&quot;</span><span class="p" data-group-id="0180192818-6">]</span><span class="p" data-group-id="0180192818-5">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">errors_on</span><span class="p" data-group-id="0180192818-7">(</span><span class="n">changeset</span><span class="p" data-group-id="0180192818-7">)</span></code></pre>
<p>A helper that transforms changeset errors into a map of messages.</p><pre><code class="makeup elixir" translate="no"><span class="n">assert</span><span class="w"> </span><span class="p" data-group-id="6273934814-1">{</span><span class="ss">:error</span><span class="p">,</span><span class="w"> </span><span class="n">changeset</span><span class="p" data-group-id="6273934814-1">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nc">Accounts</span><span class="o">.</span><span class="n">create_user</span><span class="p" data-group-id="6273934814-2">(</span><span class="p" data-group-id="6273934814-3">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;short&quot;</span><span class="p" data-group-id="6273934814-3">}</span><span class="p" data-group-id="6273934814-2">)</span><span class="w">
</span><span class="n">assert</span><span class="w"> </span><span class="s">&quot;password is too short&quot;</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">errors_on</span><span class="p" data-group-id="6273934814-4">(</span><span class="n">changeset</span><span class="p" data-group-id="6273934814-4">)</span><span class="o">.</span><span class="n">password</span><span class="w">
</span><span class="n">assert</span><span class="w"> </span><span class="p" data-group-id="6273934814-5">%{</span><span class="ss">password</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6273934814-6">[</span><span class="s">&quot;password is too short&quot;</span><span class="p" data-group-id="6273934814-6">]</span><span class="p" data-group-id="6273934814-5">}</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">errors_on</span><span class="p" data-group-id="6273934814-7">(</span><span class="n">changeset</span><span class="p" data-group-id="6273934814-7">)</span></code></pre>
</section>
</section>
<section class="detail" id="setup_sandbox/1">
Expand Down
Binary file modified Wanda.epub
Binary file not shown.
2 changes: 1 addition & 1 deletion gatherers.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h2 id="introduction" class="section-heading">
</a>
<span class="text">Introduction</span>
</h2>
<p>Gatherers can be thought of as functions:</p><ul><li>they have a name</li><li>they accept argument(s)</li><li>they return a value, the gathered <a href="specification.html#facts">Fact</a></li></ul><p>Facts Gathering process in a nutshell</p><pre><code class="makeup elixir" translate="no"><span class="n">fact</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gatherer</span><span class="p" data-group-id="8288596042-1">(</span><span class="n">argument</span><span class="p" data-group-id="8288596042-1">)</span></code></pre><h2 id="gatherers-versioning" class="section-heading">
<p>Gatherers can be thought of as functions:</p><ul><li>they have a name</li><li>they accept argument(s)</li><li>they return a value, the gathered <a href="specification.html#facts">Fact</a></li></ul><p>Facts Gathering process in a nutshell</p><pre><code class="makeup elixir" translate="no"><span class="n">fact</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">gatherer</span><span class="p" data-group-id="1807057726-1">(</span><span class="n">argument</span><span class="p" data-group-id="1807057726-1">)</span></code></pre><h2 id="gatherers-versioning" class="section-heading">
<a href="#gatherers-versioning" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
Expand Down
2 changes: 1 addition & 1 deletion hack_on_wanda.html
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ <h2 id="requirements" class="section-heading">
</a>
<span class="text">Ensure Compatibility with asdf</span>
</h3>
<p><a href="https://asdf-vm.com/guide/introduction.html">asdf</a> allows using specific versions of programming language tools that are known to be compatible with the project, rather than relying on the version that's installed globally on the host system.</p><p>In order to use asdf, follow the official <a href="https://asdf-vm.com/guide/getting-started.html">asdf getting started guide</a>.</p><p>Install all required asdf plugins from <a href="/.tool-versions">.tool-versions</a> inside the web repository.</p><pre><code class="makeup elixir" translate="no"><span class="n">cut</span><span class="w"> </span><span class="o">-</span><span class="n">d</span><span class="sc">&#39; &#39;</span><span class="w"> </span><span class="o">-</span><span class="n">f1</span><span class="w"> </span><span class="o">.</span><span class="n">tool</span><span class="o">-</span><span class="n">versions</span><span class="o">|</span><span class="n">xargs</span><span class="w"> </span><span class="o">-</span><span class="n">i</span><span class="w"> </span><span class="n">asdf</span><span class="w"> </span><span class="n">plugin</span><span class="w"> </span><span class="n">add</span><span class="w"> </span><span class="p" data-group-id="7513489172-1">{</span><span class="p" data-group-id="7513489172-1">}</span></code></pre><p>Set up the asdf environment</p><pre><code class="makeup elixir" translate="no"><span class="n">asdf</span><span class="w"> </span><span class="n">install</span></code></pre><h2 id="development-environment" class="section-heading">
<p><a href="https://asdf-vm.com/guide/introduction.html">asdf</a> allows using specific versions of programming language tools that are known to be compatible with the project, rather than relying on the version that's installed globally on the host system.</p><p>In order to use asdf, follow the official <a href="https://asdf-vm.com/guide/getting-started.html">asdf getting started guide</a>.</p><p>Install all required asdf plugins from <a href="/.tool-versions">.tool-versions</a> inside the web repository.</p><pre><code class="makeup elixir" translate="no"><span class="n">cut</span><span class="w"> </span><span class="o">-</span><span class="n">d</span><span class="sc">&#39; &#39;</span><span class="w"> </span><span class="o">-</span><span class="n">f1</span><span class="w"> </span><span class="o">.</span><span class="n">tool</span><span class="o">-</span><span class="n">versions</span><span class="o">|</span><span class="n">xargs</span><span class="w"> </span><span class="o">-</span><span class="n">i</span><span class="w"> </span><span class="n">asdf</span><span class="w"> </span><span class="n">plugin</span><span class="w"> </span><span class="n">add</span><span class="w"> </span><span class="p" data-group-id="7743555722-1">{</span><span class="p" data-group-id="7743555722-1">}</span></code></pre><p>Set up the asdf environment</p><pre><code class="makeup elixir" translate="no"><span class="n">asdf</span><span class="w"> </span><span class="n">install</span></code></pre><h2 id="development-environment" class="section-heading">
<a href="#development-environment" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
Expand Down
8 changes: 4 additions & 4 deletions readme.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,14 +267,14 @@ <h1>
</h3>
<p>Often times knowing the returned value of the gathered facts is not a trivial thing, more during the implementation of new checks.</p><p>To better debug the fact gathering process and the returned values, the <code class="inline">facts</code> subcommand of <code class="inline">trento-agent</code> is a really useful tool. This command helps to see in the target itself what the gathered fact looks like. This is specially interesting when the returned value is a complex object or the target under test is modified and the check developer wants to see how this affects the gathered fact.</p><p>The command can be used as:</p><pre><code class="makeup elixir" translate="no"><span class="o">.</span><span class="o">/</span><span class="n">trento</span><span class="o">-</span><span class="n">agent</span><span class="w"> </span><span class="n">facts</span><span class="w"> </span><span class="n">gather</span><span class="w"> </span><span class="o">--</span><span class="n">gatherer</span><span class="w"> </span><span class="n">corosync</span><span class="o">.</span><span class="n">conf</span><span class="w"> </span><span class="o">--</span><span class="n">argument</span><span class="w"> </span><span class="n">totem</span><span class="o">.</span><span class="n">token</span><span class="w">
</span><span class="c1"># To see the currently available gatherers and their names</span><span class="w">
</span><span class="c1"># ./trento-agent facts list</span></code></pre><p>Which would return the next where the <code class="inline">Value</code> is the available value in the written check:</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="6032943757-1">{</span><span class="w">
</span><span class="c1"># ./trento-agent facts list</span></code></pre><p>Which would return the next where the <code class="inline">Value</code> is the available value in the written check:</p><pre><code class="makeup elixir" translate="no"><span class="p" data-group-id="0110037378-1">{</span><span class="w">
</span><span class="ss">&quot;Name&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;totem.token&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">&quot;CheckID&quot;</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;&quot;</span><span class="p">,</span><span class="w">
</span><span class="ss">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="6032943757-2">{</span><span class="w">
</span><span class="ss">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="p" data-group-id="0110037378-2">{</span><span class="w">
</span><span class="ss">&quot;Value&quot;</span><span class="p">:</span><span class="w"> </span><span class="mi">30000</span><span class="w">
</span><span class="p" data-group-id="6032943757-2">}</span><span class="p">,</span><span class="w">
</span><span class="p" data-group-id="0110037378-2">}</span><span class="p">,</span><span class="w">
</span><span class="ss">&quot;Error&quot;</span><span class="p">:</span><span class="w"> </span><span class="n">null</span><span class="w">
</span><span class="p" data-group-id="6032943757-1">}</span></code></pre><h2 id="adding-new-checks" class="section-heading">
</span><span class="p" data-group-id="0110037378-1">}</span></code></pre><h2 id="adding-new-checks" class="section-heading">
<a href="#adding-new-checks" class="hover-link">
<i class="ri-link-m" aria-hidden="true"></i>
</a>
Expand Down
6 changes: 3 additions & 3 deletions specification.html
Original file line number Diff line number Diff line change
Expand Up @@ -516,12 +516,12 @@ <h1>
</span><span class="o">-</span><span class="w"> </span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="n">bar_expectation</span><span class="w">
</span><span class="ss">expect</span><span class="p">:</span><span class="w"> </span><span class="n">facts</span><span class="o">.</span><span class="n">bar</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">values</span><span class="o">.</span><span class="n">expected_bar</span></code></pre></li><li><p>Pipe the expression language functions vertically in order to provide a better visual output of the code.<br/>So this:</p><pre><code class="makeup elixir" translate="no"><span class="ss">expectations</span><span class="p">:</span><span class="w">
</span><span class="o">-</span><span class="w"> </span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="n">some_expectation</span><span class="w">
</span><span class="ss">expect</span><span class="p">:</span><span class="w"> </span><span class="n">facts</span><span class="o">.</span><span class="n">foo</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="1801624957-1">(</span><span class="o">|</span><span class="n">item</span><span class="o">|</span><span class="w"> </span><span class="n">item</span><span class="o">.</span><span class="n">id</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;super&quot;</span><span class="p" data-group-id="1801624957-1">)</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="1801624957-2">(</span><span class="o">|</span><span class="n">prop</span><span class="o">|</span><span class="w"> </span><span class="n">prop</span><span class="o">.</span><span class="n">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;good&quot;</span><span class="p" data-group-id="1801624957-2">)</span><span class="o">.</span><span class="n">value</span></code></pre><p>would be:</p><pre><code class="makeup elixir" translate="no"><span class="ss">expectations</span><span class="p">:</span><span class="w">
</span><span class="ss">expect</span><span class="p">:</span><span class="w"> </span><span class="n">facts</span><span class="o">.</span><span class="n">foo</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="0014262101-1">(</span><span class="o">|</span><span class="n">item</span><span class="o">|</span><span class="w"> </span><span class="n">item</span><span class="o">.</span><span class="n">id</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;super&quot;</span><span class="p" data-group-id="0014262101-1">)</span><span class="o">.</span><span class="n">properties</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="0014262101-2">(</span><span class="o">|</span><span class="n">prop</span><span class="o">|</span><span class="w"> </span><span class="n">prop</span><span class="o">.</span><span class="n">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;good&quot;</span><span class="p" data-group-id="0014262101-2">)</span><span class="o">.</span><span class="n">value</span></code></pre><p>would be:</p><pre><code class="makeup elixir" translate="no"><span class="ss">expectations</span><span class="p">:</span><span class="w">
</span><span class="o">-</span><span class="w"> </span><span class="ss">name</span><span class="p">:</span><span class="w"> </span><span class="n">some_expectation</span><span class="w">
</span><span class="ss">expect</span><span class="p">:</span><span class="w"> </span><span class="o">|</span><span class="w">
</span><span class="n">facts</span><span class="o">.</span><span class="n">foo</span><span class="w">
</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="2174865201-1">(</span><span class="o">|</span><span class="n">item</span><span class="o">|</span><span class="w"> </span><span class="n">item</span><span class="o">.</span><span class="n">id</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;super&quot;</span><span class="p" data-group-id="2174865201-1">)</span><span class="o">.</span><span class="n">properties</span><span class="w">
</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="2174865201-2">(</span><span class="o">|</span><span class="n">prop</span><span class="o">|</span><span class="w"> </span><span class="n">prop</span><span class="o">.</span><span class="n">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;good&quot;</span><span class="p" data-group-id="2174865201-2">)</span><span class="o">.</span><span class="n">value</span></code></pre><blockquote><p>Note: Keep in mind that some functions such as <code class="inline">sort</code> and <code class="inline">drain</code> run in-place modifications, so they cannot be piped.</p></blockquote></li></ul>
</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="8370090944-1">(</span><span class="o">|</span><span class="n">item</span><span class="o">|</span><span class="w"> </span><span class="n">item</span><span class="o">.</span><span class="n">id</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;super&quot;</span><span class="p" data-group-id="8370090944-1">)</span><span class="o">.</span><span class="n">properties</span><span class="w">
</span><span class="o">.</span><span class="n">find</span><span class="p" data-group-id="8370090944-2">(</span><span class="o">|</span><span class="n">prop</span><span class="o">|</span><span class="w"> </span><span class="n">prop</span><span class="o">.</span><span class="n">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="s">&quot;good&quot;</span><span class="p" data-group-id="8370090944-2">)</span><span class="o">.</span><span class="n">value</span></code></pre><blockquote><p>Note: Keep in mind that some functions such as <code class="inline">sort</code> and <code class="inline">drain</code> run in-place modifications, so they cannot be piped.</p></blockquote></li></ul>
</div>

<div class="bottom-actions" id="bottom-actions">
Expand Down

0 comments on commit 614b79e

Please sign in to comment.