Commit Graph

42 Commits

Author SHA1 Message Date
Oliver Smith 116cf25fe2 treewide: remove FSF address
Remove the paragraph about writing to the Free Software Foundation's
mailing address. The FSF has changed addresses in the past, and may do
so again. In 2021 this is not useful, let's rather have a bit less
boilerplate at the start of source files.

Change-Id: Ifd7b7e548c9c6db140fa8cbc8a3c8dfaf4603d18
2021-12-14 12:19:36 +01:00
Vadim Yanitskiy 2768e5e923 Use proper python3 shebang in all modules
Change-Id: I1295be505f4ec30e809297a474b689e6c0cdf505
2021-04-04 20:59:35 +02:00
Harald Welte be7fcf5f28 remove_tmpdir(): Support recursion / sub-directories
The existing code assumed that tmpdir only contained regular files,
not an entire hierarchy of files with sub-directories or the like.

In case sub-directories exist, the current code fails as follows:

line 176, in test_all_apps
    remove_tmpdir(tmpdir)
  File "/usr/local/lib/python3.5/dist-packages/osmopython-0.2.0-py3.5.egg/EGG-INFO/scripts/osmotestconfig.py", line 142, in remove_tmpdir
    os.unlink(os.path.join(tmpdir, f))
IsADirectoryError: [Errno 21] Is a directory: 'writtenconfig/ericsson'

Change-Id: I896b99032d94ba0cdd340a8eed7c7b625661ad69
2020-07-15 08:53:10 +02:00
Oliver Smith 934caf1a81 Drop python2 support (again)
Re-apply reverted commit Iabda95073faa2191fd117e9637e0858c589e9d9e
("Drop python2 support"), but with additional changes to make the
scripts actually work with python3 and to make it build without python2.

I have verified, that the contrib/jenkins.sh scripts of all Osmocom
repositories (with their python3 patches on top) are working with this
patch and that all Osmocom repositories with the python3 patches build
in OBS (tested in own namespace).

All related patches for changing from python2 to 3 in other repositories
must be merged shortly after this one, as soon as the build slaves were
(automatically) updated to have the new osmo-python-tests installed:
https://gerrit.osmocom.org/q/topic:drop-py2

New fixes:
* osmopy/obscvty.py: verify: fix compare
  Comparing maps in python3 does not work the same as in python2. Convert
  them to lists first, so the compare works as intended again.
  Fix error:
	  File "/home/user/code/osmo-dev/src/osmo-python-tests/scripts/osmotestvty.py", line 57, in test_history
	    assert(self.vty.w_verify(test_str, [t1]))
	AssertionError
* osmopy/obscvty.py: use enc/dec with send/recv
  Fix error:
		self.socket.send("%s\r" % request)
	TypeError: a bytes-like object is required, not 'str'
* scripts/osmotestconfig.py: use encode() before writing to file
  Fix error:
	File "/home/user/code/osmo-dev/src/osmo-python-tests/scripts/osmotestconfig.py", line 91, in copy_config
		tmpfile.write(open(config).read())
	File "/usr/lib/python3.5/tempfile.py", line 622, in func_wrapper
		return func(*args, **kwargs)
	TypeError: a bytes-like object is required, not 'str'
* debian/control: add --buildsystem=pybuild. Otherwise "--with python3"
  is ignored and the build fails if python2 is not installed, with:
  	Can't exec "pyversions": No such file or directory at /usr/[...]/python_distutils.pm line 120.

Related: OS#2819
Change-Id: I3ffc3519bf6c22536a49dad7a966188ddad351a7
2019-12-11 12:28:40 +01:00
Oliver Smith b0ba927e33 Revert "Drop python2 support"
This reverts commit fb1dc7c405.

I was under the impression, that all previous scripts were already
working with python 3. But as it turns out, this isn't true. Reverting,
so I can properly post follow-up patches, that fix the issues before we
apply this "drop python2" patch again.

Related: OS#2819
Change-Id: Ic1559d1a9f7839fa86a841d62a04b22e1caed466
2019-12-06 16:06:38 +01:00
Oliver Smith fb1dc7c405 Drop python2 support
Remove all compatibility code for python2.

All scripts are already python 3 compatible since
I80e5850a8978d78cda793e2192ef4bd3fd54a121 and
I1b4a629f12863c498a8681b555f57b4e255cebfb.

dpkg-buildpackage shows that it is still invoking setup.py with python
in addition to python3, on debian stretch. But after spending quite some
time on trying to convince it to not care about python2 without success
(trying different variables, overrides, --without python2 flags etc.),
I'm leaving it as is. The resulting package is the python3 package, which
is what we want.

Related: OS#2819
Change-Id: Iabda95073faa2191fd117e9637e0858c589e9d9e
2019-12-05 13:41:38 +01:00
Daniel Willmann ee9f2e211b osmo_trap2cgi.py: Don't recurse in ctrl_client()
Use a loop instead. Without it the script will eventually crash with a
RecursionError.

   File "/usr/bin/osmo_trap2cgi.py", line 211, in conn_client
     await ctrl_client(proxy, reader, writer)
   File "/usr/bin/osmo_trap2cgi.py", line 202, in ctrl_client
     proxy.dispatch(wr, data)
[...]
   File "/usr/bin/osmo_trap2cgi.py", line 202, in ctrl_client
     proxy.dispatch(wr, data)
   File "/usr/bin/osmo_trap2cgi.py", line 201, in ctrl_client
[...]
RecursionError: maximum recursion depth exceeded in comparison

Change-Id: Ic909e371771f3056cb87e18793fd4225ffb90a2c
Related: SYS#4399
2019-06-26 14:44:46 +02:00
Max 684388f4e1 Add initial version of asyncio trap2cgi script
It uses the same config file format to simplify migration from ctrl2cgi.py

Change-Id: I7428cbfbc9f1b80ce42a70be555a38a3497d1cf9
Related: SYS#4399
2019-01-08 15:19:05 +01:00
Max 19b77a426c ctrl2cgi: update shared helper
* split hash generation into simpler functions
* move them into helper file
* split log init into separate function

This facilitates code sharing with new version of ctrl2cgi proxy in
folow-up patches.

Change-Id: Ic5c349349d2c246f934d6701435b1a2d9de77de1
Related: SYS#4399
2019-01-07 17:04:10 +01:00
Max 5530d7cc27 ctrl2cgi: explicitly ignore unrelated TRAPs
Previously we've tried to determine the type of TRAP and handle as many
as possible via generic method dispatcher similar to parent class. Let's
make code simpler by explicitly ignoring all but 'location-state'
TRAPs. This should also reduce debug log output because we'll only log
the TRAP variable for ignored messages instead of entire content.

Change-Id: I42b715cb82eb309950ff387649726504b6c7cf61
Related: SYS#4399
2018-12-23 12:45:37 +00:00
Max 66441e73a7 ctrl2cgi: update comments
* remove obsolete comments
* add missing function comments

Change-Id: I5ace594adbccf7ce7eda2c19aa639a4f46285c25
2018-12-21 18:44:01 +01:00
Max c4502377fd ctrl2cgi: account wait and http times separately
Save and propagate separate timestamp for HTTP request duration to
distinguish between time spent waiting on connection limit availability
from actual http request time.

Change-Id: I14d1db5206864ac9ab7c64f96f67139113ab3fcf
Related: SYS#4399
2018-12-21 13:36:36 +01:00
Oliver Smith 95952909fa scripts/*.py: mark as executable
osmo-mgw's configure.ac won't find osmotestvty.py, unless it is
executable. This allows passing its ./configure with placing the scripts
dir of osmo-python-tests in PATH, instead of installing it.

Change-Id: If6cefd32d0dc544093db08efc114db86b9bb18b0
2018-12-13 13:12:57 +01:00
Max ee3a70ebce Trap handlers: adjust http error log
Log repr() of error because it's more conscience which makes it easier to
read the logs: in case of "e" there's additional
"Failure instance: Traceback (failure with no frames)" prefix which is
pretty useless because we won't have proper tracebacks for deferred anyway.

Change-Id: I39870b83cacee9a589636974d04e356ef0d32345
2018-12-06 11:03:24 +01:00
Max 0028ce1fb5 ctrl2cgi: make http request timeout configurable
Change-Id: I7839121da831aeab0be7e599049bf79471f845fd
Related: SYS#4399
2018-12-05 18:17:33 +01:00
Max 4e95b8f34a ctrl2cgi: log request time
Log http request timestamp and duration on debug loglevel. This is
especially helpful while troubleshooting issues with multiple concurrent
requests under significant load while network issues are present.

Change-Id: I11c8ac67a2730a9c6912694e5b83bbdf08fe357d
Related: SYS#4399
2018-12-05 18:01:10 +01:00
Max 40a375228c Trap handlers: log request/reply as info level
Log the basic location-state trap triggering request and command reply
as info level - that way we can receive useful information without
turning on full debug output.

Change-Id: If8eae9f36292930571954becf6613fada43d301c
2018-12-05 17:58:00 +01:00
Max 7f0f786c27 Trap handlers: propagate expected BSC id to command processor
When receiving commands for particular BSC, log BSC id known at the time
when request was made, not the one which is part of the reply.

Change-Id: I6acdfddb9a1132f978f2b55c769559b0c29eb3e8
2018-12-05 17:55:03 +01:00
Max 8f8d9144ec ctrl2cgi: properly limit number of requests
Manual acquire()/release() of semaphore does not limit number of
concurrent requests when combined with explicit yield. Fix this by using
semaphore.run() and removing inilineCallbacks decorator.

Change-Id: I47b8b9f5b726ca0905bb7c023d63b325c7f7d85f
Related: SYS#4399
2018-12-05 16:03:57 +01:00
Max fa80a22563 ctrl2cgi: fix broken config override
Previously command-line arguments without defaults took precedence over
config file variables while values from config file which had
command-line counterparts with default value were silently ignored.

Let's fix this by making config file option mandatory values and
removing overlap between command-line and config file parameters.

Change-Id: I471b5a6497eadce6456e835233fdaba88a593324
Related: SYS#4399
2018-12-05 16:00:29 +01:00
Max f0f8a352cc Trap handlers: always log to stdout
Since the scripts are intended to be used as systemd services, there's
no need in separate logging via syslog: systemd will take care of
properly collecting and storing script output. Hence we can drop extra
options and function parameters.

Change-Id: Ifcad1877d45d43b3a2e617775a1c9b256e190591
Related: SYS#4399
2018-12-05 15:10:18 +01:00
Max 25a8297fe8 Improve code style
* reorder imports to make pylint3 happy
* drop unused imports
* use proper spacing for list constants
* don't use reserved names for internal variables

The check was run as follows:
pylint3 -d C0103,C0301,C0410,C0326,R0913,R0901 ...
to disable useless warnings.

Change-Id: I5b90ee790f73dc509081401776911f25e43f1801
2018-11-28 12:52:48 +00:00
Max f7255fa7cf Move command processing into shared function
Change-Id: I4e40607a9aa5e03a7b3f5b68e4261828209a5813
2018-11-28 12:52:48 +00:00
Max ec3944e7ae ctrl2cgi: fix deferred callbacks
Previously handle_reply() was marked as deferred callback unlike soap.py
where it's synchronous function. This seems to be causing issues where
some of the callbacks are not yield properly. Let's move to the
known-to-work semantics of soap.py where async functions are limited to
Trap() class.

Change-Id: Ib2c28dd7f79cbd28d475de93750703659ddd18f1
Related: SYS#4399
2018-11-28 12:52:48 +00:00
Max 2a1d8930f6 osmo_ctrl.py: properly ignore out-of-order traps
Sometimes when we set variable we might receive arbitrary number of TRAP
messages before we get SET_REPLY. Those could be either separate
messages or combined together with SET_REPLY depending on tcp buffering
at server side. Let's handle this gracefully by skipping over all TRAP
messages.

An example command which often triggers this behavior:
./osmo_ctrl.py -s -d 127.0.0.1 -p 4249 bts.0.location (date +%s)",fix2d,1,2,3"

Change-Id: Ia6de02c2f13a56f0381c97a9ab02c6c7a31cc32f
Related: SYS#4399
2018-11-28 12:37:23 +01:00
Max 217837cf55 ctrl: cosmetic cleanup
* remove unused function
* move internal function call outside of main

Change-Id: I3c1bf59775f08f6252d731de653ee9cc212b31da
2018-11-28 12:29:23 +01:00
Max a07e55335d Move Trap class back to separate files
After further testing it turns out that Trap() have too many
implementation details which makes it cumbersome to be shared. Instead,
it's easier to make it into wrapper over shared functions.

Change-Id: I8a3c62bcdf4286f8127c5b6d8dee6d740aca23b9
2018-11-27 18:25:23 +01:00
Max 5baba8c078 Move common Trap-related code into separate file
The ctrl2cgi.py is heavily based upon soap.py - let's move all the
shared code into separate file to make further modifications easier.

Change-Id: I7b59f2dbded9074d15f2d2f40bf5a92ed02601e2
Related: SYS#4399
2018-11-27 11:51:37 +00:00
Max 735d5b4165 ctrl2cgi: remove unused function
Change-Id: I1bff680b301b06e3b178d59bdcb86c4773ad9296
2018-11-26 15:04:35 +00:00
Max 9fa695d714 ctrl2cgi: explicitly ignore arguments to lambda function
Make sure that we don't fail regardless of number of arguments given.

Change-Id: I44035323b70f04eb8f5dc12123cb708f53eba188
2018-11-26 14:41:58 +01:00
Max f2199446b4 ctrl2cgi: log traps via debug facility
Change-Id: I21ff593be420a374a00073953c9254a013c43164
Related: SYS#4399
2018-11-26 13:31:00 +00:00
Max c16fa3c750 ctrl2cgi.py: log address on errors
Change-Id: I80cdcda134766c679c2b80b848fb9db853321cfd
Related: SYS#4399
2018-11-22 18:45:21 +01:00
Pau Espin 10fbb40b24 Introduce script ctrl2cgi.py
This scripts implements a similar proxy to the one already available in
soapy.py, but aiming at converting CTRl into a regular HTTP POST Request
to be handled by a CGI script in the HTTP server.

Furthermore, it includes several improvements over the soapy.py script,
such as using a token to authenticate users and capability to read some
parameters from a cfg file.

Change-Id: I7a83ecb379835e295c8cb4c27c39883783746544
2018-07-11 22:47:54 +02:00
Pau Espin 8739f9c4fc Move twisted_ipa.py to osmopy lib
twisted_ipa is a module expected to be used by other python scripts, so
move it to osmopy dir to be installed as a lib (in python path) so it
can be later used.

twisted_ipa has some features to use it standalone for testing purposes.
This feature can still be used from new installation path.

Change-Id: I33a0c4263297abd9e111bf43e6e9967c06474318
2018-07-11 14:05:28 +02:00
Max 34d2ca5bc8 Add rate counter dumper
This simple tool dump all the rate counters available via ctrl interface
to cvs file (or stdout).

Change-Id: I12b369434e4ee9b38f92872f297e1f3d4f0698c2
Fixes: OS#2550
2018-01-12 16:43:37 +01:00
Max 2f266e0cec Improve python3 compatibility
Use proper print() function to make scripts compatible with both python
2 and 3. This paves the way to deprecating python 2 support altogether.

Change-Id: I80e5850a8978d78cda793e2192ef4bd3fd54a121
2018-01-05 10:15:47 +00:00
Max 566f2a7590 Update ctrl command parsing for python3
* make parse() return command id in addition to variable name and value
* introduce parse_kv() wrapper which ignores that id and use it instead
  of old parse()
* make parse() compatible with python3 where we got bytes, not string
  from the socket so we have to decode it properly before using split()
* expand test_py3.py with simply asyn server which verifies that
  osmo_ctrl.py works properly

Change-Id: I599f9f5a18109929f59386ab4416b8bfd75c74d1
2017-12-28 19:34:48 +01:00
Max 8a02e36575 Use python3 for osmo_ctrl.py
It's a standalone script illustrating the use of ctrl protocol from
python. Since it's not used as a library and nothing depends on it, we
can safely switch to python3.

Change-Id: I2461dd9af67771beed5306116e8a1b0ee2285aa8
2017-12-21 14:37:23 +01:00
Neels Hofmeyr 150a6eac9b scripts: add symlink to osmopy
To allow running the scripts from within the scripts/ dir without having to
install osmopy on the system first, place a symlink to the osmopy module dir.
This allows testing modifications without having to run setup.py all the time.

Change-Id: I880c8afa8d02ef112a80cb54f649ec71902bbd4c
2017-12-20 11:11:55 +00:00
Neels Hofmeyr 56aa4785c0 fix osmo_interact_* and osmo_verify_transcript_* after dir split
After I30cdf0f85b2a60a235960911c9827f4129da40db,
* the osmo_interact_{vty,ctrl}.py can no longer import osmo_interact_common,
  since it was moved to scripts/ in error.
* the osmo_verify_{vty,ctrl} scripts can no longer import osmo_interact_{vty,ctrl},
  since it is also in scripts/. Notably, the osmo_interact_{vty,ctrl}.py also
  served as scripts while being modules at the same time, which is not good.

Fix these issues by adding a new osmopy/osmo_interact/ submodule with
osmopy/osmo_interact/common.py, /vty.py and /ctrl.py as modules, and add in
scripts thin wrappers that invoke the modules' main().

Change-Id: I40a37b212274cb70ebb1e1d9d1b3743eb2d64d05
2017-12-19 15:11:31 +00:00
Max 6ccd0785d8 Fix python3 compatibility
Use print() function with proper import.

Change-Id: Ib10dfbec18202245031a634fc3f19677fc952e60
2017-12-18 13:12:48 +01:00
Max 120075a6a5 Move scripts to appropriate directory
Having the scripts in the same directory with library code means that
it'll be installed unconditionally regardless of version check in
setup.py which makes it impossible to write separate tests for python 2
and 3. Fix this by moving the scripts into separate directory and
adjusting init and setup files accordingly.

This is necessary for implementing proper CI tests in follow-up patches.

Change-Id: I30cdf0f85b2a60a235960911c9827f4129da40db
2017-12-18 13:12:08 +01:00