adding module support, primary test/debug

ci-scripts/build_fr1_template.yaml

 
 ranRepository : https://gitlab.eurecom.fr/oai/openairinterface5g.git
-ranBranch : BRANCH_NAME 
-ranCommitID : COMMIT_ID 
-ranAllowMerge : 'true' 
+ranBranch : integration_2021_wk13_a  
+ranCommitID : 104aa7eed5d6702c1b9da663414079ef698da206     
+ranAllowMerge : 'yes' 
 ranTargetBranch : develop
 
 steps:
   - InitiateHtml,none
   - TesteNB,xml_files/fr1_multi_node_build.xml
   - TesteNB,xml_files/fr1_epc_start.xml
-  - TesteNB,xml_files/fr1_ran_ue_base.xml #ue toggle, nodes initialize, ue toggle, ping, nodes terminate
+  - TesteNB,xml_files/fr1_nsa_base_next.xml #ue toggle, nodes initialize, ue toggle, ping, nodes terminate
   - TesteNB,xml_files/fr1_epc_closure.xml
 
 

ci-scripts/ci_ueinfra.yaml

+idefix:
+  ID: idefix
+  State : enabled
+  Kind : quectel
+  Process : quectel-CM
+  WakeupScript : ci_qtel.py
+  UENetwork : wwan0
+  HostIPAddress : 192.168.18.188
+  HostUsername : oaicicd
+  HostPassword : oaicicd
+  HostSourceCodePath : none
+dummy1:
+  ID: dummy1
+  Kind : simcom
+  State : disabled
+  Process : quectel-cm 
+  HostIPAddress : 192.168.18.187
+  HostUsername : oaicicd
+  HostPassword : oaicicd
+  HostSourceCodePath : none
+dummy2:  
+  ID: dummy2
+  Kind : cots
+  State : disabled
+  Process : quectel-cm
+  HostIPAddress : 192.168.18.186
+  HostUsername : oaicicd
+  HostPassword : oaicicd
+  HostSourceCodePath : none
+

ci-scripts/cls_ci_ueinfra.py

+# * 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
+# */
+#---------------------------------------------------------------------
+#
+#   Required Python Version
+#     Python 3.x
+#
+#---------------------------------------------------------------------
+
+#to use isfile
+import os
+import sys
+import logging
+#to create a SSH object locally in the methods
+import sshconnection
+#time.sleep
+import time
+#to load ue infrastructure dictionary
+import yaml
+
+class InfraUE:
+	def __init__(self):
+		self.ci_ue_infra ={}
+
+
+#-----------------$
+#PUBLIC Methods$
+#-----------------$
+
+	#This method reads the yaml file describing the multi-UE infrastructure
+	#and stores the infra permanently in the related class attribute self.ci_ue_infra
+	def Get_UE_Infra(self,ue_infra_filename):
+		f_yaml=ue_infra_filename
+		with open(f_yaml,'r') as file:
+			logging.debug('Loading UE infrastructure from file '+f_yaml)
+			#load it permanently in the class attribute
+			self.ci_ue_infra = yaml.load(file,Loader=yaml.FullLoader)
+
+
+

ci-scripts/cls_module_ue.py

+# * 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
+# */
+#---------------------------------------------------------------------
+#
+#   Required Python Version
+#     Python 3.x
+#
+#---------------------------------------------------------------------
+
+#to use isfile
+import os
+import sys
+import logging
+#to create a SSH object locally in the methods
+import sshconnection
+#time.sleep
+import time
+
+
+import re
+import subprocess
+
+
+
+class Module_UE:
+#  ID: idefix
+#  State : enabled
+#  Kind : quectel
+#  Process : quectel-cm
+#  WakeupScript : ci_qtel.py
+#  UENetwork : wwan0
+#  HostIPAddress : 192.168.18.188
+#  HostUsername : oaicicd
+#  HostPassword : oaicicd
+#  HostSourceCodePath : none
+
+	def __init__(self,Module):
+		#create attributes as in the Module dictionary
+		for k, v in Module.items():
+			setattr(self, k, v)
+		self.UEIPAddress = ""
+		
+
+
+
+#-----------------$
+#PUBLIC Methods$
+#-----------------$
+
+	#this method checks if the specified Process is running on the server hosting the module
+	def CheckIsModule(self):
+		HOST=self.HostIPAddress
+		COMMAND="ps aux | grep " + self.Process + " | grep -v grep "
+		logging.debug(COMMAND)
+		ssh = subprocess.Popen(["ssh", "%s" % HOST, COMMAND],shell=False,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
+		result = ssh.stdout.readlines()
+		if len(result)!=0:
+			logging.debug(self.Process + " process found")
+			return True 
+		else:
+			logging.debug(self.Process + " process NOT found")
+			return False 
+
+	#this method wakes up the module by calling the specified python script 
+	def WakeUp(self):
+		mySSH = sshconnection.SSHConnection()
+		mySSH.open(self.HostIPAddress, self.HostUsername, self.HostPassword)
+		mySSH.command('echo ' + self.HostPassword + ' | sudo -S python3 ' + self.WakeupScript + ' ','\$',5)
+		time.sleep(5)
+		logging.debug("Module wake-up")
+		mySSH.close()
+
+	#this method retrieves the Module IP address (not the Host IP address) 
+	def GetModuleIPAddress(self):
+		HOST=self.HostIPAddress
+		COMMAND="ip a show dev " + self.UENetwork + " | grep inet | grep " + self.UENetwork
+		ssh = subprocess.Popen(["ssh", "%s" % HOST, COMMAND],shell=False,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
+		response = ssh.stdout.readlines()
+		if len(response)!=0:
+			result = re.search('inet (?P<moduleipaddress>[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+)', response[0].decode("utf-8") )
+			if result is not None: 
+				if result.group('moduleipaddress') is not None: 
+					self.UEIPAddress = result.group('moduleipaddress')
+					logging.debug('\u001B[1mUE Module IP Address is ' + self.UEIPAddress + '\u001B[0m')
+				else:
+					logging.debug('\u001B[1;37;41m Module IP Address Not Found! \u001B[0m')
+			else:
+				logging.debug('\u001B[1;37;41m Module IP Address Not Found! \u001B[0m')
+		else:
+			logging.debug('\u001B[1;37;41m Module IP Address Not Found! \u001B[0m')
+
+
+
+
+
+

ci-scripts/main.py

@@ -40,9 +40,9 @@ import constants as CONST
 
 import cls_oaicitest		#main class for OAI CI test framework
 import cls_physim           #class PhySim for physical simulators build and test
-import cls_cots_ue			#class CotsUe for Airplane mode control
+import cls_cots_ue			#class CotsUe for Airplane mode control of various mobile phones
 import cls_containerize     #class Containerize for all container-based operations on RAN/UE objects
-
+import cls_ci_ueinfra		#class defining the multi Ue infrastrucure
 
 import sshconnection 
 import epc
@@ -192,6 +192,14 @@ def GetParametersFromXML(action):
 		else :
 			RAN.air_interface[RAN.eNB_instance] = 'ocp-enb'
 
+	elif action == 'Initialize_UE':
+		ue_id = test.findtext('id')
+		if (ue_id is None):
+			CiTestObj.ue_id = ""
+		else:
+			CiTestObj.ue_id = ue_id
+
+
 	elif action == 'Attach_UE':
 		nbMaxUEtoAttach = test.findtext('nbMaxUEtoAttach')
 		if (nbMaxUEtoAttach is None):
@@ -252,9 +260,20 @@ def GetParametersFromXML(action):
 	elif (action == 'Ping') or (action == 'Ping_CatM_module'):
 		CiTestObj.ping_args = test.findtext('ping_args')
 		CiTestObj.ping_packetloss_threshold = test.findtext('ping_packetloss_threshold')
+		ue_id = test.findtext('id')
+		if (ue_id is None):
+			CiTestObj.ue_id = ""
+		else:
+			CiTestObj.ue_id = ue_id
 
 	elif action == 'Iperf':
 		CiTestObj.iperf_args = test.findtext('iperf_args')
+		ue_id = test.findtext('id')
+		if (ue_id is None):
+			CiTestObj.ue_id = ""
+		else:
+			CiTestObj.ue_id = ue_id
+		CiTestObj.iperf_direction = test.findtext('direction')#used for modules only	
 		CiTestObj.iperf_packetloss_threshold = test.findtext('iperf_packetloss_threshold')
 		CiTestObj.iperf_profile = test.findtext('iperf_profile')
 		if (CiTestObj.iperf_profile is None):
@@ -368,6 +387,10 @@ with open(yaml_file,'r') as f:
     xml_class_list = yaml.load(f,Loader=yaml.FullLoader)
 
 
+InfraUE=cls_ci_ueinfra.InfraUE() #initialize UE infrastructure class
+InfraUE.Get_UE_Infra("ci_ueinfra.yaml") #read the UE infra, filename is hardcoded and unique for the moment but should be passed as parameter from the test suite
+
+
 
 mode = ''
 
@@ -382,7 +405,6 @@ CONTAINERS = cls_containerize.Containerize()
 ldpc=cls_physim.PhySim()    #create an instance for LDPC test using GPU or CPU build
 
 
-
 #-----------------------------------------------------------
 # Parsing Command Line Arguments
 #-----------------------------------------------------------
@@ -671,7 +693,7 @@ elif re.match('^TesteNB$', mode, re.IGNORECASE) or re.match('^TestUE$', mode, re
 				elif action == 'Terminate_eNB':
 					RAN.TerminateeNB(HTML, EPC)
 				elif action == 'Initialize_UE':
-					CiTestObj.InitializeUE(HTML,COTS_UE)
+					CiTestObj.InitializeUE(HTML,COTS_UE, InfraUE)
 				elif action == 'Terminate_UE':
 					CiTestObj.TerminateUE(HTML,COTS_UE)
 				elif action == 'Attach_UE':
@@ -701,9 +723,9 @@ elif re.match('^TesteNB$', mode, re.IGNORECASE) or re.match('^TestUE$', mode, re
 				elif action == 'Ping_CatM_module':
 					CiTestObj.PingCatM(HTML,RAN,EPC,COTS_UE,EPC)
 				elif action == 'Ping':
-					CiTestObj.Ping(HTML,RAN,EPC,COTS_UE)
+					CiTestObj.Ping(HTML,RAN,EPC,COTS_UE, InfraUE)
 				elif action == 'Iperf':
-					CiTestObj.Iperf(HTML,RAN,EPC,COTS_UE)
+					CiTestObj.Iperf(HTML,RAN,EPC,COTS_UE, InfraUE)
 				elif action == 'Reboot_UE':
 					CiTestObj.RebootUE(HTML,RAN,EPC)
 				elif action == 'Initialize_HSS':

ci-scripts/ran.py

@@ -239,7 +239,6 @@ class RANManagement():
 		while (count > 0) and buildOAIprocess:
 			mySSH.command('ps aux | grep --color=never build_ | grep -v grep', '\$', 6)
 			result = re.search('build_oai', mySSH.getBefore())
-			print(result)
 			if result is None:
 				buildOAIprocess = False
 			else: