1*43a90889SApple OSS Distributions# LLDB macro testing 2*43a90889SApple OSS Distributions 3*43a90889SApple OSS DistributionsHow to work with bundled unit test framework. 4*43a90889SApple OSS Distributions 5*43a90889SApple OSS DistributionsBe careful when touching common framework code. For larger changes, ask the Platform Triage team to 6*43a90889SApple OSS Distributionsvalidate that the changes work in their environment before integration. 7*43a90889SApple OSS Distributions 8*43a90889SApple OSS DistributionsUnit-test architecture supports two kinds of tests: 9*43a90889SApple OSS Distributions 10*43a90889SApple OSS Distributions- Standalone unit test \ 11*43a90889SApple OSS Distributions `tools/lldbmacros/tests/standalone_tests` 12*43a90889SApple OSS Distributions- LLDB based unit test \ 13*43a90889SApple OSS Distributions `tools/lldbmacros/tests/lldb_tests` 14*43a90889SApple OSS Distributions 15*43a90889SApple OSS Distributions**Standalone** unit tests replace _lldb_ and _lldbwrap_ modules with _MagicMock_ 16*43a90889SApple OSS Distributionsinstances. All tests in this location must not depend on LLDB. 17*43a90889SApple OSS Distributions 18*43a90889SApple OSS Distributions**LLDB** unit tests are run from LLDB's python interpreter. It is possible to 19*43a90889SApple OSS Distributionsaccess debugger/process/target from such test or invoke LLDB commands. This 20*43a90889SApple OSS Distributionsway a test can exercise full stack including SBAPI and expression handlers. 21*43a90889SApple OSS Distributions 22*43a90889SApple OSS Distributions## How to run tests 23*43a90889SApple OSS Distributions 24*43a90889SApple OSS DistributionsStandalone tests do not need LLDB and can be run with: 25*43a90889SApple OSS Distributions```sh 26*43a90889SApple OSS DistributionsPYTHON=tools/lldbmacros python3 tools/lldbmacros/tests/runtest.py <kernel> 27*43a90889SApple OSS Distributions``` 28*43a90889SApple OSS Distributions 29*43a90889SApple OSS DistributionsTo run all tests (including LLDB based ones) a developer has to install 30*43a90889SApple OSS DistributionsXCode and configure properly Python's path: 31*43a90889SApple OSS Distributions 32*43a90889SApple OSS Distributions```sh 33*43a90889SApple OSS DistributionsPYTHONPATH="tools/lldbmacros:`xcrun --toolchain ios lldb -P`"xcrun --toolchain ios python3 tools/lldbmacros/tests/runtest.py <kernel> 34*43a90889SApple OSS Distributions``` 35*43a90889SApple OSS Distributions 36*43a90889SApple OSS DistributionsDefault runner supports few options: 37*43a90889SApple OSS Distributions 38*43a90889SApple OSS Distributions * `-v` enables verbose output from unit test framework 39*43a90889SApple OSS Distributions * `-d` enables debug logging and more detailed exception reports 40*43a90889SApple OSS Distributions * `-c <path>` outputus HTML coverage if `coverage` module is installed 41*43a90889SApple OSS Distributions 42*43a90889SApple OSS Distributions## Mocking framework 43*43a90889SApple OSS Distributions 44*43a90889SApple OSS DistributionsThe goal of the mocking framework is to enhance existing mocking solutions 45*43a90889SApple OSS Distributionsrather than building completely new framework. A test should still rely on 46*43a90889SApple OSS Distributions`unittest.mock` and cover specific needs with additional mocks provided by 47*43a90889SApple OSS Distributionsthis framework. 48*43a90889SApple OSS Distributions 49*43a90889SApple OSS DistributionsA test developer has three options how to handle mocking in a test: 50*43a90889SApple OSS Distributions 51*43a90889SApple OSS Distributions* `unittest.mock` that covers general purpose Python mocking. 52*43a90889SApple OSS Distributions* `lldbmock.valuemock` designed to mock away `value` class instances. 53*43a90889SApple OSS Distributions* `lldbmock.memorymock` designed to provide real object in target's memory. 54*43a90889SApple OSS Distributions 55*43a90889SApple OSS DistributionsExamples of usage can be found in: \ 56*43a90889SApple OSS Distributions `tools/lldbmacros/tests/lldb_tests/test_examples.py` 57*43a90889SApple OSS Distributions 58*43a90889SApple OSS Distributions### lldbmock.valuemock 59*43a90889SApple OSS Distributions 60*43a90889SApple OSS DistributionsA very simple mocking designed for replacing a `value` class instance or 61*43a90889SApple OSS Distributionssome similar construct in the code. 62*43a90889SApple OSS Distributions 63*43a90889SApple OSS DistributionsThe `ValueMock` class parses given `SBType` and recreates recursively whole 64*43a90889SApple OSS Distributionshierarchy of `MagicMock` instances. Final result looks like a value class but 65*43a90889SApple OSS Distributionsit does not implement any value class logic or methods. 66*43a90889SApple OSS Distributions 67*43a90889SApple OSS DistributionsIt does not perform any extra logic to handle special types like `union`. 68*43a90889SApple OSS DistributionsA developer has to correctly populate all members that overlap because this 69*43a90889SApple OSS Distributionsmock treats all such members as unique. 70*43a90889SApple OSS Distributions 71*43a90889SApple OSS DistributionsAuto generating mock specification from kernel under test allows checking that 72*43a90889SApple OSS Distributionsall referenced members do exist in the final binary. Broken reference will 73*43a90889SApple OSS Distributionsresult either in test or tested code failure. 74*43a90889SApple OSS Distributions 75*43a90889SApple OSS Distributions### lldbmock.memorymock 76*43a90889SApple OSS Distributions 77*43a90889SApple OSS DistributionsThe goal of memory mock is to provide easy to use interface for a test developer 78*43a90889SApple OSS Distributionsto describe object in target's memory. From technical perspective this is a data 79*43a90889SApple OSS Distributionsserializer that reflects memory location and representation of given SBType's 80*43a90889SApple OSS Distributionsmembers. 81*43a90889SApple OSS Distributions 82*43a90889SApple OSS DistributionsThe framework provides two kinds of mocks: 83*43a90889SApple OSS Distributions 84*43a90889SApple OSS Distributions * `RawMock` that is suitable to place unstructured data into target's memory. 85*43a90889SApple OSS Distributions * `MemoryMock` that mirrors given `SBType` and serializes data into target's 86*43a90889SApple OSS Distributions memory. 87*43a90889SApple OSS Distributions 88