osmo-python-tests

Go to file

Neels Hofmeyr cebe8f5b00 on Exception during test, also print the actual config When a test run encounters an Exception, the test config file name is printed, but that may already be gone when done, so also print the complete actual test config file contents, making it easy to reproduce the failure manually. Change-Id: I9b00f170fb0cdceb35b9231eb1f2c545ba079d1d		2017-03-06 15:31:08 +01:00
osmopy	on Exception during test, also print the actual config	2017-03-06 15:31:08 +01:00
.gitignore	Add .gitignore	2016-03-31 11:59:09 +02:00
README	Expand installation instructions	2016-03-31 11:59:10 +02:00
setup.py	Documentation: added a README, more docstrings; +x'd setup.py	2013-04-05 17:08:28 +02:00

README

Building/installation:
sudo python setup.py install
If you prefer to have it cleanly removable, install checkinstall and run
sudo checkinstall python setup.py install
Alternatively, just run 'pip install --user -e ./'

Use
There are currently 3 scripts in this package:
osmodumpdoc.py - dump documentation (the VTY's "show online-help").
osmotestconfig.py - test that apps start/write with example configs
osmotestvty.py - test vty operations (currently, tests very few)

Each of these scripts imports a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.

Run the scripts with osmoappdesc.py in the current directory (preferred)
or with -p <the directory containing osmoappdesc.py>.
Remember that osmoappdesc.py may contain relative paths.

Example:
After install osmodumpdoc for openbsc's apps can be run by:
cd <your_source_dir>/openbsc/openbsc && osmodumpdoc.py

Libraries:
osmopy/obscvty.py - connect to a vty, run commands on it, see the result 
osmopy/osmoutil.py - code that's shared between the scripts

obscvty.py may be of general use. osmoutil.py probably isn't.