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.
 
 
 
 
 
Pau Espin d8f641bd39 ttcn3-hnbgw: sed junit file in the clean_up trap 4 days ago
arm-none-eabi-gcc-4.8.2 */Dockerfile: drop MAINTAINER line 5 months ago
bind9 */.release: remove 3 months ago
centos7-build Use Osmocom OBS 3 months ago
centos7-obs-latest Use Osmocom OBS 3 months ago
centos8-build Use Osmocom OBS 3 months ago
centos8-obs-latest Use Osmocom OBS 3 months ago
centos8-repo-install-test centos8-repo-install-test: set UPSTREAM_DISTRO=almalinux:8 in Makefile 7 months ago
cgit */.release: remove 3 months ago
common Use Osmocom OBS 3 months ago
debian-bullseye-build Use Osmocom OBS 3 months ago
debian-bullseye-erlang Use Osmocom OBS 3 months ago
debian-bullseye-jenkins debian-bullseye-jenkins: new container 3 months ago
debian-bullseye-obs-latest Use Osmocom OBS 3 months ago
debian-bullseye-titan Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
debian-buster-build Use Osmocom OBS 3 months ago
debian-buster-jenkins Use Osmocom OBS 3 months ago
debian-buster-simtrace2 Use Osmocom OBS 3 months ago
debian-sid-build */.release: remove 3 months ago
debian-sid-jenkins Use Osmocom OBS 3 months ago
debian10-obs-submit debian10-obs-submit: new container 1 year ago
debian10-repo-install-test debian10-repo-install-test: new container 2 years ago
debian11-repo-install-test debian11-repo-install-test: add container 3 months ago
fpga-build */Dockerfile: drop MAINTAINER line 5 months ago
gerrit */.release: remove 3 months ago
git-daemon */.release: remove 3 months ago
gr-gsm-master */.release: remove 3 months ago
make Use Osmocom OBS 3 months ago
nplab-m3ua-test */.release: remove 3 months ago
nplab-sua-test */.release: remove 3 months ago
open5gs-latest */Dockerfile: drop MAINTAINER line 5 months ago
open5gs-master open5gs: Enable libmetrics prometheus implementation 4 months ago
openbts-umts */Dockerfile: drop MAINTAINER line 5 months ago
osmo-bsc-latest */.release: remove 3 months ago
osmo-bsc-master */.release: remove 3 months ago
osmo-bts-latest */.release: remove 3 months ago
osmo-bts-master osmo-bts-master: Depend on libosmo-netif 3 weeks ago
osmo-cbc-latest osmo-*-latest: use OSMOCOM_REPO_VERSION 1 year ago
osmo-cbc-master osmo-cbc-master: Fix missing ldconfig 2 months ago
osmo-cn-latest */.release: remove 3 months ago
osmo-dev-on-debian-sid */.release: remove 3 months ago
osmo-gbproxy-latest common/pipework: deduplicate 7 months ago
osmo-gbproxy-master common/pipework: deduplicate 7 months ago
osmo-ggsn-latest */.release: remove 3 months ago
osmo-ggsn-master */.release: remove 3 months ago
osmo-gsm-tester osmo-gsm-tester: use debian's soapysdr-module-lms7 3 months ago
osmo-hlr-latest */.release: remove 3 months ago
osmo-hlr-master osmo-hlr-master: install libsqlite3-dev/sqlite-devel 1 month ago
osmo-hnbgw-latest */.release: remove 3 months ago
osmo-hnbgw-master osmo-hnbgw-master: build with --enable-pfcp 2 weeks ago
osmo-hnodeb-latest osmo-hnodeb-latest: new container 2 months ago
osmo-hnodeb-master make/Makefile: always use docker run --rm 7 months ago
osmo-mgw-latest */.release: remove 3 months ago
osmo-mgw-master make/Makefile: always use docker run --rm 7 months ago
osmo-msc-latest */.release: remove 3 months ago
osmo-msc-master osmo-msc-master: install libsqlite3-dev/sqlite-devel 1 month ago
osmo-nitb-latest osmo-*-latest: use OSMOCOM_REPO_VERSION 1 year ago
osmo-nitb-master */.release: remove 3 months ago
osmo-ns-master common/pipework: deduplicate 7 months ago
osmo-pcap-latest osmo-pcap-latest: fix install path for centos 10 months ago
osmo-pcap-master osmo-pcap-master: doesn't need libosmo-netif 10 months ago
osmo-pcu-latest */.release: remove 3 months ago
osmo-pcu-master */.release: remove 3 months ago
osmo-ran Use Osmocom OBS 3 months ago
osmo-remsim-latest */.release: remove 3 months ago
osmo-remsim-master */.release: remove 3 months ago
osmo-sgsn-latest */.release: remove 3 months ago
osmo-sgsn-master */.release: remove 3 months ago
osmo-sip-latest */.release: remove 3 months ago
osmo-sip-master */.release: remove 3 months ago
osmo-smlc-latest osmo-*-latest: use OSMOCOM_REPO_VERSION 1 year ago
osmo-smlc-master make/Makefile: always use docker run --rm 7 months ago
osmo-stp-latest */.release: remove 3 months ago
osmo-stp-master */.release: remove 3 months ago
osmo-uecups-master */.release: remove 3 months ago
osmocom-bb-host-master */.release: remove 3 months ago
redmine */.release: remove 3 months ago
release-tarball-build-dist release-tarball-build-dist/Makefile: update 3 months ago
scripts scripts/kernel-test/run-qemu.sh: update qemu args 9 months ago
sctp-test */.release: remove 3 months ago
sigtran-tests */.release: remove 3 months ago
systemd */Dockerfile: drop MAINTAINER line 5 months ago
ttcn3-bsc-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-bsc-test-sccplite symlinks: ttcn3-bsc-test-sccplite 4 years ago
ttcn3-bsc-test-vamos Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-bscnat-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-bts-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-cbc-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-fr-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-gbproxy-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-gbproxy-test-fr ttcn3: write Osmocom repository to configs 10 months ago
ttcn3-ggsn-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-ggsn-test-ogs Add ttcn3-ggsn-ogs testsuite 8 months ago
ttcn3-hlr-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-hnbgw-test ttcn3-hnbgw: sed junit file in the clean_up trap 4 days ago
ttcn3-hnodeb-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-mgw-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-msc-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-nitb-sysinfo Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-ns-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-ns-test-fr Add ttcn3-ns-test-fr container 2 years ago
ttcn3-ns-test-sgsn-sns ttcn3-ns-test-sgsn-sns: add test run for ns sgsn role with sns 1 year ago
ttcn3-ns-test-sns Add ttcn3-ns-test-sns container 2 years ago
ttcn3-pcap-client-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-pcu-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-pcu-test-sns PCU: Differentiate between tests with classic and SNS Gb dialects 4 years ago
ttcn3-pgw-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-remsim-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-sccp-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-sgsn-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-sip-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-smlc-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
ttcn3-stp-test Use gerrit as osmo-ttcn3-hacks.git git remote 5 days ago
.gitignore release-tarball-build-dist: move osmo-ci code here 3 months ago
.gitreview add .gitreview 5 years ago
README.md Use Osmocom OBS 3 months ago
jenkins-common.sh fix_perms: use debian:bullseye 2 months ago
osmo-bisect.sh Use osmo-hnbgw from osmo-hnbgw.git instead of osmo-iuh.git 9 months 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 from the "master" branch 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)

More examples

latest (debian):

$ export IMAGE_SUFFIX="latest"
$ cd ttcn3-mgw-test
$ ./jenkins.sh

latest-centos8:

$ export IMAGE_SUFFIX="latest-centos8"
$ cd ttcn3-mgw-test
$ ./jenkins.sh

2021q1-centos8:

export OSMOCOM_REPO_TESTSUITE_MIRROR="https://downloads.osmocom.org"
export OSMOCOM_REPO_MIRROR="https://downloads.osmocom.org"
export OSMOCOM_REPO_PATH="osmo-maintained"
export OSMOCOM_REPO_VERSION="2021q1"
export IMAGE_SUFFIX="2021q1-centos8"
$ cd ttcn3-mgw-test
$ ./jenkins.sh

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://downloads.osmocom.org/packages/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