Skip to content

Commit

Permalink
Docs - Remove DejaGNU from documentation
Browse files Browse the repository at this point in the history
Also mention the Pytests where it was missing.

Bug 15606
  • Loading branch information
agilmor authored and dannyauble committed Dec 19, 2022
1 parent 28415f1 commit c78881b
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 19 deletions.
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ SOURCE DISTRIBUTION HIERARCHY
The top-level distribution directory contains this README as well as
other high-level documentation files, and the scripts used to configure
and build Slurm (see INSTALL). Subdirectories contain the source-code
for Slurm as well as a DejaGNU test suite and further documentation. A
for Slurm as well as a test suite and further documentation. A
quick description of the subdirectories of the Slurm distribution follows:

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

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

auxdir/ [ autotools directory ]
Directory for autotools scripts and files used to configure and
Expand Down
19 changes: 13 additions & 6 deletions doc/html/programmer_guide.shtml
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,7 @@ All of the top-level subdirectories are described below.</p>
these header files in this location makes for better code portability.<br>
<b>src</b> &mdash; Contains all source code and header files not in the "slurm" subdirectory
described above.<br>
<b>testsuite</b> &mdash; DejaGnu and Expect are used for testing all of its files
are here.</p>
<b>testsuite</b> &mdash; Check, Expect and Pytest tests are here.</p>


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

<h2 id="Test-Suite">Test Suite<a class="slurm_link" href="#Test-Suite"></a></h2>
<p>The <b>testsuite</b> files use a DejaGnu framework for testing. These tests
are very limited in scope.</p>
<p>The <b>testsuite</b> files use Check, Expect and Pytest for testing Slurm in
differents ways.</p>

<p>The Check tests are designed to unit test C code. Only with
<i>make check</i>, without Slurm installed, they will validate that key C
functions work correctly.</p>

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

<p>Slurm also has a Pytest environment that can work like the Expect one, but it
also works together with an external QA framework to improve the overall QA
of Slurm.</p>

<h2 id="Adding-Files-and-Directories">Adding Files and Directories
<a class="slurm_link" href="#Adding-Files-and-Directories"></a>
</h2>
Expand Down
13 changes: 4 additions & 9 deletions testsuite/slurm_unit/README
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
Deja Gnu Unit Tests
Unit Tests

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

0 comments on commit c78881b

Please sign in to comment.