Ticket #9904 (closed: fixed)
Slow Unit Tests for Sam Jackson
Reported by: | Owen Arnold | Owned by: | Samuel Jackson |
---|---|---|---|
Priority: | major | Milestone: | Release 3.3 |
Component: | Framework | Keywords: | Maintenance |
Cc: | Blocked By: | ||
Blocking: | #9905 | Tester: |
Description (last modified by Owen Arnold) (diff)
We have a number of slow running unit tests which we need to fix as part of the 3.3 maintenance window. We are targeting test suits than execute in > 2 seconds on our clean rhel6 build servers. For IO tests (Loading & Saving) we have applied a more generous threshold of > 5 seconds.
See the full list to see which tests have been assigned to you: http://www.mantidproject.org/images/2/2f/Slow_tests.xlsx_-_Sheet1.pdf
Criteria
- Test suits (each test class instance) should execute in < 1 second as a rough target
- As a corollary to the above, If the test suite contains lots of test methods aim for < 0.1 second per test method
- If for some reason you get the speed up the test below the target using the strategies listed below, you need to justify why when you close the ticket.
Guidelines/instructions to help
- Keep tests readable and improve code readability where possible. Unit tests are documentation.
- Do not delete test methods without good reason. We do not want to reduce test coverage
- Changing the algorithm code to improve speed is OK, but exercise caution. Add additional test coverage if it's not already good enough.
- Take test methods that are slow and involve IO, or are processor intensive and make them into system tests. Integration tests are not Unit tests.
- Most of the speed improvements will probably come from better selection of input data. Caching input data is also a good option.
- Create sub tickets for algorithms or groups of algorithms to help testability if you wish, but mark this ticket as the 'blocked' by each one.
Change History
comment:1 Changed 6 years ago by Owen Arnold
- Status changed from new to assigned
- Owner changed from Ricardo Leal to Samuel Jackson
- Description modified (diff)
- Summary changed from Slow Unit Tests for Ricardo Leal (cloned) to Slow Unit Tests for Sam Jackson
comment:5 Changed 6 years ago by Samuel Jackson
- Status changed from assigned to inprogress
Refs #9904 Split workspace history IO tests into separate test.
Changeset: 931f9b992592199f9c6c59d2a155a542a18ff73d
comment:6 Changed 6 years ago by Samuel Jackson
This had a lot of loading/saving tests that can't really be moved to system tests without reducing the level of test coverage. I've split the IO tests into a new test file called WorkspaceHistoryIOTest.h
To Test: Check the build servers are passing both tests. Then code review.
comment:8 Changed 6 years ago by Samuel Jackson
- Status changed from inprogress to verify
- Resolution set to fixed
comment:9 Changed 6 years ago by Owen Arnold
- Status changed from verify to closed
Merge remote-tracking branch 'origin/feature/9904_slow_unit_tests'
Full changeset: ba6fdd75f6d5a9862b0bd6d2da5b5609cb28a329
comment:10 Changed 6 years ago by Owen Arnold
Good work. Thanks a lot for this.
comment:11 Changed 5 years ago by Stuart Campbell
This ticket has been transferred to github issue 10746