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

tests: include more readable mqtt logs in Get Logs keyword #2410

Merged
merged 2 commits into from
Nov 6, 2023
Merged

tests: include more readable mqtt logs in Get Logs keyword #2410

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5de3b1
tests: include more readable mqtt logs in Get Logs keyword
reubenmiller Nov 3, 2023
98b5c91
handle any non utf8 payloads
reubenmiller Nov 6, 2023
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
21 changes: 19 additions & 2 deletions tests/RobotFramework/libraries/ThinEdgeIO/ThinEdgeIO.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,12 @@ def get_logs(
except Exception as ex: # pylint: disable=broad-except
log.warning("Failed to get device managed object. %s", ex)

# Log mqtt messages separately so it is easier to read/debug
try:
self.log_mqtt_messages("#", date_from)
except Exception as ex:
log.warning("Failed to retrieve mqtt logs. %s", ex, exc_info=True)

try:
# Get agent log files (if they exist)
log.info("tedge agent logs: /var/log/tedge/agent/*")
Expand Down Expand Up @@ -495,8 +501,7 @@ def _assert_mqtt_topic_messages(
)

messages = [
bytes.fromhex(item["payload_hex"]).decode("utf8")
# item["message"]["payload"]
bytes.fromhex(item["payload_hex"]).decode("utf8", errors="replace")
for item in items
]

Expand All @@ -512,6 +517,18 @@ def _assert_mqtt_topic_messages(

return messages

def log_mqtt_messages(self, topic: str = "#", date_from: Union[datetime, float] = None, **kwargs):
items = self.mqtt_match_messages(
topic=topic,
date_from=date_from,
**kwargs,
)
entries = [
f'{item["message"]["tst"].replace("+0000", ""):32} {item["message"]["topic"]:70} {bytes.fromhex(item["payload_hex"]).decode("utf8", errors="replace")}'
for item in items
]
log.info("---- mqtt messages ----\n%s", "\n".join(entries))

@keyword("Should Have MQTT Messages")
def mqtt_should_have_topic(
self,
Expand Down