User story #182
Updated by Ivan Herrero over 9 years ago
As a developer I want to be able to write log messages at every level of the framework. The logging mechanism shall be interrupt-safe.
This would satisfy requirements:
* MARTe-EX-F-3.1.1: The framework shall offer developers an interrupt-safe logging mechanism.
* MARTe-EX-F-3.1.2: The framework shall automatically include in the log message the absolute time of the message.
* MARTe-NE-F-3.1.3: The framework shall automatically include in the log message the source file line number.
* MARTe-NE-F-3.1.4: The framework shall automatically include in the log message the source filename.
* MARTe-NE-F-3.1.7: The framework shall automatically include in the log message the identifier of the thread from which the message is triggered from.
* MARTe-NE-F-3.1.8: The framework shall allow developers to specify the severity of the log message.
h1. Source code files modified
* SourceCore/L0Portbility/ -Logger.h- ErrorManagement.h
* SourceCore/L0Portbility/ -Logger.cpp- ErrorManagement.cpp
* SourceCore/L0Portbility/ -LogInformation.h- ErrorInformation.h ErrorManagenement.h
h1. Architecture & design review
As per the original MARTe implementation, this is a support function and does not require formal design in UML.
h1. Code and documentation review
*Date of the review:* 31/08/2015
*Person who did the review:* Ivan Herrero
*Result of review:* PASS
*List of non-conformities:* N/A
*Note:* There is an open discussion about if these classes/namespaces must be named Error infrastructure or Log infrastructure, because we log a lot of Information and Debug which by definition are not errors.
h1. Unit test review
*Date of the review:* 02/09/2015
*Person who did the review:* Ivan Herrero
*Result of coverage tests review:* PASS
*Result of functional tests review:* PASS
*Result of review:* PASS
*List of non-conformities:* N/A
*Notes:* The function ErrorManagementTest::CheckParameters does not verify ErrorInformation::header::isObject, ErrorInformation::hrtTime, ErrorInformation::objectPointer, and ErrorInformation::className, because they are not implemented.
This would satisfy requirements:
* MARTe-EX-F-3.1.1: The framework shall offer developers an interrupt-safe logging mechanism.
* MARTe-EX-F-3.1.2: The framework shall automatically include in the log message the absolute time of the message.
* MARTe-NE-F-3.1.3: The framework shall automatically include in the log message the source file line number.
* MARTe-NE-F-3.1.4: The framework shall automatically include in the log message the source filename.
* MARTe-NE-F-3.1.7: The framework shall automatically include in the log message the identifier of the thread from which the message is triggered from.
* MARTe-NE-F-3.1.8: The framework shall allow developers to specify the severity of the log message.
h1. Source code files modified
* SourceCore/L0Portbility/ -Logger.h- ErrorManagement.h
* SourceCore/L0Portbility/ -Logger.cpp- ErrorManagement.cpp
* SourceCore/L0Portbility/ -LogInformation.h- ErrorInformation.h ErrorManagenement.h
h1. Architecture & design review
As per the original MARTe implementation, this is a support function and does not require formal design in UML.
h1. Code and documentation review
*Date of the review:* 31/08/2015
*Person who did the review:* Ivan Herrero
*Result of review:* PASS
*List of non-conformities:* N/A
*Note:* There is an open discussion about if these classes/namespaces must be named Error infrastructure or Log infrastructure, because we log a lot of Information and Debug which by definition are not errors.
h1. Unit test review
*Date of the review:* 02/09/2015
*Person who did the review:* Ivan Herrero
*Result of coverage tests review:* PASS
*Result of functional tests review:* PASS
*Result of review:* PASS
*List of non-conformities:* N/A
*Notes:* The function ErrorManagementTest::CheckParameters does not verify ErrorInformation::header::isObject, ErrorInformation::hrtTime, ErrorInformation::objectPointer, and ErrorInformation::className, because they are not implemented.