cellular-infrastructure
/
osmo-python-tests
mirror of https://gerrit.osmocom.org/python/osmo-python-tests
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

README: mention osmo_interact_* and osmo_verify_transcript_* 

Move the libs/scripts that they (possibly) replace below the new additions and
mention that they are superseded.

Change-Id: Ic50e15d6cb6e94b6e171d954d75b94e09b22d548
This commit is contained in:
Neels Hofmeyr 2017-12-19 14:48:29 +01:00 committed by Harald Welte
parent be76f4d8a8
commit e5731e03b6
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README
View File

@ -7,10 +7,14 @@ depending on your python version.
Use
There are currently following 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)
soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted
osmo_interact_vty.py - pipe stdin/stdout to a VTY session
osmo_interact_ctrl.py - pipe stdin/stdout to a CTRL port
osmo_verify_transcript_vty.py - VTY testing by VTY session screen dumps
osmo_verify_transcript_ctrl.py - CTRL testing by CTRL session script files
osmodumpdoc.py - dump documentation, superseded by osmo_interact_vty.py -X
osmotestvty.py - test vty operations, superseded by osmo_verify_transcript_vty.py
Each of these scripts imports a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.
@ -24,9 +28,10 @@ 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
osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python
twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted framework
osmopy/osmo_interact/{vty,ctrl}.py - general interactions with VTY and CTRL ports
osmopy/obscvty.py - connect to a vty, superseded by osmo_interact/vty
obscvty.py may be of general use. osmoutil.py probably isn't.