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