osmo-python-tests

Go to file

Oliver Smith 92014a44fd tests/test_py3: fix deprecated loop arg The loop arg has been removed in python 3.10. The same event loop will be used without passing the argument, so it can be removed. Fix for: TypeError: gather() got an unexpected keyword argument 'loop' Related: https://stackoverflow.com/a/60315290 Related: https://docs.python.org/3/library/asyncio-task.html#asyncio.gather Change-Id: I776bc463246e7a1a9adbb7c06012353d65694507		2023-09-13 16:10:58 +00:00
contrib	contrib/jenkins: do install --user	2023-09-13 16:10:58 +00:00
debian	Bump version: 0.2.1 → 0.3.0	2023-09-13 14:48:03 +02:00
doc/examples	ctrl2cgi: update default parameters in config	2019-01-07 17:04:10 +01:00
osmopy	osmoutil: return proc's return code from end_proc()	2023-06-01 19:59:18 +07:00
scripts	treewide: remove FSF address	2021-12-14 12:19:36 +01:00
tests	tests/test_py3: fix deprecated loop arg	2023-09-13 16:10:58 +00:00
.gitignore	contrib/jenkins: do install --user	2023-09-13 16:10:58 +00:00
.gitreview	Add git-review config	2017-11-23 14:46:07 +01:00
README	README: Drop python2 references	2021-01-12 18:04:16 +01:00
setup.py	setup.py: do not install scripts/{soap,ctrl2cgi}.py	2023-05-24 09:03:08 +00:00

README

Building/installation:

	sudo python3 setup.py install

If you prefer to have it cleanly removable, install checkinstall and run

	sudo checkinstall python setup.py install

Alternatively, just run

	pip3 install --user -e ./

depending on your python version.

Use:
There are currently following scripts in this package:
osmotestconfig.py - test that apps start/write with example configs
soap.py - implementation of SOAP <-> Ctrl proxy implemented on top of Twisted (deprecated, unmaintained)
ctrl2cgi.py - implementation of CGI <-> Ctrl proxy implemented on top of Twisted (deprecated, unmaintained)
osmo_trap2cgi.py - implementation of CGI <-> Ctrl proxy implemented on top of asyncio and aiohttp
osmo_rate_ctr2csv.py - rate counter dumper on top of osmo_ipa
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
twisted_ipa.py - implementation of IPA and Ctrl protocols on top of Twisted framework
osmodumpdoc.py - dump documentation, superseded by osmo_interact_vty.py -X
osmotestvty.py - test vty operations, superseded by osmo_verify_transcript_vty.py

Some of these scripts import a project-specific osmoappdesc.py,
which provides information about the available apps, configs, vty ports, etc.
and is provided by other source trees (like osmo-bsc.git, osmo-msc.git, ...)

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/osmoutil.py - code that's shared between the scripts
osmopy/osmo_ipa.py - generic implementation of IPA and Ctrl protocols in python
osmopy/trap_helper.py - generic Trap class and related helpers used by soap.py and ctrl2cgi.py
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.