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