Commit 485d3178 authored by Waleed Akbar's avatar Waleed Akbar
Browse files

Initial Version of Analytics Component 

- Added the Analytics Frontend client and service with no logic implemented yet.
- Added enums and ports for the Analytics frontend and backend in the constants.
- Added test files and messages.
- Added test execution scripts.
parent bf4dd447

scripts/run_tests_locally-analytics-frontend.sh

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

# Copyright 2022-2024 ETSI OSG/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.





PROJECTDIR=`pwd`



cd $PROJECTDIR/src



RCFILE=$PROJECTDIR/coverage/.coveragerc

python3 -m pytest --log-level=DEBUG --log-cli-level=DEBUG --verbose \

    analytics/frontend/tests/test_frontend.py

src/analytics/README.md

0 → 100644
+4 −0
Original line number Diff line number Diff line 
# How to locally run and test Analytic service (To be added soon)



### Pre-requisets 

The following requirements should be fulfilled before the execuation of Telemetry service.

src/analytics/__init__.py

0 → 100644
+15 −0
Original line number Diff line number Diff line 


# Copyright 2022-2024 ETSI OSG/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.

src/analytics/frontend/Dockerfile

0 → 100644
+70 −0
Original line number Diff line number Diff line 
# Copyright 2022-2024 ETSI OSG/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.



FROM python:3.9-slim



# Install dependencies

RUN apt-get --yes --quiet --quiet update && \

    apt-get --yes --quiet --quiet install wget g++ git && \

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



# Set Python to show logs as they occur

ENV PYTHONUNBUFFERED=0



# Download the gRPC health probe

RUN GRPC_HEALTH_PROBE_VERSION=v0.2.0 && \

    wget -qO/bin/grpc_health_probe https://github.com/grpc-ecosystem/grpc-health-probe/releases/download/${GRPC_HEALTH_PROBE_VERSION}/grpc_health_probe-linux-amd64 && \

    chmod +x /bin/grpc_health_probe



# Get generic Python packages

RUN python3 -m pip install --upgrade pip

RUN python3 -m pip install --upgrade setuptools wheel

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



# 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



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



# Create component sub-folders, get specific Python packages

RUN mkdir -p /var/teraflow/analytics/frontend

WORKDIR /var/analyticstelemetry/frontend

COPY src/analytics/frontend/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/analytics/__init__.py analytics/__init__.py

COPY src/analytics/frontend/. analytics/frontend/

COPY src/analytics/database/. analytics/database/



# Start the service

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

src/analytics/frontend/__init__.py

0 → 100644
+15 −0
Original line number Diff line number Diff line 


# Copyright 2022-2024 ETSI OSG/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.