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