openairinterface5g/doc/TESTBenches.md

Table of Contents

[[TOC]]

Machines

Machine	IP address	Lockable Resource	Function	Connected devices
asterix	172.21.16.127	CI-Asterix-Usage	unused	172.21.19.14
obelix	172.21.16.128	CI-Obelix-Usage	eNB (n40, n78), nrUE	172.21.19.13, X300 (192.168.60.2)
porcepix	172.21.16.136	CI-Porcepix	Executor, EPC, 5GC	--
nrmodule2	172.21.16.139	CI-NrModule2	Quectel	Quectel module
nepes	172.21.16.137	CI-Nepes	gNB (n78), EPC/5GC	B200mini (30C51EB)
ofqot	172.21.16.109	CI-Ofqot	gNB (n78)	B200mini (30C51D4)
idefix	172.21.16.135	CI-Idefix	Quectel	Quectel module
caracal	172.21.16.132	CI-Caracal	gNB/phytest	N300 (192.168.10.2)
amariue	172.21.16.144	CI-Amarisoft-UE-Usage	nrUE	Amarisoft UE simulator
nano	172.21.18.48	CI-Nano-Legacy-EPC	Executor, EPC, adb	2x COTS (adb)
hutch	172.21.18.46	CI-Hutch-Legacy-FDD-eNB	eNB (B7)	B200mini (30C5239)
starsky	172.21.18.45	CI-Starsky-Legacy-TDD-eNB	eNB (B40)	b200mini (30A3E3C)
carabe	172.21.18.47	CI-Carabe-Legacy-FDD-OAI-LTE-UE	UE (B7UE)	B200mini (30AE8C9)
nokiabox	172.21.19.39	None	gNB (Nokia), 5GC	Nokia RF integrated
avra	172.21.16.124	CI-Avra-Usage	gNB (n78)	AW2S Jaguar (192.168.80.239)
orion	172.21.16.134	CI-Orion-Build-Sanity-Check-Deploy-Test, CI-Orion-DsTester-Deploy-Test	Build

Note: The available resources, and their current usage, is indicated here:

• Lockable resources of jenkins-oai: "New" Jenkins, i.e., with RAN-Container-Parent

Testbenches

5G OTA Testbench

Purpose: Over-the-air 4G/5G (NSA/SA) tests, performance tests

PDF version | LaTeX/TikZ version if you want to modify to reflect your setup

5G NSA/Faraday Cage Testbench

Purpose: Faraday cage 5G tests, functional tests

PDF version | LaTeX/TikZ version if you want to modify to reflect your setup

5G AW2S Testbench

Purpose: AW2S tests with Amarisoft UE simulator

PDF version | LaTeX/TikZ version if you want to modify to reflect your setup

5G UE OTA Testbench

Purpose: Over-the-air 5G tests with OAI UE

PDF version | LaTeX/TikZ version if you want to modify to reflect your setup

4G Testbench(es)

Purpose: 4G/LTE testbenches

PDF version | LaTeX/TikZ version if you want to modify to reflect your setup

Pipelines

RAN-Container-Parent

Purpose: automatically triggered tests on MR creation or push, from Gitlab Webhook ~documentation ~BUILD-ONLY ~4G-LTE ~5G-NR

• OAI-CN5G-COTS-UE-Test ~5G-NR
  • using 5GC bench (resources CI-Cetautomatix-OC-oaicicd-session, CI-Dogmatix-CN5G-gNB): Attach/Detach of UE with multiple PDU sessions
• RAN-cppcheck ~BUILD-ONLY ~4G-LTE ~5G-NR
  • obelix
  • performs static code analysis, currently not actively enforced
• RAN-gNB-N300-Timing-Phytest-LDPC ~5G-NR
  • caracal + N310
  • pure performance test through phy-test scheduler, see command line for more details
• RAN-Interop-F1 ~5G-NR
  • ofqot (DU, 1x UE)
  • F1 interoperability testing: sets up connection to Accelleran CU, UE connection and connectivity test
• RAN-L2-Sim-Test-4G ~4G-LTE
  • obelix (eNB, 1x UE, OAI EPC)
  • L2simulator: skips physical layer and uses proxy between eNB and UE
• RAN-L2-Sim-Test-5G ~5G-NR
  • obelix (gNB, 1x UE, OAI 5GC)
  • L2simulator: skips physical layer and uses proxy between gNB and UE, currently only ping
• RAN-LTE-FDD-LTEBOX-Container ~4G-LTE
  • hutch + B210, nano w/ ltebox + 2x UE
  • tests RRC inactivity timers, different bandwidths, IF4p5 fronthaul
• RAN-LTE-FDD-OAIUE-OAICN4G-Container ~4G-LTE
  • hutch + B210 (eNB), carabe + B210 (4G UE), nano w/ OAI 4GC
  • tests OAI 4G for 10 MHz/TM1; known to be unstable
• RAN-LTE-TDD-2x2-Container ~4G-LTE
  • obelix + N310, porcepix, nrmodule2 + Quectel
  • TM1 and TM2 test, IF4p5 fronthaul
• RAN-LTE-TDD-LTEBOX-Container ~4G-LTE
  • starsky + B210, nano w/ ltebox + 2x UE
  • TM1 over bandwidths 5, 10, 20 MHz in Band 40, default scheduler for 20 MHz
• RAN-NSA-B200-Module-LTEBOX-Container ~4G-LTE ~5G-NR
  • nepes + B200 (eNB), ofqot + B200 (gNB), idefix + Quectel, nepes w/ ltebox
  • basic NSA test
• RAN-PhySim-Cluster ~4G-LTE ~5G-NR
  • cluster (Asterix-OC-oaicicd-session resource), tests in OpenShift Cluster
  • unitary simulators (nr_dlsim, etc.)
• RAN-RF-Sim-Test-4G ~4G-LTE
  • obelix (eNB, lteUE, OAI EPC)
  • uses RFsimulator, for FDD 5, 10, 20MHz with core, 5MHz noS1
• RAN-RF-Sim-Test-5G ~5G-NR
  • obelix (gNB, nrUE, OAI 5GC)
  • uses RFsimulator, TDD 40MHz, FDD 40MHz, F1 split
• RAN-RHEL8-Cluster-Image-Builder ~BUILD-ONLY ~4G-LTE ~5G-NR
  • cluster (Asterix-OC-oaicicd-session resource): RHEL image build using the OpenShift Cluster (using gcc/clang)
• RAN-ARM-Cross-Compile-Builder ~BUILD-ONLY ~4G-LTE ~5G-NR
  • orion: Cross-compilation from Intel to ARM
• RAN-SA-AW2S-CN5G ~5G-NR
  • 5G-NR SA test setup: avra(RHEL9.1) + AW2S, amariue, OAI CN5G
  • uses OpenShift cluster for CN deployment and container images for gNB deployment
  • multi UE testing using Amarisoft UE simulator
• RAN-SA-B200-Module-SABOX-Container ~5G-NR
  • ofqot + B200, idefix + Quectel, nepes w/ sabox
  • basic SA test (20 MHz TDD), F1, reestablishment, ...
• RAN-SA-OAIUE-CN5G ~5G-NR
  • 5G-NR SA test setup: gNB on avra(RHEL9.2) + N310, OAIUE on caracal(RHEL9.1) + N310, OAI CN5G
  • OpenShift cluster for CN deployment and container images for gNB and UE deployment
• RAN-Ubuntu18-Image-Builder ~BUILD-ONLY ~4G-LTE ~5G-NR
  • obelix: Ubuntu 20 image build using docker (Note: builds U20 images while pipeline is named U18!)

RAN-CI-NSA-Trigger

DEFUNCT: longer-running over-the-air LTE, NSA, and SA tests. To be integrated into RAN-Container-Parent.

• RAN-NSA-2x2-Module-OAIEPC
  • obelix + N310 (eNB), asterix + N310 (gNB), nrmodule2 + Quectel, porcepix w/ Magma EPC
  • LTE 2x2 and NR 2x2 (non-standalone)
• RAN-SA-Module-CN5G
  • asterix + N310 (gNB), nrmodule2 + Quectel, porcepix w/ OAI 5GC
  • NR 2x2 (standalone)

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 --sa -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 --sa -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.