Add test environment for TTCN-3 development & validation

Copyright 2025 ETSI

Copyright 2019-2025 ETSI

Redistribution and use in source and binary forms, with or without 

modification, are permitted provided that the following conditions are met:

-include config.mk

ifeq (,$(ATS)) 

 $(error ATS shall be defined)

endif

ifeq (,$(TOPDIR))

 TOPDIR := .

endif

ifeq (,$(TTCN3_DIR))

 $(error TTCN3_DIR shall be defined in config.mk)

endif

first: all

define IncludeModule

undefine sources

undefine modules

undefine includes

include $(1)/module.mk

$$(foreach S, $$(sources),  $$(eval all_sources +=  $(1)/$$(S)))

$$(foreach I, $$(includes), $$(eval all_includes += $(1)/$$(I)))

$$(foreach M, $$(modules),  $$(eval $$(call IncludeModule, $$(if $$(filter /%, $$(M)), $$(M), $(1)/$$(M)))))

endef

all_includes := $(TTCN3_DIR)/include $(TTCN3_DIR)/src /usr/include/libxml2

defines  += TITAN_RUNTIME_2 _NO_SOFTLINKS_ $(ATS) AS_USE_SSL

libs     += $(TTCN3_DIR)/lib/libttcn3-rt2-parallel.a -lstdc++fs

ifeq (Windows_NT,$(OS))

# Silence linker warnings.

LDFLAGS += -Wl,--enable-auto-import,--enable-runtime-pseudo-reloc

defines += WIN32

libs += $(patsubst %, -L%/lib, $(OPENSSL_DIR))

all_includes += $(addsuffix /include, $(OPENSSL_DIR))

libs += $(WPCAP_DLL_PATH)

else

defines += LINUX

libs += -lpcap -lrt -lpthread

endif

libs += -lssl -lcrypto -lxml2 -L$(OSIP_LIB) -losipparser2

$(eval $(call IncludeModule, $(TOPDIR)/ttcn/$(ATS)))

outdir := $(TOPDIR)/build/$(ATS)

bindir := $(TOPDIR)/bin

sources     := $(sort $(all_sources))

includes    := $(outdir) $(outdir)/.. $(all_includes) $(NPCAP_INCLUDE) $(OSIP_INCLUDE)

ifeq (Windows_NT,$(OS))

  EXE=.exe

endif

ttcn_sources  := $(filter %.ttcn , $(sources))

ttcn3_sources := $(filter %.ttcn3, $(sources))

xsd_sources   := $(filter %.xsd,   $(sources))

tt_sources    := $(ttcn_sources) $(ttcn3_sources) $(xsd_sources)

cc_sources    := $(filter %.cc,    $(sources))

gen_ttcn_sources  := $(addprefix $(outdir)/, $(notdir $(patsubst %.ttcn,  %.cc, $(ttcn_sources))))

gen_ttcn_headers  := $(addprefix $(outdir)/, $(notdir $(patsubst %.ttcn,  %.hh, $(ttcn_sources))))

gen_ttcn3_sources := $(addprefix $(outdir)/, $(notdir $(patsubst %.ttcn3, %.cc, $(ttcn3_sources))))

gen_ttcn3_headers := $(addprefix $(outdir)/, $(notdir $(patsubst %.ttcn3, %.hh, $(ttcn3_sources))))

gen_xsd_sources   := $(addprefix $(outdir)/, $(notdir $(patsubst %.xsd,   %.cc, $(xsd_sources))))

gen_xsd_headers   := $(addprefix $(outdir)/, $(notdir $(patsubst %.xsd,   %.hh, $(xsd_sources))))

gen_sources := $(gen_ttcn_sources) $(gen_ttcn3_sources) $(gen_xsd_sources)

gen_headers := $(gen_ttcn_headers) $(gen_ttcn3_headers) $(gen_xsd_headers)

gen_objects := $(patsubst %.cc, %.o, $(gen_sources))

cc_objects  := $(patsubst  %.cc, $(outdir)/%.o, $(cc_sources))

.PHONY: all FORCE echo

all: $(bindir) $(outdir) $(bindir)/$(ATS)$(EXE)

echo_sources:

	@echo -e "$(addsuffix \n,$(all_sources))"

echo: echo_sources

	@echo -e "sources:\n $(addsuffix \n, $(sources))"

	@echo -e "gen_sources:\n $(addsuffix \n, $(gen_sources))"

	@echo -e "gen_objects:\n $(addsuffix \n, $(gen_objects))"

	@echo -e "cc_objects:\n $(addsuffix \n, $(cc_objects))"

	@echo -e "includes:\n $(addsuffix \n, $(includes))"

	@echo -e "defines: $(addsuffix \n, $(defines))"

clean:

	rm -f $(outdir)/$(ATS)$(EXE) $(gen_objects) $(gen_sources) $(gen_headers) $(cc_objects) $(outdir)/.generate

regen: force_regen $(outdir)/.generate

force_regen:

	rm -f $(outdir)/.generate

$(outdir) $(bindir):

	mkdir -p $@

$(bindir)/$(ATS)$(EXE): $(gen_objects) $(cc_objects)

	g++ -g -O0 -std=c++17 -o $@ $(LDFLAGS) $(gen_objects) $(cc_objects) $(libs)

$(gen_objects) :%.o :%.cc

	g++ -g -O0 -std=c++17 -c $(addprefix -D, $(defines)) $(addprefix -I, $(includes)) -o $@ $<

$(cc_objects) : $(outdir)/%.o : %.cc

	mkdir -p $(dir $@)

	g++ -g -O0 -std=c++17 -c $(addprefix -D, $(defines)) $(addprefix -I, $(includes)) -o $@ $<

$(gen_sources): $(outdir)/.generate

$(outdir)/.generate: Makefile $(tt_sources)

	$(TTCN3_DIR)/bin/compiler $(TTCN3_COMPILER_OPTIONS) -o $(outdir) $(tt_sources)

	touch $@

$(foreach S, $(ttcn_sources),  $(eval $(outdir)/$(notdir $(patsubst %.ttcn, %.cc,  $(S))): $(S)))

$(foreach S, $(ttcn3_sources), $(eval $(outdir)/$(notdir $(patsubst %.ttcn3, %.cc, $(S))): $(S)))

$(foreach S, $(xsd_sources),   $(eval $(outdir)/$(notdir $(patsubst %.xsd, %.cc,   $(S))): $(S)))

# Voice and Video over LTE/Emergency VoLTE Interoperability Tests

## Introduction

This repositories contains the test specifications and test adapter code

for interoprability tests to ETSI TS 103 796-2 (Core Network and Interoperability Testing (INT); Network Interoperability Test Description for emergency services over 5G; (3GPP™ Release 16); Part 2: Test Descriptions).

## Contact information

Email at cti_support at etsi dot org

## License

The content of this repository and the files contained are released under the BSD-3-Clause License.

See the attached LICENSE file or visit

https://forge.etsi.org/legal-matters

## Standard links

- ETSI TS 103 796-1: "Core Network and Interoperability Testing (INT); Network Interoperability Test Description for emergency services over 5G; (3GPP™ Release 16); Part 1: Test Purposes (TP)".

- ETSI TS 124 229: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; 5G; IP multimedia call control protocol based on Session Initiation Protocol (SIP) and Session Description Protocol (SDP); Stage 3 (3GPP TS 24.229 Release 16)".

- ETSI TS 129 165: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; 5G; Inter-IMS Network to Network Interface (NNI) (3GPP TS 29.165 Release 16)".

- ETSI TS 129 228: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; IP Multimedia (IM) Subsystem Cx and Dx Interfaces; Signalling flows and message contents (3GPP TS 29.228 Release 16)".

- ETSI TS 129 229: "Digital cellular telecommunications system (Phase 2+) (GSM); Universal Mobile Telecommunications System (UMTS); LTE; Cx and Dx interfaces based on the Diameter protocol; Protocol details (3GPP TS 29.229 Release 16)".

## RFC links

- IETF RFC 3261: "SIP: Session Initiation Protocol"

- IETF RFC 7090: "Public Safety Answering Point (PSAP) Callback".

- IETF RFC 5031: "A Uniform Resource Name (URN) for Emergency and Other Well-Known Services".

- IETF RFC 8147: "Next-Generation Pan-European eCall"

NOTE All draft can be found in the 'IETF XML Registry', accessible [here](https://www.iana.org/assignments/xml-registry/xml-registry.xhtml)

# Installation

The ETSI Emergency VoLTE Interoperability Tests project builds and tests regularly on the following platforms:

  - Linux (Ubuntu)

Note: The [OpenSSL](https://www.openssl.org) version > 1.1.x is also required.

## How to do it?

They are two different methods:

- Using [Vagrant](https://www.vagrantup.com/)

- Using [Docker](https://www.docker.com/)

How to choose one of these methods is depending of your host system.

NOTE: In all case, if you want to setup an continuous integration process (e.g. Jenkins), Docker is the best choice. 

### The host system is Windows

The both methods require a virtual machine. You can use either VirtualBox or WMware.

In this case, the easiest way is to use Vagrant.

### The host system is Linux

Vagrant requires a virtual machine. You can use either VirtualBox or WMware.

Docker does not need a virtual machine, so it is the more efficant way.

## Using TITAN compiler on a Docker image

In this configuration, TITAN compiler is located on a Docker image and the sources and the outputs are located on the host.

Pre-requisites on your host machine:

- Install Docker

Procedure on the host machine:

- Open a Terminal

- Clone the ETSI Emergency VoLTE Interoperability Test System

- From the ETSI Emergency VoLTE Interoperability Test System root directory, build the Docker image executing the following commands:

```sh

$ cd ./virtualization/docker

$ docker build --no-cache --tag alpine-emergency-5g-iop -f Dockerfile --force-rm .

$ docker images

```

To build the Emergency VoLTE Interoperability Test Suite, execute the following command:

```sh

$ ./docker-run.sh build

```

Possble other options are 'clean' to remove all the build outputs or 'rebuild' to force a build of the Test Suite after a 'clean'.

To retrieve the list of the available test cases, execute the following command:

```sh

$ ./docker-run.sh list

```

Before to execute the Emergency VoLTE Interoperability Test Suite, prepare, edit and update the configuration file:

```sh

$ ln -sf ../../etc/AtsXxx/AtsXxx_yyy.cf_ ../../etc/AtsXxx/AtsXxx.cfg

$ vi ../../etc/AtsXxx/AtsXxx.cfg # To update it

```

To execute the Emergency VoLTE Interoperability Test Suite, execute the following command:

```sh

$ ./docker-run.sh run

```

<b>Notes</b>:

- The Emergency VoLTE Interoperability Test System is listening on port 443

- Updating the file etc/AtsXxx/AtsXxx.cfg is about (e.g. etc/AtsBCF/AtsBCF.cfg):

. Selecting the test(s) to be executed

. Updating value of PICs and PIXITs

. Updating HTTP port setting

## Using development Docker image

In this configuration, the TITAN compiler, the sources and the outputs are located on the Docker image.

Pre-requisites on your host machine:

- Install Docker

Procedure for a Windows host machine:

- On your host machine, open a the Docker Quickstart Terminal

- On your host machine, clone the ETSI EEmergency Communications project. NOTE that only Docker folder and .jenkins.sh script file are required

- From the ETSI Emergency VoLTE Interoperability Tests project root directory, execute the following commands:

```sh

$ ./.jenkins.sh

...

```

NOTE The creation and the installations will take some time to achieve

- Start the container

```sh

$ ./docker/run-container.sh

...

```

- Switch to the next clause (Usage)

## Using Vagrant

Pre-requisites on your host machine:

- Install [Virtualbox](https://www.virtualbox.org/manual/ch01.html)

- Install [Vagrant](https://www.vagrantup.com/intro/getting-started/)

- Install Vagrant plugin vagrant-vbguest

- Credentials to access [ETSI forge](https://forge.etsi.org/gitlab/users/sign_in)

    - Set the environment variable USERNAME to your ETSI EOL account user name

    - Set the environment variable PASSWORD to your ETSI EOL account password

Procedure:

- On your host machine, open a command line session (PuTTY, DOS window...)

- From the ETSI Emergency VoLTE Interoperability Tests project, clone the Vagrant folder

- In the file Vagrantfile, modify the tag config.vm.provision replacing <username> & <password> strings by your ETSI credentials

- In the Vagrant folder, execute the following commands:

```sh

$ vagrant up --provider virtualbox --provision

...

```

NOTE The creation and the installations will take some time to achieve

- Stop vagrant virtual machine

```sh

$ vagrant halt

...

```

- Update the file 'Vagrantfile' to match with your networks configuration

- Re-start the vagrant virtual machine and log to to the machine

```sh

$ vagrant up

...

$ vagrant ssh

```

- Switch to the next clause (Usage)

NOTE The user password is vagrant.

## From scratch

Pre-requisites:

- Install Virtualbox

Procedure:

- Install a new Linux Virtual machine (Mint, Debian...)

- Update your system with the latest version of kernel and security packages

- Install the following packages (According to the Linux chosen, the package naming can be different)

    autoconf

    bison

    build-essential

    cmake

    curl

    dos2unix

    doxygen

    emacs

    expect

    flex

    g++:latest

    gcc:latest

    graphviz

    gdb 

    git-core

    gnutls-bin

    libglib2.0-dev

    libpcap-dev

    libgcrypt-dev

    libncurses5-dev

    libssl-dev

    libtool-bin

    libtool

    libwireshark-dev

    libxml2-dev

    lsof

    ntp

    pkg-config

    qt5-default

    qtmultimedia5-dev

    libqt5svg5-dev

    subversion

    sudo

    sshpass

    tcpdump

    texlive-font-utils

    tshark

    valgrind

    vim

    vsftpd

    xutils-dev 

    tree

    tzdata

    unzip

    wget

    xsltproc

- In your home directory, create the following folders: 

    - $HOME/frameworks, 

    - $HOME/dev

    - $HOME/lib

- In $HOME/frameworks, build the following package:

    - Eclipse IDE for C/C++ Developers, according the procedure specified [here](https://www.eclipse.org/cdt/)

    - TITAN, according the procedure specified [here](https://github.com/eclipse/titan.core)

    - Import the TITAN plugin into your Eclipse IDE, according the procedure specified [here](https://github.com/eclipse/titan.core)

- Install LibOSIP framework

```sh

$ cd ${HOME}/frameworks

$ git clone https://git.savannah.gnu.org/git/osip.git ./osip

$ cd osip

$ ./autogen.sh

$ ./configure --prefix=/home/etsi

$ make && make install

```

- Clone the ETSI Emergency VoLTE Interoperability Tests project into $HOME/dev folder

```sh

$ git clone --recurse-submodules --branch devel https://forge.etsi.org/rep/int/vxlte/emergency-5g-iop.git

```

- Apply patches

```sh

$ cd /home/etsi/dev/emergency-5g-iop/

$ ./install.sh

```

- Update your default environment with the content of the script $HOME/dev/emergency-5g-iop/scripts/devenv.bash.ubuntu

- Switch to the next clause (Usage)

# Generate certificates for TLS and Emergency VoLTE Interoperability security support 

This clause describes how generate certificates desrived from Let's encrypt certificate. These certificate will be used for TS mutual authentication.

<b>NOTE:</b>

- Certficates shall be renewed every 3 months

- The port 80 shall be vailable for standalone validation

Pre-requisites:

- You need to install python and [certbot](https://manpages.ubuntu.com/manpages/impish/en/man1/certbot.1.html).

To generate certifcates, execute the following command:

```sh

$ export REQUESTS_CA_BUNDLE=$(dirname `python -c "import certifi; print(certifi.where())"`)

$ mkdir -p $HOME/var/ssl

$ sudo certbot certonly --debug --emergency-5g-iop-tls-cert --config-dir $HOME/var/ssl --work-dir $HOME/var/ssl  --logs-dir $HOME/var/ssl --standalone --agree-tos --email <your email> -d <your domain> -w $HOME/var/ssl/

```

<b>NOTE:</b> For testing certificate generation and renewal, use the certbot's --dry-run option.

# Usage

This clause describes how to compile and execute an Abstract Test Suite.

The procedures below illustrate how to run the CAM test suite. The same procedures will apply for any other ETSI Emergency Communications test suite.

Pre-requisites:

- Your machine is installed following one of the installation method describes in the previous clause

- Your are logged as 'etsi' or 'vagrant' user

Procedure in TITAN command line:

- Open several SSH session (PuTTY...)

- Change to the directory ~/dev/emergency-5g-iop/

- Build the test suite you want to exectue (e.g. LIS test suite)

```sh

$ cd ~/dev/emergency-5g-iop/

$ export ATS=AtsImsIot

$ make

...

```

- Edit the file ../etc/AtsImsIot/AtsImsIot.cfg

- Update the following fields:

    - system.httpPort.params

    - system.SIPP.params

    - system.DIAMETER.params

- To run the test suitem, execute the following command:

```sh

$ cd ~/dev/emergency-5g-iop/scripts

$ ./run-all.bash

...

```

- The log files are located in ../logs/AtsImsIot folder. You can edit them using any editor or using the Eclipse TITAN log plugins

# How to Report a Bug

The ETSI Emergency VoLTE Interoperability Tests project is under constant development, so it is possible that you will

encounter a bug while using it. Please report bugs at cti_support at etsi dot org.

sources := \

  LibDiameter_EncDec.cc