Skip to content

Commit e8baa1e

Browse files
committed
migrated regressions to run_regressions
1 parent e3ecd1c commit e8baa1e

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

development.html

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ <h2>Testing<a class="headerlink" href="#testing" title="Permalink to this headli
217217
<div class="section" id="regression-tests">
218218
<span id="index-2"></span><h3>Regression tests<a class="headerlink" href="#regression-tests" title="Permalink to this headline"></a></h3>
219219
<p>Regression tests ensure that bugs, once fixed, stay fixed. These are real-life files that at some point broke a cclib parser, and are stored in folders like <code class="docutils literal"><span class="pre">data/regression/Jaguar/Jaguar6.4</span></code>. The files associated with regression tests are not stored stored together with the source code as they are often quite large. A separate repository on github, <a class="reference external" href="https://github.com/cclib/cclib-data">cclib-data</a>, is used to track these files, and we do not distribute them with any releases.</p>
220-
<p>For every bug found in the parsers, there should be a corresponding regression test that tests this bug stays fixed. The process is automated by <a class="reference external" href="https://github.com/cclib/cclib/blob/master/test/regression.py">regression.py</a>, which runs through all of our test data, both the basic data and regression files, opens them, tries to parse, and runs any relevant regression tests defined for that file. New regression tests are added by creating a function <code class="docutils literal"><span class="pre">testMyFileName_out</span></code> according to the examples at the start of <a class="reference external" href="https://github.com/cclib/cclib/blob/master/test/regression.py">regression.py</a>.</p>
220+
<p>For every bug found in the parsers, there should be a corresponding regression test that tests this bug stays fixed. The process is automated by <a class="reference external" href="https://github.com/cclib/cclib/blob/master/test/run_regressions.py">run_regressions.py</a>, which runs through all of our test data, both the basic data and regression files, opens them, tries to parse, and runs any relevant regression tests defined for that file. New regression tests are added by creating a function <code class="docutils literal"><span class="pre">testMyFileName_out</span></code> according to the examples at the start of <a class="reference external" href="https://github.com/cclib/cclib/blob/master/test/run_regressions.py">run_regressions.py</a>.</p>
221221
</div>
222222
<div class="section" id="doctests">
223223
<h3>Doctests<a class="headerlink" href="#doctests" title="Permalink to this headline"></a></h3>
@@ -336,4 +336,5 @@ <h2>Developers<a class="headerlink" href="#developers" title="Permalink to this
336336

337337

338338
</body>
339-
</html>
339+
</html>
340+

tutorial.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ <h2>What next?<a class="headerlink" href="#what-next" title="Permalink to this h
223223
<div><ul class="simple">
224224
<li>Read the list and specifications of the <a class="reference external" href="data.html">parsed data</a> and related <a class="reference external" href="data_notes.html">data notes</a></li>
225225
<li>Test the program using the test data files included in the full source distribution</li>
226-
<li>Run the unit and regression tests in the test directory (<code class="docutils literal"><span class="pre">testall.py</span></code> and <code class="docutils literal"><span class="pre">regression.py</span></code>)</li>
226+
<li>Run the unit and regression tests in the test directory (<code class="docutils literal"><span class="pre">testall.py</span></code> and <code class="docutils literal"><span class="pre">run_regressions.py</span></code>)</li>
227227
<li>Send any questions to the cclib-users mailing list at <a class="reference external" href="https://lists.sourceforge.net/lists/listinfo/cclib-users">https://lists.sourceforge.net/lists/listinfo/cclib-users</a>.</li>
228228
<li>Write some computational chemistry algorithms using information parsed from cclib and donate the code to the project</li>
229229
</ul>
@@ -300,4 +300,4 @@ <h2>What next?<a class="headerlink" href="#what-next" title="Permalink to this h
300300

301301

302302
</body>
303-
</html>
303+
</html>

0 commit comments

Comments
 (0)