LibItsSremSsem_Functions.ttcn 18.2 KB
Newer Older
garciay's avatar
garciay committed
1
/**
2
 *    @author   ETSI STF517 / STF581 / TTF002
Yann Garcia's avatar
Yann Garcia committed
3
4
 *    @version  $Url: https://oldforge.etsi.org/svn/LibIts/tags/20170222_STF527_Final/ttcn/SremSsem/LibItsSremSsem_Functions.ttcn $
 *              $Id: LibItsSremSsem_Functions.ttcn,v 1.2 2018/05/31 15:57:11 dte Exp $
garciay's avatar
garciay committed
5
 *    @desc     Module containing common functions for ITS SREMM SSEM
garciay's avatar
garciay committed
6
7
8
9
 *    @copyright   ETSI Copyright Notification
 *                 No part may be reproduced except as authorized by written permission.
 *                 The copyright and the foregoing restriction extend to reproduction in all media.
 *                 All rights reserved.
garciay's avatar
garciay committed
10
11
12
13
14
15
16
17
18
19
20
21
 *
 */
module LibItsSremSsem_Functions {
    
    // LibCommon
    import from LibCommon_Sync all;
    import from LibCommon_Time all;
    import from LibCommon_VerdictControl all;
    
    // LibIts
    import from ITS_Container language "ASN.1:1997" all;
    import from DSRC language "ASN.1:1997" all;
22
    import from IEEE1609dot2BaseTypes language "ASN.1:1997" all;
garciay's avatar
garciay committed
23
24
25
    
    // LibItsCommon
    import from LibItsCommon_TypesAndValues all;
26
27
    import from LibItsCommon_Templates all;
    import from LibItsCommon_Functions all;
28
    import from LibItsCommon_Pixits all;
garciay's avatar
garciay committed
29
    
30
31
32
    // LibItsSecurity
    import from LibItsSecurity_Functions all;
    
garciay's avatar
garciay committed
33
34
35
36
    // LibItsSremSsem
    import from LibItsSremSsem_TestSystem all;
    import from LibItsSremSsem_TypesAndValues all;
    import from LibItsSremSsem_Templates all;
37
38
    import from LibItsSremSsem_Pics all;
    import from LibItsSremSsem_Pixits all;
garciay's avatar
garciay committed
39
40
41
42
43
44
45

    group utFuntions { 
            
        /**
         * @desc    Requests to bring the IUT in an initial state
         * @param   p_init The initialisation to trigger.
         */
46
        function f_utInitializeIut(template (value) UtSremInitialize p_init) runs on ItsSremSsem {
garciay's avatar
garciay committed
47
            
Yann Garcia's avatar
Yann Garcia committed
48
49
50
            //deactivate sremSsemPort default alts
            vc_sremSsemDefaultActive := false;
            
garciay's avatar
garciay committed
51
52
53
            utPort.send(p_init);
            tc_wait.start;
            alt {
54
              [] utPort.receive(UtSremResults: { utSremInitializeResult := true }) {
garciay's avatar
garciay committed
55
56
57
58
59
60
61
62
                    tc_wait.stop;
                    log("*** " & testcasename() & ": INFO: IUT initialized ***");
                }
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }            
Yann Garcia's avatar
Yann Garcia committed
63
64
65
            
            //deactivate sremSsemPort default alts
            vc_sremSsemDefaultActive := true;
garciay's avatar
garciay committed
66
67
68
69
70
71
72
        }
        
        /**
         * @desc    Triggers an event from the application layer
         * @param   p_event The event to trigger.
         */
        function f_utTriggerEvent(
garciay's avatar
garciay committed
73
                                  in template (value) UtSremTrigger p_event
garciay's avatar
garciay committed
74
75
        ) runs on ItsSremSsem {
            
Yann Garcia's avatar
Yann Garcia committed
76
77
78
            //deactivate sremSsemPort default alts
            vc_sremSsemDefaultActive := false;
            
garciay's avatar
garciay committed
79
80
81
            utPort.send ( p_event );
            tc_wait.start;
            alt {
82
83
84
85
              [] utPort.receive ( UtSremResults: { utSremTriggerResult := true }) {
                tc_wait.stop;
              }
              [] utPort.receive ( UtSremResults: { utSremTriggerResult := false }) {
garciay's avatar
garciay committed
86
                    tc_wait.stop;
87
                    f_selfOrClientSyncAndVerdict("SREM Trigger failed", e_error);
garciay's avatar
garciay committed
88
89
90
91
92
93
94
95
96
97
98
99
100
                }
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
                [else] { // Shortcut defaults
                    //f_sleep(0.050); // 50 ms
                    repeat; 
                }
            }
            
            return;
        }
101
102
103
104
105
106
107
108
109
110
111
112
        
        /**
         * @desc    Updates an event from the application layer
         * @param   p_event The event to trigger.
         */
        function f_utUpdateEvent(
                                 in template (value) UtSremUpdate p_event
        ) runs on ItsSremSsem {
            
            utPort.send ( p_event );
            tc_wait.start;
            alt {
113
              [] utPort.receive ( UtSremResults: { utSremUpdateResult := true }) {
114
                    tc_wait.stop;
115
116
117
118
                }
              [] utPort.receive ( UtSremResults: { utSremUpdateResult := false }) {
                    tc_wait.stop;
                    f_selfOrClientSyncAndVerdict("SREM Update failed", e_error);
119
120
121
122
123
124
125
                }
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
            
Yann Garcia's avatar
Yann Garcia committed
126
127
128
            //activate sremSsemPort default alts
            vc_sremSsemDefaultActive := true;
            
129
130
131
            return;
        }
        
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
        /**
         * @desc    Updates an event from the application layer
         * @param   p_event The event to trigger.
         */
        function f_utCancelationEvent(
                                      in template (value) UtSremCancelation p_event
        ) runs on ItsSremSsem {
            
            utPort.send ( p_event );
            tc_wait.start;
            alt {
              [] utPort.receive ( UtSremResults: { utSremCancelationResult := true }) {
                    tc_wait.stop;
                }
              [] utPort.receive ( UtSremResults: { utSremCancelationResult := false }) {
                    tc_wait.stop;
                    f_selfOrClientSyncAndVerdict("SREM cancelation failed", e_error);
                }
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
            
            //activate sremSsemPort default alts
            vc_sremSsemDefaultActive := true;
            
            return;
        }
        
garciay's avatar
garciay committed
162
163
    } // End of group utFuntions
    
164
165
166
167
168
169
    group adapterControl {
        
        /**
         * @desc Initialise secure mode if required
         */
        function f_initialiseSecuredMode(
Yann Garcia's avatar
Yann Garcia committed
170
                                         in charstring p_certificateId := PX_CERT_FOR_TS 
171
172
173
174
        ) runs on ItsSremSsem {
            
            if (PICS_IS_IUT_SECURED == true) {
                
Yann Garcia's avatar
Yann Garcia committed
175
                if(e_success != f_acTriggerSecEvent(m_acEnableSecurity(p_certificateId))) { 
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
                    log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
                    stop;
                }
            }
            
        } // End of function f_initialiseSecuredMode()
        
        function f_uninitialiseSecuredMode() runs on ItsSremSsem {
            
            if (PICS_IS_IUT_SECURED == true) {
                f_acTriggerSecEvent(m_acDisableSecurity);
            }
            
        } // End of function f_initialiseSecuredMode()
        
        /**
         * @desc    Triggers event in the test system adaptation.
         * @param   p_event The event to trigger
         * @return  FncRetCode
         */
        function f_acTriggerSecEvent(template (value) AcSecPrimitive p_event) runs on ItsSremSsem return FncRetCode {
            var FncRetCode v_ret := e_success;
            
            acPort.send(p_event);
            tc_ac.start;
            alt {
                [] acPort.receive(m_acSecResponseSuccess) {
                    tc_ac.stop;
                }
                [] acPort.receive {
                    tc_ac.stop;
                    log("*** " & __SCOPE__ & ": ERROR: Received unexpected message ***");
                    f_selfOrClientSyncAndVerdict("error", e_error);
                }
                [] tc_ac.timeout {
                    log("*** " & __SCOPE__ & ": ERROR: Timeout while waiting for adapter control event result ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
            
            return v_ret;
        }
        
    } // End of group adapterControl 
    
garciay's avatar
garciay committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
    group altsteps {
        
        /**
         * @desc Default handling cf01 de-initialisation.
         */
        altstep a_cf01Down() runs on ItsSremSsem {
            [] a_shutdown() {
                f_poDefault();
                f_cfDown();
                log("*** a_cf01Down: INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
                stop;
            }
        }
        
        /**
         * @desc The base default.
         */
        altstep a_default() runs on ItsSremSsem {
239
            [vc_sremSsemDefaultActive] sremSsemPort.receive(mw_sremInd(mw_sremPdu)) { 
garciay's avatar
garciay committed
240
241
242
243
                log("*** " & testcasename() & ": INFO: SREMM received in default ***");
                vc_sremReceived := true;
                repeat;
            }
244
            [vc_sremSsemDefaultActive] sremSsemPort.receive(mw_ssemInd(mw_ssemPdu)) { 
garciay's avatar
garciay committed
245
246
247
248
                log("*** " & testcasename() & ": INFO: SREMM received in default ***");
                vc_ssemReceived := true;
                repeat;
            }
Yann Garcia's avatar
Yann Garcia committed
249
            [vc_sremSsemDefaultActive] sremSsemPort.receive {
garciay's avatar
garciay committed
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
                log("*** " & testcasename() & ": ERROR: Received an unexpected message ***");
                f_selfOrClientSyncAndVerdict("error", e_error);
            }
            [] any timer.timeout {
                log("*** " & testcasename() & ": INCONC: Timeout while awaiting the reception of a message ***");
                f_selfOrClientSyncAndVerdict("error", e_timeout);
            }
            [] a_shutdown() {
                f_poDefault();
                f_cfDown();
                log("*** " & testcasename() & ": INFO: TEST COMPONENT NOW STOPPING ITSELF! ***");
                stop;   
            }
        }
        
        /**
         * @desc The default for handling upper tester messages.
         */
        altstep a_utDefault() runs on ItsSremSsem {
269
270
271
            var UtSremEventInd v_sremevent;
            var UtSsemEventInd v_ssemevent;
            [] utPort.receive(UtSremEventInd:?) -> value v_sremevent {
garciay's avatar
garciay committed
272
                //store every upper tester indication received
273
                vc_utSremEvents[lengthof(vc_utSremEvents)] := v_sremevent;
garciay's avatar
garciay committed
274
275
                repeat;
            }
276
            [] utPort.receive(UtSsemEventInd:?) -> value v_ssemevent {
garciay's avatar
garciay committed
277
                //store every upper tester indication received
278
                vc_utSsemEvents[lengthof(vc_utSsemEvents)] := v_ssemevent;
garciay's avatar
garciay committed
279
280
281
282
283
284
285
286
287
288
                repeat;
            }
            [] utPort.receive {
                log("*** " & testcasename() & ": INFO: Received unhandled/unknown UT message from IUT ***");
                repeat;
            }
        }
        
    } // End of group altsteps

Yann Garcia's avatar
Yann Garcia committed
289
    group sremSsemConfigurationFunctions {
garciay's avatar
garciay committed
290
291
292
        
        /**
         * @desc    Setups default configuration   
Yann Garcia's avatar
Yann Garcia committed
293
         * @param   p_certificateId The certificate identifier the TA shall use in case of secured IUT
garciay's avatar
garciay committed
294
         */
295
        function f_cfUp(
Yann Garcia's avatar
Yann Garcia committed
296
297
                        in charstring p_certificateId := PX_CERT_FOR_TS,
                        in charstring p_iutCertificateId := ""
Yann Garcia's avatar
Yann Garcia committed
298
        )  runs on ItsSremSsem system ItsSremSsemSystem {
garciay's avatar
garciay committed
299
            
300
            map(self:acPort, system:acPort);
garciay's avatar
garciay committed
301
302
303
304
305
306
307
            map(self:utPort, system:utPort);
            map(self:sremSsemPort, system:sremSsemPort);
            
            // Connect
            f_connect4SelfOrClientSync();
            activate(a_cf01Down());
            
308
            // Initialise secured mode
Yann Garcia's avatar
Yann Garcia committed
309
            f_initialiseSecuredMode(p_certificateId); 
310
            
garciay's avatar
garciay committed
311
            //Initialze the IUT
Yann Garcia's avatar
Yann Garcia committed
312
            f_prInitialState(p_iutCertificateId);
garciay's avatar
garciay committed
313
314
315
316
317
318
            
        } // End of f_cfUp
        
        /**
         * @desc    Deletes default configuration 
         */
Yann Garcia's avatar
Yann Garcia committed
319
        function f_cfDown() runs on ItsSremSsem system ItsSremSsemSystem {
garciay's avatar
garciay committed
320
            
321
322
323
            // Initialise secured mode
            f_uninitialiseSecuredMode();
            
garciay's avatar
garciay committed
324
            unmap(self:utPort, system:utPort);
325
            unmap(self:acPort, system:acPort);
garciay's avatar
garciay committed
326
327
328
329
330
            unmap(self:sremSsemPort, system:sremSsemPort);
            
            f_disconnect4SelfOrClientSync();
        } // End of f_cfDown
        
Yann Garcia's avatar
Yann Garcia committed
331
    } // End of of sremSsemConfigurationFunctions
garciay's avatar
garciay committed
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
    
    group preambles {
        
        /**
         * @desc The default preamble.
         */
        function f_prDefault() runs on ItsSremSsem {
            vc_default := activate(a_default());
            activate(a_utDefault());
        }
        
        /**
         * @desc Brings the IUT into an initial state.
         * @return FncRetCode 
         */
347
348
349
        function f_prInitialState(
                                  in charstring p_certificate_id := ""
                                  ) runs on ItsSremSsem return FncRetCode {
garciay's avatar
garciay committed
350
351
            var FncRetCode v_ret := e_success;
            
352
353
354
355
356
357
358
359
360
361
362
363
364
365
            // Initialize IUT with given certificate
            if (p_certificate_id != "") { // Initialize IUT with given certificate
                var HashedId8 v_hashedId8 := '0000000000000000'O;
                
                fx_readCertificateDigest("CERT_SRM_SSP_NONE", v_hashedId8);
                if ('0000000000000000'O ==  v_hashedId8) {
                    // Certificate not found
                    log("*** " & testcasename() & ": Required IUT certificate is not found on the test system ***");
                    return e_timeout;
                }
                f_utInitializeIut(m_sremSsemInitialize(v_hashedId8));
            } else {
                f_utInitializeIut(m_sremSsemInitialize);
            }
garciay's avatar
garciay committed
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
            f_prDefault();
            return v_ret;
        }
        
    } // End of group preambles

    group postambles {
        
        /**
         * @desc The default postamble.
         */
        function f_poDefault() runs on ItsSremSsem {
            //empty
        }
        
    } // End of group postambles
382
383
    
    group sendFunctions {
garciay's avatar
garciay committed
384
385
        
        /**
386
         * @desc Sends a SSEM message
387
388
         * @param p_sendMsg The IVI message to send.
         * @param p_overrideSeqNo Overrides the sequence number with the stored one. 
garciay's avatar
garciay committed
389
         */
390
391
392
393
394
395
396
        function f_sendSseMessage(
                                  in template (value) SignalRequestMessage p_signalRequestMessage
        ) runs on ItsSremSsem {
            sremSsemPort.send( 
                m_ssemReq(
                    m_ssemPdu(
                        m_ssem(
397
                            valueof(p_signalRequestMessage)
398
            ))));
garciay's avatar
garciay committed
399
400
        }
        
401
    } // End of group sendFunctions
garciay's avatar
garciay committed
402
    
garciay's avatar
garciay committed
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
    group receiveFunctions {
        
        /**
         * @desc Awaits a SREM and returns it
         * @param p_rcvMsg The expected message to be received.
         * @param p_rcvdMsg The received message - OUT.
         */
        function f_awaitSreMessage(
                                   in template (present) SremInd p_rcvMsg, 
                                   out SremInd p_rcvdMsg
        ) runs on ItsSremSsem {
            
            tc_ac.start;
            alt {
                [] sremSsemPort.receive(p_rcvMsg) -> value p_rcvdMsg {
                    tc_ac.stop;
                }
                [] tc_ac.timeout {
Yann Garcia's avatar
Yann Garcia committed
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
                    log("*** " & testcasename() & ": INFO: Timeout while awaiting the reception of a message ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
        }
        
        /**
         * @desc Awaits a SREM and returns it
         * @param p_rcvMsg The expected message to be received.
         */
        function f_awaitSreMessageCancellation(
                                               template (present) RequestID p_requestID := ?
                                               ) runs on ItsSremSsem {
            tc_ac.start;
            alt {
                [] sremSsemPort.receive(
                                        mw_sremInd(
                                                   mw_sremPdu(
                                                              mw_sremWellFormatted(
                                                                                   mw_requestorDescription,
                                                                                   {
                                                                                     mw_signalRequestPackage(
                                                                                                             mw_signalRequest(
                                                                                                                              ?, 
                                                                                                                              p_requestID,
                                                                                                                              priorityCancellation
                                                                                                             ))
                                                                                   }, 
                                                                                   ?
                                        )))) {
                    tc_ac.stop;
                }
                [] tc_ac.timeout {
garciay's avatar
garciay committed
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
                    log("*** " & testcasename() & ": INFO: Timeout while awaiting the reception of a message ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
        }
        
    } // End of group receiveFunctions
    
    group miscellaneousFunctions {
        
        /**
         * @desc Increases the RequestID number and handles the special case where the 
         *       SremIdentification number reaches the limit of 32768 and will be reset to 0.
         * @param p_requestID The RequestID number to increase.
         * @return The increased RequestID number.
         */
        function f_increaseRequestID(
                                     in RequestID p_requestID
        ) return RequestID {
            // if maximum number of 256 reached, reset it to 0
            return ((p_requestID + 1) mod 256);
        }
        
    } // End of group miscellaneousFunctions
    
479
} // End of module LibItsSremSsem_Functions