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

Merge branch 'develop' of ssh://gifrerenom_labs.etsi.org/tfs/controller into... 

Merge branch 'develop' of ssh://gifrerenom_labs.etsi.org/tfs/controller into feat/292-cttc-implement-integration-test-for-ryu-openflow
parents b2e882ec c0eb5377

.gitlab-ci.yml

+1 −0
Original line number Diff line number Diff line
@@ -61,6 +61,7 @@ include: 
#  - local: '/src/vnt_manager/.gitlab-ci.yml'

#  - local: '/src/e2e_orchestrator/.gitlab-ci.yml'

#  - local: '/src/ztp_server/.gitlab-ci.yml'

#  - local: '/src/osm_client/.gitlab-ci.yml'



  # This should be last one: end-to-end integration tests

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

src/osm_client/.gitlab-ci.yml

0 → 100644
+116 −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 osm_client:

  variables:

    IMAGE_NAME: 'osm_client' # name of the microservice

    MOCK_IMAGE_NAME: 'mock_osm_nbi' # name of the mock 

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

  stage: build

  before_script:

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

  script:

    - docker buildx build -t "$IMAGE_NAME:$IMAGE_TAG" -f ./src/$IMAGE_NAME/Dockerfile .

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

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

    # Build mock images

    - docker buildx build -t "$MOCK_IMAGE_NAME:$IMAGE_TAG" -f ./src/tests/tools/$MOCK_IMAGE_NAME/Dockerfile .

    - docker tag "$MOCK_IMAGE_NAME:$IMAGE_TAG" "$CI_REGISTRY_IMAGE/$MOCK_IMAGE_NAME:$IMAGE_TAG"

    - docker push "$CI_REGISTRY_IMAGE/$MOCK_IMAGE_NAME:$IMAGE_TAG"

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

      - src/$IMAGE_NAME/Dockerfile

      - src/$IMAGE_NAME/tests/*.py

      - manifests/${IMAGE_NAME}service.yaml

      - src/tests/tools/$MOCK_IMAGE_NAME/**/*.{py,in,yml}

      - src/tests/tools/$MOCK_IMAGE_NAME/Dockerfile

      - .gitlab-ci.yml



# Apply unit test to the component

unit_test osm_client:

  variables:

    IMAGE_NAME: 'osm_client' # name of the microservice

    MOCK_IMAGE_NAME: 'mock_osm_nbi'

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

  stage: unit_test

  needs:

    - build osm_client

  before_script:

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

    - docker ps -aq | xargs -r docker rm -f

    - >

      if docker network list | grep teraflowbridge; then

        echo "teraflowbridge is already created";

      else

        docker network create -d 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

    - docker container prune -f

  script:

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

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

    - >

      docker run --name $IMAGE_NAME -d -v "$PWD/src/$IMAGE_NAME/tests:/opt/results" 

      --network=teraflowbridge

      --env LOG_LEVEL=DEBUG

      --env FLASK_ENV=development

      --env OSM_ADDRESS=mock_osm_nbi

      $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

    - >

      docker run --name $MOCK_IMAGE_NAME -d 

      --network=teraflowbridge

      --env LOG_LEVEL=DEBUG

      --env FLASK_ENV=development

      $CI_REGISTRY_IMAGE/$MOCK_IMAGE_NAME:$IMAGE_TAG

    - while ! docker logs $IMAGE_NAME 2>&1 | grep -q 'Configured Rules'; do sleep 1; done

    - sleep 5 # Give extra time to container to get ready

    - docker ps -a

    - docker logs $IMAGE_NAME

    - docker logs $MOCK_IMAGE_NAME

    - docker exec -i $IMAGE_NAME bash -c "coverage run --append -m pytest --log-level=INFO --verbose $IMAGE_NAME/tests/test_unitary.py --junitxml=/opt/results/${IMAGE_NAME}_report_unitary.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 logs $IMAGE_NAME

    - docker rm -f $IMAGE_NAME

    - docker rm -f $MOCK_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

src/osm_client/Dockerfile

+1 −1
Original line number Diff line number Diff line
@@ -18,7 +18,7 @@ FROM python:3.10.16-slim 
# Install dependencies

RUN apt-get --yes --quiet --quiet update

RUN apt-get --yes --quiet --quiet install wget g++ git build-essential cmake make git \

    libpcre2-dev python3-dev python3-pip python3-cffi curl software-properties-common && \

    libpcre2-dev python3-dev python3-pip python3-cffi curl software-properties-common libmagic1 libmagic-dev && \

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



# Set Python to show logs as they occur

src/osm_client/tests/PrepareTestScenario.py

0 → 100644
+43 −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.



import pytest, os



from common.Settings import (

    ENVVAR_SUFIX_SERVICE_HOST, ENVVAR_SUFIX_SERVICE_PORT_GRPC,

    ENVVAR_SUFIX_SERVICE_PORT_HTTP, get_env_var_name, get_service_port_grpc

)



from common.Constants import ServiceNameEnum

from osm_client.client.OsmClient import OsmClient

from osm_client.service.OsmClientService import OsmClientService



LOCAL_HOST = '127.0.0.1'

GRPC_PORT = 10000 + int(get_service_port_grpc(ServiceNameEnum.OSMCLIENT))



os.environ[get_env_var_name(ServiceNameEnum.OSMCLIENT, ENVVAR_SUFIX_SERVICE_HOST     )] = str(LOCAL_HOST)

os.environ[get_env_var_name(ServiceNameEnum.OSMCLIENT, ENVVAR_SUFIX_SERVICE_PORT_HTTP)] = str(GRPC_PORT)



@pytest.fixture(scope='session')

def osm_client_service(): # pylint: disable=redefined-outer-name

    _service = OsmClientService()

    _service.start()

    yield _service

    _service.stop()



@pytest.fixture(scope='session')

def osm_client(osm_client_service : OsmClientService):    # pylint: disable=redefined-outer-name

    _client = OsmClient()

    yield _client

    _client.close()

src/osm_client/tests/__init__.py

0 → 100644
+14 −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.