Newer
Older
* @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 $
* @desc Module containing common functions for ITS SREMM SSEM
* @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.
*
*/
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;
import from IEEE1609dot2BaseTypes language "ASN.1:1997" all;
// LibItsCommon
import from LibItsCommon_TypesAndValues all;
import from LibItsCommon_Templates all;
import from LibItsCommon_Functions all;
import from LibItsCommon_Pixits all;
// LibItsSecurity
import from LibItsSecurity_Functions all;
// LibItsSremSsem
import from LibItsSremSsem_TestSystem all;
import from LibItsSremSsem_TypesAndValues all;
import from LibItsSremSsem_Templates all;
import from LibItsSremSsem_Pics all;
import from LibItsSremSsem_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) UtSremInitialize p_init) runs on ItsSremSsem {
//deactivate sremSsemPort default alts
vc_sremSsemDefaultActive := false;
[] utPort.receive(UtSremResults: { utSremInitializeResult := 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 sremSsemPort default alts
vc_sremSsemDefaultActive := true;
}
/**
* @desc Triggers an event from the application layer
* @param p_event The event to trigger.
*/
function f_utTriggerEvent(
//deactivate sremSsemPort default alts
vc_sremSsemDefaultActive := false;
utPort.send ( p_event );
tc_wait.start;
alt {
[] utPort.receive ( UtSremResults: { utSremTriggerResult := true }) {
tc_wait.stop;
}
[] utPort.receive ( UtSremResults: { utSremTriggerResult := false }) {
f_selfOrClientSyncAndVerdict("SREM Trigger failed", e_error);
}
[] 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) UtSremUpdate p_event
) runs on ItsSremSsem {
utPort.send ( p_event );
tc_wait.start;
alt {
[] utPort.receive ( UtSremResults: { utSremUpdateResult := true }) {
tc_wait.stop;
}
[] utPort.receive ( UtSremResults: { utSremUpdateResult := false }) {
tc_wait.stop;
f_selfOrClientSyncAndVerdict("SREM Update 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;
}
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;
}
group adapterControl {
/**
* @desc Initialise secure mode if required
*/
function f_initialiseSecuredMode(
) runs on ItsSremSsem {
if (PICS_IS_IUT_SECURED == true) {
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
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 {
[vc_sremSsemDefaultActive] sremSsemPort.receive(mw_sremInd(mw_sremPdu(mw_defaultSrem))) {
log("*** " & testcasename() & ": INFO: SREMM received in default ***");
vc_sremReceived := true;
repeat;
}
[vc_sremSsemDefaultActive] sremSsemPort.receive(mw_ssemInd(mw_ssemPdu(mw_defaultSsem))) {
log("*** " & testcasename() & ": INFO: SREMM received in default ***");
vc_ssemReceived := true;
repeat;
}
[vc_sremSsemDefaultActive] sremSsemPort.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 ItsSremSsem {
var UtSremEventInd v_sremevent;
var UtSsemEventInd v_ssemevent;
[] utPort.receive(UtSremEventInd:?) -> value v_sremevent {
vc_utSremEvents[lengthof(vc_utSremEvents)] := v_sremevent;
[] utPort.receive(UtSsemEventInd:?) -> value v_ssemevent {
vc_utSsemEvents[lengthof(vc_utSsemEvents)] := v_ssemevent;
repeat;
}
[] utPort.receive {
log("*** " & testcasename() & ": INFO: Received unhandled/unknown UT message from IUT ***");
repeat;
}
}
} // End of group altsteps
/**
* @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 ItsSremSsem system ItsSremSsemSystem {
map(self:acPort, system:acPort);
map(self:utPort, system:utPort);
map(self:sremSsemPort, system:sremSsemPort);
// Connect
f_connect4SelfOrClientSync();
activate(a_cf01Down());
// Initialise secured mode
//Initialze the IUT
f_prInitialState();
} // End of f_cfUp
/**
* @desc Deletes default configuration
*/
function f_cfDown() runs on ItsSremSsem system ItsSremSsemSystem {
// Initialise secured mode
f_uninitialiseSecuredMode();
unmap(self:acPort, system:acPort);
unmap(self:sremSsemPort, system:sremSsemPort);
f_disconnect4SelfOrClientSync();
} // End of f_cfDown
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
*/
function f_prInitialState(
in charstring p_certificate_id := ""
) runs on ItsSremSsem return FncRetCode {
// 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);
}
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
group sendFunctions {
* @param p_sendMsg The IVI message to send.
* @param p_overrideSeqNo Overrides the sequence number with the stored one.
function f_sendSseMessage(
in template (value) SignalRequestMessage p_signalRequestMessage
) runs on ItsSremSsem {
sremSsemPort.send(
m_ssemReq(
m_ssemPdu(
m_ssem(
valueof(p_signalRequestMessage)
))));
} // End of group sendFunctions
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
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 {
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
} // End of module LibItsSremSsem_Functions