diff --git a/docs/tests.md b/docs/tests.md index d8da5d5c5592fd947053e10b8c0f4b6ec1b92aa8..557fba682342d433058d1ffcd13d82abd8457b6e 100644 --- a/docs/tests.md +++ b/docs/tests.md @@ -14,12 +14,26 @@ should be sufficient to edit `test-dumper` and add a new entry under To add the tests to CI, you'll also have to edit [`.gitlab-ci.yml`]({{repo_url}}-/tree/main/.gitlab-ci.yml) -#### Making inputs for tests +### Making inputs for tests We keep the input files small (roughly 10 MB) so that tests are quick to run locally. If you need a new input format for your test, you can create a smaller file in several ways. +#### The easy way (recommended) + +A few scripts to make test files live in [the test file +repository][dumper-test-files]. Use these to make a test file and then +skip to the [uploading test files](tests.md#uploading-test-files) +section below. + +#### Doing it manually + +??? Warning "Are you sure you don't want to do this the easy way?" + + The scripts in [the test file repository][dumper-test-files] should be all you need, and will take care of getting the naming conventions correct. + If you're having trouble running them please file an issue there. + Sometimes you can download a dataset from the grid, set up Athena, and run @@ -27,18 +41,10 @@ run Merge_tf.py --CA --inputAODFile <xAOD-file> --outputAOD_MRGFile <name>.small.pool.root --maxEvents 10 ``` -??? bug "There should be a simpler command, currently broken!" - The previous way to do this was with `acmd merge-files`, but that is - currently broken, see [ATEAM-941][ateam-941]. - ```bash - acmd merge-files <xAOD-file> -o test.pool.root --evts 10 - ``` - - Unfortunately this may not work for some DAODs. In this case, see the section on [making test DAODs](tests.md#making-daods-from-aods). -#### Uploading test files +### Uploading test files Test files are stored in a [dedicated repository][dumper-test-files] via [Git LFS][lfs]. After you've confirmed that you can use your