Commit 7f1c6dff authored by Lluis Gifre Renom's avatar Lluis Gifre Renom
Browse files

Adapted Service to common proto folder 

- Moved imports from *.proto folder to common.proto folder
- Removed service'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
- Removed redundant/unused Tools file in service_handlers
parent 4b61052e

src/service/.gitlab-ci.yml

+5 −1
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ build service: 
  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,6 +30,8 @@ build service: 
    - 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
@@ -64,6 +66,8 @@ unit test service: 
    - 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/service/Dockerfile

+34 −16
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.



FROM python:3-slim

FROM python:3.9-slim



# Install dependencies

RUN apt-get --yes --quiet --quiet update && \
@@ -28,25 +28,43 @@ 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/service

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



# Get Python packages per module

COPY service/requirements.in service/requirements.in

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

RUN python3 -m pip install -r service/requirements.txt

# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/service

WORKDIR /var/teraflow/service

COPY src/service/requirements.in requirements.in

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

RUN python3 -m pip install -r requirements.txt



# Add files into working directory

COPY common/. common

COPY context/. context

COPY device/. device

COPY monitoring/. monitoring

COPY service/. service

# Add component files into working directory

WORKDIR /var/teraflow

COPY src/context/. context/

COPY src/device/. device/

COPY src/service/. service/



# Start service service

# Start the service

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

src/service/client/ServiceClient.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, Service, ServiceId

from common.proto.service_pb2_grpc import ServiceServiceStub

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

from common.tools.grpc.Tools import grpc_message_to_json_string

from service.proto.context_pb2 import Empty, Service, ServiceId

from service.proto.service_pb2_grpc import ServiceServiceStub



LOGGER = logging.getLogger(__name__)

MAX_RETRIES = 15

src/service/genproto.sh

deleted100755 → 0
+0 −49
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 service.proto

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



rm proto/context_pb2_grpc.py

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

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

src/service/proto/__init__.py

deleted100644 → 0
+0 −14
Original line number Diff line number Diff line 
# 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.