Setup and cleanup at build time
Sometimes you want to make changes to Unity or to the file system before building tests, and to clean up such changes after the test run. You can do pre-build setup and post-build cleanup in your tests in one of the following ways:
- Implement IPrebuildSetup and/or IPostBuildCleanup interfaces in your test class.
- Apply the PrebuildSetup attribute and PostBuildCleanup attribute to your test class, to one of the tests, or to the test assembly, providing a class name that implements the corresponding interface as an argument (e.g.
[PrebuildSetup("MyTestSceneSetup")]
).
Execution order
All setups run in a deterministic order one after another. The first to run are the setups defined with attributes. Then any test class implementing the interface runs, in alphabetical order inside their namespace, which is the same order tests run in.
Note: Cleanup runs right away for a standalone test run, but only after related tests run in the Unity Editor.
PrebuildSetup and PostBuildCleanup
Both PrebuildSetup
and PostBuildCleanup
attributes run if the respective test or test class is in the current test run. The test is included either by running all tests or setting a filter that includes the test. If multiple tests reference the same pre-build setup or post-build cleanup, then it only runs once.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.