blob: 7a325dd534b79d91fc30a7506f59abe1286c2cea [file] [log] [blame]
Neels Hofmeyrac45a222017-04-14 04:18:21 +02001DOCUMENTATION
2
3For the complete documentation, please refer to the osmo-gsm-manuals:
4http://git.osmocom.org/osmo-gsm-manuals/
5http://jenkins.osmocom.org/jenkins/job/Osmocom_Manuals/ws/
6
7
Neels Hofmeyrdae3d3c2017-03-28 12:16:58 +02008INSTALLATION
9
10So far the osmo-gsm-tester directory is manually placed in /usr/local/src
11
12
13DEPENDENCIES
14
15Packages required to run the osmo-gsm-tester:
16
17 dbus
18 python3
19 python3-dbus
20 python3-pip
21 python3-mako
22 tcpdump
23 smpplib (pip install git+git://github.com/podshumok/python-smpplib.git)
24 ofono
25
26To build ofono:
27 libglib2.0-dev
28 libdbus-1-dev
29 libudev-dev
30 mobile-broadband-provider-info
31
32
33INSTALLATION
34
35Place a copy of the osmo-gsm-tester repository in /usr/local/src/
36
37 cp install/osmo-gsm-tester-limits.conf /etc/security/limits.d/
38 cp install/*.service /lib/systemd/system/
39 cp install/org.ofono.conf /etc/dbus-1/system.d/
40 systemctl daemon-reload
41
42To run:
43
44 systemctl enable ofono
45 systemctl start ofono
46 systemctl status ofono
47
48 systemctl enable osmo-gsm-tester
49 systemctl start osmo-gsm-tester
50 systemctl status osmo-gsm-tester
51
52
53To stop:
54
55 systemctl stop osmo-gsm-tester
56
57After ofonod has been started and modems have been connected to the system,
58you can run the 'list-modems' script located in /usr/local/src/ofono/test to get
59a list of the modems that have been detected by ofono.
60
61
62CONFIGURATION
63
64Host System configuration
65
66Create the /var/tmp/osmo-gsm-tester directory. It will be used to accept new test jobs.
67
68Test resources (NITB, BTS and modems) are currently configured in the test_manager.py.
69
70For every nitb resource that can be allocated, one alias IP address needs
71to be set up in /etc/network/interfaces on the interface that is connected to the BTSes.
72By add the following lines for each nitb instance that can be allocated (while making
73sure each interface alias and IP is unique)
74
75 auto eth1:0
76 allow-hotplug eth1:0
77 iface eth1:0 inet static
78 address 10.42.42.2
79 netmask 255.255.255.0
80
81Also make sure, the user executing the tester is allowed to run tcpdump. If
82the user is not root, we have used the folloing line to get proper permissions:
83
84 groupadd pcap
85 addgroup <your-user-name> pcap
86 setcap cap_net_raw,cap_net_admin=eip /usr/sbin/tcpdump
87 chgroup pcap /usr/sbin/tcpdump
88 chmod 0750 /usr/sbin/tcpdump
89
90The tester main unit must be able to ssh without password to the sysmobts (and
91possibly other) hardware: place the main unit's public SSH key on the sysmoBTS.
92Log in via SSH at least once to accept the BTS' host key.
93
94
95LAUNCHING A TEST RUN
96
97osmo-gsm-tester watches /var/tmp/osmo-gsm-tester for instructions to launch
98test runs. A test run is triggered by a subdirectory containing binaries and a
Neels Hofmeyr3531a192017-03-28 14:30:28 +020099checksums file, typically created by jenkins using the scripts in contrib/.