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

Adapted WebUI to common proto folder 

- Moved imports from *.proto folder to common.proto folder
- Removed webui's genproto.sh script
- Minor code and linting fixing
- Arranged requirements to accelerate Docker image creation
- Updated Dockerfile
- Arranged GitLab CI/CD pipeline
- Corrected usage of ConfigRules to use new custom ConfigRules
- Moved config variables to new config framework
- Removed unneeded Config variables
parent c8a36551

manifests/webuiservice.yaml

+2 −0
Original line number Diff line number Diff line
@@ -39,6 +39,8 @@ spec: 
        env:

        - name: LOG_LEVEL

          value: "DEBUG"

        - name: WEBUISERVICE_SERVICE_BASEURL_HTTP

          value: "/webui"

        readinessProbe:

          httpGet:

            path: /healthz/ready

src/common/Constants.py

+3 −0
Original line number Diff line number Diff line
@@ -47,6 +47,7 @@ class ServiceNameEnum(Enum): 
    CYBERSECURITY = 'cybersecurity'

    INTERDOMAIN   = 'interdomain'

    PATHCOMP      = 'pathcomp'

    WEBUI         = 'webui'



# Default gRPC service ports

DEFAULT_SERVICE_GRPC_PORTS = {
@@ -68,10 +69,12 @@ DEFAULT_SERVICE_GRPC_PORTS = { 
DEFAULT_SERVICE_HTTP_PORTS = {

    ServiceNameEnum.CONTEXT   .value : 8080,

    ServiceNameEnum.COMPUTE   .value : 8080,

    ServiceNameEnum.WEBUI     .value : 8004,

}



# Default HTTP/REST-API service base URLs

DEFAULT_SERVICE_HTTP_BASEURLS = {

    ServiceNameEnum.CONTEXT   .value : '/api',

    ServiceNameEnum.COMPUTE   .value : '/restconf/data',

    ServiceNameEnum.WEBUI     .value : None,

}

src/webui/.gitlab-ci.yml

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

# limitations under the License.



# build, tag and push the Docker image to the gitlab registry

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

build webui:

  variables:

    IMAGE_NAME: 'webui' # name of the microservice
@@ -21,7 +21,7 @@ build webui: 
  before_script:

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

  script:

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

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

  after_script:
@@ -30,14 +30,15 @@ build webui: 
    - 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

      - src/$IMAGE_NAME/tests/Dockerfile

      - manifests/${IMAGE_NAME}service.yaml

      - .gitlab-ci.yml



# apply unit test to the webui component

# Apply unit test to the component

unit test webui:

  variables:

    IMAGE_NAME: 'webui' # name of the microservice
@@ -51,11 +52,11 @@ unit test webui: 
    - 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 8004:8004 -v "$PWD/src/$IMAGE_NAME/tests:/opt/results" --network=teraflowbridge  --rm $CI_REGISTRY_IMAGE/$IMAGE_NAME:$IMAGE_TAG

    - docker run --name $IMAGE_NAME -d -p 8004:8004 -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 --user root -i $IMAGE_NAME bash -c "coverage run -m pytest --log-level=DEBUG --verbose ${IMAGE_NAME}/tests/test_unitary.py --junitxml=/opt/results/${IMAGE_NAME}_report.xml"

    - docker exec --user root -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 --user root -i $IMAGE_NAME bash -c "coverage report --include='${IMAGE_NAME}/*' --show-missing"

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

  after_script:
@@ -65,6 +66,8 @@ unit test webui: 
    - 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
@@ -76,7 +79,7 @@ unit test webui: 
      reports:

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



# Deployment of the webui service in Kubernetes Cluster

# Deployment of the service in Kubernetes Cluster

deploy webui:

  variables:

    IMAGE_NAME: 'webui' # name of the microservice

src/webui/Config.py

+2 −25
Original line number Diff line number Diff line
@@ -12,30 +12,7 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



import os

import logging



# General settings

LOG_LEVEL = logging.DEBUG



# gRPC settings

WEBUI_SERVICE_PORT = 8004



# Prometheus settings

METRICS_PORT = 9192



HOST = '0.0.0.0'  # accepts connections coming from any address

DEBUG = False

SECRET_KEY = '>s&}24@{]]#k3&^5$f3#?6?h3{W@[}/7z}2pa]>{3&5%RP<)[('

MAX_CONTENT_LENGTH = 1024*1024
 


HOST = '0.0.0.0'  # accepts connections coming from any ADDRESS



DEBUG=False



CONTEXT_SERVICE_ADDRESS = os.environ.get('CONTEXTSERVICE_SERVICE_HOST', 'contextservice')

CONTEXT_SERVICE_PORT = int(os.environ.get('CONTEXTSERVICE_SERVICE_PORT_GRPC', 1010))



DEVICE_SERVICE_ADDRESS = os.environ.get('DEVICESERVICE_SERVICE_HOST', 'deviceservice')

DEVICE_SERVICE_PORT = int(os.environ.get('DEVICESERVICE_SERVICE_PORT_GRPC', 2020))



SERVICE_SERVICE_ADDRESS = os.environ.get('SERVICESERVICE_SERVICE_HOST', 'serviceservice')

SERVICE_SERVICE_PORT = int(os.environ.get('SERVICESERVICE_SERVICE_PORT_GRPC', 3030))

src/webui/genproto.sh

deleted100755 → 0
+0 −59
Original line number Diff line number Diff line 
#!/bin/bash -eu

#

# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

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



# Make folder containing the script the root folder for its execution

cd $(dirname $0)



rm -rf proto/*.py

rm -rf proto/__pycache__

tee proto/__init__.py << EOF > /dev/null

# Copyright 2021-2023 H2020 TeraFlow (https://www.teraflow-h2020.eu/)

#

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



EOF



# building protos of services used

# python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto compute.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto context.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto device.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto service.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto monitoring.proto

python -m grpc_tools.protoc -I../../proto --python_out=proto --grpc_python_out=proto kpi_sample_types.proto



# rm proto/compute_pb2_grpc.py

rm proto/context_pb2_grpc.py

rm proto/device_pb2_grpc.py

rm proto/service_pb2_grpc.py

rm proto/monitoring_pb2_grpc.py

rm proto/kpi_sample_types_pb2_grpc.py



# sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/compute_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/context_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/device_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/service_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/monitoring_pb2.py

sed -i -E 's/(import\ .*)_pb2/from . \1_pb2/g' proto/kpi_sample_types_pb2.py