OneM2M_Functions.ttcn 134 KB
Newer Older
1 2 3 4 5 6 7
/**
 *  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.
 *  
8 9 10
 *  @author     ETSI
 *  @version    $URL: https://oldforge.etsi.org/svn/oneM2M/branches/Release1/ttcn/LibOneM2M/OneM2M_Functions.ttcn $
 *              $Id: OneM2M_Functions.ttcn 347 2017-08-11 08:48:20Z reinaortega $
11 12 13 14 15 16 17
 *  @desc       Module containing functions for oneM2M
 *
 */
module OneM2M_Functions {
	
	import from XSD all;
	import from OneM2M_Templates all;
18
	import from OneM2M_Types all;
19 20 21
	import from OneM2M_TypesAndValues all;
	import from OneM2M_TestSystem all;
	import from OneM2M_Pixits all;
22
	import from OneM2M_Pics all;
23
	
24
	group ConfigFunctions {
25
		
26 27 28
		/**
			@desc Ports mapping and default behaviour activation for Config 1
		*/
29 30
		function f_cf01Up(in boolean p_auxiliaryAe2Required := false) runs on AeSimu {
			
31
			// Variables
32 33
			vc_config := e_cf01;
			vc_testSystemRole := e_ae;	
34
			
35 36 37
			// Map
			map(self:mcaPort, system:mcaPort);
			map(self:acPort, system:acPort);
38
			
39
			activate(a_default());
40
			activate(a_cse_cf01());
41
				
42 43 44 45 46
			// Initialize AE2
			if(p_auxiliaryAe2Required) {
				vc_auxiliaryAe2Up := p_auxiliaryAe2Required;
				vc_ae2 := AeSimu.create("AE2") alive;
				vc_ae2.start(f_cf01UpAe2());
47
				vc_ae2.done;
48 49 50 51 52 53 54 55 56 57 58 59
			}
				
			//Initialze the IUT
							
		} // end f_cf01Up
		
		/**
			@desc Ports mapping and default behaviour activation for Config 1 on the auxiliary AE2
		*/
		function f_cf01UpAe2() runs on AeSimu {
			
			// Variables
60 61
			vc_config := e_cf01;
			vc_testSystemRole := e_ae;		
62 63 64 65 66 67 68 69 70 71
			
			// Map
			map(self:mcaPort, system:mcaPort);
			map(self:mcaPortIn, system:mcaPortIn);
			map(self:acPort, system:acPort);
			
			activate(a_default());
			activate(a_cse_cf01());
			activate(a_cse_cf01_ae2()); //For mcaPortIn
	
72
			//Initialze the IUT
73
							
74
		} // end f_cf01Up
75
		
76 77 78
		/**
		 * @desc Ports mapping and default behaviour activation for Config 02
		 */
79
		function f_cf02Up() runs on AeSimu {
80
				
81
			// Variables
82
			vc_config := e_cf02;
83
			vc_testSystemRole := e_ae;	
84
			vc_cse1 := CseSimu.create("CSE1") alive;
85
				
86 87 88
			// Map
			map(self:mcaPort, system:mcaPort);
			map(self:acPort, system:acPort);
89 90 91
			if(PX_UT_IMPLEMENTED) {
				map(self:utPort, system:utPort);
			}
92
			activate(a_default());
93 94 95
			activate(a_cse_cf02_ae1());
			vc_cse1.start(f_cf02UpCse1());
			vc_cse1.done;
96
				
97
			// Connect
98
			
99
			//Initialze the IUT
100
							
101
		} // end f_cf02Up
102 103 104 105 106 107 108
		
		/**
			@desc Ports mapping and default behaviour activation for Config 2 on the CSE1
		*/
		function f_cf02UpCse1() runs on CseSimu {
			
			// Variables
109
			var PrimitiveContent v_cSEBaseResource;
110 111
			vc_config := e_cf02;
			vc_testSystemRole := e_cse;		
112 113 114 115 116 117 118 119 120
			
			// Map
			map(self:mccPort, system:mccPort);
			map(self:mccPortIn, system:mccPortIn);
			map(self:acPort, system:acPort);
			
			activate(a_default());
			activate(a_cse_cf02_cse1());
			
121 122 123
			v_cSEBaseResource := f_cse_generateLocalResource(-, -1, int5);
			vc_cSEBaseIndex := f_setLocalResource(v_cSEBaseResource, int5, -1);
			
124 125 126
			//Initialze the IUT
							
		} // end f_cf02UpCse1
127 128 129 130 131 132 133

		/**
		 * @desc Ports mapping and default behaviour activation for Config 02
		 */
		function f_cf02UpCseSimuMaster() runs on CseSimu {
				
			// Variables
134 135
			var PrimitiveContent v_cSEBaseResource;
			vc_config := e_cf02CseSimuMaster;
136
			vc_testSystemRole := e_cse;		
137
			vc_ae1 := AeSimu.create("AE1") alive;
138 139 140
				
			// Map
			map(self:mccPort, system:mccPort);
141
			map(self:mccPortIn, system:mccPortIn);
142 143
			map(self:acPort, system:acPort);
			activate(a_default());
144 145 146
			activate(a_cse_cf02_cse1());
			vc_ae1.start(f_cf02UpAe1());
			vc_ae1.done;
147 148 149
			
			v_cSEBaseResource := f_cse_generateLocalResource(-, -1, int5);
			vc_cSEBaseIndex := f_setLocalResource(v_cSEBaseResource, int5, -1);
150 151
				
			// Connect
152
			
153 154 155
			//Initialze the IUT
							
		} // end f_cf02UpCseSimuMaster
156
		
157 158 159 160 161 162
		/**
			@desc Ports mapping and default behaviour activation for Config 2 on the AE1
		*/
		function f_cf02UpAe1() runs on AeSimu {
			
			// Variables
163
			vc_config := e_cf02CseSimuMaster;	
164
			vc_testSystemRole := e_ae;		
165 166 167
			
			// Map
			map(self:mcaPort, system:mcaPort);
168
			map(self:mcaPortIn, system:mcaPortIn);
169 170 171 172 173 174 175 176 177
			map(self:acPort, system:acPort);
			
			activate(a_default());
			activate(a_cse_cf02_ae1());
			
			//Initialze the IUT
							
		} // end f_cf02UpAe1
		
178 179 180
		/**
		 * @desc Ports mapping and default behaviour activation for Config 03
		 */
181
		function f_cf03Up() runs on CseSimu {
182 183
		
			// Variables
184
			var PrimitiveContent v_cSEBaseResource;
185
			vc_config := e_cf03;
186
			vc_testSystemRole := e_cse;		
187
			
188
			// Map
189
			map(self:mcaPortIn, system:mcaPortIn);//TODO To be consistent, we should use mcaPortIn for AE testing
190
			map(self:acPort, system:acPort);
191 192 193
			if(PX_UT_IMPLEMENTED) {
				map(self:utPort, system:utPort);
			}
194
			activate(a_default());
195
			activate(a_ae_cf03());
196 197 198 199 200
			
			//Creation of CSEBase
			
			v_cSEBaseResource := f_cse_generateLocalResource(-, -1, int5);
			vc_cSEBaseIndex := f_setLocalResource(v_cSEBaseResource, int5, -1);
201 202 203 204 205 206
		
			// Connect
					
			//Initialze the IUT
					
		} // end f_cf03Up
207 208 209 210
		
		/**
		 * @desc Ports mapping and default behaviour activation for Config 04
		 */
211
		function f_cf04Up() runs on CseSimu {
212 213

			// Variables
214
			var PrimitiveContent v_cSEBaseResource;
215
			vc_config := e_cf04;
216 217
			vc_testSystemRole := e_cse;	
			
218 219 220
	
			// Map
			map(self:mccPort, system:mccPort);
221
			map(self:mccPortIn, system:mccPortIn);
222 223 224
			map(self:acPort, system:acPort);
			activate(a_default());
			activate(a_cse_cf04());
225 226 227 228 229
			
			//Creation of CSEBase
			
			v_cSEBaseResource := f_cse_generateLocalResource(-, -1, int5);
			vc_cSEBaseIndex := f_setLocalResource(v_cSEBaseResource, int5, -1);
230 231 232

			// Connect
			
233
			//Initialize the IUT
234 235
			
		} // end f_cf03Up
236 237

		/**
238
		 * @desc Ports unmapping
239
		 */
240
		function f_cf01Down() runs on AeSimu {
241
		
242
			unmap(self:mcaPort, system:mcaPort);
243
			unmap(self:acPort, system:acPort);
244 245
			if(vc_auxiliaryAe2Up) {
				vc_ae2.start(f_cf01DownAe2());
246
				vc_ae2.done;
247 248 249 250 251 252 253 254 255 256 257 258 259
			}
		}
		
		/**
		 * @desc Ports unmapping
		 */
		function f_cf01DownAe2() runs on AeSimu {
				
			unmap(self:mcaPort, system:mcaPort);
			unmap(self:acPort, system:acPort);
			unmap(self:mcaPortIn, system:mcaPortIn);
		}
		
260 261 262
		/**
		 * @desc Ports unmapping
		 */
263
		function f_cf02Down() runs on AeSimu {
264
		
265
			unmap(self:mcaPort, system:mcaPort);
266
			unmap(self:acPort, system:acPort);
267 268 269
			if(PX_UT_IMPLEMENTED){
				unmap(self:utPort, system:utPort);
			}
270 271 272
			unmap(vc_cse1:mccPort, system:mccPort);
			unmap(vc_cse1:mccPortIn, system:mccPortIn);
			unmap(vc_cse1:acPort, system:acPort);
273 274 275 276 277 278
		}		
		/**
		 * @desc Ports unmapping
		 */
		function f_cf02DownCseSimuMaster() runs on CseSimu {
				
279
			unmap(self:mccPort, system:mccPort);
280
			unmap(self:mccPortIn, system:mccPortIn);
281
			unmap(self:acPort, system:acPort);
282 283
			unmap(vc_ae1:mcaPort, system:mcaPort);
			unmap(vc_ae1:acPort, system:acPort);
284
		}		
285 286 287
		/**
		 * @desc Ports unmapping for Config 03
		 */
288
		function f_cf03Down() runs on CseSimu {
289
			
290
			unmap(self:mcaPortIn, system:mcaPortIn);
291 292 293
			if(PX_UT_IMPLEMENTED){
				unmap(self:utPort, system:utPort);
			}
294 295
			unmap(self:acPort, system:acPort);
		}
296
		
297 298 299
		/**
		 * @desc Ports unmapping for Config 04
		 */
300
		function f_cf04Down() runs on CseSimu {
301 302
	
			unmap(self:mccPort, system:mccPort);
303
			unmap(self:mccPortIn, system:mccPortIn);
304 305
			unmap(self:acPort, system:acPort);
		}
306 307 308 309 310 311 312 313 314

	}//end group configFunctions
	
	group InfoPortCommunication {
	
		/**
		 * @desc Connection of InfoPort of two components
		 * @param p_tester PTC where InfoPort is to be connected
		 */
315 316 317 318 319
		function f_connectInfoPort(in Tester p_tester) runs on Tester {
			// Connect
			connect(self:infoPort, p_tester:infoPort);		
		} 
	
320 321 322 323
		/**
		 * @desc Disconnection of InfoPort of two components
		 * @param p_tester PTC where InfoPort is to be connected
		 */
324 325 326 327
		function f_disconnectInfoPort(in Tester p_tester) runs on Tester {
			// Disconnect
			disconnect(self:infoPort, p_tester:infoPort);		
		} 
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
	
		/**
		 * @desc Getting last responsePrimitive saved in a component
		 * @param p_tester Given component
		 */
		function f_getResponsePrimitive(in Tester p_component) runs on Tester return ResponsePrimitive {
			var ResponsePrimitive v_response;
			
			f_connectInfoPort(p_component);
	
			p_component.start(f_sendResponsePrimitive());
			alt {
				[]infoPort.receive(mw_responsePrimitiveforInfoPort) -> value v_response {
				}
			}
	
			f_disconnectInfoPort(p_component);
				
			return v_response;
				
		}
349
		
350 351 352 353 354 355 356 357 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 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498
		/**
		 * @desc Getting last requestPrimitive saved in an AeSimu component
		 * @param p_tester Given component
		 */
		function f_getRequestPrimitive(in Tester p_component) runs on Tester return RequestPrimitive {
			var RequestPrimitive v_request;

			f_connectInfoPort(p_component);

			p_component.start(f_sendRequestPrimitive());
			alt {
				[]infoPort.receive(mw_requestPrimitiveforInfoPort) -> value v_request {
				}
			}

			f_disconnectInfoPort(p_component);
	
			return v_request;
	
		}
							
		/**
		 * @desc Getting primitiveContent retrieved in an AeSimu component
		 * @param p_tester AeSimu component
		 */
		function f_getPrimitiveContentRetrievedResource(in AeSimu p_ae) runs on Tester return PrimitiveContent {
			var PrimitiveContent v_primitiveContent;
			
			f_connectInfoPort(p_ae);
	
			p_ae.start(f_sendPrimitiveContentRetrievedResource());
			alt {
				[]infoPort.receive(mw_primitiveContent) -> value v_primitiveContent {
				}
			}
	
			f_disconnectInfoPort(p_ae);
				
			return v_primitiveContent;
				
		}
		
		/**
		 * @desc Getting remoteCSE resource from a CseSimu component
		 * @param p_tester CseSimu component
		 */
		function f_getRemoteCseResource(in CseSimu p_cse) runs on Tester return integer {
			var MyResource v_resource;
			var integer v_resourceIndex := -1;
			
			f_connectInfoPort(p_cse);
	
			p_cse.start(f_sendRemoteCseResource());
			alt {
				[]infoPort.receive(mw_resource) -> value v_resource {
					v_resourceIndex := f_setResource(v_resource.resource, v_resource.resourceType, v_resource.parentIndex, false);
				}
			}
	
			f_disconnectInfoPort(p_cse);
				
			return v_resourceIndex;
				
		}
		
		/**
		 * @desc Getting a specific resource from an AeSimu component
		 * @param p_tester AeSimu component
		 * @param p_resourceIndex Index of resource to be retrieved
		 */
		function f_getResource(in Tester p_component, in integer p_resourceIndex := -1) runs on Tester return integer {
			var MyResource v_resource;
			var integer v_resourceIndex := -1;
		
			f_connectInfoPort(p_component);

			p_component.start(f_sendResource(p_resourceIndex));
			alt {
				[]infoPort.receive(mw_resource) -> value v_resource {
					v_resourceIndex := f_setResource(v_resource.resource, v_resource.resourceType, v_resource.parentIndex, false);
				}
			}

			f_disconnectInfoPort(p_component);
			
			return v_resourceIndex;
			
		}		

		/**
		 * @desc Sending of last responsePrimitive (vc_response) through InfoPort
		 */	
		function f_sendResponsePrimitive() runs on Tester {
	
			infoPort.send(vc_response.primitive.responsePrimitive);
				
		} 

		/**
		 * @desc Sending of last requestPrimitive (vc_request) through InfoPort
		 */			
		function f_sendRequestPrimitive() runs on Tester {
	
			infoPort.send(vc_request.primitive.requestPrimitive);
	
		} 
		
		/**
		 * @desc Sending of last primitiveContent retrieved (vc_primitiveContentRetrievedResource) through InfoPort
		 */	
		function f_sendPrimitiveContentRetrievedResource() runs on AeSimu {
	
			infoPort.send(vc_primitiveContentRetrievedResource);
				
		} 	
		
		/**
		 * @desc Sending of remoteCSE resource through InfoPort
		 */	
		function f_sendRemoteCseResource() runs on CseSimu {
	
			infoPort.send(vc_resourcesList[vc_remoteCseIndex]);
				
		} 
		
		/**
		 * @desc Sending of Ae resource through InfoPort
		 */	
		function f_sendAeResource() runs on AeSimu {
	
			infoPort.send(vc_resourcesList[vc_aeAuxIndex]);
				
		} 		
		
		/**
		 * @desc Sending of a specific resource through InfoPort
		 * @param p_resourceIndex Index of resource to be sent
		 */	
		function f_sendResource(in integer p_resourceIndex) runs on Tester {
	
			if(p_resourceIndex == -1) {
				infoPort.send(vc_resourcesList[vc_aeAuxIndex]);  //TODO To send Ae or RemoteCSE depending on the component type
			} else {
				infoPort.send(vc_resourcesList[p_resourceIndex]);
			}
				
		} 	
	
	}// end of gropu InfoPortCommunication	
499
	
500
	group CseFunctions {
501
	
502
		group PreambleFunctions {
503

504 505 506 507 508 509
			/**
			 * @desc Creation of auxiliar resources ACP for correct execution of the test case
			 * @param p_allowedOperations Allowed operations for the auxiliar AE resource
			 * @return Internal ACP resource index
			 * @verdict 
			 */
510
			function f_cse_preamble_createAcpAux(in template (value) XSD.String p_acpName := c_acpAuxName, in template (value) AccessControlOperations p_allowedOperations := int63) runs on AeSimu return integer {//c_CRUDNDi
511
			
512
				return f_cse_createAccessControlPolicyAux(p_acpName, -, p_allowedOperations);
513 514
			
			}
515

516 517
	
			/**
518 519 520
			 * @desc Creation of auxiliar resource AE for correct execution of the test case
			 * @param p_accessControlPolicyIDs AccessControlPolicyIDs for the auxiliar AE resource
			 * @param p_poaList Point of contact of the auxiliar AE resource
521 522 523
			 * @return Internal AE resource index
			 * @verdict 
			 */
524
			function f_cse_preamble_registerAe(template (omit) AcpType p_accessControlPolicyIDs := omit, in template (omit) PoaList p_poaList := omit) runs on AeSimu return integer {//c_CRUDNDi
525 526 527 528 529
			
				var RequestPrimitive v_request;
				var MsgIn v_response;
								
				v_request := valueof(m_createAeAux(p_accessControlPolicyIDs, p_poaList));
530 531
				
				v_request := f_getCreateRequestPrimitive(int2, v_request, -1);
532
				
533
				mcaPort.send(m_request(v_request));
534 535 536 537 538
				
				tc_ac.start;
				alt {
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value v_response {
						tc_ac.stop;
539
						setverdict(pass,__SCOPE__&":INFO: Application registered successfuly");
540
						if(ischosen(v_response.primitive.responsePrimitive.primitiveContent.aE)) {
541
							
542 543
							f_checkAttributesToBeSaved(int2, v_request, v_response.primitive.responsePrimitive);
							
544
							vc_aeAuxIndex := f_setResource(v_response.primitive.responsePrimitive.primitiveContent, int2);
545
							
546 547
							if(ispresent(v_response.primitive.responsePrimitive.primitiveContent.aE.aE_ID)){
								f_sendAcPrimitive("AE-ID_changed", oct2char(unichar2oct(v_response.primitive.responsePrimitive.primitiveContent.aE.aE_ID)));
548 549 550 551 552 553 554
							} else {
								f_sendAcPrimitive("AE-ID_changed", "0");
							}
						}
					}
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
						tc_ac.stop;
555
						setverdict(inconc, __SCOPE__&":INFO: Error while registering application");
556 557 558 559
						stop;
					}
					[] mcaPort.receive {
						tc_ac.stop;
560
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
561 562 563
						stop;
					};
					[] tc_ac.timeout {
564
						setverdict(inconc, __SCOPE__&":INFO: No answer while registering resource");
565 566 567 568
						stop;
					}
				}	
				
569
				f_checkAeSimuStatus();
570
				return vc_aeAuxIndex;
571 572 573 574 575
			}
			
			/**
			 * @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
576
			 * @param p_appId AppID of the AE resource to be created
577 578 579
			 * @return Internal AE resource index
			 * @verdict 
			 */
580
			function f_cse_preamble_registerAeWithId(XSD.ID p_appId, in template (value) AccessControlOperations p_allowedOperations := int63) runs on AeSimu return integer {//c_CRUDNDi
581 582
			
				var RequestPrimitive v_request;
583
				
584
				if(PICS_ACP_SUPPORT){
585
					vc_acpAuxIndex := f_cse_createAccessControlPolicyAux(p_allowedOperations := p_allowedOperations);
586 587
				}
				
588 589 590
				if(vc_acpAuxIndex != -1) {
					vc_resourcesIndexToBeDeleted := {vc_acpAuxIndex};
					v_request := valueof(m_createAe(p_appId, {f_getResourceId(vc_resourcesList[vc_acpAuxIndex].resource)}, -));
591 592 593 594 595 596 597 598 599 600 601
					
					//TODO Test, to be removed
					v_request.to_ := 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_createAe(p_appId)));
				}
				tc_ac.start;
				alt {
602
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value vc_response {
603
						tc_ac.stop;
604
						setverdict(pass, __SCOPE__&": INFO: Application registered successfuly");
605
						if(ischosen(vc_response.primitive.responsePrimitive.primitiveContent.aE)) {
606
							
607
							vc_aeAuxIndex := f_setResource(vc_response.primitive.responsePrimitive.primitiveContent, int2);
608
							
609 610
							if(ispresent(vc_response.primitive.responsePrimitive.primitiveContent.aE.aE_ID)){
								f_sendAcPrimitive("AE-ID_changed", oct2char(unichar2oct(vc_response.primitive.responsePrimitive.primitiveContent.aE.aE_ID)));
611 612 613 614 615 616 617 618
							} else {
								f_sendAcPrimitive("AE-ID_changed", "0");
							}	
						}
					}
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO))
					{
						tc_ac.stop;
619
						setverdict(inconc, __SCOPE__&":INFO: Error while registering application");
620 621 622 623
						stop;
					}
					[] mcaPort.receive {
						tc_ac.stop;
624
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
625 626 627
						stop;
					}
					[] tc_ac.timeout {
628
						setverdict(inconc, __SCOPE__&":INFO: No answer while registering resource");
629 630 631 632
						stop;
					}
				}	
				
633
				f_checkAeSimuStatus();
634
				return vc_aeAuxIndex;
635 636 637
			
			}
			
638 639 640 641 642 643
			/**
			 * @desc Creation of ServiceSubscribedAppRule resource
			 * @param p_allowedAEs Allowed AEs
			 * @return Internal resource index
			 * @verdict 
			 */
644
			function f_cse_preamble_createServiceSubscribedAppRule(in template ListOfM2MID p_allowedAEs := {""}) runs on AeSimu return integer {//c_CRUDNDi
645 646 647 648 649 650 651 652 653
			
				var integer v_serviceSubscribedAppRuleIndex := -1;
	
				v_serviceSubscribedAppRuleIndex := f_cse_createResource(int19, m_createServiceSubscribedAppRule({"None"}, {PX_APP_ID}, valueof(p_allowedAEs)));
				
				return v_serviceSubscribedAppRuleIndex;
			
			}
			
654 655 656 657 658 659
			/**
			 * @desc Creation of SubscribedProfile resource
			 * @param p_allowedAEs Allowed AEs
			 * @return Internal resource index
			 * @verdict 
			 */
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
			function f_cse_preamble_createServiceSubscribedProfile(in template ListOfM2MID p_allowedAEs := {""}) runs on AeSimu return integer {//c_CRUDNDi
			
				var integer v_serviceSubscribedAppRuleIndex := -1;
				var integer v_serviceSubscribedProfileIndex := -1;
				var template RequestPrimitive m_request := m_createM2mServiceSubscriptionProfileBase;
				
				//TODO Create/Update serviceSubscribedNode //m_request.primitiveContent.m2mServiceSubscriptionProfile.choice.choice_list[0].serviceSubscribedNode := m_contentServiceSubscribedNode;
				v_serviceSubscribedAppRuleIndex := f_cse_createResource(int19, m_createServiceSubscribedAppRule({"None"}, {PX_APP_ID}, valueof(p_allowedAEs)));
				m_request.primitiveContent.m2mServiceSubscriptionProfile.choice.choice_list[0].serviceSubscribedNode.ruleLinks := {f_getResourceAddress(v_serviceSubscribedAppRuleIndex)};
				v_serviceSubscribedProfileIndex := f_cse_createResource(int11, m_request);
			
				return v_serviceSubscribedProfileIndex;
	
			}
			
675 676 677 678 679 680 681 682
			/**
			 * @desc Registration of AE2 for handling of notifications and handling of subscription verification started if subscription resource is to be created
			 * @param p_ae2Index Internal AE2 resource index
			 * @param p_createRequestPrimitive CREATE Request for the resource to be created
			 * @param p_resourceType ResourceType of the resource to be created
			 * @param p_responseStatusCode Response Status Code to be sent in response to the subscription verification request
			 * @verdict 
			 */
Naum Spaseski's avatar
Naum Spaseski committed
683
			function f_cse_preamble_subscriptionVerification(inout integer p_ae2Index, inout template RequestPrimitive p_createRequestPrimitive,in ResourceType p_resourceType, in ResponseStatusCode p_responseStatusCode := int2000) runs on AeSimu {
684
				if(p_resourceType == int23){
685
					
686
					vc_ae2.start(f_cse_createResource(int2, m_createAe(PX_APP_ID, -, PX_AE2_ID_STEM, c_defaultAE2Name, {f_getAnnouncementTargetPoA("HTTP", PX_AE2_ADDRESS, "")}), -1)); // AE2 is registred
687 688 689 690
					
					f_checkComponentDoneAndGetVerdict(vc_ae2);
					
					p_ae2Index := f_getResource(vc_ae2);
691
					if(ischosen(p_createRequestPrimitive.primitiveContent.subscription)){		//this condition is necessary for Subscription TCs where notification URI is set in m_createSubscriptionAdvanced
692
						p_createRequestPrimitive.primitiveContent.subscription.notificationURI := {f_getResourceAddress(p_ae2Index)};
693
					}
694
					vc_ae2.start(f_cse_notifyProcedure_subscriptionVerificationHandler(p_responseStatusCode));
695
				}
696
			}
697 698 699 700 701 702
		
		}//end group preambleFunctions
		
		group PostambleFunctions {
	
			/**
703
			 * @desc Deletion of all resources created during the test case execution. It deals also with AE2 created resources if any. IUT gets clean and ready for next execution
704 705
			 * @verdict 
			 */
706
			function f_cse_postamble_deleteResources() runs on AeSimu {
707 708 709 710 711 712
				var integer i;
				var XSD.ID v_resourceAddress;
				var RequestPrimitive v_request;
				
				if (PX_RUN_POSTAMBLE) {
					
713 714 715 716
					if(vc_auxiliaryAe2Up) {
						f_cse_postamble_aeSimu(vc_ae2);
					}
					
717
					for(i := lengthof(vc_resourcesIndexToBeDeleted) -1; i >=0; i := i - 1) {
718
						
719
						v_resourceAddress := f_getResourceAddress(vc_resourcesIndexToBeDeleted[i]); 
720
						
721
						v_request := valueof(m_delete(v_resourceAddress, f_getOriginator(vc_resourcesIndexToBeDeleted[i])));
722
						
723
						v_request.from_ := f_getOriginator(vc_resourcesIndexToBeDeleted[i]);
724

725 726 727 728 729 730
						mcaPort.send(m_request(v_request));
						
						tc_ac.start;
						alt {
							[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) {
								tc_ac.stop;
731
								log(__SCOPE__&" INFO: Resource " & v_request.to_ & " deleted");
732 733 734 735 736 737 738 739 740
							}
							[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
								tc_ac.stop;
								log(__SCOPE__&" INFO: Error while deleting resource " & v_request.to_);
							}
							[] tc_ac.timeout {
								log(__SCOPE__&" INFO: No answer while deleting resource " & v_request.to_);
							}	
						}	
741
						
742 743
					}
				}
744 745 746 747
						
			}
			
			/**
748
			 * @desc Calls to postamble for AeSimu components (i.e. AE2)
749 750 751 752 753 754 755
			 * @verdict 
			 */
			function f_cse_postamble_aeSimu(in AeSimu p_ae) runs on AeSimu {
				if(p_ae.running) {
					p_ae.stop;
				}
					p_ae.start(f_cse_postamble_deleteResources());
756 757
			}
			
758 759 760 761
			/**
			 * @desc Deletion of all resources created during the test case execution. IUT gets clean and ready for next execution
			 * @verdict 
			 */
762
			function f_cse_postamble_deleteResourcesCSE() runs on CseSimu {
763 764 765
				var integer i;
				var XSD.ID v_resourceAddress;
				var RequestPrimitive v_request;
766
	
767
				if (PX_RUN_POSTAMBLE) {
768
		
769
					for(i := lengthof(vc_resourcesIndexToBeDeleted) -1; i >=0; i := i - 1) {
770
			
771
						v_resourceAddress := f_getResourceAddress(vc_resourcesIndexToBeDeleted[i]); 
772
			
773
						v_request := valueof(m_delete(v_resourceAddress, f_getOriginator(vc_resourcesIndexToBeDeleted[i],false)));
774
			
775 776 777
						v_request.from_ := PX_SUPER_CSE_ID;

						mccPort.send(m_request(v_request));
778
			
779 780 781 782 783 784
						tc_ac.start;
						alt {
							[] mccPort.receive(mw_response(mw_responsePrimitiveOK)) {
								tc_ac.stop;
								log(__SCOPE__&" INFO: Resource " & v_request.to_ & " deleted");
							}
785 786 787 788 789 790 791 792
							[] mccPort.receive(mw_response(mw_responsePrimitiveKO)) {
								tc_ac.stop;
								log(__SCOPE__&" INFO: Error while deleting resource " & v_request.to_);
							}
							[] tc_ac.timeout {
								log(__SCOPE__&" INFO: No answer while deleting resource " & v_request.to_);
							}	
						}	
793
			
794
					}
795
				}
796
			
797
			}			
798 799 800
			
		}//end group postambleFunctions
		
801 802
		group AeSimuFunctions {
			
803 804 805
			/**
			 * @desc Creation of a resource
			 * @param p_resourceType Resource type of the resource to be created
806
			 * @param p_requestPrimitive CREATE request primitive for the resource to be created
807 808 809 810
			 * @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 
			 */
811
			function f_cse_createResource(in ResourceType p_resourceType, template RequestPrimitive p_requestPrimitive := m_create, integer p_parentIndex := -1) runs on AeSimu return integer {
812 813 814 815 816 817 818 819 820
			
				var RequestPrimitive v_request;
				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 {
821
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value vc_response {
822
						tc_ac.stop;
823
						setverdict(pass, __SCOPE__&":INFO: Resource type " & int2str(enum2int(p_resourceType)) & " created successfuly");
824 825 826 827 828
						f_checkAttributesToBeSaved(p_resourceType, v_request, vc_response.primitive.responsePrimitive);
						v_resourceIndex := f_setResource(vc_response.primitive.responsePrimitive.primitiveContent, p_resourceType, p_parentIndex);
						if(p_resourceType == int2) {
							vc_aeAuxIndex := v_resourceIndex;
						}
829 830 831
					}
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
						tc_ac.stop;
832
						setverdict(inconc, __SCOPE__&":INFO: Error while creating resource type " & int2str(enum2int(p_resourceType)));
833 834 835
					}
					[] mcaPort.receive {
						tc_ac.stop;
836
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
837 838
					}
					[] tc_ac.timeout {
839
						setverdict(inconc, __SCOPE__&":INFO: No answer while creating resource type " & int2str(enum2int(p_resourceType)));
840 841 842
					}
				}	
				
843
				f_checkAeSimuStatus();
844
				
845 846 847 848 849 850 851 852 853 854 855
				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 
			 */
856
			function f_cse_createAccessControlPolicyAux(in template (value) XSD.String p_acpName := c_acpAuxName, in template (value) ListOfURIs p_acor := PX_ACOR, in template (value) AccessControlOperations p_allowedOperations := int63) runs on AeSimu return integer{				var RequestPrimitive v_request;
857 858 859 860
				var integer v_acpAuxIndex := -1;
				
				v_request := valueof(m_createAcpAux(p_acpName := p_acpName, p_allowedOperations := p_allowedOperations));
				
861
				v_request := f_getCreateRequestPrimitive(int1, v_request, -1);
862
								
863 864 865
				mcaPort.send(m_request(v_request));
				tc_ac.start;
				alt {
866
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value vc_response {
867
						tc_ac.stop;
868
						setverdict(pass, __SCOPE__&":INFO: Resource type " & int2str(1) & " created successfuly");
869 870
						f_checkAttributesToBeSaved(int1, v_request, vc_response.primitive.responsePrimitive);
						v_acpAuxIndex := f_setResource(vc_response.primitive.responsePrimitive.primitiveContent, int1);
871
						vc_acpAuxIndex := v_acpAuxIndex;
872
					}
873 874
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) {
						tc_ac.stop;
875
						setverdict(inconc, __SCOPE__&":INFO: Error while creating resource type " & int2str(1));
876 877 878
					}
					[] mcaPort.receive {
						tc_ac.stop;
879
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
880 881
					}
					[] tc_ac.timeout {
882
						setverdict(inconc, __SCOPE__&":INFO: No answer while creating resource type " & int2str(1));
883 884
					}
				}	
885
				
886
				f_checkAeSimuStatus();
887 888 889 890
			
				return v_acpAuxIndex;
	
			}
891
							
892
			/**
893 894
			 * @desc Message exchange for the update of a resource
			 * @param p_requestPrimitive UPDATE request primitive to be used
895 896
			 * @verdict 
			 */
897
			function f_cse_updateResource(in RequestPrimitive p_requestPrimitive) runs on AeSimu {
898 899 900 901

				mcaPort.send(m_request(p_requestPrimitive));
				tc_ac.start;
				alt {
902
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value vc_response {
903
						tc_ac.stop;
904
						setverdict(pass, __SCOPE__&":INFO: Attribute of resource updated successfuly");
905
					}
906
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) -> value vc_response {
907
						tc_ac.stop;
908
						setverdict(inconc, __SCOPE__&":INFO: Error while updating resource");
909 910 911
					}
					[] mcaPort.receive{
						tc_ac.stop;
912
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
913 914
					}
					[] tc_ac.timeout {
915
						setverdict(inconc, __SCOPE__&":INFO: No answer while updating resource");
916 917
					}
				}	
918
				
919
				f_checkAeSimuStatus();
920
				
921
			}// end f_cse_updateResource
922
			
923
			/**
924 925 926
			 * @desc Message exchange for the retrieval of a resource
			 * @param p_resourceIndex Resource index of the resource to be retrieved
			 * @return PrimitiveContent parameter of the RETRIEVE response
927 928
			 * @verdict 
			 */
929
			function f_cse_retrieveResource(integer p_resourceIndex) runs on AeSimu return PrimitiveContent{
930

931
				mcaPort.send(m_request(m_retrieve(f_getResourceAddress(p_resourceIndex), f_getOriginator(p_resourceIndex))));
932 933
				tc_ac.start;
				alt {
934
					[] mcaPort.receive(mw_response(mw_responsePrimitiveOK)) -> value vc_response {
935 936 937
						tc_ac.stop;
						setverdict(pass, __SCOPE__&":INFO: Resource retrieved successfuly");
					}
938
					[] mcaPort.receive(mw_response(mw_responsePrimitiveKO)) -> value vc_response {
939
						tc_ac.stop;
940
						setverdict(inconc, __SCOPE__&":INFO: Error while retrieving resource");
941 942 943
					}
					[] mcaPort.receive{
						tc_ac.stop;
944
						setverdict(inconc, __SCOPE__&":INFO: Unexpected message received");
945 946 947 948 949 950
					}
					[] tc_ac.timeout {
						setverdict(inconc, __SCOPE__&":INFO: No answer while retrieving resource");
					}
				}	
				
951
				f_checkAeSimuStatus();
952
				
953
				return vc_response.primitive.responsePrimitive.primitiveContent;
954
				
955
			}// end f_cse_retrieveResource
956
			
957
			/**
958 959 960
			 * @desc Message exchange for the deletion of a resource
			 * @param p_index Resource index of the resource to be deleted
			 * @param p_requestPrimitive DELETE request to be used. If not present default DELETE request will be used