Make run_locally.sh script take the full path to the xml file

Use full path to xml file in run_locally.sh to allow usage of system
command line completion feature.

ci-scripts/README.md

@@ -0,0 +1,52 @@
+This document outlines how to use the OAI CI framework and gives a quickstart.
+
+[[_TOC_]]
+
+# Quickstart
+
+There is a script `main.py` that
+
+- reads scenario files from XML
+- executes the steps (e.g., deployment of core network, gNB, UE, attach, ping,
+  ...)
+
+To simplify, a script `run_locally.sh` can be used to run a single scenario.
+First, download images for gNB&UE (we assume you already downloaded the CN):
+
+    docker pull oaisoftwarealliance/oai-gnb:develop
+    docker tag oaisoftwarealliance/oai-gnb:develop oai-gnb
+    docker pull oaisoftwarealliance/oai-nr-ue:develop
+    docker tag oaisoftwarealliance/oai-nr-ue:develop oai-nr-ue
+
+`run_locally.sh` expects `oai-gnb:latest` and `oai-nr-ue:latest` to be present,
+hence the tagging.
+
+Now, run the scenario:
+
+    cd ~/openairinterface5g/ci-scripts/
+    ./run_locally.sh xml_files/container_5g_rfsim_simple.xml
+
+Output should look like
+
+```
+[2025-08-07 18:07:49,631]     INFO: ----------------------------------------
+[2025-08-07 18:07:49,631]     INFO:   Creating HTML header 
+[2025-08-07 18:07:49,631]     INFO: ----------------------------------------
+[2025-08-07 18:07:49,766]     INFO: ----------------------------------------
+[2025-08-07 18:07:49,767]     INFO:   Starting Scenario: xml_files/container_5g_rfsim_simple.xm
+l
+[2025-08-07 18:07:49,767]     INFO: ----------------------------------------
+[2025-08-07 18:07:49,767]     INFO: placing all artifacts for this run in /home/richie/oai/cmake_targets/log/container_5g_rfsim_simple.xml.d/
+
+[...]
+
+[2025-08-07 18:07:49,771]     INFO: ----------------------------------------
+[2025-08-07 18:07:49,771]     INFO:  Test ID: 1 (#1)
+[2025-08-07 18:07:49,771]     INFO:  Deploy OAI 5G CoreNetwork
+[2025-08-07 18:07:49,771]     INFO: ----------------------------------------
+```
+
+it will run and end-to-end test, connecting one UE to the gNB, and ping, before
+undeploying. As shown, logs will be under
+`/home/richie/oai/cmake_targets/log/container_5g_rfsim_simple.xml.d/`. The
+python code also produces an HTML report in `ci-scripts/test_results.html`.

ci-scripts/run_locally.sh

@@ -26,8 +26,20 @@ fi
 docker tag oai-nr-ue oai-ci/oai-nr-ue:develop-${SHORT_COMMIT_SHA}
 docker tag oai-gnb oai-ci/oai-gnb:develop-${SHORT_COMMIT_SHA}
 
+python3 main.py --mode=InitiateHtml --ranRepository=NONE --ranBranch=${CURRENT_BRANCH} \
+    --ranCommitID=${COMMIT_SHA} --ranAllowMerge=false \
+    --ranTargetBranch=NONE \
+    --XMLTestFile=xml_files/${TESTCASE} --local
+
 python3 main.py --mode=TesteNB --ranRepository=NONE --ranBranch=${CURRENT_BRANCH} \
     --ranCommitID=${COMMIT_SHA} --ranAllowMerge=false \
     --ranTargetBranch=NONE --eNBIPAddress=NONE --eNBUserName=NONE --eNBPassword=NONE \
     --eNBSourceCodePath=${REPO_PATH} \
-    --XMLTestFile=xml_files/${TESTCASE} --local
+    --XMLTestFile=${TESTCASE} --local
+RET=$?
+
+python3 main.py --mode=FinalizeHtml \
+  --local \
+  --eNBIPAddress=NONE --eNBUserName=NONE --eNBPassword=NONE
+
+exit ${RET}

ci-scripts/xml_files/container_5g_rfsim_simple.xml

@@ -0,0 +1,101 @@
+<!--
+
+ Licensed to the OpenAirInterface (OAI) Software Alliance under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The OpenAirInterface Software Alliance licenses this file to You under
+ the OAI Public License, Version 1.1  (the "License"); you may not use this file
+ except in compliance with the License.
+ You may obtain a copy of the License at
+
+      http://www.openairinterface.org/?page_id=698
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ For more information about the OpenAirInterface (OAI) Software Alliance:
+      contact@openairinterface.org
+
+-->
+<testCaseList>
+        <htmlTabRef>rfsim-5gnr-tdd</htmlTabRef>
+        <htmlTabName>Monolithic SA TDD gNB</htmlTabName>
+        <htmlTabIcon>wrench</htmlTabIcon>
+        <TestCaseRequestedList>
+ 000001
+ 000002
+ 000003
+ 000008
+ 020001
+ 444444
+ 100001
+        </TestCaseRequestedList>
+        <TestCaseExclusionList></TestCaseExclusionList>
+
+        <testCase id="000001">
+                <class>Deploy_Object</class>
+                <desc>Deploy OAI 5G CoreNetwork</desc>
+                <yaml_path>ci-scripts/yaml_files/5g_rfsimulator</yaml_path>
+                <services>mysql oai-amf oai-smf oai-upf oai-ext-dn</services>
+                <eNB_instance>0</eNB_instance>
+                <eNB_serverId>0</eNB_serverId>
+        </testCase>
+
+        <testCase id="000002">
+                <class>Deploy_Object</class>
+                <desc>Deploy OAI 5G gNB RF sim SA</desc>
+                <yaml_path>ci-scripts/yaml_files/5g_rfsimulator</yaml_path>
+                <services>oai-gnb</services>
+                <eNB_instance>0</eNB_instance>
+                <eNB_serverId>0</eNB_serverId>
+        </testCase>
+
+        <testCase id="000003">
+                <class>Deploy_Object</class>
+                <desc>Deploy OAI 5G NR-UE RF sim SA</desc>
+                <yaml_path>ci-scripts/yaml_files/5g_rfsimulator</yaml_path>
+                <services>oai-nr-ue</services>
+                <eNB_instance>0</eNB_instance>
+                <eNB_serverId>0</eNB_serverId>
+        </testCase>
+
+        <testCase id="000008">
+                <class>Attach_UE</class>
+                <desc>Attach OAI UE (Wait for IP)</desc>
+                <id>rfsim5g_ue</id>
+                <nodes>acamas</nodes>
+        </testCase>
+
+        <testCase id="020001">
+                <class>Ping</class>
+                <desc>Ping ext-dn from NR-UE</desc>
+                <id>rfsim5g_ue</id>
+                <nodes>acamas</nodes>
+                <svr_id>rfsim5g_ext_dn</svr_id>
+                <svr_node>acamas</svr_node>
+                <ping_args>-c 20 -i 0.25</ping_args>
+                <ping_packetloss_threshold>5</ping_packetloss_threshold>
+        </testCase>
+
+        <testCase id="444444">
+                <class>Detach_UE</class>
+                <desc>Detach OAI UE 1</desc>
+                <id>rfsim5g_ue</id>
+                <nodes>acamas</nodes>
+        </testCase>
+
+        <testCase id="100001">
+                <class>Undeploy_Object</class>
+                <always_exec>true</always_exec>
+                <desc>Undeploy all OAI 5G stack</desc>
+                <yaml_path>ci-scripts/yaml_files/5g_rfsimulator</yaml_path>
+                <d_retx_th>1,0,0,0</d_retx_th>
+                <u_retx_th>1,0,0,0</u_retx_th>
+                <eNB_instance>0</eNB_instance>
+                <eNB_serverId>0</eNB_serverId>
+        </testCase>
+
+</testCaseList>