Skip to content

Commit

Permalink
Deployed 1938783 to main with MkDocs 1.5.2 and mike 1.1.2
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Aug 10, 2023
1 parent 953ed81 commit 47fdb3f
Show file tree
Hide file tree
Showing 7 changed files with 341 additions and 341 deletions.
185 changes: 185 additions & 0 deletions main/api/tests.logging/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -773,6 +773,26 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#anta.tests.logging.VerifyLoggingErrors" class="md-nav__link">
VerifyLoggingErrors
</a>

<nav class="md-nav" aria-label="VerifyLoggingErrors">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#anta.tests.logging.VerifyLoggingErrors.test" class="md-nav__link">
test()
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1560,6 +1580,26 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#anta.tests.logging.VerifyLoggingErrors" class="md-nav__link">
VerifyLoggingErrors
</a>

<nav class="md-nav" aria-label="VerifyLoggingErrors">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#anta.tests.logging.VerifyLoggingErrors.test" class="md-nav__link">
test()
</a>

</li>

</ul>
</nav>

</li>

<li class="md-nav__item">
Expand Down Expand Up @@ -1883,6 +1923,151 @@ <h3 id="anta.tests.logging.VerifyLoggingAccounting.test" class="doc doc-heading"



<h2 id="anta.tests.logging.VerifyLoggingErrors" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">VerifyLoggingErrors</span>


<a href="#anta.tests.logging.VerifyLoggingErrors" class="headerlink" title="Permanent link">&para;</a></h2>


<div class="doc doc-contents ">
<p class="doc doc-class-bases">
Bases: <code><a class="autorefs autorefs-internal" title="anta.models.AntaTest" href="../models/#anta.models.AntaTest">AntaTest</a></code></p>


<p>This test verifies there are no syslog messages with a severity of ERRORS or higher.</p>

<details class="expected-results" open>
<summary>Expected Results</summary>
<ul>
<li>success: The test will pass if there are NO syslog messages with a severity of ERRORS or higher.</li>
<li>failure: The test will fail if ERRORS or higher syslog messages are present.</li>
</ul>
</details>
<details class="quote">
<summary>Source code in <code>anta/tests/logging.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">293</span>
<span class="normal">294</span>
<span class="normal">295</span>
<span class="normal">296</span>
<span class="normal">297</span>
<span class="normal">298</span>
<span class="normal">299</span>
<span class="normal">300</span>
<span class="normal">301</span>
<span class="normal">302</span>
<span class="normal">303</span>
<span class="normal">304</span>
<span class="normal">305</span>
<span class="normal">306</span>
<span class="normal">307</span>
<span class="normal">308</span>
<span class="normal">309</span>
<span class="normal">310</span>
<span class="normal">311</span>
<span class="normal">312</span>
<span class="normal">313</span>
<span class="normal">314</span>
<span class="normal">315</span>
<span class="normal">316</span>
<span class="normal">317</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="k">class</span> <span class="nc">VerifyLoggingErrors</span><span class="p">(</span><span class="n">AntaTest</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> This test verifies there are no syslog messages with a severity of ERRORS or higher.</span>

<span class="sd"> Expected Results:</span>
<span class="sd"> * success: The test will pass if there are NO syslog messages with a severity of ERRORS or higher.</span>
<span class="sd"> * failure: The test will fail if ERRORS or higher syslog messages are present.</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="n">name</span> <span class="o">=</span> <span class="s2">&quot;VerifyLoggingWarning&quot;</span>
<span class="n">description</span> <span class="o">=</span> <span class="s2">&quot;This test verifies there are no syslog messages with a severity of ERRORS or higher.&quot;</span>
<span class="n">categories</span> <span class="o">=</span> <span class="p">[</span><span class="s2">&quot;logging&quot;</span><span class="p">]</span>
<span class="n">commands</span> <span class="o">=</span> <span class="p">[</span><span class="n">AntaCommand</span><span class="p">(</span><span class="n">command</span><span class="o">=</span><span class="s2">&quot;show logging threshold errors&quot;</span><span class="p">,</span> <span class="n">ofmt</span><span class="o">=</span><span class="s2">&quot;text&quot;</span><span class="p">)]</span>

<span class="nd">@AntaTest</span><span class="o">.</span><span class="n">anta_test</span>
<span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Run VerifyLoggingWarning validation</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">command_output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_commands</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text_output</span>

<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">command_output</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">is_success</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">is_failure</span><span class="p">(</span><span class="s2">&quot;Device has reported syslog messages with a severity of ERRORS or higher&quot;</span><span class="p">)</span>
</code></pre></div></td></tr></table></div>
</details>



<div class="doc doc-children">










<div class="doc doc-object doc-function">



<h3 id="anta.tests.logging.VerifyLoggingErrors.test" class="doc doc-heading">
<span class="doc doc-object-name doc-function-name">test</span>


<a href="#anta.tests.logging.VerifyLoggingErrors.test" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><span class="n">test</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="kc">None</span>
</code></pre></div>

<div class="doc doc-contents ">

<p>Run VerifyLoggingWarning validation</p>

<details class="quote">
<summary>Source code in <code>anta/tests/logging.py</code></summary>
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal">307</span>
<span class="normal">308</span>
<span class="normal">309</span>
<span class="normal">310</span>
<span class="normal">311</span>
<span class="normal">312</span>
<span class="normal">313</span>
<span class="normal">314</span>
<span class="normal">315</span>
<span class="normal">316</span>
<span class="normal">317</span></pre></div></td><td class="code"><div><pre><span></span><code><span class="nd">@AntaTest</span><span class="o">.</span><span class="n">anta_test</span>
<span class="k">def</span> <span class="nf">test</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Run VerifyLoggingWarning validation</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">command_output</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">instance_commands</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">text_output</span>

<span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">command_output</span><span class="p">)</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">is_success</span><span class="p">()</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">result</span><span class="o">.</span><span class="n">is_failure</span><span class="p">(</span><span class="s2">&quot;Device has reported syslog messages with a severity of ERRORS or higher&quot;</span><span class="p">)</span>
</code></pre></div></td></tr></table></div>
</details>
</div>

</div>



</div>

</div>

</div>

<div class="doc doc-object doc-class">



<h2 id="anta.tests.logging.VerifyLoggingHostname" class="doc doc-heading">
<span class="doc doc-object-name doc-class-name">VerifyLoggingHostname</span>

Expand Down
Loading

0 comments on commit 47fdb3f

Please sign in to comment.