Skip to content

Commit

Permalink
docs: updated tests readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vincepick committed Dec 1, 2024
1 parent 23ca488 commit 6ce72a0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion scripts/testScript/testreadme.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

This is a directory which contains scripts to test various AutoIG runs using regex to test output

To run this, put the commands to navigate to the AutoIG experiment directory, setup the project, and run it.
To run this, put the commands to navigate to the AutoIG experiment directory, setup the project, and run it. See the general README for further instructions on running.

The script will automatically scan the standard output, then output weather the output of each file contained the desired lines specified within the script. The lines need to exist independently in the output, not be sequential.

After all tests are run, the script also outputs the number of passed tests / the number of failed tests, as well as time taken to run all of them.

This is one of the same test script which will eventuall be integrated into the automated CI pipeline in GitHub, but is used manually for now.

An example contents of a test may look like:

## Within tests/macc-graded:
Expand Down

0 comments on commit 6ce72a0

Please sign in to comment.