* update Doxyfile for documentation

* update build_oai.bash to build OAI doxygen documentation
* comment eMBMS pre-ci tests 


git-svn-id: http://svn.eurecom.fr/openair4G/trunk@6126 818b1a75-f10b-46b9-bf7c-635c3b92a50f

targets/TEST/OAI/case03.py

@@ -129,50 +129,50 @@ def execute(oai, user, pw, host, logfile,logdir,debug):
     else:
         log.ok(case, test, name, conf, '', logfile)  
 
-    try:
-        test = '05'
-        name = 'Run oai.rel10.phy.eMBMS.MCCH'
-        diag = 'eMBMS procedure is not finished completely, make sure that the SIB13/MCCH have been correclty received by UEs'
-        for i in range(NUM_UE) :
-            for j in range(NUM_eNB) :
-                conf = '-A AWGN -l7 -x 1 -Q3 -n' + str((i+1+j) * 50) + ' -u' + str(i+1) +' -b'+ str(j+1)
-                trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
-                tee = ' 2>&1 | tee ' + trace
-                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Found MBSFNAreaConfiguration from eNB ' + str(j),  (i+1) * 200)
-    except log.err, e:
-        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
-    else:
-        log.ok(case, test, name, conf, '', logfile)  
-        
-    try:
-        test = '06'
-        name = 'Run oai.rel10.phy.eMBMS.OTG'
-        diag = 'eMBMS multicast/broadcast data is not received, make sure that the SIB13/MCCH/MTCH have been correclty received by UEs'
-        for i in range(NUM_UE) :
-            for j in range(NUM_eNB) :
-                conf = '-A AWGN -l7 -x 1 -T mscbr -Q3 -n' + str((i+1+j) * 100) + ' -u' + str(i+1) +' -b'+ str(j+1)
-                trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
-                tee = ' 2>&1 | tee ' + trace
-                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Received a multicast packet',  (i+1) * 200)
-    except log.err, e:
-        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
-    else:
-        log.ok(case, test, name, conf, 'Note: check the packet loss from the OTG stats', logfile)   
-
-    try:
-        test = '07'
-        name = 'Run oai.rel10.phy.eMBMS.OTG.fdd'
-        diag = 'eMBMS multicast/broadcast data is not received in fdd mode, make sure that the SIB13/MCCH/MTCH have been correclty received by UEs'
-        for i in range(NUM_UE) :
-            for j in range(NUM_eNB) :
-                conf = '-A AWGN -l7 -F -x 1 -T mscbr -Q3 -n' + str((i+1+j) * 100) + ' -u' + str(i+1) +' -b'+ str(j+1)
-                trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
-                tee = ' 2>&1 | tee ' + trace
-                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Received a multicast packet',  (i+1) * 200)
-    except log.err, e:
-        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
-    else:
-        log.ok(case, test, name, conf, 'Note: check the packet loss from the OTG stats', logfile)   
+ #   try:
+ #       test = '05'
+#        name = 'Run oai.rel10.phy.eMBMS.MCCH'
+#        diag = 'eMBMS procedure is not finished completely, make sure that the SIB13/MCCH have been correclty received by UEs'
+#        for i in range(NUM_UE) :
+#            for j in range(NUM_eNB) :
+#                conf = '-A AWGN -l7 -x 1 -Q3 -n' + str((i+1+j) * 50) + ' -u' + str(i+1) +' -b'+ str(j+1)
+#                trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
+#                tee = ' 2>&1 | tee ' + trace
+#                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Found MBSFNAreaConfiguration from eNB ' + str(j),  (i+1) * 200)
+#    except log.err, e:
+#        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
+#    else:
+#        log.ok(case, test, name, conf, '', logfile)  
+        
+#    try:
+#        test = '06'
+#        name = 'Run oai.rel10.phy.eMBMS.OTG'
+#        diag = 'eMBMS multicast/broadcast data is not received, make sure that the SIB13/MCCH/MTCH have been correclty received by UEs'
+#        for i in range(NUM_UE) :
+#            for j in range(NUM_eNB) :
+#                conf = '-A AWGN -l7 -x 1 -T mscbr -Q3 -n' + str((i+1+j) * 100) + ' -u' + str(i+1) +' -b'+ str(j+1)
+#                trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
+#                tee = ' 2>&1 | tee ' + trace
+#                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Received a multicast packet',  (i+1) * 200)
+#    except log.err, e:
+#        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
+#    else:
+#        log.ok(case, test, name, conf, 'Note: check the packet loss from the OTG stats', logfile)   
+
+#    try:
+#        test = '07'
+#        name = 'Run oai.rel10.phy.eMBMS.OTG.fdd'
+#        diag = 'eMBMS multicast/broadcast data is not received in fdd mode, make sure that the SIB13/MCCH/MTCH have been correclty received by UEs'
+#        for i in range(NUM_UE) :
+#            for j in range(NUM_eNB) :
+#                conf = '-A AWGN -l7 -F -x 1 -T mscbr -Q3 -n' + str((i+1+j) * 100) + ' -u' + str(i+1) +' -b'+ str(j+1)
+#               trace = logdir + '/log_' + host + case + test + '_' + str(i) + str(j) + '.txt'
+#               tee = ' 2>&1 | tee ' + trace
+#                oai.send_expect('./oaisim.rel10.' + host + ' ' + conf + tee, ' Received a multicast packet',  (i+1) * 200)
+#    except log.err, e:
+#        log.fail(case, test, name, conf, e.value, diag, logfile,trace)
+#    else:
+#        log.ok(case, test, name, conf, 'Note: check the packet loss from the OTG stats', logfile)   
 
    # try:
    #     test = '08'
@@ -186,24 +186,24 @@ def execute(oai, user, pw, host, logfile,logdir,debug):
    # else:
    #     log.ok(case, test, name, conf, 'Note: check the packet loss from the OTG stats', logfile)   
 
-    try:
-        test = '09'
-        name = 'Run oai.rel10.itti.phy.eMBMS.MCCH'
-        diag = 'eMBMS procedure is not finished completely, check the eNB config file (enb.sfr.sud.conf), and make sure that the SIB13/MCCH have been correclty received by UEs'
-        for i in range(NUM_UE) :
-            for j in range(NUM_eNB) :
-                log_name = logdir + '/log_' + host + case + test + '_' + str(i) + str(j)
-                itti_name = log_name + '.log'
-                trace_name = log_name + '.txt'
-                conf = '-A AWGN -l7 -x 1 -Q3 --enb-conf ../../PROJECTS/GENERIC-LTE-EPC/CONF/enb.sfr.sud.conf -n' + str((i+1+j) * 50) + ' -u' + str(i+1) +' -b'+ str(j+1) + ' -K' + itti_name
-                tee = ' 2>&1 | tee -a ' + trace_name
-                command = './oaisim.rel10.itti.' + host + ' ' + conf
-                oai.send('echo ' + command + ' > ' + trace_name + ';')
-                oai.send_expect(command + tee, ' Found MBSFNAreaConfiguration from eNB ' + str(j),  (i+1) * 200)
-    except log.err, e:
-        log.fail(case, test, name, conf, e.value, diag, logfile, trace_name)
-    else:
-        log.ok(case, test, name, conf, '', logfile)  
+#    try:
+#        test = '09'
+#        name = 'Run oai.rel10.itti.phy.eMBMS.MCCH'
+#        diag = 'eMBMS procedure is not finished completely, check the eNB config file (enb.sfr.sud.conf), and make sure that the SIB13/MCCH have been correclty received by UEs'
+#        for i in range(NUM_UE) :
+#            for j in range(NUM_eNB) :
+#                log_name = logdir + '/log_' + host + case + test + '_' + str(i) + str(j)
+#                itti_name = log_name + '.log'
+#                trace_name = log_name + '.txt'
+#                conf = '-A AWGN -l7 -x 1 -Q3 --enb-conf ../../PROJECTS/GENERIC-LTE-EPC/CONF/enb.sfr.sud.conf -n' + str((i+1+j) * 50) + ' -u' + str(i+1) +' -b'+ str(j+1) + ' -K' + itti_name
+#                tee = ' 2>&1 | tee -a ' + trace_name
+#                command = './oaisim.rel10.itti.' + host + ' ' + conf
+#                oai.send('echo ' + command + ' > ' + trace_name + ';')
+ #               oai.send_expect(command + tee, ' Found MBSFNAreaConfiguration from eNB ' + str(j),  (i+1) * 200)
+#    except log.err, e:
+#        log.fail(case, test, name, conf, e.value, diag, logfile, trace_name)
+#    else:
+#        log.ok(case, test, name, conf, '', logfile)  
         
 
 

targets/build_helper.bash

@@ -352,6 +352,8 @@ check_install_oai_software() {
 	test_install_package sshfs
 	test_install_package subversion
 	test_install_package valgrind
+	test_install_package doxygen
+	test_install_package graphviz
 	
 # TODO: install the USRP UHD packages 
 #	test_install_package libboost-all-dev
@@ -895,7 +897,7 @@ set_openair_env(){
     openair_path=${openair_path%/openair[123]/*}
 
     export OPENAIR_DIR=$openair_path
-    export OPENAIR_HOME=$openair_path
+    export OPENAIRge_HOME=$openair_path
     export OPENAIR1_DIR=$openair_path/openair1
     export OPENAIR2_DIR=$openair_path/openair2
     export OPENAIR3_DIR=$openair_path/openair3
@@ -910,15 +912,16 @@ set_openair_env(){
 
 print_help(){
     echo_success "Name : build_oai  - install and build OAI"
-    echo_success "Usage: build_oai.bash -b -c -d -eRTAI -m -rREL8 -s -tOAISIM -wEXMIMO -x"
+    echo_success "Usage: build_oai.bash -a -b -c -d -eRTAI -m -rREL8 -s -tOAISIM -wEXMIMO -x"
+    echo_success "-a   : enable doxygen for documentation (default disabled)"
     echo_success "-b   : disables S1 interface for eNB (default enabled)"
     echo_success "-c   : enables clean OAI build (default disabled)"
     echo_success "-d   : enables debug mode (default disabled)"
     echo_success "-e   : sets realtime mode: RTAI, NONE (default NONE)"
-    echo_success "-l   : sets the LTE build target: ENB,EPC,HSS (default ENB)"
+    echo_success "-l   : sets the LTE build target: ENB,EPC,HSS,NONE (default ENB)"
     echo_success "-m   : enables build from the makefile (default disabled)"
     echo_success "-r   : sets the release: REL8, REL10 (default REL8)"
-    echo_success "-s   : enables OAI sanity check (default disabled)"
+    echo_success "-s   : enables OAI testing and sanity check (default disabled)"
     echo_success "-t   : sets the eNB build target: ALL, SOFTMODEM,OAISIM,UNISIM (default ALL)"
     echo_success "-w   : sets the hardware platform: EXMIMO, USRP, ETHERNET NONE, (default EXMIMO)"
     echo_success "-x   : enables xforms (default disabled)"

targets/build_oai.bash

@@ -67,6 +67,7 @@ ITTI_ANALYZER=0
 VCD_TIMING=0
 WIRESHARK=0
 TIME_MEAS=0
+DOXYGEN=0
 DEV=0
 
 EMULATION_DEV_INTERFACE="eth0"
@@ -86,8 +87,12 @@ fi
 #    echo "i is : $i"
 #    case $i in
 
-while getopts "bcdmsxzhe:l:w:r:t:" OPTION; do
+while getopts "abcdmsxzhe:l:w:r:t:" OPTION; do
    case "$OPTION" in
+       a)
+	 DOXYGEN=1
+	 echo "setting doxygen flag to: $DOXYGEN"
+	 ;;
        b)
 	   ENB_S1=0
 	   echo "disable eNB S1 flag"
@@ -387,21 +392,6 @@ build_enb(){
     echo_info "build terminated, binaries are located in bin/"
     echo_info "build terminated, logs are located in bin/${oai_build_date} and bin/install_log.txt"
     
-############################################
-# testing
-############################################
-    
-    if [ $OAI_TEST = 1 ]; then 
-	echo_info "9. Testing ..."
-	python $OPENAIR_TARGETS/TEST/OAI/test01.py
-    else 
-	echo_info "9. Bypassing the Tests ..."
-    fi 
-    
-############################################
-# run 
-############################################
-    echo_info "10. Running ... To be done"
 
 
 }
@@ -551,7 +541,40 @@ case "$BUILD_LTE" in
 	echo_warning "build HSS: Experimental"
 	build_hss 
 	;;
+    'NONE')
+	;;
     *)
 	echo_error "Unknown option $BUILD_LTE: do not build"
 	;;
 esac
+
+# Additional operation 
+
+############################################
+# Generate doxygen documentation
+############################################
+    
+    if [ $DOXYGEN = 1 ]; then 
+	echo_info "9. Generate doxygen documentation ..."
+	doxygen $OPENAIR_TARGETS/DOCS/Doxyfile
+	echo_info "9.1 use your navigator to open $OPENAIR_TARGETS/DOCS/html/index.html "
+    else 
+	echo_info "9. Bypassing doxygen documentation ..."
+    fi 
+
+
+############################################
+# testing
+############################################
+    
+    if [ $OAI_TEST = 1 ]; then 
+	echo_info "10. Testing ..."
+	python $OPENAIR_TARGETS/TEST/OAI/test01.py
+    else 
+	echo_info "10. Bypassing the Tests ..."
+    fi 
+    
+############################################
+# run 
+############################################
+    echo_info "11. Running ... To be done"