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