Meeting #331
Updated by André Neto almost 8 years ago
With respect to v0.13 this version contains minor bug fixes and the addition of the CircularStaticList class.
h1. Requirements review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of requirements:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: This version only provides minor updates w.r.t. to v0.12.
h1. Architecture & design review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of architecture & design document:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: This version only provides minor updates w.r.t. to v0.12.
h1. Code and documentation review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of source code:* 0.14
*Result of review:* PASS
*List of non-conformities:*
<pre>
Note 974: Worst case function for stack usage: 'MARTe::ConfigurationDatabase::Copy' is recursive, loop contains call to 'MARTe::ConfigurationDatabase::Copy'. See +stack for a full report. [MISRA C++ Rule 7-5-4]
</pre>
*List of warnings reported by Doxygen:*
<pre>
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/BasicFileProperties.h:44: Warning: Compound MARTe::BasicFileProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Linux/BasicFileProperties.h:42: Warning: Compound MARTe::BasicFileProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L4LoggerService/LoggerConsumerI.h:113: Warning: Compound MARTe::LoggerConsumerI::FormatPreferences is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/InternetHost.cpp:50: Warning: Compound MARTe::LocalHostInfo is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Linux/InternetHost.cpp:53: Warning: Compound MARTe::LocalHostInfo is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Windows/MutexSem.cpp:42: Warning: Compound MARTe::MutexSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Linux/MutexSem.cpp:45: Warning: Compound MARTe::MutexSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/SelectProperties.h:42: Warning: Compound MARTe::SetIdentifier is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Windows/EventSem.cpp:45: Warning: Compound MARTe::EventSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Linux/EventSem.cpp:46: Warning: Compound MARTe::EventSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L0Types/TemplateParametersVerificator.h:47: Warning: Compound TemplateParametersVerificator< true > is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L1Portability/Environment/Windows/BasicConsole.cpp:43: Warning: Compound MARTe::BasicConsoleProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L1Portability/Environment/Linux/BasicConsole.cpp:49: Warning: Compound MARTe::BasicConsoleProperties is not documented.
</pre>
_Disclaimer: These warnings are due a bug of Doxygen (https://bugzilla.gnome.org/show_bug.cgi?id=406027), fixed on version 1.8.10 (we use 1.6.1 on vcis-jenkins.f4e.europa.eu)._
*Remark*
The documentation of DataSourceI has to be revisited.
*Remark*
The SquareRoot template methods for float32 and float64 need to be provided.
<pre>
template<typename Type>
inline Type SquareRoot(const Type x) {
Type tmp = x;
if (tmp < (Type) 0) {
REPORT_ERROR_STATIC_0(ErrorManagement::Warning, "SquareRoot<Type> of negative number");
tmp *= -1;
}
return sqrt(tmp);
}
</pre>
It is only valid for Type being float64. In case of float32, there would be an implicit casting to satisfy the sqrt method. Two implementations shall be provided to call sqrt and sqrtf, as appropriate
*Remark*
The following classes have non-virtual destructors. As long they are not base classes of any derived class, it is safe, but they need to be monitored (flexlint will check and signal this as error code 1509).
<pre>
Matrix, Vector, GlobalObjectsDatabase, LoadableLibrary, MemoryArea, StaticListHolder, CharBuffer, AnyTypeCreator, LexicalAnalyzer, Token, TokenInfo, Directory, MutexSem, ThreadInformation.
</pre>
h1. Unit test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of unit tests:* 0.14
*Result of coverage tests review:* PASS
*Result of functional tests review:* PASS
*Result of review:* PASS
*List of non-conformities:*
_LCOV report (files containing functions (methods not executed at all):_
Note: execute with <pre>lcov -l Build/MARTe2.coverage.info</pre>
<pre>
|Lines |Functions|Branches
Filename |Rate Num|Rate Num|Rate Num
================================================================================ TimeoutType EmbeddedThreadI::GetTimeout() const
L1Portability/Environm...Linux/BasicConsole.cpp|79.4% 223|76.2% 42| - 0 inline ExceptionHandler::~ExceptionHandler()
L1Portability/FastResourceContainer.cpp |83.5% 97|71.4% 7| - 0 bool GAMDataSource::Synchronise()
L1Portability/MemoryArea.cpp |91.2% 57|91.7% 12| - 0 bool GAM::SetContext(ConstReference context)
L2Objects/ClassProperties.cpp |92.9% 28|87.5% 8| - 0 ReferenceT<T>* ReferenceT<T>::operator&() (*)
L2Objects/Introspection.cpp |73.3% 15|85.7% 7| - 0 Object *Object::Clone() const
L2Objects/IntrospectionEntry.cpp |88.3% 111|93.3% 15| - 0 IntrospectionEntry::IntrospectionEntry()
L2Objects/Object.cpp |88.8% 250|96.8% 31| - 0 Introspection::Introspection()
L5GAMs/GAM.cpp |98.0% 349|94.6% 37| - 0 uint32 ClassProperties::GetSize() const
ExceptionHandler.h | 0.0% 2| 0.0% 2| - 0 void MemoryArea::SetHeapName(const char8 * const name)
QueuedMessageI.cpp |95.9% 49|90.0% 10| - 0
</pre>
(*) The ReferenceT<T>::operator& is private. See solution applied in Reference::operator&.
_LCOV report (files containing functions with coverage < 90%):_ (fragments of code not executed):_
<pre>
|Lines |Functions|Branches
Filename |Rate Num|Rate Num|Rate Num
================================================================================ case if (timeout.IsFinite()) @ bool BasicUDPSocket::Write(const char8 * const input, uint32 & size, const TimeoutType &timeout)
L1Portability/Environm...Linux/BasicConsole.cpp|79.4% 223|76.2% 42| - 0 loop for (uint32 i = 0u; i < numberOfChildren; i++) @ bool RealTimeThread::ToStructuredData(StructuredDataI& data)
L1Portability/Environment/Linux/Sleep.cpp |76.1% 92| 100% 8| - 0 call with recursive==true @ Reference ReferenceContainer::Find(const char8 * const path, const bool recursive)
L1Portability/FastResourceContainer.cpp |83.5% 97|71.4% 7| - 0 case if (dllOpened) @ ClassRegistryItem *ClassRegistryDatabase::Find(const char8 *className)
L2Objects/ClassRegistryDatabase.cpp |81.9% 127| 100% 15| - 0 case if (ok) @ bool BasicConsole::Open(const FlagsType &mode)
L2Objects/Introspection.cpp |73.3% 15|85.7% 7| - 0 case else if (shift < bitSize) @ DoubleInteger<T2> Shift::LogicalRightShift(DoubleInteger<T2> number, uint8 shift)
L2Objects/IntrospectionEntry.cpp |88.3% 111|93.3% 15| - 0 error reporting and set variables to default values on error checking @ all classes
L2Objects/Object.cpp |88.8% 250|96.8% 31| - 0
L2Objects/ReferenceCon...erFilterReferences.cpp|84.6% 13| 100% 5| - 0
L3Streams/BufferedStreamIOBuffer.cpp |86.0% 50| 100% 8| - 0
L3Streams/DoubleBufferedStream.cpp |82.7% 110|84.0% 25| - 0
L3Streams/IOBufferFloatPrint.cpp |84.5% 464| 100% 29| - 0
L3Streams/IOBufferIntegerPrint.cpp |85.2% 460|93.5% 93| - 0
L3Streams/SingleBufferedStream.cpp |84.1% 176|83.3% 24| - 0
BasicFile.cpp |87.8% 278|93.9% 33| - 0
BasicTCPSocket.cpp |85.5% 234| 100% 25| - 0
BasicUDPSocket.cpp |88.1% 118|95.7% 23| - 0
Directory.cpp |86.2% 80| 100% 15| - 0
DirectoryScanner.cpp |88.0% 92|90.0% 10| - 0
File.cpp |71.4% 7|57.1% 7| - 0
EventSem.cpp |87.2% 141| 100% 15| - 0
MutexSem.cpp |86.8% 121| 100% 13| - 0
ExceptionHandler.h | 0.0% 2| 0.0% 2| - 0
</pre>
_GTest report_
<pre>
[----------] Global test environment tear-down
[==========] 3865 tests from 143 test cases ran. (211109 ms total)
[ PASSED ] 3864 tests.
[ FAILED ] 1 tests, listed below:
[ FAILED ] IOBufferGTest.TestPrintStructuredDataInterface
</pre>
h1. Integration test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of integration tests:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: Not performed.
h1. Acceptance test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of acceptance tests:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: Not performed.
h1. Requirements review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of requirements:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: This version only provides minor updates w.r.t. to v0.12.
h1. Architecture & design review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of architecture & design document:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: This version only provides minor updates w.r.t. to v0.12.
h1. Code and documentation review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of source code:* 0.14
*Result of review:* PASS
*List of non-conformities:*
<pre>
Note 974: Worst case function for stack usage: 'MARTe::ConfigurationDatabase::Copy' is recursive, loop contains call to 'MARTe::ConfigurationDatabase::Copy'. See +stack for a full report. [MISRA C++ Rule 7-5-4]
</pre>
*List of warnings reported by Doxygen:*
<pre>
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/BasicFileProperties.h:44: Warning: Compound MARTe::BasicFileProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Linux/BasicFileProperties.h:42: Warning: Compound MARTe::BasicFileProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L4LoggerService/LoggerConsumerI.h:113: Warning: Compound MARTe::LoggerConsumerI::FormatPreferences is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/InternetHost.cpp:50: Warning: Compound MARTe::LocalHostInfo is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Linux/InternetHost.cpp:53: Warning: Compound MARTe::LocalHostInfo is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Windows/MutexSem.cpp:42: Warning: Compound MARTe::MutexSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Linux/MutexSem.cpp:45: Warning: Compound MARTe::MutexSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/FileSystem/L1Portability/Environment/Windows/SelectProperties.h:42: Warning: Compound MARTe::SetIdentifier is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Windows/EventSem.cpp:45: Warning: Compound MARTe::EventSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/Scheduler/L1Portability/Environment/Linux/EventSem.cpp:46: Warning: Compound MARTe::EventSemProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L0Types/TemplateParametersVerificator.h:47: Warning: Compound TemplateParametersVerificator< true > is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L1Portability/Environment/Windows/BasicConsole.cpp:43: Warning: Compound MARTe::BasicConsoleProperties is not documented.
/home/aneto/Projects/MARTe2-dev/Source/Core/BareMetal/L1Portability/Environment/Linux/BasicConsole.cpp:49: Warning: Compound MARTe::BasicConsoleProperties is not documented.
</pre>
_Disclaimer: These warnings are due a bug of Doxygen (https://bugzilla.gnome.org/show_bug.cgi?id=406027), fixed on version 1.8.10 (we use 1.6.1 on vcis-jenkins.f4e.europa.eu)._
*Remark*
The documentation of DataSourceI has to be revisited.
*Remark*
The SquareRoot template methods for float32 and float64 need to be provided.
<pre>
template<typename Type>
inline Type SquareRoot(const Type x) {
Type tmp = x;
if (tmp < (Type) 0) {
REPORT_ERROR_STATIC_0(ErrorManagement::Warning, "SquareRoot<Type> of negative number");
tmp *= -1;
}
return sqrt(tmp);
}
</pre>
It is only valid for Type being float64. In case of float32, there would be an implicit casting to satisfy the sqrt method. Two implementations shall be provided to call sqrt and sqrtf, as appropriate
*Remark*
The following classes have non-virtual destructors. As long they are not base classes of any derived class, it is safe, but they need to be monitored (flexlint will check and signal this as error code 1509).
<pre>
Matrix, Vector, GlobalObjectsDatabase, LoadableLibrary, MemoryArea, StaticListHolder, CharBuffer, AnyTypeCreator, LexicalAnalyzer, Token, TokenInfo, Directory, MutexSem, ThreadInformation.
</pre>
h1. Unit test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of unit tests:* 0.14
*Result of coverage tests review:* PASS
*Result of functional tests review:* PASS
*Result of review:* PASS
*List of non-conformities:*
_LCOV report (files containing functions (methods not executed at all):_
Note: execute with <pre>lcov -l Build/MARTe2.coverage.info</pre>
<pre>
|Lines |Functions|Branches
Filename |Rate Num|Rate Num|Rate Num
================================================================================ TimeoutType EmbeddedThreadI::GetTimeout() const
L1Portability/Environm...Linux/BasicConsole.cpp|79.4% 223|76.2% 42| - 0 inline ExceptionHandler::~ExceptionHandler()
L1Portability/FastResourceContainer.cpp |83.5% 97|71.4% 7| - 0 bool GAMDataSource::Synchronise()
L1Portability/MemoryArea.cpp |91.2% 57|91.7% 12| - 0 bool GAM::SetContext(ConstReference context)
L2Objects/ClassProperties.cpp |92.9% 28|87.5% 8| - 0 ReferenceT<T>* ReferenceT<T>::operator&() (*)
L2Objects/Introspection.cpp |73.3% 15|85.7% 7| - 0 Object *Object::Clone() const
L2Objects/IntrospectionEntry.cpp |88.3% 111|93.3% 15| - 0 IntrospectionEntry::IntrospectionEntry()
L2Objects/Object.cpp |88.8% 250|96.8% 31| - 0 Introspection::Introspection()
L5GAMs/GAM.cpp |98.0% 349|94.6% 37| - 0 uint32 ClassProperties::GetSize() const
ExceptionHandler.h | 0.0% 2| 0.0% 2| - 0 void MemoryArea::SetHeapName(const char8 * const name)
QueuedMessageI.cpp |95.9% 49|90.0% 10| - 0
</pre>
(*) The ReferenceT<T>::operator& is private. See solution applied in Reference::operator&.
_LCOV report (files containing functions with coverage < 90%):_ (fragments of code not executed):_
<pre>
|Lines |Functions|Branches
Filename |Rate Num|Rate Num|Rate Num
================================================================================ case if (timeout.IsFinite()) @ bool BasicUDPSocket::Write(const char8 * const input, uint32 & size, const TimeoutType &timeout)
L1Portability/Environm...Linux/BasicConsole.cpp|79.4% 223|76.2% 42| - 0 loop for (uint32 i = 0u; i < numberOfChildren; i++) @ bool RealTimeThread::ToStructuredData(StructuredDataI& data)
L1Portability/Environment/Linux/Sleep.cpp |76.1% 92| 100% 8| - 0 call with recursive==true @ Reference ReferenceContainer::Find(const char8 * const path, const bool recursive)
L1Portability/FastResourceContainer.cpp |83.5% 97|71.4% 7| - 0 case if (dllOpened) @ ClassRegistryItem *ClassRegistryDatabase::Find(const char8 *className)
L2Objects/ClassRegistryDatabase.cpp |81.9% 127| 100% 15| - 0 case if (ok) @ bool BasicConsole::Open(const FlagsType &mode)
L2Objects/Introspection.cpp |73.3% 15|85.7% 7| - 0 case else if (shift < bitSize) @ DoubleInteger<T2> Shift::LogicalRightShift(DoubleInteger<T2> number, uint8 shift)
L2Objects/IntrospectionEntry.cpp |88.3% 111|93.3% 15| - 0 error reporting and set variables to default values on error checking @ all classes
L2Objects/Object.cpp |88.8% 250|96.8% 31| - 0
L2Objects/ReferenceCon...erFilterReferences.cpp|84.6% 13| 100% 5| - 0
L3Streams/BufferedStreamIOBuffer.cpp |86.0% 50| 100% 8| - 0
L3Streams/DoubleBufferedStream.cpp |82.7% 110|84.0% 25| - 0
L3Streams/IOBufferFloatPrint.cpp |84.5% 464| 100% 29| - 0
L3Streams/IOBufferIntegerPrint.cpp |85.2% 460|93.5% 93| - 0
L3Streams/SingleBufferedStream.cpp |84.1% 176|83.3% 24| - 0
BasicFile.cpp |87.8% 278|93.9% 33| - 0
BasicTCPSocket.cpp |85.5% 234| 100% 25| - 0
BasicUDPSocket.cpp |88.1% 118|95.7% 23| - 0
Directory.cpp |86.2% 80| 100% 15| - 0
DirectoryScanner.cpp |88.0% 92|90.0% 10| - 0
File.cpp |71.4% 7|57.1% 7| - 0
EventSem.cpp |87.2% 141| 100% 15| - 0
MutexSem.cpp |86.8% 121| 100% 13| - 0
ExceptionHandler.h | 0.0% 2| 0.0% 2| - 0
</pre>
_GTest report_
<pre>
[----------] Global test environment tear-down
[==========] 3865 tests from 143 test cases ran. (211109 ms total)
[ PASSED ] 3864 tests.
[ FAILED ] 1 tests, listed below:
[ FAILED ] IOBufferGTest.TestPrintStructuredDataInterface
</pre>
h1. Integration test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of integration tests:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: Not performed.
h1. Acceptance test review
*Date of the review:* 13/06/2017
*Person who did the review:* André Neto
*Version of acceptance tests:* 0.14
*Result of review:* N/A
*List of non-conformities:* N/A
*Comments*: Not performed.