Complete re-organization of the ATSs; Add unified TITAN framework

bindir := $(TOPDIR)/bin

sources     := $(sort $(all_sources))

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

includes    := $(outdir) $(outdir)/.. $(all_includes) /usr/include/libxml2 $(NPCAP_INCLUDE)

ifeq (Windows_NT,$(OS))

  EXE=.exe

	mkdir -p $@

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

	g++ -g -O0 -o $@ $(LDFLAGS) $(gen_objects) $(cc_objects) $(libs)

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

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

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

	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 -c $(addprefix -D, $(defines)) $(addprefix -I, $(includes)) -o $@ $<

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

#$(gen_sources):

#	$(TTCN3_DIR)/bin/compiler -n -e -L -R -U none -o $(outdir) $(tt_sources)

# MEC Testing Framework in TTCN-3 - - GS 032-3

## Introduction

This repositories contains the test specifications and test adapter code for MEC API Conformance Testing in TTCN-3, GS 032-3.

More information and dowload of the standard at https://portal.etsi.org/webapp/WorkProgram/Report_WorkItem.asp?WKI_ID=56776.

This repositories contains the test specifications and test adapter code for MEC API Conformance Testing in TTCN-3, GS 032-2/3.

More information and download of the standard at https://portal.etsi.org/webapp/WorkProgram/Report_WorkItem.asp?WKI_ID=56776.

For more information on ETSI ISG Multi-access Edge Computing (MEC), visit https://www.etsi.org/technologies/multi-access-edge-computing.

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

## Download required libraries

## STFs/TTFs

The following STFs were or are currently involved in the evolutions of the ETSI MEC protocols project:

- STF 569, STF 625, TTF T012

This projects requires the LibCommon and LibIts libraries to compile. The libraries location are git submodules of the current repository.

# Installation

Once you have cloned the present repository, in order to install the libraries you want to execute:

The ETSI MEC protocols project builds and tests regularly on the following platforms:

    git submodule init

    git submodule update

  - Linux (Ubuntu)

  - Windows ([Cygwin x64](https://cygwin.com/install.html), [Npcap SDK x64](https://nmap.org/npcap/#download) and [OpenSSL-Windows x64](https://www.openssl.org) are required)

Alternatively, you may clone the project together with the required libraries with the following command:

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

    git clone --recurse-submodules <URL to the repository>

## Installation

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

### How to do it?

They are two different methods:

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

### Using Vagrant

### 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 [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

- Install Docker

Procedure:

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

- From the ETSI MEC Testing Framework 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:

Procedure on the host machine:

- Open a Terminal

- Clone the ETSI MEC Test System

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

```sh

$ vagrant up --provider virtualbox --provision

...

$ cd ./virtualization/docker

$ docker build --no-cache --tag alpine-mec -f Dockerfile --force-rm .

$ docker images

```

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

- Stop vagrant virtual machine

To build the MEC Test Suite, execute the following command:

```sh

$ vagrant halt

...

$ ./docker-run.sh build

```

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

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

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

$ vagrant up

...

$ vagrant ssh

$ ./docker-run.sh list

```

- Switch to the next clause (Usage)

Before to execute the MEC Test Suite, prepare, edit and update the configuration file:

NOTE The user password is vagrant.

```sh

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

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

```

To execute the MEC Test Suite, execute the following command:

```sh

$ ./docker-run.sh run

```

<b>Notes</b>:

- The MEC Test System is listening on port 30181

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

. Selecting the test(s) to be executed

. Updating value of PICs and PIXITs

. Updating HTTP port setting

### Using Docker

### 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 Virtualbox

- 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 MEC Testing Framework 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:

- Switch to the next clause (Usage)

## Generate certificates for TLS and MEC security support 

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

<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 --mec-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.

[MODULE_PARAMETERS]

# This section shall contain the values of all parameters that are defined in your TTCN-3 modules.

# IUT roles

LibCommon_Time.PX_TAC := 30.0

#LibCommon_Time.PX_TWAIT := 30.0

LibCommon_Sync.PX_TSYNC_TIME_LIMIT := 30.0;

LibCommon_Sync.PX_TSHUT_DOWN_TIME_LIMIT := 30.0;

LibHttp_Pics.PICS_HEADER_HOST := "sandbox-mec.etsi.org" #"192.168.1.39"

LibHttp_Pics.PICS_HEADER_CONTENT_TYPE := "application/json"

LibHttp_Pics.PICS_USE_TOKEN_HEADER    := true

#LibHttp_Pics.PICS_TOKEN_HEADER        := "Basic WrongToken"

LibMec_Pics.PICS_ROOT_API                := "/sbx8tunqyy/mep1" # Need to sign in on https://sandbox-mec.etsi.org/, section 'Try-it from your MEC application'

LibMec_Pics.PICS_MEC_PLAT := true

[LOGGING]

# In this section you can specify the name of the log file and the classes of events

# you want to log into the file or display on console (standard error).

LogFile := "../logs/AtsMec_V2XInformationService/%e.%h-%r.%s"

#FileMask := LOG_ALL | USER | DEBUG | MATCHING

#ConsoleMask := LOG_ALL | USER | DEBUG | MATCHING

FileMask := ERROR | WARNING | USER | MATCHING | EXECUTOR_RUNTIME | VERDICTOP | PORTEVENT

ConsoleMask := ERROR | WARNING | USER | MATCHING | EXECUTOR_RUNTIME | VERDICTOP | PORTEVENT

LogSourceInfo := Stack

LogEntityName:= Yes

LogEventTypes:= Yes

#TimeStampFormat := DateTime

[TESTPORT_PARAMETERS]

# In this section you can specify parameters that are passed to Test Ports.

system.httpPort.params := "HTTP(codecs=json:json_codec)/TCP(debug=1,server=sandbox-mec.etsi.org,port=443,use_ssl=1,trusted_ca_list=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem,privkey=/home/yann/var/ssl/archive/yanngarcia.ddns.net/privkey1.pem,certificate=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem)"

system.httpPort_notif.params := "HTTP(codecs=json:json_codec)/TCP(debug=1,server_mode=1,local_port=443,use_ssl=1,mutual_auth=1,mutual_tls=1,trusted_ca_list=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem,privkey=/home/yann/var/ssl/archive/yanngarcia.ddns.net/privkey1.pem,certificate=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem)"

[DEFINE]

# In this section you can create macro definitions,

# that can be used in other configuration file sections except [INCLUDE] and [ORDERED_INCLUDE].

[INCLUDE]

# To use configuration settings given in other configuration files,

# the configuration files just need to be listed in this section, with their full or relative pathnames.

[ORDERED_INCLUDE]

# To use configuration settings given in other configuration files,

# the configuration files just need to be listed in this section, with their full or relative pathnames.

[EXTERNAL_COMMANDS]

# This section can define external commands (shell scripts) to be executed by the ETS

# whenever a control part or test case is started or terminated.

#BeginTestCase := ""

#EndTestCase := ""

#BeginControlPart := ""

#EndControlPart := ""

[EXECUTE]

# In this section you can specify what parts of your test suite you want to execute.

AtsMec_TestControl.control

[GROUPS]

# In this section you can specify groups of hosts. These groups can be used inside the

# [COMPONENTS] section to restrict the creation of certain PTCs to a given set of hosts.

[COMPONENTS]

# This section consists of rules restricting the location of created PTCs.

[MAIN_CONTROLLER]

# The options herein control the behavior of MC.

KillTimer := 10.0

LocalAddress := 127.0.0.1

TCPPort := 12000

NumHCs := 1

[MODULE_PARAMETERS]

# This section shall contain the values of all parameters that are defined in your TTCN-3 modules.

# IUT roles

LibCommon_Time.PX_TAC := 30.0

#LibCommon_Time.PX_TWAIT := 30.0

LibCommon_Sync.PX_TSYNC_TIME_LIMIT := 30.0;

LibCommon_Sync.PX_TSHUT_DOWN_TIME_LIMIT := 30.0;

LibHttp_Pics.PICS_HEADER_HOST := "sandbox-mec.etsi.org" #"192.168.1.39"

LibHttp_Pics.PICS_HEADER_CONTENT_TYPE := "application/json"

LibHttp_Pics.PICS_USE_TOKEN_HEADER    := true

#LibHttp_Pics.PICS_TOKEN_HEADER        := "Basic WrongToken"

LibMec_Pics.PICS_ROOT_API                := "/sbx8tunqyy/mep1" # Need to sign in on https://sandbox-mec.etsi.org/, section 'Try-it from your MEC application'

LibMec_Pics.PICS_MEC_PLAT := true

[LOGGING]

# In this section you can specify the name of the log file and the classes of events

# you want to log into the file or display on console (standard error).

LogFile := "../logs/AtsMec_WlanInformation/%e.%h-%r.%s"

#FileMask := LOG_ALL | USER | DEBUG | MATCHING

#ConsoleMask := LOG_ALL | USER | DEBUG | MATCHING

FileMask := ERROR | WARNING | USER | MATCHING | EXECUTOR_RUNTIME | VERDICTOP | PORTEVENT

ConsoleMask := ERROR | WARNING | USER | MATCHING | EXECUTOR_RUNTIME | VERDICTOP | PORTEVENT

LogSourceInfo := Stack

LogEntityName:= Yes

LogEventTypes:= Yes

#TimeStampFormat := DateTime

[TESTPORT_PARAMETERS]

# In this section you can specify parameters that are passed to Test Ports.

system.httpPort.params := "HTTP(codecs=json:json_codec)/TCP(debug=1,server=sandbox-mec.etsi.org,port=443,use_ssl=1,trusted_ca_list=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem,privkey=/home/yann/var/ssl/archive/yanngarcia.ddns.net/privkey1.pem,certificate=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem)"

system.httpPort_notif.params := "HTTP(codecs=json:json_codec)/TCP(debug=1,server_mode=1,local_port=443,use_ssl=1,mutual_auth=1,mutual_tls=1,trusted_ca_list=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem,privkey=/home/yann/var/ssl/archive/yanngarcia.ddns.net/privkey1.pem,certificate=/home/yann/var/ssl/archive/yanngarcia.ddns.net/fullchain1.pem)"

[DEFINE]

# In this section you can create macro definitions,

# that can be used in other configuration file sections except [INCLUDE] and [ORDERED_INCLUDE].

[INCLUDE]

# To use configuration settings given in other configuration files,

# the configuration files just need to be listed in this section, with their full or relative pathnames.

[ORDERED_INCLUDE]

# To use configuration settings given in other configuration files,

# the configuration files just need to be listed in this section, with their full or relative pathnames.

[EXTERNAL_COMMANDS]

# This section can define external commands (shell scripts) to be executed by the ETS

# whenever a control part or test case is started or terminated.

#BeginTestCase := ""

#EndTestCase := ""

#BeginControlPart := ""

#EndControlPart := ""

[EXECUTE]

# In this section you can specify what parts of your test suite you want to execute.

AtsMec_TestControl.control

[GROUPS]

# In this section you can specify groups of hosts. These groups can be used inside the

# [COMPONENTS] section to restrict the creation of certain PTCs to a given set of hosts.

[COMPONENTS]

# This section consists of rules restricting the location of created PTCs.

[MAIN_CONTROLLER]

# The options herein control the behavior of MC.

KillTimer := 10.0

LocalAddress := 127.0.0.1

TCPPort := 12000

NumHCs := 1

    export TTCN3_LICENSE_FILE=${TTCN3_DIR}/etc/license/license.dat

    export PATH_DEV_TTCN=${HOME}/dev/ttcn3

    # ITS support

    export PATH_DEV_ITS=${HOME}/dev/etsi_its

    export PATH_DEV_ITS=${HOME}/dev/TS.ITS

    # Emergency Communication support

    export PATH_DEV_EMCOM=${HOME}/dev/etsi_emcom

    export PATH_DEV_EMCOM=${HOME}/dev/NG112

    # Mobile-Edge Computing support

    export PATH_DEV_MEC=${HOME}/dev/etsi_mec

    export PATH_DEV_MEC=${HOME}/dev/gs032p3-ttcn-test-suite

    # CDM/CISE support

    export PATH_DEV_MEC=${HOME}/dev/cise

    # Validation folder

    export VALIDATION_DIR=${HOME}

fi