graph-analysis

Let's update the documentation to make it clear that the check_planarity function is the primary interface for the planar embedding tools. Also, the class PlanarEmbedding is tricky to make sure it maintains the planar data structure. People not familiar with those ideas should definitely start with the check_planarity function.

See discussion in #5079

Description

Currently our unit tests are disorganized and each test creates example StellarGraph graphs in different or similar ways with no sharing of this code.

This issue is to improve the unit tests by making functions to create example graphs available to all unit tests by, for example, making them pytest fixtures at the top level of the tests (see https://docs.pytest.org/en/latest/

There is a proof-of-concept github action using https://github.com/ReactiveCircus/android-emulator-runner in branch https://github.com/BrightID/BrightID/tree/automate_detox
It kind of runs, but not usable/reliable.

Things to try:

• Make detox test a release build of the app so we don't need to have metro running in parallel
• Use iOS simulator instead of android emulator
• Fork the android

Following the "const whenever is possible" principle, I would suggest to add this restriction to our code in places where we want our structures not to change and force them to stay untouchable.

Already commented in @ZigRazor PR