Commit 86f1c34b authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Mock QKD Node: 

- generalizing configuration of Mock QKD Node
- reorganizing module and code to enable dockerization
parent 689629fe

src/device/tests/qkd/unit/test_qkd_compliance.py

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ 
import pytest

import requests

from requests.exceptions import HTTPError

from tests.tools.mock_qkd_nodes.YangValidator import YangValidator

from tests.tools.mock_qkd_node.YangValidator import YangValidator



def test_compliance_with_yang_models():

    validator = YangValidator('etsi-qkd-sdn-node', ['etsi-qkd-node-types'])

src/tests/.gitlab-ci.yml

+13 −11
Original line number Diff line number Diff line
@@ -14,16 +14,18 @@ 


# include the individual .gitlab-ci.yml of each end-to-end integration test

include:

  - local: '/src/tests/ofc22/.gitlab-ci.yml'

  #- local: '/src/tests/oeccpsc22/.gitlab-ci.yml'

  - local: '/src/tests/ecoc22/.gitlab-ci.yml'

  #- local: '/src/tests/nfvsdn22/.gitlab-ci.yml'

  #- local: '/src/tests/ofc23/.gitlab-ci.yml'

  - local: '/src/tests/ofc24/.gitlab-ci.yml'

  - local: '/src/tests/eucnc24/.gitlab-ci.yml'

  #- local: '/src/tests/ofc25-camara-agg-net-controller/.gitlab-ci.yml'

  #- local: '/src/tests/ofc25-camara-e2e-controller/.gitlab-ci.yml'

  #- local: '/src/tests/ofc25/.gitlab-ci.yml'

  #- local: '/src/tests/ryu-openflow/.gitlab-ci.yml'

#  - local: '/src/tests/ofc22/.gitlab-ci.yml'

#  #- local: '/src/tests/oeccpsc22/.gitlab-ci.yml'

#  - local: '/src/tests/ecoc22/.gitlab-ci.yml'

#  #- local: '/src/tests/nfvsdn22/.gitlab-ci.yml'

#  #- local: '/src/tests/ofc23/.gitlab-ci.yml'

#  - local: '/src/tests/ofc24/.gitlab-ci.yml'

#  - local: '/src/tests/eucnc24/.gitlab-ci.yml'

#  #- local: '/src/tests/ofc25-camara-agg-net-controller/.gitlab-ci.yml'

#  #- local: '/src/tests/ofc25-camara-e2e-controller/.gitlab-ci.yml'

#  #- local: '/src/tests/ofc25/.gitlab-ci.yml'

#  #- local: '/src/tests/ryu-openflow/.gitlab-ci.yml'

  - local: '/src/tests/qkd_end2end/.gitlab-ci.yml'



  - local: '/src/tests/tools/mock_tfs_nbi_dependencies/.gitlab-ci.yml'

  - local: '/src/tests/tools/mock_qkd_node/.gitlab-ci.yml'

src/tests/tools/mock_qkd_node/.gitlab-ci.yml

0 → 100644
+39 −0
Original line number Diff line number Diff line 
# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#      http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.



# Build, tag, and push the Docker image to the GitLab Docker registry

build mock_qkd_node:

  stage: build

  before_script:

    - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY

  script:

    - docker buildx build -t "$CI_REGISTRY_IMAGE/mock_qkd_node:test" -f ./src/tests/tools/mock_qkd_node/Dockerfile .

    - docker push "$CI_REGISTRY_IMAGE/mock_qkd_node:test"

  after_script:

    - docker images --filter="dangling=true" --quiet | xargs -r docker rmi

  rules:

    - if: '$CI_PIPELINE_SOURCE == "merge_request_event" && ($CI_MERGE_REQUEST_TARGET_BRANCH_NAME == "develop" || $CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH)'

    - if: '$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "develop"'

    - changes:

      - src/common/**/*.py

      - proto/*.proto

      - src/src/tests/tools/mock_qkd_node/**/*.{py,in,yml,yaml}

      - src/src/tests/tools/mock_qkd_node/Dockerfile

      - src/device/**/*.{py,in,yml}

      - src/device/Dockerfile

      - src/device/tests/*.py

      - src/qkd_app/**/*.{py,in,yml}

      - src/qkd_app/Dockerfile

      - src/qkd_app/tests/*.py

      - .gitlab-ci.yml

src/tests/tools/mock_qkd_node/Dockerfile

0 → 100644
+58 −0
Original line number Diff line number Diff line 
# Copyright 2022-2025 ETSI SDG TeraFlowSDN (TFS) (https://tfs.etsi.org/)

#

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

#

#      http://www.apache.org/licenses/LICENSE-2.0

#

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.



FROM python:3.9-slim



# Install dependencies

RUN apt-get --yes --quiet --quiet update && \

    apt-get --yes --quiet --quiet install g++ git build-essential cmake libpcre2-dev python3-dev python3-cffi && \

    rm -rf /var/lib/apt/lists/*



# Download, build and install libyang. Note that APT package is outdated

# - Ref: https://github.com/CESNET/libyang

# - Ref: https://github.com/CESNET/libyang-python/

RUN mkdir -p /var/libyang

RUN git clone https://github.com/CESNET/libyang.git /var/libyang

WORKDIR /var/libyang

RUN git fetch

RUN git checkout v2.1.148

RUN mkdir -p /var/libyang/build

WORKDIR /var/libyang/build

RUN cmake -D CMAKE_BUILD_TYPE:String="Release" ..

RUN make

RUN make install

RUN ldconfig



# Set Python to show logs as they occur

ENV PYTHONUNBUFFERED=0



# Get generic Python packages

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

RUN python3 -m pip install --upgrade pip-tools



# Create component sub-folders, and copy content

RUN mkdir -p /var/teraflow/mock_qkd_node/{data,yang}

WORKDIR /var/teraflow/mock_qkd_node

COPY yang/. yang/

COPY requirements.in requirements.in

COPY wsgi.py wsgi.py

COPY YangValidator.py YangValidator.py



# Get specific Python packages

RUN pip-compile --quiet --output-file=requirements.txt requirements.in

RUN python3 -m pip install -r requirements.txt



# Start the service

ENTRYPOINT ["gunicorn", "--workers", "1", "--bind", "0.0.0.0:8080", "wsgi:app"]

src/tests/tools/mock_qkd_node/README.md

0 → 100644
+33 −0
Original line number Diff line number Diff line 
# Mock IETF ACTN SDN Controller



This REST server implements very basic support for the following YANG data models:

- IETF YANG Data Model for Transport Network Client Signals (draft-ietf-ccamp-client-signal-yang-10)

  - Ref: https://datatracker.ietf.org/doc/draft-ietf-ccamp-client-signal-yang/

- IETF YANG Data Model for Traffic Engineering Tunnels, Label Switched Paths and Interfaces (draft-ietf-teas-yang-te-34)

  - Ref: https://datatracker.ietf.org/doc/draft-ietf-teas-yang-te/



The aim of this server is to enable testing the IetfActnDeviceDriver and the IetfActnServiceHandler.





## 1. Install requirements for the Mock IETF ACTN SDN controller

__NOTE__: if you run the Mock IETF ACTN SDN controller from the PyEnv used for developing on the TeraFlowSDN

framework and you followed the official steps in

[Development Guide > Configure Environment > Python](https://labs.etsi.org/rep/tfs/controller/-/wikis/2.-Development-Guide/2.1.-Configure-Environment/2.1.1.-Python),

all the requirements are already in place. Install them only if you execute it in a separate/standalone environment.



Install the required dependencies as follows:

```bash

pip install -r src/tests/tools/mock_ietf_actn_sdn_ctrl/requirements.in

```



Run the Mock IETF ACTN SDN Controller as follows:

```bash

python src/tests/tools/mock_ietf_actn_sdn_ctrl/MockIetfActnSdnCtrl.py

```





## 2. Run the Mock IETF ACTN SDN controller

Run the Mock IETF ACTN SDN Controller as follows:

```bash

python src/tests/tools/mock_ietf_actn_sdn_ctrl/MockIetfActnSdnCtrl.py

```