Skip to content

Pytest Update Documentation #2801

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paulromano merged 3 commits into from
Dec 12, 2023
Merged

Pytest Update Documentation #2801

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
06ed4ba
added note in docs about how to generate expected outputs with pytest
jtramm Dec 11, 2023
a4022e6
updated docs
jtramm Dec 11, 2023
1b4aad4
capitalized Python
jtramm Dec 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
updated docs
  • Loading branch information
@jtramm
jtramm committed Dec 11, 2023
commit a4022e6522f8f438a7953c18ef65e7bf317fc36c
15 changes: 6 additions & 9 deletions docs/source/devguide/tests.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,15 +95,6 @@ run::

pytest --build-inputs <name-of-test>

Generating Expected Outputs
---------------------

Many of the regression tests rely on the Python API to reformat output so it can
be compared to an expected output file for the test. To generate the expected
output file, you can run::

pytest --update <name-of-test>

Adding C++ Unit Tests
---------------------

Expand Down Expand Up @@ -143,6 +134,12 @@ following files to your new test directory:
compiler options during openmc configuration and build (e.g., no MPI, no
debug/optimization).

For tests using the python API, both the **inputs_true.dat** and
**results_true.dat** files can be generated automatically in the correct format
via::

pytest --update <name-of-test>

In addition to this description, please see the various types of tests that are
already included in the test suite to see how to create them. If all is
implemented correctly, the new test will automatically be discovered by pytest.