Deploying to main from @ pyocd/pyocd-website-source@596083b 🚀

Author: pyocd-bot

docs/automated_tests.html

@@ -212,11 +212,11 @@ <h1 class="mb-4 mt-0">Automated tests</h1>
                     <div class="sidebar docs-sidebar-2 p-4">
                         <h5 class="sidebar-header">On this page</h5>
                         <ul id="toc" class="section-nav">
+<li class="toc-entry toc-h2"><a href="#test-setup">Test Setup</a></li>
 <li class="toc-entry toc-h2"><a href="#unit-tests">Unit tests</a></li>
 <li class="toc-entry toc-h2"><a href="#functional-tests">Functional tests</a></li>
 <li class="toc-entry toc-h2"><a href="#azure-pipelines">Azure Pipelines</a></li>
 <li class="toc-entry toc-h2"><a href="#testing-with-tox">Testing with tox</a></li>
-<li class="toc-entry toc-h2"><a href="#test-setup">Test Setup</a></li>
 </ul>
                     </div>
                   </div>
@@ -228,6 +228,29 @@ <h5 class="sidebar-header">On this page</h5>
 but those tests will be skipped if no probe is present. In contrast, all functional tests require
 at least one probe to be connected.</p>
 
+<h2 id="test-setup">Test Setup</h2>
+
+<p>For test setup it is good practice to create a virtualenv in the repos root subdirectory.  Otherwise expect weird
+behavior during tests.</p>
+
+<div class="language-bash highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>python <span class="nt">-mvenv</span> <span class="nt">--upgrade-deps</span> .venv
+<span class="nv">$ </span><span class="nb">source</span> .venv/bin/activate
+<span class="nv">$ </span>pip <span class="nb">install</span> <span class="nt">-e</span> .[test]
+<span class="nv">$ </span>pytest
+</code></pre></div></div>
+
+<p>To make the tests pick the correct setup, a <a href="configuration.md"><code class="highlighter-rouge">pyocd.yaml</code> configuration file</a> has to be used.
+For functional testing the file should contain a reference to a <code class="highlighter-rouge">test_binary</code> from <code class="highlighter-rouge">test/data/binaries</code>.</p>
+
+<p>Example config file:</p>
+
+<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">probes</span><span class="pi">:</span>
+  <span class="na">E6614103E7176A23</span><span class="pi">:</span> <span class="c1"># Probe's unique ID.</span>
+    <span class="na">target_override</span><span class="pi">:</span>  <span class="s">nrf52</span>
+    <span class="na">test_binary</span><span class="pi">:</span>      <span class="s">l1_nrf52840-dk.bin</span>
+    <span class="na">frequency</span><span class="pi">:</span>        <span class="m">6000000</span>
+</code></pre></div></div>
+
 <h2 id="unit-tests">Unit tests</h2>
 
 <p>The unit tests are located in the <code class="highlighter-rouge">tests/unit</code> directory of the repo. They must be executed using
@@ -298,20 +321,6 @@ <h2 id="testing-with-tox">Testing with tox</h2>
 
 <p>Currently only the functions tests are included in the tox configuration.</p>
 
-<h2 id="test-setup">Test Setup</h2>
-
-<p>To make the tests pick the correct setup, a <a href="configuration.md"><code class="highlighter-rouge">pyocd.yaml</code> configuration file</a> has to be used.
-For functional testing the file should contain a reference to a <code class="highlighter-rouge">test_binary</code> from <code class="highlighter-rouge">test/data/binaries</code>.</p>
-
-<p>Example config file:</p>
-
-<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">probes</span><span class="pi">:</span>
-  <span class="na">E6614103E7176A23</span><span class="pi">:</span> <span class="c1"># Probe's unique ID.</span>
-    <span class="na">target_override</span><span class="pi">:</span>  <span class="s">nrf52</span>
-    <span class="na">test_binary</span><span class="pi">:</span>      <span class="s">l1_nrf52840-dk.bin</span>
-    <span class="na">frequency</span><span class="pi">:</span>        <span class="m">6000000</span>
-</code></pre></div></div>
-
 
                 </div>
               </div>