8987687444

Committed 07 May 2024 03:01PM UTC coverage: 51.117% (+0.07%) from 51.046%

Build # 8987687444

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #264 from atlanticwave-sdx/add-list-connection-api

Add end point to list all connections

Run Details

293 of 541 branches covered (54.16%)

Branch coverage included in aggregate %.

19 of 32 new or added lines in 5 files covered. (59.38%)

1 existing line in 1 file now uncovered.

714 of 1429 relevant lines covered (49.97%)

2.0 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

78.85

/sdx_controller/controllers/connection_controller.py

import json
import logging

import connexion
from flask import current_app

from sdx_controller.handlers.connection_handler import ConnectionHandler
from sdx_controller.utils.db_utils import DbUtils

LOG_FORMAT = (
    "%(levelname) -10s %(asctime)s %(name) -30s %(funcName) "
    "-35s %(lineno) -5d: %(message)s"
)
logger = logging.getLogger(__name__)
logging.getLogger("pika").setLevel(logging.WARNING)
logger.setLevel(logging.DEBUG)

# Get DB connection and tables set up.
db_instance = DbUtils()
db_instance.initialize_db()
connection_handler = ConnectionHandler(db_instance)


def delete_connection(connection_id):
    """
    Delete connection order by ID.

    :param connection_id: ID of the connection that needs to be
        deleted
    :type connection_id: int

    :rtype: None
    """
    logger.info(
        f"Handling delete (connecton id: {connection_id}) "
        f"with te_manager: {current_app.te_manager}"
    )

    # # Looking up by UUID do not seem work yet.  Will address in
    # # https://github.com/atlanticwave-sdx/sdx-controller/issues/252.
    #
    # value = db_instance.read_from_db(f"{connection_id}")
    # print(f"value: {value}")
    # if not value:
    #     return "Not found", 404

    try:
        # TODO: pce's unreserve_vlan() method silently returns even if the
        # connection_id is not found.  This should in fact be an error.
        #
        # https://github.com/atlanticwave-sdx/pce/issues/180
        current_app.te_manager.unreserve_vlan(connection_id)
    except Exception as e:
        logger.info(f"Delete failed (connection id: {connection_id}): {e}")
        return "Failed, reason: {e}", 500

    return "OK", 200


def getconnection_by_id(connection_id):
    """
    Find connection by ID.

    :param connection_id: ID of connection that needs to be fetched
    :type connection_id: int

    :rtype: Connection
    """
    value = db_instance.read_from_db("connections", f"{connection_id}")
    if not value:
        return "Connection not found", 404
    return json.loads(value[connection_id])


def getconnections():  # noqa: E501
    """List all connections

    connection details # noqa: E501

    :rtype: Connection
    """
    values = db_instance.get_all_entries_in_collection("connections")
    if not values:
        return "No connection was found", 404
    return values


def place_connection(body):
    """
    Place an connection request from the SDX-Controller.

    :param body: order placed for creating a connection
    :type body: dict | bytes

    :rtype: Connection
    """
    logger.info(f"Placing connection: {body}")
    if not connexion.request.is_json:
        return "Request body must be JSON", 400

    body = connexion.request.get_json()
    logger.info(f"Gathered connexion JSON: {body}")

    logger.info("Placing connection. Saving to database.")

    connection_id = body["id"]

    db_instance.add_key_value_pair_to_db("connections", connection_id, json.dumps(body))
    logger.info("Saving to database complete.")

    logger.info(
        f"Handling request {connection_id} with te_manager: {current_app.te_manager}"
    )

    reason, code = connection_handler.place_connection(current_app.te_manager, body)
    logger.info(
        f"place_connection result: ID: {connection_id} reason='{reason}', code={code}"
    )

    response = {
        "connection_id": connection_id,
        "status": "OK" if code == 200 else "Failure",
        "reason": reason,
    }

    # # TODO: our response is supposed to be shaped just like request
    # # ('#/components/schemas/connection'), and in that case the below
    # # code would be a quick implementation.
    # #
    # # https://github.com/atlanticwave-sdx/sdx-controller/issues/251
    # response = body

    # response["id"] = connection_id
    # response["status"] = "success" if code == 200 else "failure"
    # response["reason"] = reason # `reason` is not present in schema though.

    return response, code

1	import json	4✔
2	import logging	4✔
3
4	import connexion	4✔
5	from flask import current_app	4✔
6
7	from sdx_controller.handlers.connection_handler import ConnectionHandler	4✔
8	from sdx_controller.utils.db_utils import DbUtils	4✔
9
10	LOG_FORMAT = (	4✔
11	"%(levelname) -10s %(asctime)s %(name) -30s %(funcName) "
12	"-35s %(lineno) -5d: %(message)s"
13	)
14	logger = logging.getLogger(__name__)	4✔
15	logging.getLogger("pika").setLevel(logging.WARNING)	4✔
16	logger.setLevel(logging.DEBUG)	4✔
17
18	# Get DB connection and tables set up.
19	db_instance = DbUtils()	4✔
20	db_instance.initialize_db()	4✔
21	connection_handler = ConnectionHandler(db_instance)	4✔
22
23
24	def delete_connection(connection_id):	4✔
25	"""
26	Delete connection order by ID.
27
28	:param connection_id: ID of the connection that needs to be
29	deleted
30	:type connection_id: int
31
32	:rtype: None
33	"""
34	logger.info(	4✔
35	f"Handling delete (connecton id: {connection_id}) "
36	f"with te_manager: {current_app.te_manager}"
37	)
38
39	# # Looking up by UUID do not seem work yet. Will address in
40	# # https://github.com/atlanticwave-sdx/sdx-controller/issues/252.
41	#
42	# value = db_instance.read_from_db(f"{connection_id}")
43	# print(f"value: {value}")
44	# if not value:
45	# return "Not found", 404
46
47	try:	4✔
48	# TODO: pce's unreserve_vlan() method silently returns even if the
49	# connection_id is not found. This should in fact be an error.
50	#
51	# https://github.com/atlanticwave-sdx/pce/issues/180
52	current_app.te_manager.unreserve_vlan(connection_id)	4✔
53	except Exception as e:	×
54	logger.info(f"Delete failed (connection id: {connection_id}): {e}")	×
55	return "Failed, reason: {e}", 500	×
56
57	return "OK", 200	4✔
58
59
60	def getconnection_by_id(connection_id):	4✔
61	"""
62	Find connection by ID.
63
64	:param connection_id: ID of connection that needs to be fetched
65	:type connection_id: int
66
67	:rtype: Connection
68	"""
69	value = db_instance.read_from_db("connections", f"{connection_id}")	4✔
70	if not value:	4✔
71	return "Connection not found", 404	4✔
72	return json.loads(value[connection_id])	4✔
73
74
75	def getconnections(): # noqa: E501	4✔
76	"""List all connections
77
78	connection details # noqa: E501
79
80	:rtype: Connection
81	"""
NEW 82	values = db_instance.get_all_entries_in_collection("connections")	×
NEW 83	if not values:	×
NEW 84	return "No connection was found", 404	×
NEW 85	return values	×
86
87
88	def place_connection(body):	4✔
89	"""
90	Place an connection request from the SDX-Controller.
91
92	:param body: order placed for creating a connection
93	:type body: dict \| bytes
94
95	:rtype: Connection
96	"""
97	logger.info(f"Placing connection: {body}")	4✔
98	if not connexion.request.is_json:	4✔
99	return "Request body must be JSON", 400	×
100
101	body = connexion.request.get_json()	4✔
102	logger.info(f"Gathered connexion JSON: {body}")	4✔
103
104	logger.info("Placing connection. Saving to database.")	4✔
105
106	connection_id = body["id"]	4✔
107
108	db_instance.add_key_value_pair_to_db("connections", connection_id, json.dumps(body))	4✔
109	logger.info("Saving to database complete.")	4✔
110
111	logger.info(	4✔
112	f"Handling request {connection_id} with te_manager: {current_app.te_manager}"
113	)
114
115	reason, code = connection_handler.place_connection(current_app.te_manager, body)	4✔
116	logger.info(	4✔
117	f"place_connection result: ID: {connection_id} reason='{reason}', code={code}"
118	)
119
120	response = {	4✔
121	"connection_id": connection_id,
122	"status": "OK" if code == 200 else "Failure",
123	"reason": reason,
124	}
125
126	# # TODO: our response is supposed to be shaped just like request
127	# # ('#/components/schemas/connection'), and in that case the below
128	# # code would be a quick implementation.
129	# #
130	# # https://github.com/atlanticwave-sdx/sdx-controller/issues/251
131	# response = body
132
133	# response["id"] = connection_id
134	# response["status"] = "success" if code == 200 else "failure"
135	# response["reason"] = reason # `reason` is not present in schema though.
136
137	return response, code	4✔

atlanticwave-sdx / sdx-controller / 8987687444

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous