Ensure that testing setup and techniques for all apps/components for both localhost- and RDev-based testing are well documented. There is a good deal of tribal knowledge surrounding how tests are run locally for various components of the CxG Platform. BE engineers often find it difficult to setup environment to run FE tests or FE servers, and vice-versa. There are also caveats with certain components or tests being run on Intel vs M1/2 Mac laptops.
Documentation should be added such that:
{DP,Viz} engineer can run {FE,BE} tests locally Individual test
BE engineers can run FE local servers to manually test backend changes
All engineers can run the full test suite locally.
All tests and servers can be run on either Intel and M1/2 Macs
Implementation notes:
This should be taken on by both a FE and BE engineer, which should each act as a guinea pigs (aka tester) for the other's documentation.
All testing processes should be organized and compiled into a single location, in the repo
Any scripts, Makefile commands, etc, that are found confusing should be improved (time-permitting, documentation is more important)
While improving documentation, we may identify pain points that should result in follow-up issues being created for test environment improvements or running localhost server. This may involve addressing, e.g. Docker container resource requirements (memory usage), test fixtures, etc.
Two major goals for this epic:
Documentation should be added such that:
Implementation notes: