Rework README file

Drop old one in doc/ which contains lots of outadated stuff already
placed in the User Manual.
Write a new markdown README in the root directory with pointers to
places in the repo and the issue tracket, ansible setup, etc.

Change-Id: I9febe56223eaeadc9d31291dd0110a11470e3ab1
Pau Espin 2020-05-05 19:25:31 +02:00
parent 0baa5c7269
commit 17dd270cf4
2 changed files with 28 additions and 116 deletions

28 Normal file
View File

@ -0,0 +1,28 @@
About Osmo-GSM-Tester
Osmo-GSM-Tester is a software to run automated tests on real hardware, initially
foremost to verify that ongoing Osmocom software development continues to work
with various BTS models, while being flexibly configurable and extendable to
work for other technologies, setups and projects. It can nowadays also be used
to run 4G networks with components from different providers.
Find Osmo-GSM-Tester issue tracker and wiki online at
Simple configuration setups can be found under _doc/examples/_ directory. A
Osmocom's public Osmo-Gsm-Tester configuration setup is also maintained here
under _sysmocom/_ as a reference for others.
Ansible scripts to set up hosts to be used as Osmo-GSM-Tester Main Units or/and
Slave Units on the above mentioned setup can be found at, which actually install sample
system configuration files from _utils/_ directory in this same repository.
A sample Docker setup is also maintained publicly at
For the complete documentation, please refer to Osmo-GSM-Tester User manual,
available in sources under _doc/manuals/_ under this same repository, and
prebuilt in pdf form at

View File

@ -1,116 +0,0 @@
For the complete documentation, please refer to the osmo-gsm-manuals:
So far the osmo-gsm-tester directory is manually placed in /usr/local/src
Packages required to run the osmo-gsm-tester:
apt-get install \
dbus \
tcpdump \
sqlite3 \
python3 \
python3-yaml \
python3-mako \
python3-gi \
ofono \
python3-pip \
pip3 install git+git://
pip3 install pydbus
pip3 install pysispm
To build ofono:
apt-get install libglib2.0-dev \
libdbus-1-dev \
libudev-dev \
Place a copy of the osmo-gsm-tester repository in /usr/local/src/
cp install/osmo-gsm-tester-limits.conf /etc/security/limits.d/
cp install/*.service /lib/systemd/system/
cp install/org.ofono.conf /etc/dbus-1/system.d/
systemctl daemon-reload
To run:
systemctl enable ofono
systemctl start ofono
systemctl status ofono
systemctl enable osmo-gsm-tester
systemctl start osmo-gsm-tester
systemctl status osmo-gsm-tester
To stop:
systemctl stop osmo-gsm-tester
After ofonod has been started and modems have been connected to the system,
you can run the 'list-modems' script located in /usr/local/src/ofono/test to get
a list of the modems that have been detected by ofono.
Host System configuration
Create the /var/tmp/osmo-gsm-tester directory. It will be used to accept new test jobs.
Test resources (NITB, BTS and modems) are currently configured in the
For every nitb resource that can be allocated, one alias IP address needs
to be set up in /etc/network/interfaces on the interface that is connected to the BTSes.
By add the following lines for each nitb instance that can be allocated (while making
sure each interface alias and IP is unique)
auto eth1:0
allow-hotplug eth1:0
iface eth1:0 inet static
Also make sure, the user executing the tester is allowed to run tcpdump. If
the user is not root, we have used the folloing line to get proper permissions:
groupadd pcap
addgroup <your-user-name> pcap
setcap cap_net_raw,cap_net_admin=eip /usr/sbin/tcpdump
chgroup pcap /usr/sbin/tcpdump
chmod 0750 /usr/sbin/tcpdump
The tester main unit must be able to ssh without password to the sysmobts (and
possibly other) hardware: place the main unit's public SSH key on the sysmoBTS.
Log in via SSH at least once to accept the BTS' host key.
Jenkins Configuration
(TODO: jenkins build slave details)
When adding an entry to jenkins' known_hosts file, be aware that you need to
add an actual RSA host key. Using 'ssh' to access the main unit may work, but
jenkins will still fail to access it in the absence of a full RSA host key:
ssh-keyscan -H $my_main_unit_ip_addr >> ~jenkins/.ssh/known_hosts
osmo-gsm-tester watches /var/tmp/osmo-gsm-tester for instructions to launch
test runs. A test run is triggered by a subdirectory containing binaries and a
checksums file, typically created by jenkins using the scripts in contrib/.