Skip to content

Commit c78881b

Browse files
agilmordannyauble
authored andcommitted
Docs - Remove DejaGNU from documentation
Also mention the Pytests where it was missing. Bug 15606
1 parent 28415f1 commit c78881b

File tree

3 files changed

+20
-19
lines changed

3 files changed

+20
-19
lines changed

README.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ SOURCE DISTRIBUTION HIERARCHY
3030
The top-level distribution directory contains this README as well as
3131
other high-level documentation files, and the scripts used to configure
3232
and build Slurm (see INSTALL). Subdirectories contain the source-code
33-
for Slurm as well as a DejaGNU test suite and further documentation. A
33+
for Slurm as well as a test suite and further documentation. A
3434
quick description of the subdirectories of the Slurm distribution follows:
3535

3636
src/ [ Slurm source ]
@@ -51,9 +51,8 @@ quick description of the subdirectories of the Slurm distribution follows:
5151
and slurm_errno.h, needed for compiling against the Slurm API.
5252

5353
testsuite/ [ Slurm test suite ]
54-
The testsuite directory contains the framework for a set of
55-
DejaGNU and "make check" type tests for Slurm components.
56-
There is also an extensive collection of Expect scripts.
54+
The testsuite directory contains an extensive collection of tests written
55+
for Check, Expect and Pytest.
5756

5857
auxdir/ [ autotools directory ]
5958
Directory for autotools scripts and files used to configure and

doc/html/programmer_guide.shtml

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,8 +72,7 @@ All of the top-level subdirectories are described below.</p>
7272
these header files in this location makes for better code portability.<br>
7373
<b>src</b> &mdash; Contains all source code and header files not in the "slurm" subdirectory
7474
described above.<br>
75-
<b>testsuite</b> &mdash; DejaGnu and Expect are used for testing all of its files
76-
are here.</p>
75+
<b>testsuite</b> &mdash; Check, Expect and Pytest tests are here.</p>
7776

7877

7978
<h2 id="Documentation">Documentation
@@ -195,14 +194,18 @@ Slurm daemon(s) should execute on any node based upon the configuration file con
195194
It will also manage these daemons: starting, signaling, restarting, and stopping them.</p>
196195

197196
<h2 id="Test-Suite">Test Suite<a class="slurm_link" href="#Test-Suite"></a></h2>
198-
<p>The <b>testsuite</b> files use a DejaGnu framework for testing. These tests
199-
are very limited in scope.</p>
197+
<p>The <b>testsuite</b> files use Check, Expect and Pytest for testing Slurm in
198+
differents ways.</p>
199+
200+
<p>The Check tests are designed to unit test C code. Only with
201+
<i>make check</i>, without Slurm installed, they will validate that key C
202+
functions work correctly.</p>
200203

201204
<p>We also have a set of Expect Slurm tests available under the <b>testsuite/expect</b>
202205
directory. These tests are executed after Slurm has been installed
203-
and the daemons initiated. About 400 test scripts exercise all Slurm commands
206+
and the daemons initiated. These tests exercise all Slurm commands
204207
and options including stress tests. The file <b>testsuite/expect/globals</b>
205-
contains default paths and procedures for all of the individual tests. At
208+
contains the Expect test framewrok for all of the individual tests. At
206209
the very least, you will need to set the <i>slurm_dir</i> variable to the correct
207210
value. To avoid conflicts with other developers, you can override variable settings
208211
in a separate file named <b>testsuite/expect/globals.local</b>.</p>
@@ -214,6 +217,10 @@ or the full test suite may be executed with the single command
214217
<i>regression.py</i>.
215218
See <b>testsuite/expect/README</b> for more information.</p>
216219

220+
<p>Slurm also has a Pytest environment that can work like the Expect one, but it
221+
also works together with an external QA framework to improve the overall QA
222+
of Slurm.</p>
223+
217224
<h2 id="Adding-Files-and-Directories">Adding Files and Directories
218225
<a class="slurm_link" href="#Adding-Files-and-Directories"></a>
219226
</h2>

testsuite/slurm_unit/README

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
1-
Deja Gnu Unit Tests
1+
Unit Tests
22

3-
1. These tests execute only when Slurm is built directly in the source
4-
directory, not when a separate build directory is used.
5-
2. Ensure the "expect", "dejagnu" and "check" packages are installed.
6-
3. From the top level source directory, execute "make check", which builds
7-
the executable files including various src/common/*.o files that will be
8-
unit tested.
9-
3. Change working directory to "testsuite/slurm_unit".
10-
4. Execute "make check" to execute the unit tests.
3+
1. Ensure that "check" package is installed.
4+
2. From the top level build directory, execute "make check", which builds
5+
and executes unit tests with Check.

0 commit comments

Comments
 (0)