FreedomBox/plinth/tests/test_diagnostic_check.py
James Valleroy ddc9b434a7
diagnostics: Add optional component_id to DiagnosticCheck
Signed-off-by: James Valleroy <jvalleroy@mailbox.org>
Reviewed-by: Sunil Mohan Adapa <sunil@medhas.org>
2024-05-02 21:45:12 -07:00

73 lines
2.6 KiB
Python

# SPDX-License-Identifier: AGPL-3.0-or-later
"""Tests for diagnostic check data type."""
import json
import pytest
from plinth.diagnostic_check import (CheckJSONDecoder, CheckJSONEncoder,
DiagnosticCheck, Result)
def test_result():
"""Test result enum type."""
assert Result.__members__['ERROR'].name == 'ERROR'
assert Result.__members__['ERROR'].value == 'error'
assert Result.NOT_DONE == 'not_done'
assert Result.PASSED == 'passed'
assert Result.WARNING == 'warning'
assert Result.FAILED == 'failed'
assert Result.ERROR == 'error'
def test_diagnostic_check():
"""Test the diagnostic check data class."""
with pytest.raises(TypeError):
DiagnosticCheck() # pylint: disable=E1120
check = DiagnosticCheck('some-check-id', 'sample check')
assert check.check_id == 'some-check-id'
assert check.description == 'sample check'
assert check.translated_description == 'sample check'
assert check.result == Result.NOT_DONE
assert check.component_id is None
assert not check.parameters
check = DiagnosticCheck('some-check-id', 'sample check', Result.PASSED)
assert check.result == Result.PASSED
assert not check.parameters
check = DiagnosticCheck('some-check-id', 'sample check', Result.PASSED,
{'key': 'value'})
assert check.parameters['key'] == 'value'
check = DiagnosticCheck('some-check-id', 'sample check', Result.FAILED, {},
'some-component')
assert check.component_id == 'some-component'
def test_translate():
"""Test formatting the translated description."""
check = DiagnosticCheck('some-check-id', 'sample check {key}',
Result.FAILED, {'key': 'value'})
assert check.translated_description == 'sample check value'
check = DiagnosticCheck('some-check-id', 'sample check {missing}',
Result.PASSED, {'key': 'value'})
assert check.translated_description == 'sample check ?missing?'
def test_json_encoder_decoder():
"""Test encoding and decoding as JSON."""
check = DiagnosticCheck('some-check-id', 'sample check', Result.PASSED)
check_json = json.dumps(check, cls=CheckJSONEncoder)
for string in [
'"check_id": "some-check-id"', '"description": "sample check"',
'"result": "passed"', '"parameters": {}', '"component_id": null',
'"__class__": "DiagnosticCheck"'
]:
assert string in check_json
decoded_check = json.loads(check_json, cls=CheckJSONDecoder)
assert decoded_check == check