Commit 91ab6fb0 authored by schulzs's avatar schulzs
Browse files

update based on code review

parent c7b41b43
Loading
Loading
Loading
Loading
+72 −108
Original line number Diff line number Diff line
@@ -14,150 +14,117 @@ module AtsImsIot_Functions {
 	
 	group ue {
 		
 		
 		/**
		  * @desc Triggers the UE to switch on the terminal
		  * @param p_trigger trigger component
		  * @desc Starts user component behaviour for registration from test coordinator
		  * @param p_userCompRef Reference ot IMS UE user component
		  * @param p_publicId public user identity
		  * @param p_privateId private user identity
		  * @param p_pw user password
		  * @return
		  *     true in case of successfull execution of the trigger command
		  *     otherwise false
		  */
 		function f_ue_trigger_switchOn(EutTrigger p_trigger) runs on TestCoordinator return boolean {
 		function f_mtc_userRegister(EutTrigger p_userCompRef, charstring p_publicId, charstring p_privateId, charstring p_pw) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeSwitchOn());
 			p_userCompRef.start(f_userRegistration(p_publicId, p_privateId, p_pw));
 			
 			p_trigger.done;
 			p_userCompRef.done;
     		
     		if(getverdict() == pass) {
     			v_success := true;
     		}
      // TODO add setting of v_success based on e2e verdict
          		
     	return v_success;
 		}
 		
 		/**
		  * @desc Triggers the UE to switch off the terminal
		  * @param p_trigger trigger component
		  * @desc Starts user component behaviour for registration from test coordinator
		  * @param p_userCompRef Reference ot IMS UE user component
		  * @param publicId public user identity
		  * @return
		  *     true in case of successfull execution of the trigger command
		  *     otherwise false
		  */
 		function f_ue_trigger_switchOff(EutTrigger p_trigger) runs on TestCoordinator return boolean {
 		function f_mtc_userDeregister(EutTrigger p_userCompRef, charstring p_publicId) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeSwitchOff());
 			p_userCompRef.start(f_userDeregistration(p_publicId));
 			
 			p_trigger.done;
 			p_userCompRef.done;
     		
     		if(getverdict() == pass) {
     			v_success := true;
     		}
      // TODO add setting of v_success based on e2e verdict
     		
     	return v_success;
 		}
 		
 		/**
		  * @desc Triggers the UE to register a given user
		  * @param p_trigger trigger component
		  * @param p_publicId public user identity
		  * @param p_privateId private user identity
		  * @param p_pw user password
		  * @return
		  *     true in case of successfull execution of the trigger command
		  *     otherwise false
 		 * 
 		 * @desc Starts user component behaviour for sending a message from test coordinator
 		 * @param p_userCompRef Reference ot IMS UE user component
 		 * @param p_content Content of meessage to be sent
 		 */
 		function f_ue_trigger_register(EutTrigger p_trigger, charstring p_publicId, charstring p_privateId, charstring p_pw) runs on TestCoordinator return boolean {
 		function f_mtc_userSendMessage(EutTrigger p_userCompRef, charstring p_content) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeRegistration(p_publicId, p_privateId, p_pw));
 			p_userCompRef.start(f_userSendMessage(p_content));
 			
 			p_trigger.done;
 			p_userCompRef.done;
     		
     		if(getverdict() == pass) {
     			v_success := true;
     		}
      // TODO add setting of v_success based on e2e verdict
     		
     	return v_success;
 		}
 		
 		/**
		  * @desc Triggers the UE to de-register a given user
		  * @param p_trigger trigger component
		  * @param publicId public user identity
		  * @return
		  *     true in case of successfull execution of the trigger command
		  *     otherwise false
 		 * 
 		 * @desc Starts user component behaviour for checking message receipt from test coordinator 
 		 * @param p_userCompRef Reference ot IMS UE user component
 		 * @param p_content Content of meessage to be received
 		 */
 		function f_ue_trigger_deregister(EutTrigger p_trigger, charstring p_publicId) runs on TestCoordinator return boolean {
 		function f_userCheckMessageReceipt(EutTrigger p_userCompRef) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeDeregistration(p_publicId));
 			p_userCompRef.start(f_triggerUeReceiveMessageRequest());
 			
 			p_trigger.done;
 			p_userCompRef.done;
     		
     		if(getverdict() == pass) {
     			v_success := true;
     		}
      // TODO add setting of v_success based on e2e verdict
     		
     	return v_success;
 		}
 		
 		/**
 		 * 
 		 * @desc Trigger the UE to send a Message request containing the given message body
 		 * @param p_trigger Trigger component
 		 * @param p_body Message body
 		 */
 		function f_ue_trigger_sendMessage(EutTrigger p_trigger, charstring p_body) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeSendMessageRequest(p_body));
 		
 			p_trigger.done;
 		function f_getUserInfo(integer p_productIdx, out ImsUserInfo p_userInfo) return ImsUserInfo {
 		  var integer v_size := sizeof(PX_IMS_USER_DATA);
 		  
     		if(getverdict() == pass) {
     			v_success := true;
 		  for(var integer i := 0, i < v_size, i := i=1) {
 		     if(PX_IMS_USER_DATA[i].productIndex == p_productIdx) {
 		      p_userInfo :=  PX_IMS_USER_DATA[i].userInfos;
 		      return true;
 		    }
 		    
     		return v_success;
 		  }
 		  return false;
 		}
 		
 		/**
 		 * 
 		 * @desc Trigger the UE to receive a Message request 
 		 * @param p_trigger Trigger component
 		 * @param p_body Message body
 		 */
 		function f_ue_trigger_receiveMessage(EutTrigger p_trigger) runs on TestCoordinator return boolean {
 			var boolean v_success := false;
 			
 			p_trigger.start(f_triggerUeReceiveMessageRequest());
 		
 			p_trigger.done;
 		
     		if(getverdict() == pass) {
     			v_success := true;
     		}
 		
     		return v_success;
 		}
 		
    	/**
    	 * @desc
    	 *     UE preamble force the UE to switch on the terminal and triggers the
    	 *     registration
    	 * @param p_trigger UE component
    	 *     Preamble to handle user registration in home network from test coordinator
    	 * @param p_userCompRef Reference ot IMS UE user component
    	 * @return true in case of successfull execution otherwise false
    	 */
     	function f_ue_preamble(EutTrigger p_trigger) runs on TestCoordinator return boolean {
     	function f_PR_user_home_registration(EutTrigger p_userCompRef, integer p_productIdx) runs on TestCoordinator return boolean {
     		var boolean v_status := true; 
     		var ImsUserInfo v_userInfo;
     		
     		if(v_status) {
     			v_status := f_ue_trigger_switchOn(p_trigger);
     		}
     		if( not f_getUserInfo(p_productIdx, v_userInfo) ) { return false; } 
     		
     		if(v_status) {
     			v_status := f_ue_trigger_register(p_trigger, "dummy", "dummy", "dummy"); // TODO add user parameter here
     			v_status := f_mtc_userRegister(p_user, v_userInfo.publidId, v_userInfo.privateId, v_userInfo.password); 
     		}
     		
     		return v_status;
@@ -167,20 +134,17 @@ module AtsImsIot_Functions {
     	
    	/**
    	 * @desc
    	 *     UE postamble force the UE to switch off the terminal and triggers the
    	 *     de-registration
    	 * @param p_trigger UE  component
    	 *     Postamble to handle user deregistration in home network from test coordinator
    	 * @param p_userCompRef Reference ot IMS UE user component
    	 * @return true in case of successfull execution otherwise false
    	 */
     	function f_ue_postamble(EutTrigger p_trigger) runs on TestCoordinator return boolean {
     	function f_PO_user_home_deregistration(EutTrigger p_userCompRef runs on TestCoordinator return boolean {
     		var boolean v_status := true; 
     		
     		if(v_status) {
     			v_status := f_ue_trigger_deregister(p_trigger, "*"); // deregister all previous users
     			v_status := f_mtc_userDeregister(p_userCompRef, "*"); // deregister all previous users
     		}
     		
     		if(v_status) {
     			v_status := f_ue_trigger_switchOff(p_trigger);
     		}
     		
     		return v_status;
+21 −46
Original line number Diff line number Diff line
@@ -14,101 +14,76 @@ module LibIms_ConfigAndTrigger {
	group ue {
		group ueTypes {
			group ueCommands {
				/**
				 * 
				 * @desc Trigger command to switch on the UE
				 */
				const TriggerCommand c_SWITCH_ON_UE := "UE_SWITCH_ON";
				
				/**
				 * 
				 * @desc Trigger command to switch off the UE
				 */
				const TriggerCommand c_SWITCH_OFF_UE := "UE_SWITCH_OFF";
				
				/**
				 * @desc Trigger command to force the registration at the UE
				 * @desc Command to trigger registration of the UE
				 * @remark
				 *     Note that the registration trigger command needs has
				 *     additional parameter for the public, private user id and
				 *     password.
				 */
				const TriggerCommand c_REGISTER_UE := "UE_REGISTER";
				const TriggerCommand c_UE_REGISTER := "UE_REGISTER";
				
				/**
				 * 
				 * @desc Trigger command to force the de-registration at the UE
				 * @desc Command to trigger de-registration of the UE
				 */
				const TriggerCommand c_DEREGISTER_UE := "UE_DEREGISTER";
				const TriggerCommand c_UE_DEREGISTER := "UE_DEREGISTER";
				
				/**
				 * @desc Trigger commend to force the UE to send a message request
				 * @desc Command to trigger UE to send a message
				 */
				const TriggerCommand c_SEND_MESSAGE_REQUEST := "UE_SEND_MESSAGE_REQUEST";	
				const TriggerCommand c_UE_SEND_MESSAGE := "UE_SEND_MESSAGE";	
				
								/**
				 * @desc Trigger commend to force the UE to receive a message request
				 * @desc Command to check if UE has receipt of a message
				 */
				const TriggerCommand c_RECEIVE_MESSAGE_REQUEST := "UE_RECEIVE_MESSAGE_REQUEST";	
				const TriggerCommand c_UE_CHECK_MESSAGE_RECEIPT := "UE_CHECK_MESSAGE_RECEIPT";	
			}
		}
		
		group ueFunctions {
			
			/**
			 * 
			 * @desc Triggers the ue to switch on the terminal
			 * @verdict e2e verdict will be set depending on the result of trigger action
			 */
			function f_triggerUeSwitchOn() runs on EutTrigger {
				f_sendTriggerCmd(c_SWITCH_ON_UE, {});
			}
			
			/**
			 * 
			 * @desc Triggers the ue to swith off the terminal
			 * @verdict e2e verdict will be set depending on the result of trigger action
			 */
			function f_triggerUeSwitchOff() runs on EutTrigger {
				f_sendTriggerCmd(c_SWITCH_OFF_UE, {});
			}
			
			/**
			 * 
			 * @desc Triggers the UE registration for a given user
			 * @param p_publicId The public user name
			 * @param p_privateId The private user name
			 * @desc Triggers registration of a given user via UE
			 * @param p_publicId The public user identity 
			 * @param p_privateId The private user identity
			 * @param p_pw The users password
			 * @verdict e2e verdict will be set depending on the result of trigger action
			 */
			function f_triggerUeRegistration(in charstring p_publicId, in charstring p_privateId, in charstring p_pw) runs on EutTrigger {
			function f_userRegistration(in charstring p_publicId, in charstring p_privateId, in charstring p_pw) 
			runs on EutTrigger {
				f_sendTriggerCmd(c_REGISTER_UE, {p_publicId, p_privateId, p_pw});
			}
			
			
			/**
			 * 
			 * @desc Triggers the de-registration of a given user at the ue
			 * @desc Triggers de-registration of a given user via UE
			 * @param p_publicId The public user name
			 * @verdict e2e verdict will be set depending on the result of trigger action
			 */
			function f_triggerUeDeregistration(in charstring p_publicId) runs on EutTrigger {
			function f_userDeregistration(in charstring p_publicId) 
			runs on EutTrigger {
				f_sendTriggerCmd(c_DEREGISTER_UE, {p_publicId});
			}
			
			/**
			 * 
			 * @desc Trigger the UE to send a Message request
			 * @desc Trigger sending an instant message via UE
			 */
			function f_triggerUeSendMessageRequest(in charstring p_body) runs on EutTrigger {
			function f_userSendMessage(in charstring p_body) 
			runs on EutTrigger {
				f_sendTriggerCmd(c_SEND_MESSAGE_REQUEST, {p_body});
			}
			
			/**
			 * 
			 * @desc Trigger the UE to receive a Message request
			 * @desc Trigger checking the receipt of instant message at UE
			 */
			function f_triggerUeReceiveMessageRequest() runs on EutTrigger {
			function f_userCheckMessageReceipt() runs on EutTrigger {
				f_sendTriggerCmd(c_RECEIVE_MESSAGE_REQUEST, {});
			}