Osmocom docker containers
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Oliver Smith 6ad42884a5 centos8-obs-latest: use OSMOCOM_REPO_VERSION 2 years ago
alpine-build introduce 'REGISTRY' argument to all Dockerfiles 2 years ago
alpine-lighttpd Add Dockerfile for alpine Linux with lighttpd 5 years ago
arm-none-eabi-gcc-4.8.2 arm-none-eabi-gcc-4.8.2: install missing packages 2 years ago
bind9 Makefile support for our production infrastructure containers 5 years ago
centos8-build make: add OSMOCOM_REPO_PATH 2 years ago
centos8-obs-latest centos8-obs-latest: use OSMOCOM_REPO_VERSION 2 years ago
centos8-repo-install-test centos8-repo-install-test: Upstream requires 'powertools' not 'PowerTools' 2 years ago
cgit cgit: Increase fastcgi timeout from default 60s to 120s 2 years ago
common Share a single instance of Release.key between all images 2 years ago
debian-buster-build Make respawn.sh a common part of *-build/-obs images 2 years ago
debian-buster-erlang make: add OSMOCOM_REPO_PATH 2 years ago
debian-buster-jenkins make: add OSMOCOM_REPO_PATH 2 years ago
debian-buster-simtrace2 make: add OSMOCOM_REPO_PATH 2 years ago
debian-jessie-build Make respawn.sh a common part of *-build/-obs images 2 years ago
debian-jessie-buildslave Fix "'laforge/debian-jessie-build' not found" 4 years ago
debian-jessie-buildslave-st Fix "'laforge/debian-jessie-build' not found" 4 years ago
debian-jessie-osmocom make: add OSMOCOM_REPO_PATH 2 years ago
debian-sid-build Make respawn.sh a common part of *-build/-obs images 2 years ago
debian-stretch-build make: add OSMOCOM_REPO_PATH 2 years ago
debian-stretch-build-dist Share a single instance of Release.key between all images 2 years ago
debian-stretch-jenkins make: add OSMOCOM_REPO_PATH 2 years ago
debian-stretch-obs-latest make: add OSMOCOM_REPO_PATH 2 years ago
debian-stretch-titan make: add OSMOCOM_REPO_TESTSUITE_MIRROR 2 years ago
debian9-repo-install-test rename {debian => debian9}-repo-install-test 2 years ago
debian10-obs-submit debian10-obs-submit: new container 2 years ago
debian10-repo-install-test debian10-repo-install-test: new container 2 years ago
fpga-build fpga-build: don't write path to /etc/environment 2 years ago
gerrit gerrit: update to 3.2.7 for security reasons 2 years ago
git-daemon git-deamon: Make sure to create the git-daemon user 4 years ago
gitolite Makefile support for our production infrastructure containers 5 years ago
gr-gsm-master introduce 'REGISTRY' argument to all Dockerfiles 2 years ago
make make: add OSMOCOM_REPO_TESTSUITE_MIRROR 2 years ago
nplab-m3ua-test remove deprecated 'logging level all everything' from configs 2 years ago
nplab-sua-test remove deprecated 'logging level all everything' from configs 2 years ago
open5gs-master introduce 'REGISTRY' argument to all Dockerfiles 2 years ago
osmo-bsc-latest */osmo-bsc.cfg: remove obsolete no-op parameters 2 years ago
osmo-bsc-master */osmo-bsc.cfg: remove obsolete no-op parameters 2 years ago
osmo-bts-latest remove deprecated 'logging level all everything' from configs 2 years ago
osmo-bts-master remove deprecated 'logging level all everything' from configs 2 years ago
osmo-cbc-latest osmo-*-latest: support centos8 2 years ago
osmo-cbc-master osmo-*-master: move common code to *-build 2 years ago
osmo-cn-latest osmo-mgw: Use DSCP value in valid range (<= 63) 2 years ago
osmo-dev-on-debian-sid add debian-sid-build, osmo-dev-on-debian-sid 5 years ago
osmo-gbproxy-latest osmo-*-latest: support centos8 2 years ago
osmo-gbproxy-master osmo-*-master: move common code to *-build 2 years ago
osmo-gerrit-libosmo make: use $(nproc) instead of hard-coded number of cores 2 years ago
osmo-ggsn-latest osmo-*-latest: support centos8 2 years ago
osmo-ggsn-master osmo-*-master: move common code to *-build 2 years ago
osmo-gsm-tester osmo-gsm-tester: open5gs deps only for x86_64 2 years ago
osmo-hlr-latest osmo-*-latest: support centos8 2 years ago
osmo-hlr-master osmo-*-master: move common code to *-build 2 years ago
osmo-hnbgw-latest debian-stretch-obs-latest: new container 2 years ago
osmo-hnbgw-master osmo-*-master: move common code to *-build 2 years ago
osmo-mgw-latest osmo-mgw: Use DSCP value in valid range (<= 63) 2 years ago
osmo-mgw-master remove deprecated 'logging level all everything' from configs 2 years ago
osmo-msc-latest Share a single instance of Release.key between all images 2 years ago
osmo-msc-master osmo-*-master: move common code to *-build 2 years ago
osmo-nitb-latest remove deprecated 'logging level all everything' from configs 2 years ago
osmo-nitb-master remove deprecated 'logging level all everything' from configs 2 years ago
osmo-ns-master Add ttcn3-ns-test-fr container 2 years ago
osmo-pcap-latest Add osmo-pcap-latest 2 years ago
osmo-pcap-master Add osmo-pcap-master 2 years ago
osmo-pcu-latest Make respawn.sh a common part of *-build/-obs images 2 years ago
osmo-pcu-master Make respawn.sh a common part of *-build/-obs images 2 years ago
osmo-ran make: add OSMOCOM_REPO_PATH 2 years ago
osmo-remsim-latest debian-stretch-obs-latest: new container 2 years ago
osmo-remsim-master osmo-remsim-master/Dockerfile: add missing libcsv-devel dependency 2 years ago
osmo-sgsn-latest osmo-*-latest: support centos8 2 years ago
osmo-sgsn-master osmo-*-master: move common code to *-build 2 years ago
osmo-sip-latest osmo-*-latest: support centos8 2 years ago
osmo-sip-master osmo-*-master: move common code to *-build 2 years ago
osmo-smlc-latest osmo-*-latest: support centos8 2 years ago
osmo-smlc-master osmo-*-master: move common code to *-build 2 years ago
osmo-stp-latest remove deprecated 'logging level all everything' from configs 2 years ago
osmo-stp-master remove deprecated 'logging level all everything' from configs 2 years ago
osmo-uecups-master osmo-*-master: move common code to *-build 2 years ago
osmocom-bb-host-master make: add OSMOCOM_REPO_TESTSUITE_MIRROR 2 years ago
patchwork Makefile support for our production infrastructure containers 5 years ago
public-inbox add "public-inbox" Dockerfile + Makefiel 4 years ago
redmine redmine: Make changeset keywords work with OS# annotation 2 years ago
scripts kernel-test: verify REMOTE_NAME and URL 2 years ago
sctp-test Switch all osmo-*-master and ttcn3-*-test from jessie to stretch 4 years ago
sigtran-tests Switch all osmo-*-master and ttcn3-*-test from jessie to stretch 4 years ago
systemd Introduce osmo-ran docker image set up 2 years ago
tmp add non-working yml file with service/stack description 6 years ago
ttcn3-bsc-test remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-bsc-test-sccplite symlinks: ttcn3-bsc-test-sccplite 4 years ago
ttcn3-bscnat-test */jenkins.sh: set -e after setting clean up trap 2 years ago
ttcn3-bts-test ttcn3-bts-test: OML tests ivolve no GSMTAP Um logging 2 years ago
ttcn3-cbc-test ttcn3-cbc-test: fix copy+paste error regarding osmo-stp.cfg 2 years ago
ttcn3-fr-test fr: kill the frnet container before trying to 'rm' it 2 years ago
ttcn3-gbproxy-test remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-gbproxy-test-fr remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-ggsn-test kernel-test: don't try to use KVM if not available 2 years ago
ttcn3-hlr-test ttcn3-hlr: Drop uneeded module param HLR_Tests.mp_hlr_supports_dgsm 2 years ago
ttcn3-mgw-test osmo-mgw: Use DSCP value in valid range (<= 63) 2 years ago
ttcn3-msc-test remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-nitb-sysinfo */jenkins.sh: set -e after setting clean up trap 2 years ago
ttcn3-ns-test Add ttcn3-ns-test-fr container 2 years ago
ttcn3-ns-test-fr Add ttcn3-ns-test-fr container 2 years ago
ttcn3-ns-test-sns Add ttcn3-ns-test-sns container 2 years ago
ttcn3-pcap-client-test Add ttcn3-pcap-client-test 2 years ago
ttcn3-pcu-test ttcn3-pcu-sns: add vty parameter to allow ttcn3 to connect 2 years ago
ttcn3-pcu-test-sns PCU: Differentiate between tests with classic and SNS Gb dialects 4 years ago
ttcn3-remsim-test */jenkins.sh: set -e after setting clean up trap 2 years ago
ttcn3-sccp-test */jenkins.sh: set -e after setting clean up trap 2 years ago
ttcn3-sgsn-test remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-sip-test remove deprecated 'logging level all everything' from configs 2 years ago
ttcn3-smlc-test */jenkins.sh: set -e after setting clean up trap 2 years ago
ttcn3-stp-test */jenkins.sh: set -e after setting clean up trap 2 years ago
ubuntu-zesty-build introduce 'REGISTRY' argument to all Dockerfiles 2 years ago
.gitignore Make respawn.sh a common part of *-build/-obs images 2 years ago
.gitreview add .gitreview 5 years ago
README.md make: add OSMOCOM_REPO_PATH 2 years ago
jenkins-common.sh docker_images_require: list installed Osmocom pkgs 2 years ago
osmo-bisect.sh Add script to bisect test failures with ttcn3 and docker 4 years ago

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.
  • OSMO_BSC_BRANCH, OSMO_MSC_BRANCH, ...: branch of the appropriate Osmocom project. 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_TEST_KVM: set to 0 to disable KVM acceleration
  • 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)

The OBS repository mirror consists of ${OSMOCOM_REPO_MIRROR}/${OSMOCOM_REPO_PATH}/${OSMOCOM_REPO_VERSION}, e.g. https://download.opensuse.org/repositories/network:/osmocom:/latest/.

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