From 4a873b4d43fd7ebe009e9dbbde1e116fb2bea3d7 Mon Sep 17 00:00:00 2001
From: Raphael Defosseux <raphael.defosseux@eurecom.fr>
Date: Tue, 15 Sep 2020 12:18:26 +0200
Subject: [PATCH] CI: optmimizations on VM-based framework     also correction
 for Circular Dependency Protection on header files     also correction on the
 banner check

Signed-off-by: Raphael Defosseux <raphael.defosseux@eurecom.fr>
---
 NOTICE.md                                     |  4 ++
 ci-scripts/Jenkinsfile-gitlab                 | 40 +------------------
 ci-scripts/checkCodingFormattingRules.sh      |  4 +-
 ci-scripts/runTestOnVM.sh                     | 33 ++++-----------
 common/utils/T/defs.h                         |  6 +--
 common/utils/T/tracer/defs.h                  |  6 +--
 executables/stats.h                           |  6 +--
 executables/threads_t.h                       |  6 +--
 openair2/LAYER2/nr_rlc/tests/LOG/log.h        |  6 +--
 openair2/LAYER2/rlc_v2/tests/LOG/log.h        |  6 +--
 .../nw-helloworld/NwMiniLogMgrEntity.h        |  6 +--
 .../nw-helloworld/NwMiniTmrMgrEntity.h        |  6 +--
 .../test-app/nw-helloworld/NwMiniUdpEntity.h  |  6 +--
 targets/COMMON/threads_t.h                    |  6 +--
 targets/RT/USER/stats.h                       |  6 +--
 15 files changed, 48 insertions(+), 99 deletions(-)

diff --git a/NOTICE.md b/NOTICE.md
index 96b5d4c552e..39dd33795d7 100644
--- a/NOTICE.md
+++ b/NOTICE.md
@@ -21,3 +21,7 @@ The Regents of the University of California: BSD 3-Clause Licence.
 
 Niels Provos <provos@citi.umich.edu>: BSD 2-Clause Licence.
 
+## Credits for source code openair3/GTPV1-U/nw-gtpv1u: ##
+
+Amit Chawre <http://www.amitchawre.net/contact.html>: BSD 2-Clause Licence.
+
diff --git a/ci-scripts/Jenkinsfile-gitlab b/ci-scripts/Jenkinsfile-gitlab
index c3b997a4e89..7e9e3800db5 100644
--- a/ci-scripts/Jenkinsfile-gitlab
+++ b/ci-scripts/Jenkinsfile-gitlab
@@ -30,7 +30,6 @@ def sendSocialMediaMessage(pipeChannel, pipeColor, pipeMessage) {
     }
 }
 
-def doRedHatBuild = false
 def doFlexranCtrlTest = false
 
 // Location of the executor node
@@ -85,21 +84,6 @@ pipeline {
                         echo "Platform is ${env.TESTPLATFORM_OWNER}"
                     }
 
-                    if (params.RedHatRemoteServer == null) {
-                        allParametersPresent = false
-                    }
-                    if (params.RedHatRemoteCredentials == null) {
-                        allParametersPresent = false
-                    }
-                    if (params.RedHatWorkingPath == null) {
-                        allParametersPresent = false
-                    }
-                    if (allParametersPresent) {
-                        echo "Performing Red Hat Build"
-                        doRedHatBuild = true
-                    } else {
-                        doRedHatBuild = false
-                    }
                     if (params.FlexRanRtcGitLabRepository_Credentials != null) {
                         doFlexranCtrlTest = true
                     }
@@ -279,7 +263,7 @@ pipeline {
                     steps {
                         gitlabCommitStatus(name: "Build eNB-USRP") {
                             timeout (time: 20, unit: 'MINUTES') {
-                                sh "./ci-scripts/oai-ci-vm-tool wait --workspace $WORKSPACE --variant enb-usrp --job-name ${JOB_NAME} --build-id ${BUILD_ID} --keep-vm-alive"
+                                sh "./ci-scripts/oai-ci-vm-tool wait --workspace $WORKSPACE --variant enb-usrp --job-name ${JOB_NAME} --build-id ${BUILD_ID}"
                             }
                         }
                     }
@@ -311,28 +295,6 @@ pipeline {
                         }
                     }
                 }
-                stage ("Build eNB-USRP on Red Hat") {
-                    when {
-                        expression {doRedHatBuild}
-                    }
-                    steps {
-                        gitlabCommitStatus(name: "Build eNB-USRP-RHE") {
-                            script {
-                                try {
-                                    withCredentials([
-                                        [$class: 'UsernamePasswordMultiBinding', credentialsId: "${params.RedHatRemoteCredentials}", usernameVariable: 'RH_Username', passwordVariable: 'RH_Password']
-                                    ]) {
-                                        timeout (time: 20, unit: 'MINUTES') {
-                                            sh "./ci-scripts/buildOnRH.sh --workspace $WORKSPACE --job-name ${JOB_NAME} --build-id ${BUILD_ID} --remote-host ${params.RedHatRemoteServer} --remote-path ${params.RedHatWorkingPath} --remote-user-name ${RH_Username} --remote-password ${RH_Password}"
-                                        }
-                                    }
-                                } catch (Exception e) {
-                                    echo "Red Hat build failed but we could keep running pipeline if all ubuntu-based build passed"
-                                }
-                            }
-                        }
-                    }
-                }
             }
             post {
                 failure {
diff --git a/ci-scripts/checkCodingFormattingRules.sh b/ci-scripts/checkCodingFormattingRules.sh
index fb159d4da07..d12809d3fb6 100755
--- a/ci-scripts/checkCodingFormattingRules.sh
+++ b/ci-scripts/checkCodingFormattingRules.sh
@@ -77,7 +77,7 @@ then
        IS_NFAPI=`echo $FILE | egrep -c "nfapi/open-nFAPI|nfapi/oai_integration/vendor_ext"`
        IS_OAI_LICENCE_PRESENT=`egrep -c "OAI Public License" $FILE`
        IS_BSD_LICENCE_PRESENT=`egrep -c "the terms of the BSD Licence" $FILE`
-       IS_EXCEPTION=`echo $FILE | egrep -c "common/utils/collection/tree.h|common/utils/collection/queue.h|common/utils/itti_analyzer/common/queue.h|openair3/UTILS/tree.h|openair3/UTILS/queue.h"`
+       IS_EXCEPTION=`echo $FILE | egrep -c "common/utils/collection/tree.h|common/utils/collection/queue.h|common/utils/itti_analyzer/common/queue.h|openair3/UTILS/tree.h|openair3/UTILS/queue.h|openair3/GTPV1-U/nw-gtpv1u|openair2/UTIL/OPT/ws_"`
        if [ $IS_OAI_LICENCE_PRESENT -eq 0 ] && [ $IS_BSD_LICENCE_PRESENT -eq 0 ]
        then
            if [ $IS_NFAPI -eq 0 ] && [ $IS_EXCEPTION -eq 0 ]
@@ -194,7 +194,7 @@ do
             IS_NFAPI=`echo $FULLFILE | egrep -c "nfapi/open-nFAPI|nfapi/oai_integration/vendor_ext"`
             IS_OAI_LICENCE_PRESENT=`egrep -c "OAI Public License" $FULLFILE`
             IS_BSD_LICENCE_PRESENT=`egrep -c "the terms of the BSD Licence" $FULLFILE`
-            IS_EXCEPTION=`echo $FILE | egrep -c "common/utils/collection/tree.h|common/utils/collection/queue.h|common/utils/itti_analyzer/common/queue.h|openair3/UTILS/tree.h|openair3/UTILS/queue.h"`
+            IS_EXCEPTION=`echo $FILE | egrep -c "common/utils/collection/tree.h|common/utils/collection/queue.h|common/utils/itti_analyzer/common/queue.h|openair3/UTILS/tree.h|openair3/UTILS/queue.h|openair3/GTPV1-U/nw-gtpv1u|openair2/UTIL/OPT/ws_"`
             if [ $IS_OAI_LICENCE_PRESENT -eq 0 ] && [ $IS_BSD_LICENCE_PRESENT -eq 0 ]
             then
                 if [ $IS_NFAPI -eq 0 ] && [ $IS_EXCEPTION -eq 0 ]
diff --git a/ci-scripts/runTestOnVM.sh b/ci-scripts/runTestOnVM.sh
index b9b9a2bafab..e6b93b5b4d3 100755
--- a/ci-scripts/runTestOnVM.sh
+++ b/ci-scripts/runTestOnVM.sh
@@ -2027,30 +2027,6 @@ function run_test_on_vm {
 
         done
 
-        full_l2_sim_destroy
-
-        echo "############################################################"
-        echo "Checking run status"
-        echo "############################################################"
-
-        if [ $PING_STATUS -ne 0 ]; then STATUS=-1; fi
-        if [ $IPERF_STATUS -ne 0 ]; then STATUS=-1; fi
-        if [ $MBMS_STATUS -eq 0 ]
-        then
-            echo "LTE MBMS RFSIM seems OK"
-        else
-            echo "LTE MBMS RFSIM seems to FAIL"
-            STATUS=-1
-        fi
-        if [ $STATUS -eq 0 ]
-        then
-            echo "LTE RFSIM seems OK"
-            echo "LTE: TEST_OK" > $ARCHIVES_LOC/test_final_status.log
-        else
-            echo "LTE RFSIM seems to FAIL"
-            echo "LTE: TEST_KO" > $ARCHIVES_LOC/test_final_status.log
-        fi
-
         ####################
         ## FeMBMS CASE noS1 ##
         ####################
@@ -2123,6 +2099,13 @@ function run_test_on_vm {
 
         if [ $PING_STATUS -ne 0 ]; then STATUS=-1; fi
         if [ $IPERF_STATUS -ne 0 ]; then STATUS=-1; fi
+        if [ $MBMS_STATUS -eq 0 ]
+        then
+            echo "LTE MBMS RFSIM seems OK"
+        else
+            echo "LTE MBMS RFSIM seems to FAIL"
+            STATUS=-1
+        fi
         if [ $FeMBMS_STATUS -eq 0 ]
         then
             echo "LTE FeMBMS RFSIM seems OK"
@@ -2153,7 +2136,7 @@ function run_test_on_vm {
         NR_STATUS=0
 
         ######### start of loop
-        while [ $try_cnt -lt 1 ]
+        while [ $try_cnt -lt 4 ]
         do
             SYNC_STATUS=0
             PING_STATUS=0
diff --git a/common/utils/T/defs.h b/common/utils/T/defs.h
index 69b379ce0b3..a194e621db6 100644
--- a/common/utils/T/defs.h
+++ b/common/utils/T/defs.h
@@ -1,5 +1,5 @@
-#ifndef _TRACER_DEFS_H_
-#define _TRACER_DEFS_H_
+#ifndef _COMMON_UTILS_T_DEFS_H_
+#define _COMMON_UTILS_T_DEFS_H_
 
 /* types of plots */
 #define PLOT_VS_TIME   0
@@ -27,4 +27,4 @@ void *forwarder(char *ip, int port);
 void forward(void *forwarder, char *buf, int size);
 void forward_start_client(void *forwarder, int socket);
 
-#endif /* _TRACER_DEFS_H_ */
+#endif /* _COMMON_UTILS_T_DEFS_H_ */
diff --git a/common/utils/T/tracer/defs.h b/common/utils/T/tracer/defs.h
index 443fabdde84..394351eab0f 100644
--- a/common/utils/T/tracer/defs.h
+++ b/common/utils/T/tracer/defs.h
@@ -1,5 +1,5 @@
-#ifndef _TRACER_DEFS_H_
-#define _TRACER_DEFS_H_
+#ifndef _COMMON_UTILS_T_TRACER_DEFS_H_
+#define _COMMON_UTILS_T_TRACER_DEFS_H_
 
 /* types of plots */
 #define PLOT_VS_TIME   0
@@ -21,4 +21,4 @@ void t_gui_start(void);
 void t_gui_set_input_signal(int eNB, int frame, int subframe, int antenna,
     int size, void *buf);
 
-#endif /* _TRACER_DEFS_H_ */
+#endif /* _COMMON_UTILS_T_TRACER_DEFS_H_ */
diff --git a/executables/stats.h b/executables/stats.h
index 6c847a28606..9bd4c6f0809 100644
--- a/executables/stats.h
+++ b/executables/stats.h
@@ -21,8 +21,8 @@
 
 /* Header file generated by fdesign on Thu Aug 28 12:13:51 2014 */
 
-#ifndef FD_stats_form_h_
-#define FD_stats_form_h_
+#ifndef _EXECUTABLES_STATS_H_
+#define _EXECUTABLES_STATS_H_
 
 #include <forms.h>
 
@@ -43,4 +43,4 @@ typedef struct {
 
 extern FD_stats_form *create_form_stats_form( void );
 
-#endif /* FD_stats_form_h_ */
+#endif /* _EXECUTABLES_STATS_H_ */
diff --git a/executables/threads_t.h b/executables/threads_t.h
index 0671f409883..c4b233ccc9d 100644
--- a/executables/threads_t.h
+++ b/executables/threads_t.h
@@ -1,5 +1,5 @@
-#ifndef _THREADS_T_H_
-#define _THREADS_T_H_
+#ifndef _EXECUTABLES_THREADS_T_H_
+#define _EXECUTABLES_THREADS_T_H_
 
 typedef struct threads_s {
   int main;
@@ -18,4 +18,4 @@ typedef struct threads_s {
   //int dlsch_td1_three;
 } threads_t;
 
-#endif /* _THREADS_T_H_ */
+#endif /* _EXECUTABLES_THREADS_T_H_ */
diff --git a/openair2/LAYER2/nr_rlc/tests/LOG/log.h b/openair2/LAYER2/nr_rlc/tests/LOG/log.h
index 5c9fcd643cf..8ebc7e19096 100644
--- a/openair2/LAYER2/nr_rlc/tests/LOG/log.h
+++ b/openair2/LAYER2/nr_rlc/tests/LOG/log.h
@@ -1,5 +1,5 @@
-#ifndef _LOG_H_
-#define _LOG_H_
+#ifndef _NR_RLC_TESTS_LOG_H_
+#define _NR_RLC_TESTS_LOG_H_
 
 #include <stdio.h>
 
@@ -7,4 +7,4 @@
 #define LOG_D(x, ...) printf(__VA_ARGS__)
 #define LOG_W(x, ...) printf(__VA_ARGS__)
 
-#endif /* _LOG_H_ */
+#endif /* _NR_RLC_TESTS_LOG_H_ */
diff --git a/openair2/LAYER2/rlc_v2/tests/LOG/log.h b/openair2/LAYER2/rlc_v2/tests/LOG/log.h
index 5c9fcd643cf..89d85090b17 100644
--- a/openair2/LAYER2/rlc_v2/tests/LOG/log.h
+++ b/openair2/LAYER2/rlc_v2/tests/LOG/log.h
@@ -1,5 +1,5 @@
-#ifndef _LOG_H_
-#define _LOG_H_
+#ifndef _RLC_V2_TESTS_LOG_H_
+#define _RLC_V2_TESTS_LOG_H_
 
 #include <stdio.h>
 
@@ -7,4 +7,4 @@
 #define LOG_D(x, ...) printf(__VA_ARGS__)
 #define LOG_W(x, ...) printf(__VA_ARGS__)
 
-#endif /* _LOG_H_ */
+#endif /* _RLC_V2_TESTS_LOG_H_ */
diff --git a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniLogMgrEntity.h b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniLogMgrEntity.h
index 8f2908e52aa..18b60aa6117 100644
--- a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniLogMgrEntity.h
+++ b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniLogMgrEntity.h
@@ -16,13 +16,13 @@
 #include "NwEvt.h"
 #include "NwLog.h"
 
+#ifndef __NW_MINI_LOG_MGR_H__
+#define __NW_MINI_LOG_MGR_H__
+
 #ifndef NW_ASSERT
 #define NW_ASSERT assert
 #endif
 
-#ifndef __NW_MINI_LOG_MGR_H__
-#define __NW_MINI_LOG_MGR_H__
-
 extern uint32_t g_log_level;
 
 
diff --git a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniTmrMgrEntity.h b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniTmrMgrEntity.h
index b17228c9cf7..a1f16ff89b9 100644
--- a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniTmrMgrEntity.h
+++ b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniTmrMgrEntity.h
@@ -17,13 +17,13 @@
 #include "NwEvt.h"
 #include "NwLog.h"
 
+#ifndef __NW_MINI_TMR_MGR_H__
+#define __NW_MINI_TMR_MGR_H__
+
 #ifndef NW_ASSERT
 #define NW_ASSERT assert
 #endif
 
-#ifndef __NW_MINI_TMR_MGR_H__
-#define __NW_MINI_TMR_MGR_H__
-
 typedef struct {
   NwEventT      ev;
   void*         timeoutArg;
diff --git a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniUdpEntity.h b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniUdpEntity.h
index 2e19ebbb8ee..568c5b07969 100644
--- a/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniUdpEntity.h
+++ b/openair3/GTPV1-U/nw-gtpv1u/test-app/nw-helloworld/NwMiniUdpEntity.h
@@ -17,13 +17,13 @@
 #include "NwEvt.h"
 #include "NwLog.h"
 
+#ifndef __NW_MINI_UDP_ENTITY_H__
+#define __NW_MINI_UDP_ENTITY_H__
+
 #ifndef NW_ASSERT
 #define NW_ASSERT assert
 #endif
 
-#ifndef __NW_MINI_UDP_ENTITY_H__
-#define __NW_MINI_UDP_ENTITY_H__
-
 typedef struct {
   uint32_t        hSocket;
   NwEventT      ev;
diff --git a/targets/COMMON/threads_t.h b/targets/COMMON/threads_t.h
index 0671f409883..5fb1645444b 100644
--- a/targets/COMMON/threads_t.h
+++ b/targets/COMMON/threads_t.h
@@ -1,5 +1,5 @@
-#ifndef _THREADS_T_H_
-#define _THREADS_T_H_
+#ifndef _TARGETS_COMMON_THREADS_T_H_
+#define _TARGETS_COMMON_THREADS_T_H_
 
 typedef struct threads_s {
   int main;
@@ -18,4 +18,4 @@ typedef struct threads_s {
   //int dlsch_td1_three;
 } threads_t;
 
-#endif /* _THREADS_T_H_ */
+#endif /* _TARGETS_COMMON_THREADS_T_H_ */
diff --git a/targets/RT/USER/stats.h b/targets/RT/USER/stats.h
index 264c8f7af02..15ee4a80876 100644
--- a/targets/RT/USER/stats.h
+++ b/targets/RT/USER/stats.h
@@ -21,8 +21,8 @@
 
 /* Header file generated by fdesign on Thu Aug 28 12:13:51 2014 */
 
-#ifndef FD_stats_form_h_
-#define FD_stats_form_h_
+#ifndef _TARGETS_RT_USER_STATS_H_
+#define _TARGETS_RT_USER_STATS_H_
 
 #include <forms.h>
 
@@ -43,4 +43,4 @@ typedef struct {
 
 extern FD_stats_form * create_form_stats_form( void );
 
-#endif /* FD_stats_form_h_ */
+#endif /* _TARGETS_RT_USER_STATS_H_ */
-- 
GitLab