Osmocom docker containers
Go to file
Pau Espin 6c696b2294 ttcn3-hlr: Drop uneeded module param HLR_Tests.mp_hlr_supports_dgsm
Since -latest was updated to newer releases, this param is never set to
false anymore, and it already defaults to true, so there's no need to
set it here explicitly. Furthermore, it will be completely dropped soon.

Change-Id: Icab36eba29ad4fadd07ec804ef713910b80ce706
2021-02-26 13:04:07 +01:00
alpine-build introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
alpine-lighttpd Add Dockerfile for alpine Linux with lighttpd 2017-10-15 14:37:41 +00:00
bind9 Makefile support for our production infrastructure containers 2018-06-03 16:11:26 +00:00
centos8-build centos8-build: Make 'make' work again 2020-12-16 10:54:37 +01:00
centos8-repo-install-test centos8-repo-install-test: Upstream requires 'powertools' not 'PowerTools' 2020-12-09 17:09:32 +01:00
cgit cgit: Increase fastcgi timeout from default 60s to 120s 2020-10-03 12:43:20 +02:00
debian-buster-build introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
debian-buster-erlang common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
debian-buster-simtrace2 common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
debian-jessie-build introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
debian-jessie-buildslave Fix "'laforge/debian-jessie-build' not found" 2018-09-06 15:17:06 +02:00
debian-jessie-buildslave-st Fix "'laforge/debian-jessie-build' not found" 2018-09-06 15:17:06 +02:00
debian-jessie-osmocom common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
debian-sid-build introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
debian-stretch-build common: Automatize UPSTREAM_DISTRO name based on image name 2020-12-01 11:46:20 +00:00
debian-stretch-build-dist common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
debian-stretch-jenkins Cosmetic: debian-stretch-jenkins, osmo-gsm-tester: fix indent 2021-01-13 15:56:06 +01:00
debian-stretch-titan ttcn3-{fr,gbproxy}-test: use ttcn3-docker-run too 2021-02-11 15:45:40 +01:00
debian9-repo-install-test rename {debian => debian9}-repo-install-test 2021-01-25 09:24:03 +00:00
debian10-repo-install-test debian10-repo-install-test: new container 2021-01-25 09:24:03 +00:00
fpga-build fpga-build: don't write path to /etc/environment 2021-01-13 15:56:17 +01:00
gerrit gerrit: update to 3.2.7 for security reasons 2021-02-15 12:29:22 +01:00
git-daemon git-deamon: Make sure to create the git-daemon user 2018-07-21 09:38:52 +02:00
gitolite Makefile support for our production infrastructure containers 2018-06-03 16:11:26 +00:00
gr-gsm-master introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
make Add osmo-gbproxy-* container for osmo-gbproxy 2021-02-04 16:48:23 +01:00
nplab-m3ua-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
nplab-sua-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
open5gs-master introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
osmo-bsc-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-bsc-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-bts-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-bts-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-cbc-latest add osmo-cbc-latest container 2021-02-23 20:50:05 +01:00
osmo-cbc-master cbc: Add osmo-cbc-master container 2021-02-22 10:40:33 +01:00
osmo-cn-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-dev-on-debian-sid add debian-sid-build, osmo-dev-on-debian-sid 2017-12-06 01:45:42 +01:00
osmo-gbproxy-master Add osmo-gbproxy-* container for osmo-gbproxy 2021-02-04 16:48:23 +01:00
osmo-gerrit-libosmo make: use $(nproc) instead of hard-coded number of cores 2020-07-13 02:52:10 +07:00
osmo-ggsn-latest ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
osmo-ggsn-master ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
osmo-gsm-tester */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
osmo-hlr-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-hlr-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-hnbgw-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-hnbgw-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-mgw-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-mgw-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-msc-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-msc-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-nitb-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-nitb-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-pcu-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-pcu-master osmo-pcu-master/Dockerfile: add missing libosmoctrl dependency 2021-02-01 14:19:44 +01:00
osmo-ran Introduce osmo-ran docker image set up 2020-12-18 11:45:33 +00:00
osmo-remsim-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-remsim-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-sgsn-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-sgsn-master sgsn: change configuration to the new NS2 2021-01-28 21:55:24 +01:00
osmo-sip-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-sip-master osmo-sip-master: Don't install packages not required 2021-02-11 12:52:21 +01:00
osmo-smlc-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-stp-latest common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmo-stp-master migrate from CentOS_8_Stream to CentOS_8 2020-12-16 10:54:37 +01:00
osmo-uecups-master common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
osmocom-bb-host-master common: Introduce OSMOCOM_REPO_MIRROR param 2020-12-02 14:27:02 +01:00
patchwork Makefile support for our production infrastructure containers 2018-06-03 16:11:26 +00:00
public-inbox add "public-inbox" Dockerfile + Makefiel 2018-10-07 16:27:31 +00:00
redmine redmine: Make changeset keywords work with OS# annotation 2021-02-10 16:57:26 +01:00
scripts ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
sctp-test Switch all osmo-*-master and ttcn3-*-test from jessie to stretch 2019-03-30 09:56:36 +00:00
sigtran-tests Switch all osmo-*-master and ttcn3-*-test from jessie to stretch 2019-03-30 09:56:36 +00:00
systemd Introduce osmo-ran docker image set up 2020-12-18 11:45:33 +00:00
tmp add non-working yml file with service/stack description 2017-05-03 20:50:12 +02:00
ttcn3-bsc-test ttcn3-bsc: Get rid of uneeded param BSC_Tests.mp_media_mgw_offer_ipv6 2021-02-26 12:53:21 +01:00
ttcn3-bsc-test-sccplite symlinks: ttcn3-bsc-test-sccplite 2018-10-26 10:19:05 +02:00
ttcn3-bscnat-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-bts-test bts-test: Drop uneeded module param RSL_Emulation.mp_rslem_patch_ipa_cid 2021-02-26 13:02:02 +01:00
ttcn3-cbc-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-fr-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-gbproxy-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-gbproxy-test-fr */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-ggsn-test ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
ttcn3-hlr-test ttcn3-hlr: Drop uneeded module param HLR_Tests.mp_hlr_supports_dgsm 2021-02-26 13:04:07 +01:00
ttcn3-mgw-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-msc-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-nitb-sysinfo */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-pcu-test Get rid of uneeded param StatsD_Checker.mp_enable_stats 2021-02-26 12:45:20 +01:00
ttcn3-pcu-test-sns PCU: Differentiate between tests with classic and SNS Gb dialects 2019-03-14 21:38:44 +01:00
ttcn3-remsim-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-sccp-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-sgsn-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-sip-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-smlc-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ttcn3-stp-test */jenkins.sh: set -e after setting clean up trap 2021-02-26 09:32:34 +01:00
ubuntu-zesty-build introduce 'REGISTRY' argument to all Dockerfiles 2020-11-02 17:02:26 +01:00
.gitignore ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
.gitreview add .gitreview 2018-04-12 09:20:24 +00:00
README.md ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
Release.key update OBS Release.key; the old one expired today. 2020-03-30 18:06:58 +02:00
jenkins-common.sh ttcn3-ggsn-test: add kernel test 2021-02-26 09:32:39 +01:00
osmo-bisect.sh Add script to bisect test failures with ttcn3 and docker 2019-04-26 12:07:15 +02:00

README.md

Osmocom docker playground

This repository contains some humble attempts at creating some Docker containers + related stacks around Osmocom. So far, the main focus is test automation.

Running a testsuite

All testsuite folders start with ttcn3 or nplab. Run the following to build/update all required containers and start a specific testsuite:

$ cd ttcn3-mgw-test
$ ./jenkins.sh

Environment variables:

  • IMAGE_SUFFIX: the version of the Osmocom stack to run the testsuite against. Default is master, set this to latest to test the last stable releases.
  • OSMO_TTCN3_BRANCH: osmo-ttcn3-hacks.git branch, which will be used when building a ttcn3-* docker image. Defaults to master.
  • NO_DOCKER_IMAGE_BUILD: when set to 1, it won't try to update the containers (see "caching" below)

Kernel test

OsmoGGSN can be configured to either run completely in userspace, or to use the GTP-U kernel module. To test the kernel module, OsmoGGSN and the kernel module will run with a Linux kernel (either the pre-built one from Debian, or a custom built one) in QEMU inside docker. As of writing, ttcn3-ggsn-test is the only testsuite where it makes sense to test kernel modules. But the same environment variables could be used for other testsuites in the future.

Environment variables:

  • KERNEL_TEST: set to 1 to run the SUT in QEMU
  • KERNEL_BUILD: set to 1 to build the kernel instead of using the pre-built one
  • KERNEL_REMOTE_NAME: git remote name (to add multiple git repositories in the same local linux clone, default: net-next)
  • KERNEL_URL: git remote url (default: net-next.git on kernel.org)
  • KERNEL_BRANCH branch to checkout (default: master)

Creating kernel config fragments

For the kernel tests, we are storing kernel config fragments in the git repository instead of full kernel configs. Generate them as follows:

$ cd _cache/linux
$ cp custom.config .config
$ make olddefconfig
$ cp .config custom-updated.config
$ make defconfig  # config to which to diff
$ scripts/diffconfig -m .config custom-updated.config > fragment.config

Verify that it was done right:

$ make defconfig
$ scripts/kconfig/merge_config.sh -m .config fragment.config
$ make olddefconfig
$ diff .config custom-updated.config  # should be the same

Building containers manually

Most folders in this repository contain a Dockerfile. Build a docker container with the same name as the folder like this:

$ cd debian-stretch-build
$ make

Caching

All folders named osmo-*-latest and osmo-*-master build the latest stable or most recent commit from master of the corresponding Osmocom program's git repository. When you have built it already, running make will only do a small HTTP request to check if the sources are outdated and skip the build in case it is still up-to-date.

Dependencies

Folders that don't have a jenkins.sh usually only depend on the container that is specified in the FROM line of their Dockerfile. Testsuites depend on multiple containers, they are defined on top of each jenkins.sh:

. ../jenkins-common.sh
IMAGE_SUFFIX="${IMAGE_SUFFIX:-master}"
docker_images_require \
	"osmo-stp-$IMAGE_SUFFIX" \
	"osmo-bsc-$IMAGE_SUFFIX" \
	"osmo-bts-$IMAGE_SUFFIX" \
	"ttcn3-bsc-test"

Reasoning for this implementation

Before having the docker_images_require lines, there used to be a top-level Makefile for resolving dependencies between the containers. But it was prone to mistakes: when new folders in the repository were added without related targets in the Makefile, make would always assume that the targets where the always existing folders and therefore never build the containers.

In order to implement testing latest in addition to master (OS#3268), it would have been necessary to add further complexity to the Makefile. Instead it was decided to scrap the file, and just keep the short list of dependencies right above where they would be needed in the jenkins.sh.

Obtaining gdb backtrace from crash

If for instance TTCN3 test is producing a crash on a program running in docker, eg. osmo-msc, it is desirable to get a full crash report. This section describes how to do so.

First, open osmo-$program/Dockerfile and add lines to install gdb plus $program dependency debug packages. For instance:

+RUN    apt-get install -y --no-install-recommends \
+               gdb \
+               libosmocore-dbg libosmo-abis-dbg libosmo-netif-dbg libosmo-sigtran-dbg osmo-msc-dbg && \
+               apt-get clean

In same Dockerfile file, modify configure to build with debug symbols enabled and other interesting options, such as --enable-sanitize:

-       ./configure --enable-smpp --enable-iu && \
+       export CPPFLAGS="-g -O0 -fno-omit-frame-pointer" && \
+       export CFLAGS="-g -O0 -fno-omit-frame-pointer" && \
+       export CXXFLAGS="-g -O0 -fno-omit-frame-pointer" && \
+       ./configure --enable-smpp --enable-iu --enable-sanitize && \

Finally open the script you use to run the program (for instance ttcn3-$program-master/jenkins.sh), and modify it to launch the process using gdb, and to print a full backtrace when control returns to gdb (when the process crashes):

-/bin/sh -c "osmo-msc -c /data/osmo-msc.cfg >>/data/osmo-msc.log 2>&1"
+/bin/sh -c "gdb -ex 'run' -ex 'bt full' --arg osmo-msc -c /data/osmo-msc.cfg >>/data/osmo-msc.log 2>&1"

See also