Resolve "(CTTC) Implement NBI connector to interface with OSM Client"

Lluis Gifre Renomrequested to merge
feat/310-cttc-implement-nbi-connector-to-interface-with-osm-client into develop

Closes #310 (closed)

Merge request reports

manifests/nginx_ingress_http.yaml

+7 −0
Changes for manifests/nginx_ingress_http.yaml: 7 added lines, 0 removed lines.
Original line number Diff line number Diff line
@@ -113,3 +113,10 @@ spec: 
                name: nbiservice

                port:

                  number: 8080

          - path: /()(osm-api/.*)

            pathType: Prefix

            backend:

              service:

                name: nbiservice

                port:

                  number: 8080

manifests/osm_clientservice.yaml

+16 −6
Changes for manifests/osm_clientservice.yaml: 16 added lines, 6 removed lines.
Original line number Diff line number Diff line
@@ -15,16 +15,16 @@ 
apiVersion: apps/v1

kind: Deployment

metadata:

  name: osm_clientservice

  name: osm-clientservice

spec:

  selector:

    matchLabels:

      app: osm_clientservice

      app: osm-clientservice

  #replicas: 1

  template:

    metadata:

      labels:

        app: osm_clientservice

        app: osm-clientservice

    spec:

      terminationGracePeriodSeconds: 5

      containers:
@@ -37,6 +37,16 @@ spec: 
          env:

            - name: OSM_ADDRESS

              value: "127.0.0.1"

            - name: OSM_PORT

              value: "80"

            - name: OSM_USERNAME

              value: "admin"

            - name: OSM_PASSWORD

              value: "admin"

            - name: OSM_PROJECT

              value: "admin"

            - name: OSM_VERIFY_TLS

              value: "FALSE"

            - name: LOG_LEVEL

              value: "INFO"

          readinessProbe:
@@ -56,13 +66,13 @@ spec: 
apiVersion: v1

kind: Service

metadata:

  name: osm_clientservice

  name: osm-clientservice

  labels:

    app: osm_clientservice

    app: osm-clientservice

spec:

  type: ClusterIP

  selector:

    app: osm_clientservice

    app: osm-clientservice

  ports:

    - name: grpc

      protocol: TCP

scripts/run_tests_locally-osm-client.sh

0 → 100755
+74 −0
Changes for scripts/run_tests_locally-osm-client.sh: 74 added lines, 0 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash

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





# Pre-build Cleanup

docker ps --all --quiet | xargs --no-run-if-empty docker stop

docker container prune --force

docker ps --all --quiet | xargs --no-run-if-empty docker rm --force

docker image prune --force

docker network prune --force

docker volume prune --all --force

#docker buildx prune --force



# Build Docker images

docker buildx build -t "mock-osm-nbi:test" -f ./src/tests/tools/mock_osm_nbi/Dockerfile ./src/tests/tools/mock_osm_nbi

docker buildx build -t "osm_client:latest" -f ./src/osm_client/Dockerfile .



# Post-build Cleanup

docker image prune --force





# Deploy Mock OSM NBI and OSM Client

docker network create --driver bridge --subnet=172.254.251.0/24 --gateway=172.254.251.254 mock-osm-nbi-br



docker run --detach --name mock_osm_nbi --network=mock-osm-nbi-br --ip 172.254.251.10 --publish 80 --publish 443 \

  --env LOG_LEVEL=DEBUG --env FLASK_ENV=development \

  mock-osm-nbi:test



docker run --detach --name osm_client --network=mock-osm-nbi-br --ip 172.254.251.11 \

  --env LOG_LEVEL=DEBUG --env FLASK_ENV=development \

  --env OSM_ADDRESS=172.254.251.10 --env OSM_PORT=443 \

  osm_client:latest





# Post-deploy status

docker ps -a



while ! docker logs osm_client 2>&1 | grep -q 'Running...'; do sleep 1; done

docker logs osm_client

docker logs mock_osm_nbi





# Execute tests

docker exec -i osm_client bash -c "coverage run -m pytest --log-level=INFO --verbose osm_client/tests/test_unitary.py"

docker exec -i osm_client bash -c "coverage report --include='osm_client/*' --show-missing"





# Post-tests logs

docker logs osm_client

docker logs mock_osm_nbi





# Post-tests cleanup

docker ps --all --quiet | xargs --no-run-if-empty docker stop

docker container prune --force

docker ps --all --quiet | xargs --no-run-if-empty docker rm --force

docker image prune --force

docker network prune --force

docker volume prune --all --force

docker buildx prune --force



echo "Bye!"

scripts/show_logs_osm_client.sh

0 → 100755
+27 −0
Changes for scripts/show_logs_osm_client.sh: 27 added lines, 0 removed lines.
Original line number Diff line number Diff line 
#!/bin/bash

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



########################################################################################################################

# Define your deployment settings here

########################################################################################################################



# If not already set, set the name of the Kubernetes namespace to deploy to.

export TFS_K8S_NAMESPACE=${TFS_K8S_NAMESPACE:-"tfs"}



########################################################################################################################

# Automated steps start here

########################################################################################################################



kubectl --namespace $TFS_K8S_NAMESPACE logs deployment/osm-clientservice -c server

src/nbi/service/osm_nbi/Resources.py

0 → 100644
+69 −0
Changes for src/nbi/service/osm_nbi/Resources.py: 69 added lines, 0 removed lines.
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 logging

from flask.json import jsonify

from flask_restful import Resource, request

from common.proto.context_pb2 import Empty

from common.proto.osm_client_pb2 import CreateRequest, GetRequest, DeleteRequest

from common.tools.grpc.Tools import grpc_message_to_json

from osm_client.client.OsmClient import  OsmClient





LOGGER = logging.getLogger(__name__)





def format_grpc_to_json(grpc_reply):

    return jsonify(grpc_message_to_json(grpc_reply))





class _Resource(Resource):

    def __init__(self) -> None:

        super().__init__()

        self.osm_client = OsmClient()





class NS_Services(_Resource):

    def get(self):

        grpc_response = self.osm_client.NsiList(Empty())

        return format_grpc_to_json(grpc_response)



    def post(self):

        json_requests = request.get_json()

        req = CreateRequest(

            nst_name = json_requests.get('nst_name', ''),

            nsi_name = json_requests.get('nsi_name', ''),

            account  = json_requests.get('account',  ''),

            ssh_key  = json_requests.get('ssh_key',  ''),

            config   = json_requests.get('config',   ''),

        )

        grpc_response = self.osm_client.NsiCreate(req)

        return format_grpc_to_json(grpc_response)





class NS_Service(Resource):

    def __init__(self) -> None:

        super().__init__()

        self.osm_client = OsmClient()



    def get(self, ns_id : str):

        req = GetRequest(id=ns_id)

        resp = self.osm_client.NsiGet(req)

        return format_grpc_to_json(resp)



    def delete(self, ns_id : str):

        req = DeleteRequest(id=ns_id)

        resp = self.osm_client.NsiDelete(req)

        return format_grpc_to_json(resp)