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

Adapted Slice to common proto folder 

- Moved imports from *.proto folder to common.proto folder
- Removed slice's genproto.sh script
- Minor code and linting fixing
- Arranged requirements to accelerate Docker image creation
- Updated Dockerfile
- Arranged GitLab CI/CD pipeline
parent 226d1087

src/slice/.gitlab-ci.yml

+52 −20
Original line number Diff line number Diff line
@@ -12,29 +12,36 @@ 
# See the License for the specific language governing permissions and

# limitations under the License.



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

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

build slice:

  variables:

    IMAGE_NAME: 'slice' # name of the microservice

    IMAGE_NAME_TEST: 'slice-test' # name of the microservice

    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 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:

    - 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/$IMAGE_NAME/**

      - 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



# Pull, execute, and run unitary tests for the Docker image from the GitLab registry

unit_test slice:

# Apply unit test to the component

unit test slice:

  variables:

    IMAGE_NAME: 'slice' # name of the microservice

    IMAGE_NAME_TEST: 'slice-test' # name of the microservice

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

  stage: unit_test

  needs:
@@ -42,33 +49,58 @@ unit_test slice: 
  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 -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

  script:

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

    - docker run -d -p 4040:4040 --name $IMAGE_NAME --network=teraflowbridge "$IMAGE_NAME:$IMAGE_TAG"

    - docker ps -a

    - docker run --name $IMAGE_NAME -d -p 4040:4040  -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 "pytest --log-level=DEBUG --verbose $IMAGE_NAME/tests/test_unitary.py"

    - 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 stop $IMAGE_NAME

    - docker rm $IMAGE_NAME

    - 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/$IMAGE_NAME/**

      - 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

  artifacts:

      when: always

      reports:

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



# Deployment of the service in Kubernetes Cluster

deploy slice:

  variables:

    IMAGE_NAME: 'slice' # name of the microservice

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

  stage: deploy

  needs:

    - build slice

    - unit_test slice

    - dependencies all

    - integ_test execute

    - unit test slice

    # - integ_test execute

  script:

    - 'sed -i "s/$IMAGE_NAME:.*/$IMAGE_NAME:$IMAGE_TAG/" manifests/${IMAGE_NAME}service.yaml'

    - kubectl version

    - kubectl get all

    - kubectl apply -f "manifests/sliceservice.yaml"

    - kubectl delete pods --selector app=sliceservice

    - kubectl apply -f "manifests/${IMAGE_NAME}service.yaml"

    - kubectl get all

  # environment:

  #   name: test

  #   url: https://example.com

  #   kubernetes:

  #     namespace: test

  rules:

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

      when: manual    

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

      when: manual

src/slice/Dockerfile

+49 −16
Original line number Diff line number Diff line 
FROM python:3-slim

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



FROM python:3.9-slim



# Install dependencies

RUN apt-get --yes --quiet --quiet update && \
@@ -14,25 +28,44 @@ RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \ 
    chmod +x /bin/grpc_health_probe



# Get generic Python packages

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

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

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



# Set working directory

# 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



# Create module sub-folders

RUN mkdir -p /var/teraflow/slice

# Add common files into working directory

WORKDIR /var/teraflow/common

COPY src/common/. ./

RUN rm -rf proto



# Get Python packages per module

COPY slice/requirements.in slice/requirements.in

RUN pip-compile --output-file=slice/requirements.txt slice/requirements.in

RUN python3 -m pip install -r slice/requirements.in

# 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' {} \;



# Add files into working directory

COPY common/. common

COPY context/. context

COPY interdomain/. interdomain

COPY service/. service

COPY slice/. slice

# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/slice

WORKDIR /var/teraflow/slice

COPY src/slice/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/context/. context/

COPY src/interdomain/. interdomain/

COPY src/service/. service/

COPY src/slice/. slice/



# Start slice service

# Start the service

ENTRYPOINT ["python", "-m", "slice.service"]

src/slice/client/SliceClient.py

+2 −2
Original line number Diff line number Diff line
@@ -15,10 +15,10 @@ 
import grpc, logging

from common.Constants import ServiceNameEnum

from common.Settings import get_service_host, get_service_port_grpc

from common.proto.context_pb2 import Empty, Slice, SliceId

from common.proto.slice_pb2_grpc import SliceServiceStub

from common.tools.client.RetryDecorator import retry, delay_exponential

from common.tools.grpc.Tools import grpc_message_to_json_string

from slice.proto.context_pb2 import Empty, Slice, SliceId

from slice.proto.slice_pb2_grpc import SliceServiceStub



LOGGER = logging.getLogger(__name__)

MAX_RETRIES = 15

src/slice/genproto.sh

deleted100755 → 0
+0 −52
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



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 kpi_sample_types.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 slice.proto



rm proto/context_pb2_grpc.py

rm proto/kpi_sample_types_pb2_grpc.py

rm proto/service_pb2_grpc.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/service_pb2.py

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

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

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

src/slice/old_code/ConstraintsChecker.py

+1 −1
Original line number Diff line number Diff line
@@ -16,7 +16,7 @@ import grpc, logging 
from typing import Dict, List, Set, Tuple

from common.Checkers import chk_string

from common.exceptions.ServiceException import ServiceException

from service.proto.context_pb2 import Constraint

from common.proto.context_pb2 import Constraint



def check_constraint(

    logger : logging.Logger, constraint_number : int, parent_name : str, constraint : Constraint,