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 all 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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
### v0.4.1
- fix: Session added as optional parameter to enable tls communication with clients ([#249](https://github.com/RWTH-EBC/FiLiP/pull/249))

#### v0.4.0
- add tutorial for protected endpoint with bearer authentication ([#208](https://github.com/RWTH-EBC/FiLiP/issues/208))
- add internal mqtt url for unittests @djs0109 ([#239](https://github.com/RWTH-EBC/FiLiP/pull/239))
Expand Down
90 changes: 69 additions & 21 deletions filip/utils/cleanup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,13 @@
QuantumLeapClient


def clear_context_broker(url: str, fiware_header: FiwareHeader):
def clear_context_broker(url: str = None,
fiware_header: FiwareHeader = None,
cb_client: ContextBrokerClient = None):
"""
Function deletes all entities, registrations and subscriptions for a
given fiware header
given fiware header. To use TLS connection you need to provide the cb_client parameter
as an argument with the Session object including the certificate and private key.

Note:
Always clear the devices first because the IoT-Agent will otherwise
Expand All @@ -25,12 +28,18 @@ def clear_context_broker(url: str, fiware_header: FiwareHeader):
Args:
url: Url of the context broker service
fiware_header: header of the tenant
cb_client: enables TLS communication if created with Session object, only needed for self-signed certificates

Returns:
None
"""
assert url or cb_client, "Either url or client object must be given"
# create client
client = ContextBrokerClient(url=url, fiware_header=fiware_header)
if cb_client is None:
client = ContextBrokerClient(url=url, fiware_header=fiware_header)
else:
client = cb_client

# clean entities
client.delete_entities(entities=client.get_entity_list())

Expand All @@ -45,20 +54,28 @@ 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] = None,
fiware_header: FiwareHeader = None,
iota_client: IoTAClient = None):
"""
Function deletes all device groups and devices for a
given fiware header
given fiware header. To use TLS connection you need to provide the iota_client parameter
as an argument with the Session object including the certificate and private key.

Args:
url: Url of the context broker service
fiware_header: header of the tenant
iota_client: enables TLS communication if created with Session object, only needed for self-signed certificates

Returns:
None
"""
assert url or iota_client, "Either url or client object must be given"
# create client
client = IoTAClient(url=url, fiware_header=fiware_header)
if iota_client is None:
client = IoTAClient(url=url, fiware_header=fiware_header)
else:
client = iota_client

# clear registrations
for device in client.get_device_list():
Expand All @@ -72,12 +89,16 @@ 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 = None,
fiware_header: FiwareHeader = None,
ql_client: QuantumLeapClient = None):
"""
Function deletes all data for a given fiware header
Function deletes all data for a given fiware header. To use TLS connection you need to provide the ql_client parameter
as an argument with the Session object including the certificate and private key.
Args:
url: Url of the quantumleap service
fiware_header: header of the tenant
ql_client: enables TLS communication if created with Session object, only needed for self-signed certificates

Returns:
None
Expand All @@ -96,8 +117,12 @@ def handle_emtpy_db_exception(err: RequestException) -> None:
pass
else:
raise
assert url or ql_client, "Either url or client object must be given"
# create client
client = QuantumLeapClient(url=url, fiware_header=fiware_header)
if ql_client is None:
client = QuantumLeapClient(url=url, fiware_header=fiware_header)
else:
client = ql_client

# clear data
entities = []
Expand All @@ -113,10 +138,13 @@ def handle_emtpy_db_exception(err: RequestException) -> None:


def clear_all(*,
fiware_header: FiwareHeader,
fiware_header: FiwareHeader = None,
cb_url: str = None,
iota_url: Union[str, List[str]] = None,
ql_url: str = None):
ql_url: str = None,
cb_client: ContextBrokerClient = None,
iota_client: IoTAClient = None,
ql_client: QuantumLeapClient = None):
"""
Clears all services that a url is provided for

Expand All @@ -125,27 +153,38 @@ 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
cb_client: enables TLS communication if created with Session object, only needed
for self-signed certificates
iota_client: enables TLS communication if created with Session object, only needed
for self-signed certificates
ql_client: enables TLS communication if created with Session object, only needed
for self-signed certificates

Returns:
None
"""
if iota_url is not None:
if iota_url is not None or iota_client is not None:
if isinstance(iota_url, (str, AnyUrl)):
iota_url = [iota_url]
for url in iota_url:
clear_iot_agent(url=url, fiware_header=fiware_header)
if cb_url is not None:
clear_context_broker(url=cb_url, fiware_header=fiware_header)
if ql_url is not None:
clear_quantumleap(url=ql_url, fiware_header=fiware_header)
clear_iot_agent(url=url, fiware_header=fiware_header, iota_client=iota_client)

if cb_url is not None or cb_client is not None:
clear_context_broker(url=cb_url, fiware_header=fiware_header, cb_client=cb_client)

if ql_url is not None or ql_client is not None:
clear_quantumleap(url=ql_url, fiware_header=fiware_header, ql_client=ql_client)


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,
cb_client: ContextBrokerClient = None,
iota_client: IoTAClient = None,
ql_client: QuantumLeapClient = None) -> Callable:
"""
Decorator to clean up the server before and after the test

Expand All @@ -161,6 +200,9 @@ def clean_test(*,
cb_url: url of context broker service
iota_url: url of IoT-Agent service
ql_url: url of quantumleap service
cb_client: enables TLS communication if created with Session object, only needed for self-signed certificates
iota_client: enables TLS communication if created with Session object, only needed for self-signed certificates
ql_client: enables TLS communication if created with Session object, only needed for self-signed certificates

Returns:
Decorator for clean tests
Expand All @@ -170,7 +212,10 @@ 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,
cb_client=cb_client,
iota_client=iota_client,
ql_client=ql_client)
# Inner decorator function
def decorator(func):
# Wrapper function for the decorated function
Expand All @@ -182,6 +227,9 @@ 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,
cb_client=cb_client,
iota_client=iota_client,
ql_client=ql_client)

return decorator
return decorator