OneM2M_Functions.ttcn 25.5 KB
Newer Older
1 2 3 4 5 6 7 8
/**
 *  Copyright Notification
 *  No part of this document may be reproduced, in an electronic retrieval system or otherwise, except as authorized by written permission.
 *  The copyright and the foregoing restriction extend to reproduction in all media.
 *  © 2016, oneM2M Partners Type 1 (ARIB, ATIS, CCSA, ETSI, TIA, TSDSI, TTA, TTC).
 *  All rights reserved.
 *  
 *  @author     ETSI
9
 *  @version    $URL: https://forge.etsi.org/svn/oneM2M/branches/Release1/ttcn/LibOneM2M/OneM2M_Functions.ttcn $
10
 *              $Id: OneM2M_Functions.ttcn 173 2016-11-22 08:10:48Z reinaortega $
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
 *  @desc       Module containing functions for oneM2M
 *
 */
module OneM2M_Functions {
	
	import from LibCommon_Time {modulepar all;}
	import from XSD all;
	import from OneM2M_Templates all;
	import from OneM2M_Types all;//{type XSD.ID};
	import from OneM2M_TypesAndValues all;
	import from OneM2M_TestSystem all;
	import from OneM2M_Pixits all;
//	import from OneM2M_AdditionalTypes all;
	
	
	group configFunctions {
    	/**
28
    		@desc Ports mapping and default behaviour activation for Config 1
29
    	*/
30
    	function f_cf01Up() runs on CseTester {
31
    			
32
			// Variables
33
    			
34 35 36 37
			// Map
			map(self:mcaPort, system:mcaPort);
			map(self:acPort, system:acPort);
			activate(a_default());
38
			activate(a_cse_cf01());
39
    			
40
			// Connect
41
    						
42
			//Initialze the IUT
43
    						
44
		} // end f_cf01Up
45
		
46
		function f_cf02Up() runs on CseTester {
47 48 49 50 51 52 53 54
    			
			// Variables
    			
			// Map
			map(self:mcaPort, system:mcaPort);
			map(self:mccPort, system:mccPort);
			map(self:acPort, system:acPort);
			activate(a_default());
55
			activate(a_cse_cf02());
56 57 58 59 60 61
    			
			// Connect
    						
			//Initialze the IUT
    						
		} // end f_cf02Up
62
		
63 64 65
		/**
		 * @desc Ports unmapping
		 * @verdict 
66
		 */
67 68
		function f_cf01Down() runs on CseTester {
    	
69
			unmap(self:mcaPort, system:mcaPort);
70 71 72
			unmap(self:acPort, system:acPort);
			//stop;
		}	
73 74 75
    		
		function f_cf02Down() runs on CseTester {
    	
76
			unmap(self:mcaPort, system:mcaPort);
77
			unmap(self:mccPort, system:mccPort);
78 79
			unmap(self:acPort, system:acPort);
			//stop;
80
		}		
81 82
    	
	}//end group configFunctions
83
	
84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224
	group cseFunctions {
	
    	group preambleFunctions {
    
    		/**
    		 * @desc Creation of auxiliar resources ACP and AE for correct execution of the test case
    		 * @param p_allowedOperations Allowed operations for the auxiliar AE resource
    		 * @return Internal AE resource index
    		 * @verdict 
    		 */
    		function f_cse_preamble_registerAe(in template (value) AccessControlOperations p_allowedOperations := int63) runs on CseTester return integer {//c_CRUDNDi
    		
    			var RequestPrimitive v_request;
    			var MsgIn v_response;
    			var integer v_aeAuxIndex := -1;
    			var integer v_acpAuxIndex := -1;
    		
    			if(PX_ACP_SUPPORT){
    				v_acpAuxIndex := f_cse_createAccessControlPolicyAux(p_allowedOperations := p_allowedOperations);
    				vc_acpAuxIndex := v_acpAuxIndex;
    			}
    			
    			if(v_acpAuxIndex != -1) {
    				vc_resourcesIndexToBeDeleted := {v_acpAuxIndex};
    				v_request := valueof(m_createAeAux(p_accessControlPolicyIDs := {f_getResourceId(vc_resourcesList[v_acpAuxIndex].resource)}));
    				
    				//TODO Test, to be removed
    				v_request.to_ := f_addPrefix(f_getResourceAddress());
    				
    				mcaPort.send(m_request(v_request));
    				//mcaPort.send(m_request(m_createAeAux(p_name, {PX_URI_CSE & PX_CSE_NAME & "/" & PX_ACPAUX_NAME})));
    			} else {
    				mcaPort.send(m_request(m_createAeAux()));
    			}
    			tc_ac.start;
    			alt {
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value v_response {
    					tc_ac.stop;
    					log("Preamble: Application registered successfuly");
    					if(ischosen(v_response.primitive.responsePrimitive.primitiveContent.any_1[0].AE_optional)) {
    						vc_aeAux := v_response.primitive.responsePrimitive.primitiveContent.any_1[0].AE_optional;
    						
    						v_aeAuxIndex := f_setResource(v_response.primitive.responsePrimitive.primitiveContent);
    						vc_resourcesIndexToBeDeleted := vc_resourcesIndexToBeDeleted & {v_aeAuxIndex};
    						
    						if(ispresent(vc_aeAux.aE_ID)){
    							f_sendAcPrimitive("AE-ID_changed", oct2char(unichar2oct(vc_aeAux.aE_ID)));
    						} else {
    							f_sendAcPrimitive("AE-ID_changed", "0");
    						}	
    					}
    				}
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
    					tc_ac.stop;
    					setverdict(inconc, "Preamble: Error while registering application");
    					stop;
    				}
    				[] mcaPort.receive {
    					tc_ac.stop;
    					setverdict(inconc, "Preamble: Unexpected message received");
    					stop;
    				}
    				[] tc_ac.timeout {
    					setverdict(inconc, "Preamble: No answer while registering resource");
    					stop;
    				}
    			}	
    			
    			return v_aeAuxIndex;
    		
    		}
    		
    		//Added by @Naum
    		function f_cse_preamble_createServiceSubscribedAppRule(in template ListOfM2MID p_allowedAEs, in template (value) AccessControlOperations p_allowedOperations := int63) runs on CseTester return integer {//c_CRUDNDi
    		
    			var MsgIn v_response;
    			var integer v_serviceSubscribedAppRuleIndex := -1;
    			var RequestPrimitive v_request;
    
    			v_serviceSubscribedAppRuleIndex := f_cse_createResource(int19, m_createServiceSubscribedAppRule({"None"}, {PX_APP_ID}, valueof(p_allowedAEs)));
    			
    			return v_serviceSubscribedAppRuleIndex;
    		
    		}
    	
    	}//end group preambleFunctions
    	
    	group postambleFunctions {
    
    		/**
    		 * @desc Deletion of all resources created during the test case execution. IUT gets clean and ready for next execution
    		 * @verdict 
    		 */
    		function f_cse_postamble_deleteResources() runs on CseTester {
    			var integer i;
    			var XSD.ID v_resourceAddress;
    			var MsgIn v_response;
    			var RequestPrimitive v_request;
    			
    			if (PX_RUN_POSTAMBLE) {
    				
    				for(i := 0; i < lengthof(vc_resourcesIndexToBeDeleted); i := i + 1) {
    					
    					v_resourceAddress := f_getResourceAddress(lengthof(vc_resourcesIndexToBeDeleted)-1 - i);
    					
    					v_request := valueof(m_deleteRequest(v_resourceAddress));
    					
    					if(PX_FROM_IS_AE_ID){
    						if(ischosen(vc_resourcesList[i].resource.any_1[0].AccessControlPolicy_optional)) {
    							v_request.from_ := PX_AE_ID_STEM;
    						} else {
    							v_request.from_ := vc_aeAux.aE_ID;
    						}
    					}
    					mcaPort.send(m_request(v_request));
    					
    					tc_ac.start;
    					alt {
    						[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) {
    							tc_ac.stop;
    							log("Postamble: AE Resource deleted");
    						}
    						[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
    							tc_ac.stop;
    							log("Postamble: Error while deleting resource");
    						}
    						[] tc_ac.timeout {
    							log("Postamble: No answer while deleting resource");
    						}	
    					}	
    				}
    			}
    						
    			f_cse_postamble_default();
    		}
    		
			/**
			 * @desc Default postamble
			 * @verdict 
			 */
			function f_cse_postamble_default() runs on CseTester {
225
			}
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356
    		
    		
    	}//end group postambleFunctions
    	
    	group helpingFunctions {
    
    		/**
    		 * @desc Creation of a resource
    		 * @param p_resourceType Resource type of the resource to be created
    		 * @param p_requestPrimitive Template request primitive
    		 * @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
    		 * @return Internal resource index of the created resource
    		 * @verdict 
    		 */
    		function f_cse_createResource(in ResourceType p_resourceType, template RequestPrimitive p_requestPrimitive, integer p_parentIndex := -1) runs on CseTester return integer {
    		
    			var MsgIn v_response;
    			var RequestPrimitive v_request;
    			var XSD.ID v_resourceId;
    			var integer v_resourceIndex := -1;
    			
    			v_request := f_getCreateRequestPrimitive(p_resourceType, p_requestPrimitive, p_parentIndex);
    		
    			mcaPort.send(m_request(v_request));
    			tc_ac.start;
    			alt {
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value v_response {
    					tc_ac.stop;
    					setverdict(pass, "f_createResource: Resource type " & int2str(enum2int(p_resourceType)) & " created successfuly");
    					v_resourceIndex := f_setResource(v_response.primitive.responsePrimitive.primitiveContent, p_parentIndex);
    				}
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
    					tc_ac.stop;
    					setverdict(inconc, "f_createResource: Error while creating resource type " & int2str(enum2int(p_resourceType)));
    				}
    				[] mcaPort.receive {
    					tc_ac.stop;
    					setverdict(inconc, "f_createResource: Unexpected message received");
    				}
    				[] tc_ac.timeout {
    					setverdict(inconc, "f_createResource: No answer while creating resource type " & int2str(enum2int(p_resourceType)));
    				}
    			}	
    			
    			return v_resourceIndex;
    	
    		}
    	
    		/**
    		 * @desc Creation of the auxiliar ACP resource
    		 * @param p_acpName ACP name
    		 * @param p_allowedOperations Allowed operations
    		 * @return Internal resource index of the created auxiliar ACP resource
    		 * @verdict 
    		 */
    		function f_cse_createAccessControlPolicyAux(in template (value) XSD.String p_acpName := c_acpAuxName, in template (value) AccessControlOperations p_allowedOperations := int63) runs on CseTester return integer{
    			var RequestPrimitive v_request;
    			var MsgIn v_response;
    			var integer v_acpAuxIndex := -1;
    			
    			v_request := valueof(m_createAcpAux(p_acpName := p_acpName, p_allowedOperations := p_allowedOperations));
    			
    			v_request.to_ := f_addPrefix(f_getResourceAddress());
    			
    			mcaPort.send(m_request(v_request));
    			tc_ac.start;
    			alt {
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value v_response {
    					tc_ac.stop;
    					setverdict(pass, "f_createAccessControlPolicy: Resource type " & int2str(1) & " created successfuly");
    					v_acpAuxIndex := f_setResource(v_response.primitive.responsePrimitive.primitiveContent);
    					vc_acpAux := v_response.primitive.responsePrimitive.primitiveContent.any_1[0].AccessControlPolicy_optional;//TODO To be removed
    				}
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
    					tc_ac.stop;
    					setverdict(inconc, "f_createAccessControlPolicy: Error while creating resource type " & int2str(1));
    				}
    				[] mcaPort.receive {
    					tc_ac.stop;
    					setverdict(inconc, "f_createAccessControlPolicy: Unexpected message received");
    				}
    				[] tc_ac.timeout {
    					setverdict(inconc, "f_createAccessControlPolicy: No answer while creating resource type " & int2str(1));
    				}
    			}	
    		
    			return v_acpAuxIndex;
    
    		}
    			
    			
    		/**
    		 * @desc Creation of the auxiliar Container resource
    		 * @param p_parentIndex Internal resource index which indicates the parent of the Container resource to be created
    		 * @return Internal resource index of the created Container resource
    		 * @verdict 
    		 */
    		function f_cse_createContainerResourceAux (integer p_parentIndex := -1) runs on CseTester return integer {
    		
    			var MsgIn v_response;
    			var RequestPrimitive v_request;
    			var integer v_acpAuxIndex := -1;
    			var integer v_containerResourceIndex := -1;
    			
    			v_acpAuxIndex := f_cse_createAccessControlPolicyAux(p_acpName := c_acpAuxName);//"MyAcp_2"
    			
    			v_request := valueof(m_createContainerBase);
    			v_request.primitiveContent.any_1[0].Container_optional.accessControlPolicyIDs := {f_getResourceId(vc_resourcesList[v_acpAuxIndex].resource)};
    			v_request.primitiveContent.any_1[0].Container_optional.resourceName := "MyContainerAux";
    			
    			v_containerResourceIndex := f_cse_createResource(int3, v_request, p_parentIndex);
    			
    			return v_containerResourceIndex;		
    	
    		}
    		
    		/**
    		 * @desc Update of the auxiliar ACP resource
    		 * @param p_allowedOperations New allowed operations
    		 * @verdict 
    		 */
    		function f_cse_updateAcpAuxResource (in template (value) AccessControlOperations p_allowedOperations) runs on CseTester {
    			var RequestPrimitive v_request;
    			
    			v_request := valueof(m_updateAcpBase);
    			
    			v_request.to_ := f_addPrefix(f_getResourceAddress(vc_acpAuxIndex));
    			v_request.primitiveContent.any_1[0].AccessControlPolicy_optional.privileges.accessControlRule_list := {
    				{
    					accessControlOriginators := PX_ACOR, //{"admin:admin"}
    					accessControlOperations := valueof(p_allowedOperations),
357
    					accessControlContexts_list := {}
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
    				}
    			};
    						
    			mcaPort.send(m_request(v_request));
    			tc_ac.start;
    			alt {
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveOK))  {
    					tc_ac.stop;
    					setverdict(pass, "f_updateAcpAuxResource: " & v_request.to_ & " resource updated successfuly");
    				}
    				[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
    					tc_ac.stop;
    					setverdict(fail, "f_updateAcpAuxResource: Error while updating " & v_request.to_ & " resource");
    				}
    				[] tc_ac.timeout {
    					setverdict(inconc, "f_updateAcpAuxResource: No answer while updating " & v_request.to_ & " resource" );
    				}
    			}		
    		}   
    
    	}//end group helpingFunctions
    	
		group altstepFunctions {
    		 
			/**
			  * @desc	Cse altstep for config 01
			  */
			 altstep a_cse_cf01() runs on CseTester {
		
				[] mcaPort.receive {
					log("a_default: WARNING: Unexpected message received");
					repeat;
				}
			 }			
    		 
			/**
			  * @desc	Cse altstep for config 02
			  */
			 altstep a_cse_cf02() runs on CseTester {
    		
				[] mcaPort.receive {
					log("a_default: WARNING: Unexpected message received");
					repeat;
				}
				[] mccPort.receive {
					log("a_default: WARNING: Unexpected message received");
					repeat;
				}
			 }	

		}//end group altstepFunctions	
    	
	}//end cseFunctions
411
	
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
	group aeFunctions {
		
		group altstepFunctions {
    
			/**
			  * @desc	Ae altstep
			  */
			 altstep a_ae_default() runs on AeTester {
    		
				[] mcaPort.receive {
					log("a_default: WARNING: Unexpected message received");
					repeat;
				}
			 }		
    		 
		}//end group altstepFunctions
		
	}//end of aeFunctions

431

432 433
	group getSetFunctions {
    
434 435 436 437 438 439 440
		/**
		 * @desc Creation of a CREATE request primitive from a template request primitive
		 * @param p_resourceType Type of resource to be created
		 * @param p_request Template request primitive 
		 * @param p_parentIndex Internal resource index which indicates the parent of the resource to be created
		 * @return Created CREATE request primitive
		 * @verdict 
441
		 */
442 443
		function f_getCreateRequestPrimitive(in ResourceType p_resourceType, template RequestPrimitive p_request, integer p_parentIndex) runs on CseTester return RequestPrimitive {
    		
444
			p_request.from_ := f_getOriginator(p_parentIndex);
445
                
446
			p_request.to_ := f_addPrefix(f_getResourceAddress(p_parentIndex));
447
                
448
			if (p_resourceType == int1) {//AccessControlPolicy
449
    			
450 451
			} 
			if (p_resourceType == int9) {//group
452
				p_request.primitiveContent.any_1[0].Group_optional.memberIDs := {f_getResourceAddress(p_parentIndex)};
453
			}
454
    		
455
			if (p_resourceType == int15) {//pollingChannel
456
				p_request.from_ := vc_aeAux.aE_ID;
457
			} 
458
    			
459
			if (p_resourceType == int23) {//subscription
460
				p_request.primitiveContent.any_1[0].Subscription_optional.notificationURI := {f_getResourceAddress(p_parentIndex)};
461
    					
462
				/*if(PX_FROM_IS_AE_ID) {
463 464 465 466 467 468
					if(PX_UNSTRUCTURED){
						p_request.primitiveContent.any_1[0].Subscription_optional.notificationURI := {vc_aeAux.aE_ID};
					} else {
						p_request.primitiveContent.any_1[0].Subscription_optional.notificationURI := {PX_CSE_ID & "/" & vc_aeAux.aE_ID};
					}
				} else {
oneM2MTester Develop Team's avatar
oneM2MTester Develop Team committed
469
					p_request.primitiveContent.any_1[0].Subscription_optional.notificationURI := {"/" & PX_CSE_NAME & "/" & PX_AEAUX_NAME};//c_aeAuxName
470
				}*/
471
			}
472
    		
473 474
			return valueof(p_request);
		}
475
    	
476 477 478 479 480 481 482
		/**
		 * @desc Creation of an UPDATE request primitive from a template request primitive
		 * @param p_resourceType Type of resource to be created
		 * @param p_resourceIndex Internal resource index which indicates the resource to be updated
		 * @param p_request Template request primitive
		 * @return Created UPDATE request primitive
		 * @verdict 
483
		 */
484 485
		function f_getUpdateRequestPrimitive(in ResourceType p_resourceType, integer p_resourceIndex, template RequestPrimitive p_request) runs on CseTester return RequestPrimitive {
    		
486
			p_request.from_ := f_getOriginator(p_resourceIndex);
487
                
488
			p_request.to_ := f_addPrefix(f_getResourceAddress(p_resourceIndex));
489
    			
490
			if (p_resourceType == int3) {//Container
491
    			
492 493
			//TODO
			} 
494
    		
495 496
			if (p_resourceType == int9) {//group
				//TODO	
497
    		
498
			}
499
    		
500 501
			if (p_resourceType == int18) {//schedule
				//TODO			
502
    	
503
			} 
504
    
505 506 507
			if (p_resourceType == int15) {//pollingChannel
				//TODO		
			}
508
    		
509 510 511
			if (p_resourceType == int23) {//subscription
				//TODO		
			} 
512
    		
513 514
			return 	valueof(p_request);
		}
515
    
516 517 518 519 520
		/**
		 * @desc Extraction from a primitiveContent field the resourceID attribute
		 * @param p_contentResource primitiveContent field
		 * @return resourceID attribute
		 * @verdict 
521
		 */
522
		function f_getResourceId(PrimitiveContent p_contentResource) return XSD.ID {
523
    				
524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540
			if(ischosen(p_contentResource.any_1[0].AccessControlPolicy_optional)) {
				return p_contentResource.any_1[0].AccessControlPolicy_optional.resourceID;
			}
			if(ischosen(p_contentResource.any_1[0].Container_optional)) {
				return p_contentResource.any_1[0].Container_optional.resourceID;
			}
			if(ischosen(p_contentResource.any_1[0].Schedule_optional)) {
				return p_contentResource.any_1[0].Schedule_optional.resourceID;
			}
			if(ischosen(p_contentResource.any_1[0].PollingChannel_optional)) {
				return p_contentResource.any_1[0].PollingChannel_optional.resourceID;
			}
			if(ischosen(p_contentResource.any_1[0].Subscription_optional)) {
				return p_contentResource.any_1[0].Subscription_optional.resourceID;
			}
			if(ischosen(p_contentResource.any_1[0].Group_optional)) {
				return p_contentResource.any_1[0].Group_optional.resourceID;
541
			}
542 543 544 545
			if(ischosen(p_contentResource.any_1[0].AE_optional)) {
				return p_contentResource.any_1[0].AE_optional.resourceID;
			}
			return "1";
546
      
547
		}
548
    		
549 550 551 552 553
		/**
		 * @desc Extraction from a primitiveContent field the resourceName attribute
		 * @param p_contentResource primitiveContent field
		 * @return resourceName attribute
		 * @verdict 
554
		 */
555
		function f_getResourceName(PrimitiveContent p_contentResource) return XSD.ID {
556
    				
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
			if(ischosen(p_contentResource.any_1[0].AccessControlPolicy_optional)) {
				return p_contentResource.any_1[0].AccessControlPolicy_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].Container_optional)) {
				return p_contentResource.any_1[0].Container_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].Schedule_optional)) {
				return p_contentResource.any_1[0].Schedule_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].PollingChannel_optional)) {
				return p_contentResource.any_1[0].PollingChannel_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].Subscription_optional)) {
				return p_contentResource.any_1[0].Subscription_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].Group_optional)) {
				return p_contentResource.any_1[0].Group_optional.resourceName;
			}
			if(ischosen(p_contentResource.any_1[0].AE_optional)) {
				return p_contentResource.any_1[0].AE_optional.resourceName;
			}
578
    			
579
			return "1";
580
      
581
		}
582
    		
583 584 585 586 587
		/**
		 * @desc Resolution of the originator field (from) for a given resource
		 * @param p_targetResourceIndex Internal resource index of the given resource
		 * @return Originator for a given resource
		 * @verdict 
588
		 */
589 590
		function f_getOriginator(integer  p_targetResourceIndex := -1) runs on CseTester return XSD.AnyURI {
    			
591 592 593
			if(p_targetResourceIndex == -1) {
				return PX_AE_ID_STEM;
			}	
594
    			
595 596 597 598 599 600 601 602 603 604
			if(PX_FROM_IS_AE_ID) {
				if(ischosen(vc_resourcesList[p_targetResourceIndex].resource.any_1[0].AE_optional)) {
					return vc_resourcesList[p_targetResourceIndex].resource.any_1[0].AE_optional.aE_ID;
				} else {
					return f_getOriginator(vc_resourcesList[p_targetResourceIndex].parentIndex);
				}
			} else {
				return PX_AE_ID_STEM;
			}
		}
605
    		
606 607 608 609 610 611
		/**
		 * @desc Return of a index of a specific attribute from an attributeList by attributeName
		 * @param p_attributeList Target attributeList
		 * @param p_attributeName attributeName to be searched
		 * @return Index of the attribute in the attributeList
		 * @verdict 
612
		 */
613
		function f_getAttribute(in AttributeList p_attributeList, in XSD.NCName p_attributeName) return integer {
614 615
		var integer i;
		var Attribute v_attribute := {-, -};
616
    		
617
		for (i:=0; i < lengthof(p_attributeList); i := i + 1){
618 619
			if(p_attributeList[i] == p_attributeName){
				return i;
620 621
			}	
		}
622
    			
623
		return -1;
624
    		
625
		}
626
    		
627 628 629 630 631
		/**
		 * @desc Resolution of the resource address field (to) for a given resource depending on addressing and hierarchical format 
		 * @param p_targetResourceIndex Internal resource index of the given resource
		 * @return Resource address for the given resource
		 * @verdict 
632
		 */
633
		function f_getResourceAddress(integer  p_targetResourceIndex := -1) runs on CseTester return XSD.ID {
634
			var XSD.ID v_resourceAddress;
635
    		
636
			if(PX_ADDRESSING_FORMAT == e_cseRelative) {
637
    				
638 639 640 641 642 643 644 645 646 647 648 649 650 651
				if(PX_UNSTRUCTURED) {
					if(p_targetResourceIndex == -1) {
						return "";
					} else {
						return f_getResourceId(vc_resourcesList[p_targetResourceIndex].resource);
					}
				} else {
					if(p_targetResourceIndex == -1) {
						return PX_CSE_NAME;
					} else {
						v_resourceAddress := f_getResourceAddress(vc_resourcesList[p_targetResourceIndex].parentIndex) & "/" & f_getResourceName(vc_resourcesList[p_targetResourceIndex].resource);
						return v_resourceAddress;
					}	
				}
652
    				
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685
			} else if (PX_ADDRESSING_FORMAT == e_spRelative) {
				if(PX_UNSTRUCTURED) {
					if(p_targetResourceIndex == -1) {
						return "/" & PX_CSE_ID;
					} else {
						v_resourceAddress := f_getResourceAddress() & "/" & f_getResourceId(vc_resourcesList[p_targetResourceIndex].resource);
						return v_resourceAddress;
					}
				} else {
					if(p_targetResourceIndex == -1) {
						return "/" & PX_CSE_ID & "/" & PX_CSE_NAME;
					} else {
						v_resourceAddress := f_getResourceAddress(vc_resourcesList[p_targetResourceIndex].parentIndex) & "/" & f_getResourceName(vc_resourcesList[p_targetResourceIndex].resource);
						return v_resourceAddress;
					}
				}
			} else if (PX_ADDRESSING_FORMAT ==  e_absolute) {
				if(PX_UNSTRUCTURED) {
					if(p_targetResourceIndex == -1) {
						return "";
					} else {
						return "";
					}
				} else {
					if(p_targetResourceIndex == -1) {
						return "";
					} else {
						return "";
					}	
				}				
			} else {
				return "";
			}
686
    			
687
		}
688 689 690 691 692 693
		/**
		 * @desc Saving of a resource and its parent index in the internal resource list
		 * @param p_resource Resource to be saved
		 * @param p_parentIndex Parent index of resource to be saved
		 * @return Internal resource index of the saved resource
		 * @verdict 
694
		 */
695 696
		function f_setResource(PrimitiveContent p_resource, integer  p_parentIndex := -1) runs on CseTester return integer {
    			
697 698 699 700 701 702
			if(isbound(vc_resourcesList)) {
				vc_resourcesList[lengthof(vc_resourcesList)] := {p_parentIndex, p_resource};
			} else {
				vc_resourcesList[0] := {p_parentIndex, p_resource};
			}
			return lengthof(vc_resourcesList)-1;
703
    					
704
		}
705
    				
706 707
	}//end group getSetFunctions
	
708
	group commonFunctions {
709
		
710 711 712 713 714 715
		/**
		 * @desc Sending of an Adapter Control primitive
		 * @param event Action to be performed by TA
		 * @param data Corresponding information for the correct execution of the given action
		 * @verdict 
		 */
716
		function f_sendAcPrimitive(in charstring event, in charstring data) runs on Tester {
717 718 719 720 721

			var charstring v_data := "" & data; // clear encoding rules (ttwb issue ?)
			acPort.send(AcRequestPrimitive:{event, {charstring := v_data}});
			
		}
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
		
		group altstepFunctions {
    
			/**
			  * @desc	Default altstep
			  */
			 altstep a_default() runs on Tester {
    		
				[] tc_wait.timeout {
					 setverdict(inconc,"a_default: ERROR: Timeout while awaiting reaction of the IUT prior to Upper Tester action");
				}
				[] tc_ac.timeout {
					setverdict(inconc,"a_default: ERROR: Timeout while awaiting the reception of a message");
				}
			 }	    		 
737

738 739 740
		}//end group altstepFunctions
		
	}//end of commonFunctions
741 742 743 744 745 746 747 748 749 750 751 752 753

		

	

		

		

	

	
}  // end of module