Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Session added as optional parameter to enable tls communication … #249

Merged
merged 6 commits into from
Apr 17, 2024
Merged

fix: Session added as optional parameter to enable tls communication … #249

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
4851bf2
fix: Session added as optional parameter to enable tls communication …
mwr-ebc Feb 21, 2024
0d4f3a6
Update CHANGELOG.md
mwr-ebc Feb 21, 2024
f21b8c0
fix: Session deleted as optional parameter. clients added instead to …
mwr-ebc Apr 3, 2024
e9194a9
Merge remote-tracking branch 'origin/248-support-tls-connection-possi…
mwr-ebc Apr 3, 2024
777b717
chore: make url as not required
djs0109 Apr 16, 2024
fd92497
Merge branch 'master' into 248-support-tls-connection-possibility-in-…
djs0109 Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
- update pandas version to `~=2.1.4` for `python>=3.9` ([#231](https://github.com/RWTH-EBC/FiLiP/pull/231))
- fix: wrong msg in iotac post device ([#214](https://github.com/RWTH-EBC/FiLiP/pull/214))
- add function to override the existing entity ([#232 ](https://github.com/RWTH-EBC/FiLiP/pull/232 ))
- fix: Session added as optional parameter to enable tls communication with clients ([#249](https://github.com/RWTH-EBC/FiLiP/pull/249))

#### v0.3.0
- fix: bug in typePattern validation @richardmarston ([#180](https://github.com/RWTH-EBC/FiLiP/pull/180))
Expand Down
36 changes: 23 additions & 13 deletions filip/utils/cleanup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@
ContextBrokerClient, \
IoTAClient, \
QuantumLeapClient
from requests import Session


def clear_context_broker(url: str, fiware_header: FiwareHeader):
def clear_context_broker(url: str, fiware_header: FiwareHeader, session: Session = None ):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of adding Session as a parameter, I will suggest to use cb_client: ContextBrokerClient = None. And then reuse the given client below. This can be beneficial for maintenance, because if later we add or fix something in the client class, then we don't need to change here again

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And maybe make url no more as required variable

"""
Function deletes all entities, registrations and subscriptions for a
given fiware header
Expand All @@ -25,12 +26,13 @@ def clear_context_broker(url: str, fiware_header: FiwareHeader):
Args:
url: Url of the context broker service
fiware_header: header of the tenant
session: session object with set ca.crt and ca.key for TLS support

Returns:
None
"""
# create client
client = ContextBrokerClient(url=url, fiware_header=fiware_header)
client = ContextBrokerClient(url=url, fiware_header=fiware_header, session=session)
# clean entities
client.delete_entities(entities=client.get_entity_list())

Expand All @@ -45,20 +47,21 @@ def clear_context_broker(url: str, fiware_header: FiwareHeader):
assert len(client.get_registration_list()) == 0


def clear_iot_agent(url: Union[str, AnyHttpUrl], fiware_header: FiwareHeader):
def clear_iot_agent(url: Union[str, AnyHttpUrl], fiware_header: FiwareHeader, session: Session = None):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, iota_client

"""
Function deletes all device groups and devices for a
given fiware header

Args:
url: Url of the context broker service
fiware_header: header of the tenant
session: session object with set ca.crt and ca.key for TLS support

Returns:
None
"""
# create client
client = IoTAClient(url=url, fiware_header=fiware_header)
client = IoTAClient(url=url, fiware_header=fiware_header, session=session)

# clear registrations
for device in client.get_device_list():
Expand All @@ -72,12 +75,13 @@ def clear_iot_agent(url: Union[str, AnyHttpUrl], fiware_header: FiwareHeader):
assert len(client.get_group_list()) == 0


def clear_quantumleap(url: str, fiware_header: FiwareHeader):
def clear_quantumleap(url: str, fiware_header: FiwareHeader, session: Session = None):
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, ql_client

"""
Function deletes all data for a given fiware header
Args:
url: Url of the quantumleap service
fiware_header: header of the tenant
session: session object with set ca.crt and ca.key for TLS support

Returns:
None
Expand All @@ -97,7 +101,7 @@ def handle_emtpy_db_exception(err: RequestException) -> None:
else:
raise
# create client
client = QuantumLeapClient(url=url, fiware_header=fiware_header)
client = QuantumLeapClient(url=url, fiware_header=fiware_header, session=session)

# clear data
entities = []
Expand All @@ -116,7 +120,8 @@ def clear_all(*,
fiware_header: FiwareHeader,
cb_url: str = None,
iota_url: Union[str, List[str]] = None,
ql_url: str = None):
ql_url: str = None,
session: Session = None):
"""
Clears all services that a url is provided for

Expand All @@ -125,6 +130,7 @@ def clear_all(*,
cb_url: url of the context broker service
iota_url: url of the IoT-Agent service
ql_url: url of the QuantumLeap service
session: session object with set ca.crt and ca.key for TLS support

Returns:
None
Expand All @@ -133,19 +139,20 @@ def clear_all(*,
if isinstance(iota_url, (str, AnyUrl)):
iota_url = [iota_url]
for url in iota_url:
clear_iot_agent(url=url, fiware_header=fiware_header)
clear_iot_agent(url=url, fiware_header=fiware_header, session=session)
if cb_url is not None:
clear_context_broker(url=cb_url, fiware_header=fiware_header)
clear_context_broker(url=cb_url, fiware_header=fiware_header, session=session)
if ql_url is not None:
clear_quantumleap(url=ql_url, fiware_header=fiware_header)
clear_quantumleap(url=ql_url, fiware_header=fiware_header, session=session)


def clean_test(*,
fiware_service: str,
fiware_servicepath: str,
cb_url: str = None,
iota_url: Union[str, List[str]] = None,
ql_url: str = None) -> Callable:
ql_url: str = None,
session: Session = None) -> Callable:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, three clients

"""
Decorator to clean up the server before and after the test

Expand All @@ -161,6 +168,7 @@ def clean_test(*,
cb_url: url of context broker service
iota_url: url of IoT-Agent service
ql_url: url of quantumleap service
session: session object with set ca.crt and ca.key for TLS support

Returns:
Decorator for clean tests
Expand All @@ -170,7 +178,8 @@ def clean_test(*,
clear_all(fiware_header=fiware_header,
cb_url=cb_url,
iota_url=iota_url,
ql_url=ql_url)
ql_url=ql_url,
session=session)
# Inner decorator function
def decorator(func):
# Wrapper function for the decorated function
Expand All @@ -182,6 +191,7 @@ def wrapper(*args, **kwargs):
clear_all(fiware_header=fiware_header,
cb_url=cb_url,
iota_url=iota_url,
ql_url=ql_url)
ql_url=ql_url,
session=session)

return decorator