Skip to content

TESTBenches.md

Latest commit

 

History

History
442 lines (392 loc) · 24.1 KB

TESTBenches.md

File metadata and controls

442 lines (392 loc) · 24.1 KB
Raw

Table of Contents

[[TOC]]

CI resources

The available resources, and their current usage, is indicated here: Lockable resources of jenkins-oai

Finding the resources used by a CI pipeline

To view the resource configuration for a specific pipeline run:

  1. Open the Jenkins job, for example RAN-SA-OAIUE-CN5G.
  2. In Builds, click a build number of a completed run.
  3. Select Parameters in the run's sidebar.
  4. Look for the LockResources parameter, which lists the resources configured for that run. For example, RAN-SA-OAIUE-CN5G

Pipelines

CI pipelines fall into two groups:

  • Event-triggered pipelines: triggered automatically when a pull request is opened or updated, or on a push event. Which pipelines run depends on the labels of the pull request.
  • Scheduled pipelines: Runs on a nightly schedule against the latest develop or integration branch, independently of any pull request. They cover long-running or resource-intensive tests.

Event-triggered pipelines

All pipelines in this group are started by the parent pipeline RAN-GitHub-Container-Parent.

This pipeline has two main stages: image build and image test. For the image build, please also refer to the dedicated documentation.

Image Build pipelines

Image Test pipelines

Scheduled pipelines

Runs on a nightly schedule against the latest develop or integration branch, independently of any pull request. They cover long-running or resource-intensive tests.

  • RAN-SA-FHI72-4x4-CN5G
    • Purpose: FHI 7.2 testing with 100 MHz bandwidth, 4 layers in DL, 2 layers in UL
    • Hardware: VVDN LPRU, Benetel 550/650, LiteON FlexFi, Metanoia Cobra, AMD T2 Telco Card
    • Details: OpenShift cluster for CN deployment
  • RAN-Nightly-Channel-Simulation
    • Purpose: test_channel_scalability to test GPU channel simulation across different channel configurations
  • RAN-SA-OAIUE-CN5G-Longrun
    • Purpose: 5G-NR SA test setup with OAI nrUE; iperf3 traffic test runs for 1 hour
    • Hardware: USRP N310 (gNB + nrUE)
    • Details: OpenShift cluster for CN deployment and container images for gNB and UE deployment

How to reproduce CI results

The CI builds docker images at the beginning of every test run. To see the exact command line steps, please refer to the docker/Dockerfile.build.* files. Note that the console log of each pipeline run also lists the used docker files.

The CI uses these images for most of the pipelines. It uses docker-compose to orchestrate the images. To identify the docker-compose file, follow these steps:

  1. Each CI test run HTML lists the XML file used for a particular test run. Open the corresponding XML file under ci-scripts/xml_files/.
  2. The XML file has a "test case" that refers to deployment of the image; it will reference a directory containing a YAML file (the docker-compose file) using option yaml_path, which will be under ci-scripts/yaml_files/. Go to this directory and open the docker-compose file.
  3. The docker-compose file can be used to run images locally, or you can infer the used configuration file and possible additional options that are to be passed to the executable to run from source.

For instance, to see how the CI runs the multi-UE 5G RFsim test case, the above steps look like this:

  1. The first tab in the 5G RFsim test mentions xml_files/container_5g_rfsim.xml, so open ci-scripts/xml_files/container_5g_rfsim.xml.
  2. This XML file has a DeployGenObject test case, referencing the directory yaml_files/5g_rfsimulator. The corresponding docker-compose file path is ci-scripts/yaml_files/5g_rfsimulator/docker-compose.yaml.
  3. To know how to run the gNB, realize that there is a section oai-gnb. It mounts the configuration ci-scripts/conf_files/gnb.sa.band78.106prb.rfsim.conf (note that the path is relative to the directory in which the docker-compose file is located). Further, an environment variable USE_ADDITIONAL_OPTIONS is declared, referencing the relevant options -E --rfsim (you can ignore logging options). You would therefore run the gNB from source like this: 
    sudo ./cmake_targets/ran_build/build/nr-softmodem -O ci-scripts/conf_files/gnb.sa.band78.106prb.rfsim.conf -E --rfsim
    To run this on your local machine, assuming you have a 5GC installed, you might need to change IP information in the config to match your core.

If you wish, you can rebuild CI images locally following these steps and then use the docker-compose file directly.

Some tests are run from source (e.g. ci-scripts/xml_files/gnb_phytest_usrp_run.xml), which directly give the options they are run with.

How to debug CI failures

It is possible to debug CI failures using the generated core dump and the image used for the run. A script is provided (see developer instructions below) that, provided the core dump file, container image, and the source tree, executes gdb inside the container; using the core dump information, a developer can investigate the cause of failure.

Developer instructions

The CI team will send you a docker image and a core dump file, and the commit as of which the pipeline failed. Let's assume the coredump is stored at /tmp/coredump.tar.xz, and the image is in /tmp/oai-nr-ue.tar.gz. First, you should check out the corresponding branch (or directly the commit), let's say in ~/oai-branch-fail. Now, unpack the core dump, load the image into docker, and use the script docker/debug_core_image.sh to open gdb, as follows:

cd /tmp
tar -xJf /tmp/coredump.tar.xz
docker load < /tmp/oai-nr-ue.tar.gz
~/oai-branch-fail/docker/debug_core_image.sh <image> /tmp/coredump ~/oai-branch-fail

where you replace <image> with the image loaded in docker load. The script will start the container and open gdb; you should see information about where the failure (e.g., segmentation fault) happened. If you just see ??, the core dump and container image don't match. Be also on the lookout for the corresponding message from gdb:

warning: core file may not match specified executable file.

Once you quit gdb, the container image will be removed automatically.

CI team instructions

The entrypoint scripts of all containers print the core pattern that is used on the running machine. Search for core_pattern at the start of the container logs to retrieve the possible location. Possible locations might be:

See below for instructions on how to retrieve the core dump. Further, download the image and store it to a file using docker save. Make sure to pick the right image (Ubuntu or RHEL)!

Core dump in a file

This is not recommended, as files could pile up and fill the system disk completely! Prefer another method further down.

If the core pattern is a path: it should at least include the time in the pattern name (suggested pattern: /tmp/core.%e.%p.%t) to correlate the time the segfault occurred with the CI logs. If you identified the core dump, copy the core dump from that machine; if identification is difficult, consider rerunning the pipeline.

Core dump via systemd

Use the first command to list all core dumps. Scroll down to the core dump of interest (it lists the executables in the last column; use the time to correlate the segfault and the CI run). Take the PID of the executable (first column after the time). Dump the core dump to a location of your choice.

sudo coredumpctl list
sudo coredumpctl dump <PID> > /tmp/coredump

Core dump via abrt (automatic bug reporting tool)

TBD: use the documentation page for the moment.

Core dump via apport

I did not find an easy way to use apport. Anyway, the systemd approach works fine. So remove apport, install systemd-coredump, and verify it is the new coredump handler:

sudo systemctl stop apport
sudo systemctl mask --now apport
sudo apt install systemd-coredump
# Verify this changed the core pattern to a pipe to systemd-coredump
sysctl kernel.core_pattern