Skip to content

Commit 1cff1e9

Browse files
authored
Merge pull request #904 from NHSDigital/correct-readme
Update README
2 parents 062c5fa + 0cc8af4 commit 1cff1e9

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,14 @@ Test data is created before running tests using the `/api/testing/onboard` endpo
148148
1. For each programme group (HPV, Flu, Doubles, MMR)
149149
1. A random valid year group is selected.
150150
2. Two random valid schools that have this year group are retrieved using the MAVIS `/api/testing/locations` endpoint.
151-
3. User, team, and organisation data is generated by the test worker.
152-
4. The school, user, team, and organisation data is sent to the MAVIS `/api/testing/onboard` endpoint, inserting all of this data into the database and linking the schools to the team.
153-
5. The test worker also generates two children which are not immediately added to the database but can be imported later.
154-
2. The generated test data is provided as a set of fixtures, which can be injected into tests (or other fixtures). Some common examples:
151+
2. User, team, and organisation data is generated by the test worker.
152+
3. The school, user, team, and organisation data is sent to the MAVIS `/api/testing/onboard` endpoint, inserting all of this data into the database and linking the schools to the team.
153+
4. The test worker also generates two children for each programme which are not immediately added to the database but can be imported later.
154+
5. The generated test data is provided as a set of fixtures, which can be injected into tests (or other fixtures). Some common examples:
155155
- `children` – provides two children for each programme group (in the form of a map)
156156
- `schools` – provides two schools for each programme group (also in the form of a map)
157-
3. After a test module has finished, the worker clears out any data created by running the test module by calling the MAVIS `/api/testing/teams/<workgroup>` endpoint with parameter `keep_itself=true`.
158-
4. After a worker has finished running all test modules allocated to it, it calls the MAVIS `/api/testing/teams/<workgroup>` endpoint without the `keep_itself` parameter, which clears all associated with the team used by the worker including the team itself. No data should remain after a test run.
157+
6. After a test module has finished, the worker clears out any data created by running the test module by calling the MAVIS `/api/testing/teams/<workgroup>` endpoint with parameter `keep_itself=true`.
158+
7. After a worker has finished running all test modules allocated to it, it calls the MAVIS `/api/testing/teams/<workgroup>` endpoint without the `keep_itself` parameter, which clears all associated with the team used by the worker including the team itself. No data should remain after a test run.
159159
160160
[here]: https://github.com/NHSDigital/manage-vaccinations-in-schools-testing/blob/main/mavis/test/fixtures/data_models.py
161161

0 commit comments

Comments
 (0)