Commit d8a114e3 authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Tests - Ryu-OpenFlow integration test: 

- Add files
parent fbf12733

src/tests/.gitlab-ci.yml

+1 −0
Original line number Diff line number Diff line
@@ -24,5 +24,6 @@ include: 
  - 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/tools/mock_tfs_nbi_dependencies/.gitlab-ci.yml'

src/tests/ryu-openflow/.gitignore

0 → 100644
+0 −0

Empty file added.

src/tests/ryu-openflow/.gitlab-ci.yml

0 → 100644
+258 −0
Original line number Diff line number Diff line 
# Copyright 2022-2024 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 ryu-openflow:

  variables:

    TEST_NAME: 'ryu-openflow'

  stage: build

  before_script:

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

  script:

    - docker buildx build -t "${TEST_NAME}:latest" -f ./src/tests/${TEST_NAME}/Dockerfile .

    - docker tag "${TEST_NAME}:latest" "$CI_REGISTRY_IMAGE/${TEST_NAME}:latest"

    - docker push "$CI_REGISTRY_IMAGE/${TEST_NAME}:latest"

  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/tests/${TEST_NAME}/**/*.{py,in,sh,yml}

      - src/tests/${TEST_NAME}/Dockerfile

      - .gitlab-ci.yml



# Deploy TeraFlowSDN and Execute end-2-end test

end2end_test ryu-openflow:

  timeout: 90m

  variables:

    TEST_NAME: 'ryu-openflow'

  stage: end2end_test

  # Disable to force running it after all other tasks

  #needs:

  #  - build ryu-openflow

  before_script:

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

    - docker rm -f ${TEST_NAME} || true

    - containerlab destroy --all --cleanup || true



  script:

    # Download Docker image to run the test

    - docker pull "${CI_REGISTRY_IMAGE}/${TEST_NAME}:latest"



    # Check MicroK8s is ready

    - microk8s status --wait-ready

    - kubectl get pods --all-namespaces



    # Deploy ContainerLab Scenario

    - RUNNER_PATH=`pwd`

    #- cd $PWD/src/tests/${TEST_NAME}

    - mkdir -p /tmp/clab/${TEST_NAME}

    - cp -R src/tests/${TEST_NAME}/clab/* /tmp/clab/${TEST_NAME}

    - tree -la /tmp/clab/${TEST_NAME}

    - cd /tmp/clab/${TEST_NAME}

    - containerlab deploy --reconfigure --topo ryu-openflow.clab.yml

    - cd $RUNNER_PATH



    # Wait for initialization of Device NOSes

    - sleep 3

    - docker ps -a



    # Dump configuration of the routers (before any configuration)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Configure TeraFlowSDN deployment

    # Uncomment if DEBUG log level is needed for the components

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/contextservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/deviceservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="frontend").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/pathcompservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/serviceservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/nbiservice.yaml

    #- yq -i '((select(.kind=="Deployment").spec.template.spec.containers.[] | select(.name=="server").env.[]) | select(.name=="LOG_LEVEL").value) |= "DEBUG"' manifests/monitoringservice.yaml



    - source src/tests/${TEST_NAME}/deploy_specs.sh

    #- export TFS_REGISTRY_IMAGES="${CI_REGISTRY_IMAGE}"

    #- export TFS_SKIP_BUILD="YES"

    #- export TFS_IMAGE_TAG="latest"

    #- echo "TFS_REGISTRY_IMAGES=${CI_REGISTRY_IMAGE}"



    # Deploy TeraFlowSDN

    - ./deploy/crdb.sh

    - ./deploy/nats.sh

    - ./deploy/kafka.sh

    - ./deploy/qdb.sh

    - ./deploy/tfs.sh

    - ./deploy/show.sh



    ## Wait for Context to be subscribed to NATS

    ## WARNING: this loop is infinite if there is no subscriber (such as monitoring).

    ##          Investigate if we can use a counter to limit the number of iterations.

    ##          For now, keep it commented out.

    #- LOOP_MAX_ATTEMPTS=180

    #- LOOP_COUNTER=0

    #- >

    #  while ! kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server 2>&1 | grep -q 'Subscriber is Ready? True'; do

    #    echo "Attempt: $LOOP_COUNTER"

    #    kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server 2>&1;

    #    sleep 1;

    #    LOOP_COUNTER=$((LOOP_COUNTER + 1))

    #    if [ "$LOOP_COUNTER" -ge "$LOOP_MAX_ATTEMPTS" ]; then

    #      echo "Max attempts reached, exiting the loop."

    #      break

    #    fi

    #  done

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server



    # Run end-to-end test: onboard scenario

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-onboarding.sh



    # Run end-to-end test: configure service TFS

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-service-tfs-create.sh



    # Dump configuration of the routers (after configure TFS service)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Run end-to-end test: test connectivity with ping

    - export TEST1_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.1.10' --format json)

    - echo $TEST1_10

    - echo $TEST1_10 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST1_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.1.1' --format json)

    - echo $TEST1_1

    - echo $TEST1_1 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST2_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.2.1' --format json)

    - echo $TEST2_1

    - echo $TEST2_1 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST2_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.2.10' --format json)

    - echo $TEST2_10

    - echo $TEST2_10 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST3_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.3.1' --format json)

    - echo $TEST3_1

    - echo $TEST3_1 | grep -E '3 packets transmitted, 0 received, 100\% packet loss'

    - export TEST3_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.3.10' --format json)

    - echo $TEST3_10

    - echo $TEST3_10 | grep -E '3 packets transmitted, 0 received, 100\% packet loss'



    # Run end-to-end test: deconfigure service TFS

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-service-tfs-remove.sh



    # Dump configuration of the routers (after deconfigure TFS service)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Run end-to-end test: configure service IETF

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-service-ietf-create.sh



    # Dump configuration of the routers (after configure IETF service)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Run end-to-end test: test connectivity with ping

    - export TEST1_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.1.10' --format json)

    - echo $TEST1_10

    - echo $TEST1_10 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST1_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.1.1' --format json)

    - echo $TEST1_1

    - echo $TEST1_1 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST2_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.2.1' --format json)

    - echo $TEST2_1

    - echo $TEST2_1 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST2_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.2.10' --format json)

    - echo $TEST2_10

    - echo $TEST2_10 | grep -E '3 packets transmitted, 3 received, 0\% packet loss'

    - export TEST3_1=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.3.1' --format json)

    - echo $TEST3_1

    - echo $TEST3_1 | grep -E '3 packets transmitted, 0 received, 100\% packet loss'

    - export TEST3_10=$(containerlab exec --name ryu-openflow --label clab-node-name=dc1 --cmd 'ping -n -c3 172.16.3.10' --format json)

    - echo $TEST3_10

    - echo $TEST3_10 | grep -E '3 packets transmitted, 0 received, 100\% packet loss'



    # Run end-to-end test: deconfigure service IETF

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-service-ietf-remove.sh



    # Dump configuration of the routers (after deconfigure IETF service)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Run end-to-end test: cleanup scenario

    - >

      docker run -t --rm --name ${TEST_NAME} --network=host 

      --volume "$PWD/tfs_runtime_env_vars.sh:/var/teraflow/tfs_runtime_env_vars.sh"

      --volume "$PWD/src/tests/${TEST_NAME}:/opt/results"

      $CI_REGISTRY_IMAGE/${TEST_NAME}:latest /var/teraflow/run-cleanup.sh



  after_script:

    # Dump configuration of the routers (on after_script)

    - containerlab exec --name ryu-openflow --label clab-node-name=r1 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r2 --cmd "Cli --command \"enable"$'\n'$"show running-config\""

    - containerlab exec --name ryu-openflow --label clab-node-name=r3 --cmd "Cli --command \"enable"$'\n'$"show running-config\""



    # Dump TeraFlowSDN component logs

    - source src/tests/${TEST_NAME}/deploy_specs.sh

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/contextservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/deviceservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/pathcompservice -c frontend

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/serviceservice -c server

    - kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/nbiservice -c server

    #- kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/monitoringservice -c server



    # Destroy Scenario

    - docker rm -f ${TEST_NAME} || true

    - RUNNER_PATH=`pwd`

    #- cd $PWD/src/tests/${TEST_NAME}

    - cd /tmp/clab/${TEST_NAME}

    - containerlab destroy --topo ryu-openflow.clab.yml --cleanup || true

    - sudo rm -rf clab-ryu-openflow/ .ryu-openflow.clab.yml.bak || true

    - cd $RUNNER_PATH

    - kubectl delete namespaces tfs || true



    # Clean old docker images

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



  #coverage: '/TOTAL\s+\d+\s+\d+\s+(\d+%)/'

  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"'

  artifacts:

      when: always

      reports:

        junit: ./src/tests/${TEST_NAME}/report_*.xml

src/tests/ryu-openflow/README.md

0 → 100644
+41 −0
Original line number Diff line number Diff line 
# Control of OpenFlow domain through Ryu SDN controller and TeraFlowSDN



## TeraFlowSDN Deployment

```bash

cd ~/tfs-ctrl

source ~/tfs-ctrl/src/tests/ryu-openflow/deploy_specs.sh

./deploy/all.sh

```



## Download and install Mininet

```bash

sudo apt-get install "mininet=2.3.0-1ubuntu1"

```



## Deploy SDN controller and dataplane

```bash

cd ~/tfs-ctrl/src/tests/ryu-openflow/

docker compose build # or docker buildx build --no-cache -t "ryu-image:dev" -f ./Ryu.Dockerfile .

docker compose up -d # or docker run -d -p 6653:6653 -p 8080:8080 ryu-image:dev

sudo python3 custom_pentagon_topology.py

```



## Destroy scenario

```bash

cd ~/tfs-ctrl/src/tests/ryu-openflow/

docker compose down

# Ctrl+C mininet dataplane

```



## Onboard scenario

- Through TFS WebUI



## Request connectivity service

```bash

cd ~/tfs-ctrl/src/tests/ryu-openflow/

curl -X POST \

  --header "Content-Type: application/json" \

  --data @ietf-l3vpn-service.json \

  --user "admin:admin" \

  http://127.0.0.1/restconf/data/ietf-l3vpn-svc:l3vpn-svc/vpn-services

```

src/tests/ryu-openflow/Test.Dockerfile

0 → 100644
+86 −0
Original line number Diff line number Diff line 
# Copyright 2022-2024 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 wget g++ git && \

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



# 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



# Get common Python packages

# Note: this step enables sharing the previous Docker build steps among all the Python components

WORKDIR /var/teraflow

COPY common_requirements.in common_requirements.in

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

RUN python3 -m pip install -r common_requirements.txt



# Add common files into working directory

WORKDIR /var/teraflow/common

COPY src/common/. ./

RUN rm -rf proto



# Create proto sub-folder, copy .proto files, and generate Python code

RUN mkdir -p /var/teraflow/common/proto

WORKDIR /var/teraflow/common/proto

RUN touch __init__.py

COPY proto/*.proto ./

RUN python3 -m grpc_tools.protoc -I=. --python_out=. --grpc_python_out=. *.proto

RUN rm *.proto

RUN find . -type f -exec sed -i -E 's/^(import\ .*)_pb2/from . \1_pb2/g' {} \;



# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/tests/ryu-openflow

WORKDIR /var/teraflow/tests/ryu-openflow

COPY src/tests/ryu-openflow/requirements.in requirements.in

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

RUN python3 -m pip install -r requirements.txt



# Add component files into working directory

WORKDIR /var/teraflow

COPY src/__init__.py ./__init__.py

COPY src/common/*.py ./common/

COPY src/common/tests/. ./common/tests/

COPY src/common/tools/. ./common/tools/

COPY src/context/__init__.py context/__init__.py

COPY src/context/client/. context/client/

COPY src/device/__init__.py device/__init__.py

COPY src/device/client/. device/client/

COPY src/monitoring/__init__.py monitoring/__init__.py

COPY src/monitoring/client/. monitoring/client/

COPY src/service/__init__.py service/__init__.py

COPY src/service/client/. service/client/

COPY src/slice/__init__.py slice/__init__.py

COPY src/slice/client/. slice/client/

COPY src/vnt_manager/__init__.py vnt_manager/__init__.py

COPY src/vnt_manager/client/. vnt_manager/client/

COPY src/tests/*.py ./tests/

COPY src/tests/ryu-openflow/__init__.py ./tests/ryu-openflow/__init__.py

COPY src/tests/ryu-openflow/data/. ./tests/ryu-openflow/data/

COPY src/tests/ryu-openflow/tests/. ./tests/ryu-openflow/tests/

COPY src/tests/ryu-openflow/scripts/. ./



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

    apt-get --yes --quiet --quiet install tree && \

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



RUN tree -la /var/teraflow