blob: ed4c8d062cc8e1cb2f38df98410b3b9f8eec9b9c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
|
Testing libsosplugin
=====================================
**Test assembly**
The test asembly file must follow two rules:
1. the test class must be named `Program` and
2. it must have a static `Main` method.
**Running tests**
Make sure that python's lldb module is accessible. To run the tests, use the following command:
`python test_libsosplugin.py --clr-args="/path/to/corerun [corerun_options] /path/to/test_assembly.exe"`
`--clr-args` is a command that would normally be used to launch `corerun`
This will run the test suite on the specified assembly.
**Writing tests**
Tests start with the `TestSosCommands` class defined in `test_libsosplugin.py`. To add a test to the suite, start with implementing a new method inside this class whose name begins with `test_`. Most new commands will require only one line of code in this method: `self.do_test("scenarioname")`. This command will launch a new `lldb` instance, which in turn will call the `runScenario` method from `scenarioname` module. `scenarioname` is the name of the python module that will be running the scenario inside `lldb` (found in `tests` folder alongside with `test_libsosplugin.py` and named `scenarioname.py`).
An example of a scenario looks like this:
import lldb
def runScenario(assemblyName, debugger, target):
process = target.GetProcess()
# do some work
process.Continue()
return True
`runScenario` method does all the work related to running the scenario: setting breakpoints, running SOS commands and examining their output. It should return a boolean value indicating a success or a failure.
***Note:*** `testutils.py` defines some useful commands that can be reused in many scenarios.
**Useful links**
[Python scripting in LLDB](http://lldb.llvm.org/python-reference.html)
[Python unittest framework](https://docs.python.org/2.7/library/unittest.html)
|
