Commit 657912ce authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Merge branch 'feat/137-fix-ci-cd-pipeline-issues' into 'develop' 

Resolve "Fix CI/CD pipeline issues"

See merge request !215
parents 46fc68a9 1db99e51

scripts/run_tests_locally-optical-attack-detector.sh

0 → 100755
+102 −0
Original line number Diff line number Diff line 
#!/bin/bash

# Copyright 2022-2023 ETSI TeraFlowSDN - TFS OSG (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.





PROJECTDIR=`pwd`

RCFILE=$PROJECTDIR/coverage/.coveragerc

COVERAGEFILE=$PROJECTDIR/coverage/.coverage



# Destroy old coverage file and configure the correct folder on the .coveragerc file

rm -f $COVERAGEFILE

cat $PROJECTDIR/coverage/.coveragerc.template | sed s+~/tfs-ctrl+$PROJECTDIR+g > $RCFILE



echo

echo "Pre-test clean-up:"

echo "------------------"

docker rm -f redis opticalattackdetector dbscanserving

docker network rm tfs_br



echo

echo "Pull Docker images:"

echo "-------------------"

docker pull redis:7.0-alpine



echo

echo "Build optical attack detector:"

echo "------------------------------"

docker build -t "opticalattackdetector:latest" -f ./src/opticalattackdetector/Dockerfile .

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



echo

echo "Build dbscan serving:"

echo "---------------------"

docker build -t "dbscanserving:latest" -f ./src/dbscanserving/Dockerfile .

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



echo

echo "Create test environment:"

echo "------------------------"

export REDIS_PASSWORD=$(uuidgen)

docker network create -d bridge --subnet=172.254.254.0/24 --gateway=172.254.254.1 --ip-range=172.254.254.0/24 tfs_br



docker run --name redis -d --network=tfs_br -p 16379:6379 --rm \

    --env REDIS_PASSWORD=${REDIS_PASSWORD} \

    redis:7.0-alpine redis-server --requirepass ${REDIS_PASSWORD}



docker run --name dbscanserving -d --network=tfs_br -p 10008:10008 --rm \

    --env LOG_LEVEL=DEBUG \

    dbscanserving:latest "python -m dbscanserving.service"



echo

echo "Waiting for initialization..."

echo "-----------------------------"

while ! docker logs redis 2>&1 | grep -q 'Ready to accept connections'; do sleep 1; done

docker logs redis

#while ! docker logs dbscanserving 2>&1 | grep -q 'Server is ready'; do sleep 1; done

docker logs dbscanserving

#sleep 10

docker ps -a



echo

echo "Run unitary tests and analyze code coverage:"

echo "--------------------------------------------"

export REDIS_ADDRESS=$(docker inspect redis --format "{{.NetworkSettings.Networks.tfs_br.IPAddress}}")

export DBSCANSERVING_ADDRESS=$(docker inspect dbscanserving --format "{{.NetworkSettings.Networks.tfs_br.IPAddress}}")

docker run --name opticalattackdetector -d --network=tfs_br -p 10006:10006 --rm \

    --env REDIS_PASSWORD=${REDIS_PASSWORD} \

    --env DBSCANSERVINGSERVICE_SERVICE_HOST=${DBSCANSERVING_ADDRESS} \

    --env CACHINGSERVICE_SERVICE_HOST=${REDIS_ADDRESS} \

    opticalattackdetector:latest



sleep 5

docker ps -a

docker logs opticalattackdetector

docker exec -i opticalattackdetector bash -c "coverage run -m pytest --log-level=DEBUG --verbose opticalattackdetector/tests/test_unitary.py"

docker logs redis

docker logs dbscanserving

docker logs opticalattackdetector



echo

echo "Coverage report:"

echo "----------------"

docker exec -i opticalattackdetector bash -c "coverage report --include='opticalattackdetector/*' --sort cover --show-missing --skip-covered"



echo

echo "Post-test clean-up:"

echo "-------------------"

docker rm -f redis opticalattackdetector dbscanserving

docker network rm tfs_br



echo "Done!"

src/bgpls_speaker/.gitlab-ci.yml

+39 −39
Original line number Diff line number Diff line
@@ -38,45 +38,45 @@ build bgpls_speaker: 
      - manifests/${IMAGE_NAME}service.yaml

      - .gitlab-ci.yml



# Apply unit test to the component

unit_test bgpls_speaker:

  variables:

    IMAGE_NAME: 'bgpls_speaker' # name of the microservice

    IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)

  stage: unit_test

  needs:

    - build bgpls_speaker

  before_script:

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

    - if docker network list | grep teraflowbridge; then echo "teraflowbridge is already created"; else docker network create --driver=bridge teraflowbridge; fi

    - if docker container ls | grep $IMAGE_NAME; then docker rm -f $IMAGE_NAME; else echo "$IMAGE_NAME image is not in the system"; fi

  script:

    - docker pull "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"

    - docker run --name $IMAGE_NAME -d -p 20030:20030  -v "$PWD/src/$IMAGE_NAME/tests:/opt/results" --network=teraflowbridge $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

    - sleep 5

    - docker ps -a

    - docker logs $IMAGE_NAME

    - docker exec -i $IMAGE_NAME bash -c "coverage run -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_unitary.py --junitxml=/opt/results/${IMAGE_NAME}_report.xml"

    - docker exec -i $IMAGE_NAME bash -c "coverage report --include='${IMAGE_NAME}/*' --show-missing"

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

  after_script:

    - docker rm -f $IMAGE_NAME

    - docker network rm teraflowbridge

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

      - src/$IMAGE_NAME/Dockerfile

      - src/$IMAGE_NAME/tests/*.py

      - manifests/${IMAGE_NAME}service.yaml

      - .gitlab-ci.yml

  artifacts:

      when: always

      reports:

        junit: src/$IMAGE_NAME/tests/${IMAGE_NAME}_report.xml

## Apply unit test to the component

#unit_test bgpls_speaker:

#  variables:

#    IMAGE_NAME: 'bgpls_speaker' # name of the microservice

#    IMAGE_TAG: 'latest' # tag of the container image (production, development, etc)

#  stage: unit_test

#  needs:

#    - build bgpls_speaker

#  before_script:

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

#    - if docker network list | grep teraflowbridge; then echo "teraflowbridge is already created"; else docker network create --driver=bridge teraflowbridge; fi

#    - if docker container ls | grep $IMAGE_NAME; then docker rm -f $IMAGE_NAME; else echo "$IMAGE_NAME image is not in the system"; fi

#  script:

#    - docker pull "$CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG"

#    - docker run --name $IMAGE_NAME -d -p 20030:20030  -v "$PWD/src/$IMAGE_NAME/tests:/opt/results" --network=teraflowbridge $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

#    - sleep 5

#    - docker ps -a

#    - docker logs $IMAGE_NAME

#    - docker exec -i $IMAGE_NAME bash -c "coverage run -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_unitary.py --junitxml=/opt/results/${IMAGE_NAME}_report.xml"

#    - docker exec -i $IMAGE_NAME bash -c "coverage report --include='${IMAGE_NAME}/*' --show-missing"

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

#  after_script:

#    - docker rm -f $IMAGE_NAME

#    - docker network rm teraflowbridge

#  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/$IMAGE_NAME/**/*.{py,in,yml}

#      - src/$IMAGE_NAME/Dockerfile

#      - src/$IMAGE_NAME/tests/*.py

#      - manifests/${IMAGE_NAME}service.yaml

#      - .gitlab-ci.yml

#  artifacts:

#      when: always

#      reports:

#        junit: src/$IMAGE_NAME/tests/${IMAGE_NAME}_report.xml



## Deployment of the service in Kubernetes Cluster

#deploy bgpls_speaker:

src/device/Config.py

+6 −0
Original line number Diff line number Diff line
@@ -12,3 +12,9 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.





import os



TRUE_VALUES = {'T', 'TRUE', 'YES', '1'}

DEVICE_EMULATED_ONLY = os.environ.get('DEVICE_EMULATED_ONLY')

LOAD_ALL_DEVICE_DRIVERS = (DEVICE_EMULATED_ONLY is None) or (DEVICE_EMULATED_ONLY.upper() not in TRUE_VALUES)

src/device/service/DeviceService.py

+7 −3
Original line number Diff line number Diff line
@@ -12,15 +12,17 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



import os

from common.Constants import ServiceNameEnum

from common.Settings import get_service_port_grpc

from common.proto.device_pb2_grpc import add_DeviceServiceServicer_to_server

from common.proto.openconfig_device_pb2_grpc import add_OpenConfigServiceServicer_to_server

from common.tools.service.GenericGrpcService import GenericGrpcService

from device.Config import LOAD_ALL_DEVICE_DRIVERS

from .driver_api.DriverInstanceCache import DriverInstanceCache

from .DeviceServiceServicerImpl import DeviceServiceServicerImpl

from .monitoring.MonitoringLoops import MonitoringLoops

from .OpenConfigServicer import OpenConfigServicer

from common.proto.openconfig_device_pb2_grpc import add_OpenConfigServiceServicer_to_server



# Custom gRPC settings

# Multiple clients might keep connections alive waiting for RPC methods to be executed.
@@ -33,11 +35,13 @@ class DeviceService(GenericGrpcService): 
        super().__init__(port, max_workers=GRPC_MAX_WORKERS, cls_name=cls_name)

        self.monitoring_loops = MonitoringLoops()

        self.device_servicer = DeviceServiceServicerImpl(driver_instance_cache, self.monitoring_loops)

        if LOAD_ALL_DEVICE_DRIVERS:

            self.openconfig_device_servicer = OpenConfigServicer(driver_instance_cache,self.monitoring_loops)



    def install_servicers(self):

        self.monitoring_loops.start()

        add_DeviceServiceServicer_to_server(self.device_servicer, self.server)

        if LOAD_ALL_DEVICE_DRIVERS:

            add_OpenConfigServiceServicer_to_server(self.openconfig_device_servicer,self.server)



    def stop(self):

src/device/service/DeviceServiceServicerImpl.py

+0 −1
Original line number Diff line number Diff line
@@ -31,7 +31,6 @@ from context.client.ContextClient import ContextClient 
from .driver_api._Driver import _Driver

from .driver_api.DriverInstanceCache import DriverInstanceCache, get_driver

from .monitoring.MonitoringLoops import MonitoringLoops

from .drivers.oc_driver.OCDriver import OCDriver

from .ErrorMessages import ERROR_MISSING_DRIVER, ERROR_MISSING_KPI

from .Tools import (

    check_connect_rules, check_no_endpoints, compute_rules_to_add_delete, configure_rules, deconfigure_rules,