LibItsRtcmem_Functions.ttcn 13.8 KB
Newer Older
Yann Garcia's avatar
Yann Garcia committed
1
2
3
4
5
6
7
8
9
10
module LibItsRtcmem_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 RTCMEM_PDU_Descriptions language "ASN.1:1997" all;
Yann Garcia's avatar
Yann Garcia committed
11
    import from IEEE1609dot2BaseTypes language "ASN.1:1997" all;
Yann Garcia's avatar
Yann Garcia committed
12
13
14
15
16
17
18
    
    // LibItsCommon
    import from LibItsCommon_TypesAndValues all;
    import from LibItsCommon_Templates all;
    import from LibItsCommon_Functions all;
    import from LibItsCommon_Pixits all;
    
Yann Garcia's avatar
Yann Garcia committed
19
20
21
    // LibItsSecurity
    import from LibItsSecurity_Functions all;
    
Yann Garcia's avatar
Yann Garcia committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
    // LibItsRtcmem
    import from LibItsRtcmem_TestSystem all;
    import from LibItsRtcmem_TypesAndValues all;
    import from LibItsRtcmem_Templates all;
    import from LibItsRtcmem_Pics all;
    import from LibItsRtcmem_Pixits all;

    group utFuntions { 
            
        /**
         * @desc    Requests to bring the IUT in an initial state
         * @param   p_init The initialisation to trigger.
         */
        function f_utInitializeIut(template (value) UtRtcmemInitialize p_init) runs on ItsRtcmem {
            
            //deactivate rtcmemPort default alts
            vc_rtcmemDefaultActive := false;
            
            utPort.send(p_init);
            tc_wait.start;
            alt {
              [] utPort.receive(UtRtcmemResults: { utRtcmemInitializeResult := true }) {
                    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);
                }
            }            
            
            //deactivate rtcmemPort default alts
            vc_rtcmemDefaultActive := true;
        }
        
        /**
         * @desc    Triggers an event from the application layer
         * @param   p_event The event to trigger.
         */
        function f_utTriggerEvent(
                                  in template (value) UtRtcmemTrigger p_event
        ) runs on ItsRtcmem {
            
            //deactivate rtcmemPort default alts
            vc_rtcmemDefaultActive := false;
            
            utPort.send ( p_event );
            tc_wait.start;
            alt {
              [] utPort.receive ( UtRtcmemResults: { utRtcmemTriggerResult := true }) {
                tc_wait.stop;
              }
              [] utPort.receive ( UtRtcmemResults: { utRtcmemTriggerResult := false }) {
                    tc_wait.stop;
76
                    f_selfOrClientSyncAndVerdict("RTCMEM Trigger failed", e_error);
Yann Garcia's avatar
Yann Garcia committed
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
                }
                [] 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;
        }
        
        /**
         * @desc    Updates an event from the application layer
         * @param   p_event The event to trigger.
         */
        function f_utUpdateEvent(
                                 in template (value) UtRtcmemUpdate p_event
        ) runs on ItsRtcmem {
            
            utPort.send ( p_event );
            tc_wait.start;
            alt {
              [] utPort.receive ( UtRtcmemResults: { utRtcmemUpdateResult := true }) {
                    tc_wait.stop;
                }
              [] utPort.receive ( UtRtcmemResults: { utRtcmemUpdateResult := false }) {
                    tc_wait.stop;
107
                    f_selfOrClientSyncAndVerdict("RTCMEM Update failed", e_error);
Yann Garcia's avatar
Yann Garcia committed
108
109
110
111
112
113
114
115
116
117
118
119
120
                }
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
            
            //activate rtcmemPort default alts
            vc_rtcmemDefaultActive := true;
            
            return;
        }
        
121
122
123
124
125
126
127
128
129
130
131
132
        /**
         * @desc    Terminates an event at the application layer
         * @param   p_event The event to terminate.
         */
        function f_utTerminateEvent(template (value) UtRtcmemTermination p_event) runs on ItsRtcmem {
            
            //deactivate rtcmemPort default alts
            vc_rtcmemDefaultActive := false;
            
            utPort.send(p_event);
            tc_wait.start;
            alt {
Yann Garcia's avatar
Yann Garcia committed
133
                [] utPort.receive(UtRtcmemResults: { utRtcmemTerminationResult := true}) {
134
135
                    tc_wait.stop;
                }
Yann Garcia's avatar
Yann Garcia committed
136
137
138
139
                [] utPort.receive(UtRtcmemResults: { utRtcmemTerminationResult := false}) {
                    tc_wait.stop;
                    f_selfOrClientSyncAndVerdict("RTCMEM Termination failed", e_error);
                }
140
141
142
143
144
145
146
147
148
149
150
151
152
153
                [] tc_wait.timeout {
                    log("*** " & testcasename() & ": INFO: Could not receive expected UT message from IUT in time ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
                [] a_utDefault() {
                  //empty on purpose
                }
            }
            
            //activate rtcmemPort default alts
            vc_rtcmemDefaultActive := true;
            
        }
        
Yann Garcia's avatar
Yann Garcia committed
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
225
226
227
228
229
230
231
    } // End of group utFuntions
    
    group adapterControl {
        
        /**
         * @desc Initialise secure mode if required
         */
        function f_initialiseSecuredMode(
                                         in charstring p_certificateId := PX_CERT_FOR_TS 
        ) runs on ItsRtcmem {
            
            if (PICS_IS_IUT_SECURED == true) {
                
                if(e_success != f_acTriggerSecEvent(m_acEnableSecurity(p_certificateId))) { 
                    log("*** INFO: TEST CASE NOW STOPPING ITSELF! ***");
                    stop;
                }
            }
            
        } // End of function f_initialiseSecuredMode()
        
        function f_uninitialiseSecuredMode() runs on ItsRtcmem {
            
            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 ItsRtcmem 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 
    
    group altsteps {
        
        /**
         * @desc Default handling cf01 de-initialisation.
         */
        altstep a_cf01Down() runs on ItsRtcmem {
            [] 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 ItsRtcmem {
            [vc_rtcmemDefaultActive] rtcmemPort.receive(mw_rtcmemInd(mw_rtcmemPdu(mw_defaultRtcmem))) { 
Yann Garcia's avatar
Yann Garcia committed
232
                log("*** " & testcasename() & ": INFO: RTCMEM received in default ***");
Yann Garcia's avatar
Yann Garcia committed
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
                vc_rtcmemReceived := true;
                repeat;
            }
            [vc_rtcmemDefaultActive] rtcmemPort.receive {
                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 ItsRtcmem {
            var UtRtcmemEventInd v_rtcmemevent;
            
            [] utPort.receive(UtRtcmemEventInd:?) -> value v_rtcmemevent {
                //store every upper tester indication received
260
                vc_utEvents[lengthof(vc_utEvents)] := v_rtcmemevent;
Yann Garcia's avatar
Yann Garcia committed
261
262
263
264
265
266
267
268
269
270
                repeat;
            }
            [] utPort.receive {
                log("*** " & testcasename() & ": INFO: Received unhandled/unknown UT message from IUT ***");
                repeat;
            }
        }
        
    } // End of group altsteps

271
    group rtcmemConfigurationFunctions {
Yann Garcia's avatar
Yann Garcia committed
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
        
        /**
         * @desc    Setups default configuration   
         * @param   p_certificateId The certificate identifier the TA shall use in case of secured IUT
         */
        function f_cfUp(
                        in charstring p_certificateId := PX_CERT_FOR_TS
        )  runs on ItsRtcmem system ItsRtcmemSystem {
            
            map(self:acPort, system:acPort);
            map(self:utPort, system:utPort);
            map(self:rtcmemPort, system:rtcmemPort);
            
            // Connect
            f_connect4SelfOrClientSync();
            activate(a_cf01Down());
            
            // Initialise secured mode
            f_initialiseSecuredMode(p_certificateId); 
            
            //Initialze the IUT
            f_prInitialState();
            
        } // End of f_cfUp
        
        /**
         * @desc    Deletes default configuration 
         */
        function f_cfDown() runs on ItsRtcmem system ItsRtcmemSystem {
            
            // Initialise secured mode
            f_uninitialiseSecuredMode();
            
            unmap(self:utPort, system:utPort);
            unmap(self:acPort, system:acPort);
            unmap(self:rtcmemPort, system:rtcmemPort);
            
            f_disconnect4SelfOrClientSync();
        } // End of f_cfDown
        
312
    } // End of of rtcmemConfigurationFunctions
Yann Garcia's avatar
Yann Garcia committed
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
    
    group preambles {
        
        /**
         * @desc The default preamble.
         */
        function f_prDefault() runs on ItsRtcmem {
            vc_default := activate(a_default());
            activate(a_utDefault());
        }
        
        /**
         * @desc Brings the IUT into an initial state.
         * @return FncRetCode 
         */
Yann Garcia's avatar
Yann Garcia committed
328
329
330
        function f_prInitialState(
                                  in charstring p_certificate_id := ""
                                  ) runs on ItsRtcmem return FncRetCode {
Yann Garcia's avatar
Yann Garcia committed
331
332
            var FncRetCode v_ret := e_success;
            
Yann Garcia's avatar
Yann Garcia committed
333
334
335
336
337
338
339
340
341
342
343
344
345
346
            // 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_rtcmemInitialize(v_hashedId8));
            } else {
                f_utInitializeIut(m_rtcmemInitialize);
            }
Yann Garcia's avatar
Yann Garcia committed
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
            f_prDefault();
            return v_ret;
        }
        
    } // End of group preambles

    group postambles {
        
        /**
         * @desc The default postamble.
         */
        function f_poDefault() runs on ItsRtcmem {
            //empty
        }
        
    } // End of group postambles
    
    group sendFunctions {
        
    } // End of group sendFunctions
    
    group receiveFunctions {
        
        /**
371
         * @desc Awaits a RTCMEM and returns it
Yann Garcia's avatar
Yann Garcia committed
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
         * @param p_rcvMsg The expected message to be received.
         * @param p_rcvdMsg The received message - OUT.
         */
        function f_awaitRtcmeMessage(
                                     in template (present) RtcmemInd p_rcvMsg, 
                                     out RtcmemInd p_rcvdMsg
        ) runs on ItsRtcmem {
            
            tc_ac.start;
            alt {
                [] rtcmemPort.receive(p_rcvMsg) -> value p_rcvdMsg {
                    tc_ac.stop;
                }
                [] tc_ac.timeout {
                    log("*** " & testcasename() & ": INFO: Timeout while awaiting the reception of a message ***");
                    f_selfOrClientSyncAndVerdict("error", e_timeout);
                }
            }
        }
        
    } // End of group receiveFunctions
    
} // End of module LibItsRtcmem_Functions