blob: db7bc109d315de56eb158df96cfe8ccde21111fa [file] [log] [blame]
= 5G system TS29510 Nnrf Protocol Modules for TTCN-3 Toolset with TITAN, Description
:author: Gábor Szalai
:toc: left
== About This Document
This is the description for the 5G system TS29510 Nnrf protocol module. The 5G system TS29510 Nnrf protocol modules are developed for the TTCN-3 Toolset with Titan.
== Functionality
The 5G system TS29510 Nnrf protocol module implements the object structures of the 3GPP TS 29510 v15.1.0<<_5, [5]>> in a formalized way, using the standard specification language TTCN-3. This allows defining of test data (templates) in the TTCN-3 language and correctly encoding/decoding messages when executing test suites using the Titan TTCN-3 test environment.
The 5G system TS29510 Nnrf protocol module uses Titans JSON encoding <<_3, [3]>> and hence is usable with the Titan test toolset only.
=== System Requirements
Protocol modules are a set of TTCN-3 source code files that can be used as part of TTCN-3 test suites only. Hence, protocol modules alone do not put specific requirements on the system used. However, in order to compile and execute a TTCN-3 test suite using the set of protocol modules the following system requirements must be satisfied:
* Titan TTCN-3 Test Executor version CRL 113 200/6 R5A (6.5.pl0) or higher installed. For Installation Guide see <<_2, [2]>>. Please note: This version of the test port is not compatible with Titan releases earlier than CRL 113 200/6 R5A.
=== Installation
The set of protocol modules can be used in developing TTCN-3 test suites using any text editor. Since the 5G system TS29510 Nnrf protocol is used as a part of a TTCN-3 test suite, this requires TTCN-3 Test Executor be installed before the module can be compiled and executed together with other parts of the test suite. For more details on the installation of TTCN-3 Test Executor see the relevant section of <<_2, [2]>>.
== Interface description
=== Encoding/decoding and other related functions
This product also contains encoding/decoding functions, which assure correct encoding of messages when sent from Titan and correct decoding of messages when received by Titan.
==== Implemented encoding and decoding functions
Name Type of formal parameters Type of return value
f_enc_SearchResult(in SearchResult pdu) return octetstring
f_dec_SearchResult(in octetstring stream, out SearchResult pdu) return integer
f_enc_NFProfile(in NFProfile pdu) return octetstring
f_dec_NFProfile(in octetstring stream, out NFProfile pdu) return integer
f_enc_NFRegistrationData(in NFRegistrationData pdu) return octetstring
f_dec_NFRegistrationData(in octetstring stream, out NFRegistrationData pdu) return integer
f_enc_SubscriptionData(in SubscriptionData pdu) return octetstring
f_dec_SubscriptionData(in octetstring stream, out SubscriptionData pdu) return integer
f_enc_NotificationData(in NotificationData pdu) return octetstring
f_dec_NotificationData(in octetstring stream, out NotificationData pdu) return integer
f_enc_AccessTokenRsp(in AccessTokenRsp pdu) return octetstring
f_dec_AccessTokenRsp(in octetstring stream, out AccessTokenRsp pdu) return integer
f_enc_AccessTokenErr(in AccessTokenErr pdu) return octetstring
f_dec_AccessTokenErr(in octetstring stream, out AccessTokenErr pdu) return integer
== Usage
The protocol module provides abstract data types for JSON objects used by the services defined in the standard <<_5, [5]>>. The protocol module provides encoder and decoder functions for the JSON objects. The decoder function validates the received JSON object based on the JSON schema as well. Only the validated JSON value is decoded.
== Terminology
=== Abbreviations
JSON:: JavaScript Object Notation
PDU:: Protocol Data Unit
TTCN-3:: Testing and Test Control Notation version 3
== References
[1] ETSI ES 201 873-1 v4.4.1 (2012-04) +
The Testing and Test Control Notation version 3. Part 1: Core Language
[2] 1/ 198 17-CRL 113 200/6 Uen +
Installation Guide for the TITAN TTCN-3 Test Executor
[3] 2/198 17-CRL 113 200/6 Uen +
Programmer's Technical Reference for Titan TTCN-3 Test Executor
[5] 3GPP TS 29510 v15.1.0+
5G System; Network function repository services; Stage 3