4.6. Adapters

Adapters can be Enabled / Disabled in the Adapters Dialog available in the MQC application. By disabling unnecessary Tool Adapters the speed of importing huge data can be improved.

The allowed file extensions for the Data Sources depend on the enabled Adapters.

../../_images/MQC_ConfigAdapters_Manage.png

Figure 4.51 Enabling / Disabling Tool and Custom Adapters in the Adapter Dialog

Not all available adapters are shown in the dialog. To add a special adapter click on Add and then Special to add the needed adapter.

../../_images/MQC_ConfigAdapters_AddSpecialAdapter.png

Figure 4.52 Adding a special adapter

4.6.1. Tool Adapters

The following tools are supported by MQC with default adapters:

4.6.1.1. MES Model Examiner® (MXAM)

MQC supports two types of MXAM report formats:

4.6.1.1.1. MXMR

The following example of an MXMR report describes which information is imported by MQC’s MXAM adapter to MQC:

  • from the <RReport> element, specifically the date element: ReportDateTime

  • from the first <subcomponents> element inside an <artifacts> element, the attribute name as ArtifactName and the attribute path as ArtifactPath

MXAM provides guideline and finding result data for each artifact in the MXMR Report. Therefore, each artifact section will be parsed to get the information of all findings and guideline results.

<artifacts result="Aborted" adapterId="com.modelengineers.mxam.tooladapter.matlab" storageNature="Tool artifact">
  <structure>
    <subComponents name="ExPol" path="ExPol">
    </subComponents>
  </structure>
  …
  <summary itemType="Findings">
    <statistic resultType="Review" count="3"/>
    <statistic resultType="Failed" count="66"/>
    <statistic resultType="Info" count="28"/>
    <statistic resultType="Passed" count="12"/>
    <statistic resultType="Ignored" count="2"/>
  </summary>
  …
  <summaries itemType="Guidelines">
    <statistic resultType="Review" count="1"/>
    <statistic resultType="Failed" count="5"/>
    <statistic resultType="Passed with Infos" count="24"/>
    <statistic resultType="Passed" count="11"/>
  </summaries>
</artifacts>

The adapter reads those measures to be found in the Findings and Guidelines header: <summary itemType="Findings"> and <summaries itemType="Guidelines">. Please note that an MXAM report can contain various artifacts and for each artifact MQC reads out the Findings and Guidelines Summary, that are saved as FindingCount and GuidelineCount, respectively:

  • Review

  • Failed

  • Info (for FindingCount) and Passed with Infos (for GuidelineCount)

  • Passed

  • Ignored

  • Aborted

  • Canceled

  • Repaired

  • Unrepaired

  • Warning (for FindingCount) and Warnings (for GuidelineCount)

The adapter also reads the Model Architecture chapter data separately with ModelArchitecture as MeasurementName. For this, the adapter extracts all findings related to this chapter and aggregates the finding results from the result attribute for each artifact to define the FindingCount measure. To get the GuidelineCount measure, the adapter determines the worst finding for each artifact and guideline (e.g. MXRAY_COMPLEXITY_LOCAL) and aggregates again equal results.

<findings xsi:type="MatlabReport:RMatlabFinding" result="Passed" path="ExPol" name="ExPol" qualifier="Model"
          checkTreePath="mes_guidelines_embedded_coder_fs/Model Architecture/mes_arch_1301/matlab_mxray_1301"
          check="//@project/@documents.0/@chapters.1/@guidelines.0/@checks.0" artifact="//@artifacts.0"
          artifactStructureComponent="//@artifacts.0/@structure/@subComponents.0" ignoreComment=""
          parentPath="ExPol" repairInfo="">
    <properties key="Mask type" value="" visible="false"/>
    <properties key="Block type" value="" visible="false"/>
    <properties key="MessageParameter" value="[local complexity, 22]" visible="false"/>
    <properties key="metric" value="MXRAY_COMPLEXITY_LOCAL" visible="false"/>
    <message messageId="BoundCheck_GOOD" messageText="The local complexity is 22.">
        <messageParameter>local complexity</messageParameter>
        <messageParameter>22</messageParameter>
    </message>
    <linkAction>
        <properties key="label" value="Open Model" visible="true"/>
        <properties key="link" value="matlab:open_system('EV3Control_demo_ec');" visible="true"/>
    </linkAction>
    <elementIdentifier xsi:type="XMatlab:XMatlabElementIdentifier"
                       elementIdentifier="ExPol,&#xA;ExPol,&#xA;Model,&#xA;BoundCheck_GOOD:
                                          The local complexity is 22."
     path="ExPol" name="ExPol" qualifier="Model" artifactName="ExPol" version="5.1.0.xMessage" sid="">
        <message messageId="BoundCheck_GOOD" messageText="The local complexity is 22.">
            <messageParameter>local complexity</messageParameter>
            <messageParameter>22</messageParameter>
        </message>
    </elementIdentifier>
</findings>

Even if MQC shows the Model Architecture results separately, it is still contained in the overall GuidelineCount and FindingCount measure values.

4.6.1.1.2. Excel

MQC accepts an Excel file as a valid MXAM report file, if it at least contains the Project Overview sheet. All guideline results and finding results are read then from the Findings sheet taking into account that multiple Findings sheets may be present (e.g. in addition Findings 2, Findings 3 etc).

MQC reads

  • from the Project Overview sheet:

    • the ReportDateTime as stored in the row that contains the string “Generated at:”

  • from the Findings sheets EACH row as an MXAM finding, where:

    • the Check ID column is used to extract the guideline name

    • the Objectives column is used to extract the MeasurementName

    • the Artifact column is read as ArtifactName

    • the Result column is read as VariableName.

To extract the guideline name from the entry of the Check ID column, MQC splits the given path into its parts, where the last part is the check and the part next to the last indicates the guideline. If for example the column contains the string

mes_first_set_modeling_guidelines_fs/Layout and Design/Modeling of Data Flow/ misra_slsf_030_abc/mcheck_misra_slsf_030_ab

  • mes_first_set_modeling_guidelines_fs is the name of the document

  • Layout and Design is a chapter inside the document

  • Modeling of Data Flow is a subsection of the above chapter

  • misra_slsf_030_abc is the guideline and

  • mcheck_misra_slsf_030_ab is the check.

If the column Objectives is not existing, MQC instead checks for the column name Check Type to extract the measurement name. If multiple entries are contained, MQC uses the first entry as measurement name.

If the MXAM Excel report contains findings for different subsystems for the same artifact, MQC tries to extract a common prefix of all artifact paths as ArtifactName.

After reading all rows, the extracted findings (each row equals one MXAM finding) are aggregated and stored as MXAM measures:

  • the sum of all findings with the same measurement name, the same artifact name and the same variable name is stored as MeasurementName.FindingCount.VariableName = RowCount, e.g. Functionality.FindingCount.Passed = 212.

To extract the GuidelineCount measure:

  • MQC first groups all findings according to the same measurement name, the same artifact name and the same guideline name

  • then for each group MQC takes the variable name of the worst finding as guideline result, e.g. Failed

  • and afterwards counts the occurrence of findings with the same measurement name, the same artifact name and the same variable name as MeasurementName.GuidelineCount.VariableName, e.g. Functionality.GuidelineCount.Failed = 15.

4.6.1.2. MES M-XRAY® (MXRAY)

MQC supports the Standard XML MXRAY Report file.

The following information is extracted by the MQC/ MXRAY adapter:

  • from the <Timestamp> element

    • ReportDateTime

  • from the <SubsystemQualityOverview> header all included elements, usually these are:

    • Local Complexity

    • Level

    • %Elementary Inputs Unused (globally)

    • Cyclomatic Complexity

    • Inports

    • Outports

    For each of these Measures the variables Good, Acceptable and Bad are imported. Furthermore for Local Complexity the variables LowerBoundOfAcceptable and LowerBoundOfBad are read .

  • from the GlobalValueSummary element

    • Global Complexity (Ref0)

    • Global Complexity (Ref1)

    • Global Complexity (RefN)

    • Global Complexity Stateflow (Ref0)

    • Global Complexity Stateflow (Ref1)

    • Global Complexity Stateflow (RefN)

  • from the CloneGroups element

    • NumberOfDetectedCloneGroups

    • NumberOfSubsystemsAnalyzed

    • NumberOfUniqueSubsystemsInAllCloneGroups

    • NumberOfSubsystemsInAllCloneGroups

    In MQC CloneGroups.NumberOfUniqueSubsystemsInAllCloneGroups is shown as CloneGroups.Bad:

    Bad = NumberOfUniqueSubsystemsInAllCloneGroups

    Additionally CloneGroups.NumberOfSubsystemsAnalyzed is used together with CloneGroups.NumberOfUniqueSubsystemsInAllCloneGroups to calculate a value for CloneGroups.Good:

    Good = NumberOfSubsystemsAnalyzed - NumberOfUniqueSubsystemsInAllCloneGroups

4.6.1.3. MES Test Manager® (MTest)

The MQC-MTest adapter supports the MQC-XML format for MTest Report files.

The MTest XML report consists of one <DataEntryList> header, which contains several <DataEntry> elements, each of them containing all the information for one Base Measure and Artifact.

The following information is extracted by the MQC/MTest adapter:

  • from the <RevisionDate> element

    • ReportDateTime

  • from the <ArtifactNameOrAlias> element

    • ArtifactName

  • from the <DataSourceNameOrAlias> element the BaseMeasureName with its two variables (read out of the <DataSourceValue> element):

    • Absolute stored in MQC as Reached

    • Reference stored in MQC as Total

According to this pattern, from the <DataEntryList> element, the following Base Measures are imported with its respective variables (Reached and Total):

  • Assessment Work Progress

  • Model Condition Coverage

  • Model Decision Coverage

  • Requirements Compliance

  • Requirements with Reviewed Testability

  • Reviewed Assessments

  • Reviewed Test Sequences

  • Test Sequence Work Progress

  • Test Sequences Compliance

  • Testable Requirements with Assessments

  • Testable Requirements with Test Sequences

  • Testable Requirements

For the following Base Measures there only exists one value that is stored in the variable Reached:

  • Total Assessments

  • Total Requirements

  • Total Test Sequences

4.6.1.4. PikeTec TPT

MQC supports two types of TPT report formats:

4.6.1.4.1. XML

The following TPT XML report example shows, where the TPT XML adapter extracts the expected measures from:

<Header ExecutionConfig="Lights Control MATLAB" ExecutionDate="14:47:58 10.05.2016"
        TptFileName="D:\requirements.tpt" TptVersion="8u2">
  <Property Name="Model Under Test" Value="D:\matlab-platform\lights_control_simulink.mdl"/>
  <Property Name="System Under Test" Value="lights_control_simulink/lights_control"/>
  <Platform History="100" Name="MATLAB-Platform" Stepsize="10000" Timeout="60000000">
    <Property Name="MATLAB Version" Value="MATLAB 8.4"/>
  </Platform>
</Header>
…
<Summary AssessmentDuration="2.518" ExecutionDuration="2.078">
  <ExecutionSummary Errors="0" Failed="6" Inconclusive="0" Succeeded="5" Tests="11"/>
</Summary>

MQC reads out

  • from the <Header.. > element

    • ExecutionDateTime (stored in MQC as ReportDateTime)

    • SystemUnderTest Value (stored in MQC as ArtifactName), in this case “lights_control_simulink/lights_control”. Please, note that TPT stores in the XML only the name (instead of the complete path) of the subsystem

  • from the <ExecutionSummary> element the categories

    • Tests (stored in MQC as TestCount.Total)

    • Succeeded (stored in MQC as TestCount.Passed)

    • Failed (stored in MQC as TestCount.Failed)

    • Errors (stored in MQC as TestCount.Errors)

    • Inconclusive (stored in MQC as TestCount.Inconclusive)

In addition, structural coverage information and status and number of requirements are read:

<Header>
  <Property Name="System under Test" Value=""/>
  <Property Name="Revision" Value=""/>
  <Platform History="100" Name="C Platform" Stepsize="10000" Timeout="60000000">
    <Property Name="Platform Mapping" Value="&lt;none&gt;"/>
    <CoverageData Coverage="1.0" CoverageType="Function" ToolName="CTC++" ToolVersion=""/>
    <CoverageData Coverage="0.29" CoverageType="Statement" ToolName="CTC++" ToolVersion=""/>
    <CoverageData Coverage="0.29" CoverageType="Decision" ToolName="CTC++" ToolVersion=""/>
    <CoverageData Coverage="0.16" CoverageType="Condition" ToolName="CTC++" ToolVersion=""/>
    <CoverageData Coverage="0.21" CoverageType="MC/DC" ToolName="CTC++" ToolVersion=""/>
    <CoverageData Coverage="0.18" CoverageType="Multicondition" ToolName="CTC++" ToolVersion=""/>
  </Platform>
</Header>

  • from the <Header><Platform> branch all <CoverageData> elements using the attribute CoverageType to distinguish

    • Function Coverage.Ratio

    • Statement Coverage.Ratio

    • Decision Coverage.Ratio

    • Condition Coverage.Ratio

    • MC/DC Coverage.Ratio

    • Multicondition Coverage.Ratio

The adapter prioritizes obtaining comprehensive data for requirements from the HTML report. This ensures that the adapter can access the most complete information available for requirements, enhancing the accuracy and reliability of the generated reports. It first attempts to locate the overview.html file and extracts the requirement data from there (described in HTML). If the overview.html file is not found, the adapter retrieves the data from the XML report instead.

<Requirements>
  <Requirement Id="SPEC-12" Text="Functional requirements"/>
  <Requirement Id="SPEC-13" State="SUCCESS" Text="If light_switch is ON, then headlight shall immediately be ON."/>
</Requirements>
<Testcases Number="11">
  <Testcase Description="..." Requirements="SPEC-6 SPEC-13"/>
</Testcases>
<Assesslets Number="22">
  <Group Name="Assesslets">
    <Assesslet Id="1" Name="..." Requirements="SPEC-13"/>
  </Group>
</Assesslets>

  • from the <Requirements> element

    • Requirements Count.Total (total number of <Requirement> elements)

    • Requirements Count.Testable (number of requirements, which are linked to testcases and/or to assesslets)

    • Requirements Status.Passed (attribute State="SUCCESS")

    • Requirements Status.Failed (attribute State="FAILED")

    • Requirements Status.ExecutionError (attribute State="EXECUTION_ERROR")

    • Requirements Status.Inconclusive (attribute State="DONT_KNOW")

    • Requirements Status.NotCovered (number of requirements which are only linked to testcases but not to asseslets and vice versa)

MQC offers an additional structuring element called Measurement (described in Quality Computation). Herewith, test results (same base measure and variable name) may be read for different contexts, e.g. MiL or SiL.

The measurement name is expected as part of the file name or read from the Name attribute of the <Platform> element. In both cases, MQC expects the following syntax: _SIL_ or _MIL_. If not existing, the configured default measurement name is taken (see default-values-configuration).

4.6.1.4.2. HTML

The TPT HTML adapter extracts the same measures as the TPT XML adapter. Data is mainly read from file overview.html.

<body>
  <div class="header">TPT Report: Overview</div>
  <div class="table-caption">Test Summary</div>
  <table>
    <tr><td><span>TPT File</span></td><td><span>Model01.tptz</span></td></tr>
    <tr><td><span>TPT Version</span></td><td><span>15u3</span></td></tr>
    <tr><td><span>Date</span></td><td><span>07-Dec-2020</span></td></tr>
    <tr><td><span>System under Test</span></td><td><span>Model01</span></td></tr>
    ...
    <tr><td><span>Passed</span></td><td><span>583</span></td></tr>
    <tr><td><span>Failed</span></td><td><span>0</span></td></tr>
    <tr><td><span>Inconclusive</span></td><td><span>0</span></td></tr>
    <tr><td><span>Execution Error</span></td><td><span>0</span></td></tr>
    <tr><td><span>Total</span></td><td><span>583</span></td></tr>
  </table>

From the first table of the document, MQC reads test case information and meta data:

  • Total (stored in MQC as TestCount.Total)

  • Passed (stored in MQC as TestCount.Succeeded)

  • Failed (stored in MQC as TestCount.Failed)

  • Execution Error (stored in MQC as TestCount.Errors)

  • Inconclusive (stored in MQC as TestCount.Inconclusive)

  • Date (stored in MQC as ReportDateTime)

  • System under Test (stored in MQC as ArtifactName)

It may also be the case that System under Test is shorten to SUT. If neither the first nor the second can be found, the name of the artifact is taken from TPT File (file name without extension).

<table>
  <caption>Platform Information</caption>
  <tr><td><span>Platform Mapping</span></td><td><span>FromInterfaceImport</span></td></tr>
  <tr><td><span>MATLAB Version</span></td><td><span>MATLAB 9.3</span></td></tr>
  <tr><td><span>Variable 'TestRun'</span></td><td><span>SIL</span></td></tr>
  <tr><td><span>Variable 'iS_MIL'</span></td><td><span>0</span></td></tr>
</table>

The measurement name is expected as part of the file name. If it can’t be extracted from there, MQC checks if the report contains a table with the caption Platform Information and reads the platform name from the row with the inner text Variable 'TestRun'. If not existing, the configured default measurement name is taken (see default-values-configuration).

<table class="coverage-new">
  <caption>Coverage Information</caption>
  <tr><td><span>Type</span></td><td><span>Coverage [TER%]</span></td><td><span>Report</span></tr>
  <tr><td><span>Condition</span></td><td><span>16.0%</span></td><td/></tr>
  <tr><td><span>Decision</span></td><td><span>29.0%</span></td><td/></tr>
  <tr><td><span>Function</span></td><td><span>100.0%</span></td><td/></tr>
  <tr><td><span>MC/DC</span></td><td><span>21.0%</span></td><td/></tr>
  <tr><td><span>Multicondition</span></td><td><span>18.0%</span></td><td/></tr>
  <tr><td><span>Statement</span></td><td><span>29.0%</span></td><td/></tr>
</table>

Coverage data is fetched from the table with the caption Coverage Information. MQC reads the first column as measure name and the second column as measure value:

  • Condition Coverage.Ratio

  • Decision Coverage.Ratio

  • Function Coverage.Ratio

  • MC/DC Coverage.Ratio

  • Multicondition Coverage.Ratio

  • Statement Coverage.Ratio

The requirement information is mainly read from the table where the caption contains Requirement Coverage Summary.

  • Requirements Status.Passed (number of requirements from column Passed)

  • Requirements Status.Failed (number of requirements from column Failed)

  • Requirements Status.ExecutionError (number of requirements from column Execution Error)

  • Requirements Status.Inconclusive (number of requirements from column Inconclusive)

  • Requirements Status.NotCovered (number of requirements from column Not Covered)

  • Requirements Count.Testable (sum of all the previous values)

To distinguish between requirements linked to test cases and those linked to assesslets, MQC additionally reads requirement.html. Here, MQC fetches the data from the two tables

  • Requirements Results

    This table contains all requirements except those which are only linked to test cases but not to assesslets. It even contains requirements not linked at all, which are assumed to be not testable.

  • Requirements Assesslet Results

    This table contains all requirements linked to both test cases as well as assesslets.

Requirements with status Not Covered are either requirements not linked to testcases or requirements not linked to asesslets. The TPT HTML adapter uses this number to calculate measure which can’t be explicitly fetched from a TPT HTML report.

  • Requirements Count.Total (number of requirements from table Requirements Results plus number of requirements with status Not Covered but linked to assesslets)

4.6.1.5. Razorcat Tessy

From the extract of the Tessy Example XML report,

<report success="notok" tessy_version="4.0.15" xml_version="3">
<statistic notexecuted="0" notok="11" ok="54" total="65">
  <category count="54" name="ok"/>
  <category count="11" name="notok"/>
  <category count="0" name="notexecuted"/>
</statistic>
<info date="2018-08-23" time="16:20:30+0200"/>
…
<tessyobject id="1024" level="0" name="Testsuite" success="notok" type="project">

MQC reads

  • from the main (report) header:

    • tessy_version (stored in MQC as TessyReportVersion)

  • from the <statistics..> header the categories:

    • ok

    • notok

    • notexecuted.

  • from the <info..> header:

    • date and time (stored in MQC as ReportDateTime)

  • from the <tessyobject..> header:

    • name (stored in MQC as ArtifactName)

    • type (stored in MQC as TessyObjectType)

The Tessy data is imported maintaining the same notation of the Tessy classification of ok, notok and notexecuted, yet assigning them to the BaseMeasure TestCount.

4.6.1.6. MathWorks Polyspace

MQC supports two types of Polyspace report formats:

4.6.1.6.1. XML

If a Polyspace Xml report is created, MQC reads out from the xml-file:

  • ReportDateTime: from element PubDateTime

  • ArtifactPath: from element Subtitle

  • ArtifactName: same as ArtifactPath

The xml-file refers to several xfrag-files in the Polyspace-doc directory to be found on the same level as the xml-file.

From the image-000-chapter.xfrag-file, MQC extracts

  • BaseMeasureName: from the title elements of the tables

  • VariableName: first entry element of each table body row

  • MeasureValue: second entry element of each table body row

<table>
  <title>Coding Rules Summary - MISRA-C Checker</title>
  <tgroup>
    <tbody>
      <row><entry>Violations</entry><entry>52</entry></row>
      <row><entry>Pass/Fail</entry><entry>-</entry></row>
    </tbody>
  </tgroup>
</table>
<table>
  <title>Run-Time Checks Summary</title>
  <tgroup>
    <tbody>
      <row><entry>Number of Red Checks</entry><entry><emphasis role="red">2</emphasis></entry></row>
      <row><entry>Number of Gray Checks</entry><entry><emphasis role="gray">10</emphasis></entry></row>
      <row><entry>Number of Orange Checks</entry><entry><emphasis role="orange">13</emphasis></entry></row>
      <row><entry>Number of Green Checks</entry><entry><emphasis role="green">205</emphasis></entry></row>
      <row><entry>Proven</entry><entry>100.0%</entry></row>
      <row><entry>Pass/Fail</entry><entry>-</entry></row>
    </tbody>
  </tgroup>
</table>
<table>
  <title>Global Variable Summary</title>
  <tgroup>
    <tbody>
      <row><entry>Used non-shared variable</entry><entry>51</entry></row>
    </tbody>
  </tgroup>
</table>

The extracted data is then modified and transformed as follows:

  • If title = Run-Time Checks Summary

    • Number of Red Checks stored as Run-Time Checks.Major

    • Number of Gray Checks stored as Run-Time Checks.Minor

    • Number of Orange Checks stored as Run-Time Checks.Moderate

    • Number of Green Checks stored as Run-Time Checks.Good

    • Percentage of Proven stored as Run-Time Checks.Proven

    • Pass/Fail stored as Run-Time Checks.Pass_Fail

  • If title = Coding Rules Summary - MISRA-C Checker

    • Violations stored as MISRA-C Checker.Violations

  • If title = Global Variable Summary

    • Used non-shared variable stored as Global Variable.Used non-shared variable

    • Unused variable stored as Global Variable.Unused variable

4.6.1.6.2. Text

If a Polyspace tab-separated Text report is created, MQC reads from this txt-file:

  • ReportDateTime: time stamp of the last modification of the txt-file

  • ArtifactPath: extracted from File column (see below)

  • ArtifactName: same as ArtifactPath

  • BaseMeasureName: extracted from Family column

  • VariableName: extracted from Color, Information,``Check`` and Comment column based on the BaseMeasureName

  • MeasureValue: aggregated count per Color

To get the ArtifactPath, MQC extracts the file paths of all files used to create the report from the File column. MQC then obtains the common prefix from these file paths and takes the last directory from that prefix. This is stored as ArtifactPath.

For example if paths read from the “File” column are as follows:

C:\dev\Models\GlobalPosition\TLProj\TL_GlobalPosition\GlobalPosition.h
C:\dev\Models\GlobalPosition\TLSim\Rte_GlobalPosition.h
C:\dev\Models\GlobalPosition\TLSim\TL_GlobalPosition_fri.h

In this example the common prefix is C:\dev\Models\GlobalPosition and MQC extracts the last common directory GlobalPosition as the artifact path.

After reading, the extracted data is then modified and transformed as follows:

  • If Family equals Run-time Check:

    • Color = Red is stored as Run-Time Checks.Major

    • Color = Red and Comment is not empty is stored as Run-Time Checks.Major with Comments

    • Color = Gray is stored as Run-Time Checks.Minor

    • Color = Gray and Comment is not empty is stored as Run-Time Checks.Minor

    • Color = Orange is stored as Run-Time Checks.Moderate

    • Color = Orange and Comment is not empty is stored as Run-Time Checks.Moderate

    • Color = Green is stored as Run-Time Checks.Good

  • If Family equals Global Variable:

    • Check = Unused variable is stored as Global Variable.Unused variable

    • Color = Used non-shared variable is stored as Global Variable.Used non-shared variable

  • Family starts with MISRA C:

    • Information = Category:Mandatory is stored as MISRA-C Checker.Mandatory

    • Information = Category:Mandatory and Comment is not empty is stored as MISRA-C Checker.Mandatory with Comments

    • Information = Category:Required is stored as MISRA-C Checker.Required

    • Information = Category:Required and Comment is not empty is stored as MISRA-C Checker.Required with Comments

    • Information = Category:Advisory is stored as MISRA-C Checker.Advisory

    • Information = Category:Advisory and Comment is not empty is stored as MISRA-C Checker.Advisory with Comments

    • Sum of Category:Mandatory, Category:Required and Category:Advisory is stored as MISRA-C Checker.Violations

All the base measures with the post fix with Comments are always a subset of the root measure. For example, Run-Time Checks.Major is the count of all run-time checks which are ‘’red’’, with or without comments. Thus, Run-Time Checks.Major with Comments is always less or equal to the value of Run-time Check.Major.

4.6.1.7. BTC EmbeddedTester

The BTC EmbeddedTester adapter reads the data from HTML report files of this dynamic test tool.

MQC reads out:

<h4>Report Base</h4>
<table class="table dualTable" id="report_base_table">
   <tr>
       <th>Property</th>
       <th>Value</th>
   </tr>
   <tr>
       <td>Scope</td>
       <td>EV3Control_main</td>
   </tr>
   <tr>
       <td>Path</td>
       <td>EV3Control_demo_ec/EV3Control</td>
   </tr>
   ...
</table>

  • From the Report Base table:

    • The value of Scope property stored in MQC as ArtifactName

    • The value of Path property stored in MQC as ArtifactPath

<h4>General</h4>
<table class="table dualTable">
  <tr>
      <th>Property</th>
      <th>Value</th>
  </tr>
  ...
  <tr>
      <td>Profile Creation Date</td>
      <td>Jan 30, 2024, 11:56:47 AM</td>
  </tr>
  ...
</table>

  • From the General table:

    • The value of Profile Creation Date stored in MQC as ReportDateTime

<h4>Test Execution Results Overview</h4>
<table class="table">
    <tr>
      <th></th>
      <th>TestCase</th>
      <th>Length</th>
      <th>Requirement (report base)</th>
      <th>Scope</th>
      <th>Folder</th>
      <th>Result (TL MIL)</th>
      <th>Result (SIL)</th>
    </tr>
    <tr>
      <td style="text-align:center"><span class="icon-sdc" title="No problems during simulation"></span></td>
      <td>TC-REQ_SC_1_2</td>
      <td>5</td>
      <td><a class="link"> REQ_SC_1_2</a></td>
      <td>SDOCAR</td>
      <td>Default Test Cases</td>
      <td><div class="ok-glyph ok-color">Passed</div></td>
      <td><div class="ok-glyph ok-color">Passed</div></td>
    </tr>
    <tr>
      <td style="text-align:center"><span class="icon-sdc" title="No problems during simulation"></span></td>
      <td><a class="link">TC-REQ_SC_2_1</a></td>
      <td>11</td>
      <td><a class="link">REQ_SC_2_1</a></td>
      <td>SDOCAR</td>
      <td>Default Test Cases</td>
      <td><div class="error-glyph error-color">Failed</div></td>
      <td><div class="error-glyph error-color">Failed</div></td>
    </tr>
</table>

  • In the Test Execution Results Overview table, distinct columns are allocated for test case results corresponding to various measurements. MQC generates these measures for each measurement based on the outcomes of the respective test cases:

    • Number of Passed test cases as Testcase\Result.Passed

    • Number of Failed test cases as Testcase\Result.Failed

    • Number of test cases as Testcase\Result.Total

<h3>2. Requirements Traceability</h3>
<table class="table">
    <tr>
       <th>Requirement ID</th>
       <th>Description</th>
       <th>Test Cases</th>
       <th>Covered</th>
       <th >Passed (TL MIL)</th>
       <th >Passed (SIL)</th>
    </tr>
    <tr id="2yR_req">
       <td>REQ_SC_1_1</td>
       <td>We ramp down the ultrasound sensor signal value.</td>
       <td>1</td>
       <td><div class="ok-glyph ok-color">Covered</div></td>
       <td>100%</td>
       <td> 100%</td>
    </tr>
    <tr id="2yV_req">
       <td>REQ_SC_2_1</td>
       <td>IStart with a zero input signal for usSensorFront. Drive revers by setting remoteCtrlCmd.</td>
       <td>1</td>
       <td><div class="ok-glyph ok-color">Covered</div></td>
       <td>0%</td>
       <td>0%</td>
     </tr>
</table>

  • In the Requirements Traceability table, there are distinct columns indicating the status of requirements passed for different measurements. The status is represented as 0% if it failed, 100% if it passed, and n.a. if it is not covered. MQC generates these measures for each measurement based on the results of requirements:

    • Number of 100% Passed requirements as Requirement\Result.Passed

    • Number of 0% Failed requirements as Requirement\Result.Failed

    • Number of n.a. requirements as Requirement\Testcase Coverage.Covered

    • Number of requirements as Requirement\Result.Total

<table>
  <tr>
    <th></th>
    <th>Properties</th>
    <th colspan="2">Handled</th>
    <th colspan="2">Covered</th>
    <th colspan="2">Unreachable (n/inf)</th>
    <th colspan="2">Justified</th>
  </tr>
  <tr>
    <td>Statement (STM)</td>
    <td>302</td>
    <td>90</td>
    <td>29.8%</td>
    <td>90</td>
    <td>29.8%</td>
    <td>0</td>
    <td>0.0%</td>
    <td>0</td>
    <td>0.0%</td>
  </tr>
</table>

  • In all tables under the Code Analysis section, the SiL (Software-in-Loop) coverage data is retrieved. The first column is interpreted as the measure name, while the subsequent columns are interpreted as variables:

    • Handled

    • Covered

    • Unreachable

    • Justified

<h2>Back-to-Back Testing</h2>
<div><h3>1. Back-to-Back Test</h3>
  <h3>Test Results Overview</h3>
  <h3 >TL MIL vs SIL</h3>
  <div>
     <h4>Comparison Results</h4>
     <table class="table">
         <tr>
           <th></th>
           <th>Name</th>
           <th>Length</th>
           <th>Result</th>
         </tr>
         <tr>
           <td>#1</td>
           <td>
               <span class="icon-wdc" title="Warnings during comparison"></span>:
               TL MIL_Stage1_TempValue <br>
               <span class="icon-sdc" title="No problems during comparison"></span>:
               SIL_Stage1_TempValue
           </td>
           <td> 1</td>
           <td><div class="ok-glyph ok-color"> Passed</div> </td>
         </tr>
     </table>
  </div>
</div>

  • In the Back-to-Back Testing table, MQC interprets these measures for the B2B measurement based on the values in the ‘Result’ column:

    • Number of Passed test cases as Testcase\Result.Passed

    • Number of Failed test cases as Testcase\Result.Failed

    • Number of test cases as Testcase\Result.Total

4.6.1.8. Verifysoft Testwell CTC++

MQC supports two types of Verifysoft Testwell CTC++ report formats:

4.6.1.8.1. XML

MQC will read from the XML file:

<ctc_xml_report>
  <header_info>
    <ctcpost_version>8.0.1</ctcpost_version>
    <copyright>Copyright (c) 1993-2013 Testwell Oy</copyright>
    <copyright>Copyright (c) 2013-2016 Verifysoft Technology GmbH</copyright>
    <report_generated>Fri Jun 05 15:22:09 2020</report_generated>
  </header_info>
  <file name="D:\source\Application\DeviceLayer\test_object.cpp">
    <file_type>source</file_type>
    <instrumentation_mode>multicondition</instrumentation_mode>
    <instrumentation_timestamp>Fri Jun 05 15:21:42 2020</instrumentation_timestamp>
    <sym_rewrite_count>0</sym_rewrite_count>
    <sym_update_count>0</sym_update_count>
    <data_rewrite_count>0</data_rewrite_count>
    <data_update_count>0</data_update_count>
    <file_summary>
      <functions>77</functions>
      <lines>200</lines>
      <measurement_points>16</measurement_points>
      <ter>68</ter>
      <hits>343</hits>
      <all>505</all>
      <statement_ter>92</statement_ter>
      <statement_hits>5310</statement_hits>
      <statement_all>5752</statement_all>
      <statement_na_functions>0</statement_na_functions>
    </file_summary>
  </file>
</ctc_xml_report>

MQC extracts the following information, stores and transforms it to the MQC data structure:

  • from the <header_info> header:

    • <report_generated> (stored in MQC as ReportDateTime)

  • from each <file> header:

    • name (stored in MQC as ArtifactName)

    • from the <file_summary> header:

      • <lines> (stored in MQC as Source lines.count)

      • <measurement_points> (stored in MQC as Measurement points.count)

      • when both <xxx_hits> and <xxx_all> exist

        • <xxx_hits> (stored in MQC as xxx.Reached)

        • <xxx_all> (stored in MQC as xxx.Total)

4.6.1.8.2. HTML

MQC will read from the HTML file:

<html>
  <head>
    <title>CTC++ Coverage Report - Files Summary</title>
  </head>
  <body>
  <table>
    <tr><td class="info">Symbol file(s)</td><td class="info">:</td><td class="info">
     c:\temp\Autopilot_ec\Test\Test_autopilot_demo_ec\Autopilot_Mode_Logic\Test001\TSeq001\CTCCov\Data_sil_ec\
     MON.sym (Thu May 21 05:35:10 2020)</td></tr>
    <tr><td class="info">Listing produced at</td><td class="info">:</td><td class="info">
     Thu May 21 05:44:18 2020</td></tr>
    <tr><td class="info">Coverage view</td><td class="info">:</td><td class="info">
     Reduced to decision coverage</td></tr>
    <tr><td class="info">Input listing</td><td class="info">:</td><td class="info">
     D:\temp\Autopilot_ec\Test\Test_autopilot_demo_ec\Autopilot_Mode_Logic\CTCCov\Data_sil_ec\profile.txt</td></tr>
    <tr><td class="info">HTML generated at</td><td class="info">:</td><td class="info">
     Thu May 21 05:44:18 2020</td></tr>
    <tr><td class="info">Structural threshold</td><td class="info">:</td><td class="infob">100 %</td></tr>
    <tr><td class="info">Statement threshold</td><td class="info">:</td><td class="infob">100 %</td></tr>
  </table><br>
  <table>
    <thead>
      <tr><th>TER %</th><th>-</th><th colspan="2">decision</th><th>TER %</th><th>-</th>
       <th colspan="2">statement</th><th>File</th></tr>
    </thead>
    <tbody>
      <tr><td class="dirb" colspan="9"><a name="a1"></a>Directory: C:\temp\Autopilot_ec\Test\
       Test_autopilot_demo_ec\Autopilot_Mode_Logic\Autopilot_Mode_Logic_sil_sil_ec_ert_rtw</td></tr>
      <tr><td class="below">98 %</td><td class="below">-</td><td class="below">(41/42)</td>
       <td width="115"><img border="1" src="red.gif" width="98" height="5" alt="">
        <img border="1" src="white.gif" width="2" height="5" alt="">
       </td><td class="below">99 %</td><td class="below">-</td><td class="below">(86/87)</td>
       <td width="115"><img border="1" src="red.gif" width="99" height="5" alt="">
        <img border="1" src="white.gif" width="1" height="5" alt="">
       </td><td><a href="indexD1.html" class="underline">Autopilot_Mode_Logic_sil_sil_ec.c</a></td></tr>
      <tr><td class="above">100 %</td><td class="above"></td><td class="above">(0/0)</td>
       <td width="115"><img border="1" src="blue.gif" width="100" height="5" alt=""></td>
       <td class="above">100 %</td><td class="above"></td><td class="above">(0/0)</td>
       <td width="115"><img border="1" src="blue.gif" width="100" height="5" alt=""></td>
       <td><a href="indexD2.html" class="underline">Autopilot_Mode_Logic_sil_sil_ec_data.c</a></td></tr>
      <tr><td class="belowb">98 %</td><td class="below">-</td><td class="below">(41/42)</td>
       <td width="115"><img border="1" src="red.gif" width="98" height="5" alt="">
        <img border="1" src="white.gif" width="2" height="5" alt=""></td>
       <td class="belowb">99 %</td><td class="below">-</td><td class="below">(86/87)</td>
       <td width="115"><img border="1" src="red.gif" width="99" height="5" alt="">
        <img border="1" src="white.gif" width="1" height="5" alt=""></td>
       <td class="dirb"><a title="C:\temp\R2018B\Autopilot_ec\Test\Test_autopilot_demo_ec\Autopilot_Mode_Logic\
        Autopilot_Mode_Logic_sil_sil_ec_ert_rtw">DIRECTORY OVERALL</a></td></tr>
      <tr><td class="ruler" colspan="9">&nbsp;</td></tr>
      <tr><td class="belowb">98 %</td><td class="below">-</td><td class="below">(41/42)</td><td width="115">
        <img border="1" src="red.gif" width="98" height="5" alt="">
        <img border="1" src="white.gif" width="2" height="5" alt=""></td>
       <td class="belowb">99 %</td><td class="below">-</td><td class="below">(86/87)</td>
       <td width="115"><img border="1" src="red.gif" width="99" height="5" alt="">
        <img border="1" src="white.gif" width="1" height="5" alt=""></td>
       <td><a href="indexO.html" class="underlineb">OVERALL</a></td></tr>
    </tbody>
  </table><br>
 </body>
</html>

MQC extracts the following information, stores and transforms it to the MQC data structure:

  • from the first <table> header:

    • read the last <td> of the <tr> with the first <td> equal to ‘Listing produced at’ (stored in MQC as ReportDateTime)

  • from the second <table> header:

    • from <thead> start from third <th> and every three <th> read as MeasureName.

    • from each <tr>:

      • read last <td> as <ArtifactName>

      • from <td> correspondent to <th> read values for that measure in such a way that the first number is fetch as Reached and second as Total variable. (e.g for second row in sample report above, (41/42) is read as decision.Reached = 41 and decision.Total = 42)

In reading rows from second table we will ignore <tr> with just one <td> or has class=”dirb” or class=”ruler” or when last <td> is equal to “DIRECTORY OVERALL” or “OVERALL”.

4.6.1.9. Danlawinc MxSuite

MQC reads data from the XML file named Report.RegResults.xml:

<MxVDevReportFile>
  <Report>
    <Date>20200423</Date>
    <Time>15:39</Time>
    <ProgramVersion>3.41.1.45984</ProgramVersion>
  </Report>
  <Regression>
    <Overview>
      <Project>
        <Name>ModelTestMiL</Name>
        <Description>
        </Description>
        <Folder>C:\ModelTest\ModelTestMiL</Folder>
        <FileName>ModelTestMiL.mxp</FileName>
        <ScenarioFolder>.\TestCases\</ScenarioFolder>
      </Project>
    </Overview>
    <StatisticsTotals Total="1" PercentTotal="100" Passed="0" PercentPassed="0" Failed="1" PercentFailed="100"
                      Skipped="0" PercentSkipped="0" RunTimeError="0" PercentRunTimeError="0"
                      Missing="0" PercentMissing="0">
      <Testcases Total="1" PercentTotal="100" Passed="0" PercentPassed="0" Failed="1" PercentFailed="100"
                 Skipped="0" PercentSkipped="0" RunTimeError="0" PercentRunTimeError="0"
                 Missing="0" PercentMissing="0" />
    </StatisticsTotals>
  </Regression>
</MxVDevReportFile>

MQC reads out

  • from the <Report>

    • <Date> and <Time> (stored in MQC as ReportDateTime)

  • from each <Regression> header:

    • <Overview><Project><Name> (stored in MQC as ArtifactName)

    • from <StatisticsTotals> header:

      • Total (stored in MQC as Scenarios.Total)

      • Passed (stored in MQC as Scenarios.Passed)

      • Failed (stored in MQC as Scenarios.Failed)

      • Skipped (stored in MQC as Scenarios.Skipped)

      • RunTimeError (stored in MQC as Scenarios.RunTimeError)

      • Missing (stored in MQC as Scenarios.Missing)

    • from <Testcases> header:

      • Total (stored in MQC as Testcases.Total)

      • Passed (stored in MQC as Testcases.Passed)

      • Failed (stored in MQC as Testcases.Failed)

      • Skipped (stored in MQC as Testcases.Skipped)

      • RunTimeError (stored in MQC as Testcases.RunTimeError)

      • Missing (stored in MQC as Testcases.Missing)

4.6.1.12. Perforce Helix QAC

MQC supports two types of QA-System QAC report formats:

4.6.1.12.1. XML

The QAC XML adapter reads rules as Guidelines and rule violations as Findings. In this way the static analysis measures are named similarly for the different static analysis tools (e.g. MXAM, SL Check).

MQC will read from the XML file:

<AnalysisData timestamp="20200423T162554" projectpath="C:/Users/public/AppData/Local/samples/Examples"
              reportpath="C:/Users/public/AppData/Local/samples/Examples/configs/reports">
  <dataroot type="project">
    <tree type = "rules" >
      <RuleGroup name="xxx" total="5212" active="1112" >
        <Rule id = "" total="5" active="2" text="" >
          <Rule id = "" total="2" active="2" text="" >
            <Message guid = "" total="2" active="2" text="" />
          </Rule>
        </Rule>
        <Rule id = "" total="3" active="0" text="" >
          <Rule id = "" total="3" active="0" text="" >
            <Message guid = "" total="1" active="0" text="" />
            <Message guid = "" total="2" active="0" text="" />
          </Rule>
        </Rule>
      </RuleGroup>
    </tree>
  </dataroot>
  <dataroot type="per-file">
    <File path=".../example.h">
      <tree type="rules">
        <RuleGroup name = "xxx" total="84" active="53" >
          <Rule id="xxx" total="29" active="23"
                text="There shall be no occurrence of undefined or critical unspecified behaviour" >
            <Message guid = "qac-9.3.1-0602" total="6" active="0" text="" />
            <Message guid = "qac-9.3.1-0603" total="12" active="12" text="" />
            <Message guid = "qac-9.3.1-0836" total="1" active="1" text="" />
            <Message guid = "qac-9.3.1-0848" total="5" active="5" text="" />
            <Message guid = "qac-9.3.1-0854" total="5" active="5" text="" />
          </Rule>
        </RuleGroup>
      </tree>
      <tree type="levels">
        <Level guid = "QA_WARNING" total="55" active="30" name="Warnings" ></Level>
        <Level guid = "QA_ERROR" total="2" active="2" name="Errors" ></Level>
      </tree>
    </File>
  </dataroot>
</AnalysisData>

MQC extracts the following information, stores and transforms it to the MQC data structure:

  • from the <AnalysisData> header:

    • ReportDateTime: read from attribute timestamp

Each <File> element inside <dataroot type="per-file"> is treated as separate artifact. For each artifact Guidelines and Findings are read:

MQC treats different rule sets <RuleGroup name = "M3CM" ... as measurements (the name of the rule group M3CM is used as measurement name in MQC). All guidelines and findings are counted separately per measurement.

  • from each <File> header:

    • ArtifactPath: read from attribute path

  • per measurement (rule group):

    • Findings.Failed: the number of active rule violations (active > 0)

    • Findings.Suppressed: value of attribute total - active (number of suppressed rule violations)

    • Guidelines.Suppressed: the number of Rule elements with Message elements (lowest level) with attribute active = "0"

    • Guidelines.Failed: the number of all Rule elements (per artifact) with Message elements substracted by the number of suppressed guidelines (Guidelines.Suppressed).

  • from the <dataroot type="project"> <tree type = "rules" > element

    • Guidelines.Total: the number of Rule elements with Message elements (lowest level)

    • Guidelines.Passed: Guidelines.Total (for all artifacts) - Guidelines.Failed (per artifact)

The number of passed guidelines includes the number of suppressed guidelines (all rules without and with suppressed violations)!

4.6.1.12.2. HTML

MQC will read from the HTML file:

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  </head>
  <body>
    <div id = "head" >
      <div class="stitle">
       Project &nbsp;&nbsp;: C:/Users/public/AppData/Local/Examples<br/>
       Status at: 23 Apr, 2019 at 16:25:13
      </div>
    </div>
    <div class="head">
      <div class="summary">
        <table border="0">
          <col border="50"/>
          <tr><td>Number of Files</td><td>185</td></tr>
          <tr><td>Lines of Code (source files only)</td><td>16431</td></tr>
          <tr><td>Total preprocessed code line</td><td>3036</td></tr>
          <tr><td>Diagnostic Count</td><td>948</td></tr>
          <tr><td>Rule Violation Count</td><td>1212</td></tr>
          <tr><td>Violated Rules</td><td>183</td></tr>
          <tr><td>Compliant Rules</td><td>7</td></tr>
          <tr><td>File Compliance Index</td><td>97.41%</td></tr>
          <tr><td>Project Compliance Index</td><td>6.68%</td></tr>
        </table>
      </div>
    </div>
   <div id="content">
     <div class="dpp">
        <div class="subsec"><h5>M3CM</h5></div>
        <div class="rgtable">
          <table border="1" >
            <tr><th>Files</th><th>Rule 0</th><th>Rule 1</th><td><b>Total Violations</b></td></tr>
            <tr>
             <td><a href="example.h" title="example.h">example.h</a></td>
             <th>2</th><th>3</th><td><b>5</b></td>
            </tr>
          </table>
        </div>
        <div class="subsec"><h5>QA-C</h5></div>
        <div class="rgtable">
          <table border="1" >
            <tr><th>Files</th><th>Rule 0</th><th>Rule 1</th><td><b>Total Violations</b></td></tr>
            <tr>
             <td><a href="example.h" title="example.h">example.h</a></td>
             <th>1</th><th>5</th><td><b>6</b></td>
            </tr>
          </table>
        </div>
    </div>
     <div class="worstrules">
        <div class="rgtable">
          <table border="1" >
            <tr><th>Files</th><th>Rule 0</th><th>Rule 1</th><th>Rule n</th></tr>
            <tr>
             <td><a href="example.h" title="example.h">example.h</a></td>
             <th>0</th><th>65</th><td>6</td>
            </tr>
          </table>
        </div>
        <div class="rgtable">
          <table border="1" >
            <tr><th>Files</th><th>Rule 0</th><th>Rule 1</th><th>Rule n</th></tr>
            <tr>
             <td><a href="example.h" title="example.h">example.h</a></td>
             <th>13</th><th>105</th><td>0</td>
            </tr>
          </table>
        </div>
     </div>
   </div>
  </body>
</html>

MQC extracts the following information, stores and transforms it to the MQC data structure:

  • from <div class="stitle"> that contains ‘Status at:’ read date and time and stored in MQC as ReportDateTime

  • from <div id="content"><div class="dpp">:

    • from <div class="subsec"> read <h5> as MeasurementName.

      MQC treats different rule sets as measurments (the name of the table is stored as measurement name in MQC). All guidelines and findings are counted separately per measurement.

    • from <div clas="rgtable"><table> for each <tr>:

      • ArtifactName: read from first <td> of <tr>

      • Findings.Failed: from last <td> of <tr>.

  • from <div id="content"><div class="worstrules"> header:

    • from <div class="subsec"> read <h5> as MeasurementName

    • from <div class="rgtable"><table> for each <tr>:

      • Guidelines.Failed: count each <td> of <tr> with violation (value > 0)

      • Guidelines.Passed: number of all guidelines for current rule - Guidelines.Failed

    • from <table> inside <div class="summary">:

      • Guidelines.Ovarall Failed: read second <td> of <tr> that first is equal to ‘Violated Rules’

      • Guidelines.Overall Passed: read second <td> of <tr> that first is equal to ‘Compliant Rules’

      • Guidelines.Overall Total: sum of Project Rules.Violated and Project Rules.Compliant

4.6.1.14. Rational Test RealTime (RTRT)

MQC supports Rational Test RealTime reports in html format.

MQC will read from index.htm file Generated on date as ReportDateTime.

<table WIDTH="100%" BORDER="2" >
   <tr><td>Name </td ><td>Status</td ><td>Failed</td ><td>Passed</td ><td>Total</td ></tr>
   <tr><td>ArtifactPath.xrd</td><td>Passed</td><td>0 </td ><td>28</td ><td>28</td ></tr>
</table>

MQC extracts the TestCount measure information from index.html file in Reporter directory, stores and transforms it to the MQC data structure:

  • Name column stored in MQC as ArtifactPath

  • Failed column stored in MQC as TestCount.Failed variable

  • Passed column stored in MQC as TestCount.Passed variable

  • Total column stored in MQC as TestCount.Total variable

Any extension (including ‘_’ and ‘numbers’) at the end of the artifact path will be removed, if there is at least one other row with the same base name, e.g. ‘Artifact’ and ‘Artifact1’ or ‘Artifact_1’ will all be reduced to ‘Artifact’. In that case the read measure values will be summed up per variable name.

<table>
 <tr>
  <td><b>Item</b></td>
  <td><b>Functions</b></td>
  <td><b>Functions and exits</b></td>
  <td><b>Statement blocks</b></td>
  <td><b>Decisions</b></td>
  <td><b>Basic conditions</b></td>
  <td><b>Modified conditions</b></td>
  <td><b>Multiple conditions</b></td>
 </tr>
 <tr>
  <td><B>ArtifactPath.C</B></td>
  <td> 10 / 10 </td>
  <td> 35 / 35 </td>
  <td> 35 / 36 </td>
  <td> 40 / 46 </td>
  <td> N/A </td>
  <td> N/A </td>
 </tr>
</table>

MQC extracts the coverage information from the last table of RateDoc.html file in Cvi directory, stores and transforms it to the MQC data structure:

  • Item column stored in MQC as ArtifactPath

  • all other columns are measures with the column header as base measure name:

    • read number before / stored in MQC as Reached variable.

    • read number after / stored in MQC as Total variable.

For the sample data extracted data is:

  • Functions Coverage.Reached=10 , Functions Coverage.Total=10

  • Functions and exits Coverage.Reached=35 , Functions and exits Coverage.Total=35

  • Statement blocks Coverage.Reached=35 , Statement blocks Coverage.Total=36

  • Decisions Coverage.Reached=40 , Decisions Coverage.Total=46

MQC keeps the extension of the read artifact path (‘.h’ / ‘.c’), but removes the following ‘#’ and ‘numbers’ from end of the name, e.g. ‘Artifact.c’ and ‘Artifact.c #1’ will all be reduced to ‘Artifact.c’. In that case the read measure values will be summed up per variable name.

4.6.2. Generic Adapters

CSV files can be imported with the Generic data sheet by using Adapter Options.

If you want to import manually collected data use the provided Excel Template and let the Manual data import (Excel Template) import it into MQC.

4.6.2.1. Generic data sheet

MQC provides the possibility to read any CSV or Excel data sheet as a data source. For that, the user has to define adapter options. Adapter options for the Generic Data Sheet adapter are rules to map for instance the columns of an Excel table to MQC data dimensions like revisions, artifacts, measures etc. Additionally, another option may specify how to filter rows.

The following code block shows an example of an adapter option to read MXAM data from an Excel sheet.

The “ImportDefinitions” define how to fetch the relevant data

  • FileExpression: name pattern of files that could be interpreted by this adapter option

  • ArtifactName: fetched from table column [SubComponents_Path]

  • Value: fetched from table column [Count]

An Excel sheet sample that could be read with this adapter option is shown in Figure 4.53

$schema: http://quality-commander.de/userguide/v71/schema/AdapterOptionSource.schema.json
$version: 1.0
Name: 'GenericDataSheet: MXAM Adapter Option'
AdapterOptions:
- $type: MES.MQC.DataSourceLibrary.Adapters.Others.GenericDataSheetAdapter+AdapterOptions
  ImportDefinitions:
  - FileExpression: MXAMReport.*_[0-9]+\.xlsx
    ArtifactPath: '[SubComponents_Path]'
    ArtifactName: '[SubComponents_Path]'
    DataSource: MXAM
    MeasurementName: '[Chapters]'
    MeasureName: '[MeasureName]'
    VariableName: '[ResultType]'
    Value: '[Count]'
    ReportDateTime: MXAMReport.*_(\d{8}).xlsx
    ReportDateTimeFormat: yyyyMMdd
../../_images/MQC_DataSources_GenericDataSheet.png

Figure 4.53 Sample Excel sheet for reading MXAM data by Generic data sheet adapter

4.6.2.2. Manual data import (Excel Template)

MQC provides the possibility to import data from any other data source using the manual import option.

All measures imported into MQC have to be configured in the Quality Model (see default-values-configuration). Imported but not configured measures will be ignored in all visualizations as well as for the quality calculation.

The manual import has to be done using Excel. From the Data Sources dialog choose the Data Template button to create an Excel import file that can be used to load data into MQC.

../../_images/MQC_DataSources_ExportTemplateManualImport.png

Figure 4.54 Export the Data template for using manual data import functionality

Select one of the following options to customize the data import template according to your needs:

  • All: The Excel file already contains a column for each measure configured in the quality model as well as one row for each artifact imported respectively configured in the project structure.

  • Filtered: The Excel file only contains those measures and artifacts selected via the filter panel on the right-hand side of the pages.

  • Marked: The Excel file only contains those measures and artifacts that were marked by the user, e.g. if the user have selected an artifact KPI and a specific data source KPI at the Data Status page, the file only contains a row for the marked artifact as well as only columns for measures belonging to the marked data source.

../../_images/MQC_DataSources_ManualImport.png

Figure 4.55 Sample file for manual import of two Base Measures for two Artifacts for the same revision

The column Artifact consists of entries representing the objects for which data shall be collected and for which quality shall be computed (e.g. Simulink models, requirements documents, software components).

The entries of the column ReportDateTime are considered by MQC as the days when raising the data, which shall be collected. Those configured report dates are used to assign the imported data to MQC revisions.

Finally, all other columns are representing measures for which data shall be imported into MQC. As shown in Figure 4.55, measures (i.e. the column names) have to follow the syntax DataSource.Measurement.BaseMeasure.Variable.

  • DataSource: Specify where your data is coming from (e.g. the name of the tool which produced the data).

  • Measurement: Provide more structuring regarding the data (e.g. the reason why data is collected, the test environment etc.). This is optional and may be left empty. In this case the measure name syntax is DataSource.BaseMeasure.Variable. Nevertheless, it is recommended to fill out Measurement to achieve a high compliance to ISO 250xx.

  • BaseMeasure: Specifies a group of measures.

  • Variable: The name of the specific measure belonging to the base measure group.

The value for a specific measure for an artifact at a certain report date then has to be assigned to the corresponding cell within the Excel template.

In case you might want to assign default values for your imported base measures, you have to define them in compliance with this syntax in the quality model (see default-values-configuration).

4.6.3. Custom Adapters

Custom Adapters, provided by MES, available as Open Source or developed yourself, can be added in this Dialog. On import a C# class file gets compiled while an IronPython script is executed and validated. If an error occurs, the import fails and the error messages are shown. A custom adapter source file (.cs or .py) can contain multiple custom adapters.

../../_images/MQC_ConfigAdapters_CompileValidation.png

Figure 4.56 Compiling error messages on a failed import of a Custom Adapter

After a custom adapter file is imported it will be saved together with the current MQC Project as a library item or a dxp file. If the source file is changed it has to be manually reloaded in this dialog so that it is compiled again and the adapter is updated in the MQC Project.

Additionally to the functionality of managing the adapters, the Adapters Dialog provides a button to view the Execution Order of the Adapters, which is defined in the Adapters itself.

../../_images/MQC_ConfigAdapters_ExecutionOrder.png

Figure 4.57 Execution Order of all enabled Adapters. The Adapters are executed in this order, by first checking if the file extension(s) match the file that is to be imported and then let the Adapter validate itself, if the provided file is to be handled by it.

With the Button “Test importing a Report File” a single data source file can be tested for import. If there are any errors while checking the Adapters and executing the correct Adapter, the error messages are shown to the user, else the data is shown in a result table.

4.6.3.1. Developing a Custom Adapter

An MQC Data Source Adapter has to inherit the MES.MQC.DataSourceLibrary.Adapters.Adapter class.

A Custom Adapter can be either a .net C# class or a IronPython class.

The Tool Adapters and Example Adapters can be downloaded from the Adapters Dialog in MQC.

../../_images/MQC_ConfigAdapters_Overview.png

Figure 4.58 Adapters Dialog in MQC: Download-Button of Adapter Examples on the right side.

When developing a new custom adapter, the following properties and methods have to be implemented:

Required Properties

  • DataSource: string

  • FileExtensions: List<string>

Optional Properties

  • Name: string (defaults to class name)

  • Description: string (defaults to empty)

  • Priority: integer (defaults to 100)

  • FindingsProvidedForDataSources: List<string> (default to empty list)

Required Methods

  • IsValid: bool

  • Read: AdapterReadResult

Optional Methods - GetHumanReadableFilePath: string - GetHumanReadableFilePaths: List<string>

4.6.3.1.1. Adapter Class

public abstract class Adapter
{
    /// <summary>
    ///    Unique Name of the Adapter
    ///    Defaults to the ClassName, can be overridden with a
    ///    user defined Name
    /// </summary>
    public virtual string Name

    /// <summary>
    ///    Description of the Adapter that is visible in the
    ///    Adapter-Dialog as a Popover
    ///    Absolute links get transformed into HTML Link-Tags,
    ///    Linebreaks (\n) get transformed into HTML linebreaks (<br>)
    ///    HTML Tags are not allowed
    /// </summary>
    public virtual string Description

    /// <summary>
    ///    File Extensions of the Adapter
    ///    This Property has to be defined and has to have at least one
    ///    file extension
    ///    The Adapter is only used for FilePaths with the defined
    ///    file extensions. The IsValid method is not called unless
    ///    the file extension matches.
    /// </summary>
    public abstract List<string> FileExtensions

    /// <summary>
    ///    Priority of the Adapter
    ///    The execution order of all adapters depend on the defined
    ///    priorities. The higher the priority the earlier the adapter
    ///    is validated and executed.
    ///    The default priority for Tool Adapters is between 10-110,
    ///    Custom Adapters should define a priority of 200 or higher if
    ///    they should be executed before the tool adapters.
    ///    If two adapters have the same priority, the order is depending
    ///    on the Name of the adapter.
    /// </summary>
    public virtual int Priority

    /// <summary>
    ///    The default Data Source of the Adapter
    ///    This Property has to be defined and is taken as data source
    ///    name for all data imported using this adapter.
    ///    If a report file contains data from multiple data sources, set
    ///    this Property to a default name (e.g. "Unknown") and
    ///    use the DataSource Property of each AdapterData object to define
    ///    a dedicated Data Source per metric.
    /// </summary>
    public abstract string DataSource

    /// <summary>
    ///    List of DataSources for which the adapter can provide findings.
    /// </summary>
    public virtual List<string> FindingsProvidedForDataSources => new List<string>();

    /// <summary>
    ///    IsValid has to be implemented by the Adapter class
    ///    The method is called when the file extensions match
    ///    If the file extension is unique this method can just return
    ///    true, else it should check if the file should be imported by
    ///    the adapter
    ///    If true is returned, the current adapter is executed and the
    ///    Read method is called. No other adapter is checked afterwards.
    /// </summary>
    protected abstract bool IsValid(AdapterContext context);

    /// <summary>
    ///    Read has to be implemented by the Adapter class
    ///    This method is called when the file extensions match and
    ///    isValid returns true, no other adapter is called
    ///    The data of the file should be read and returned as a List
    ///    of AdapterData
    /// </summary>
    protected abstract AdapterReadResult Read(AdapterContext context);

    /// <summary>
    ///    Number of Human Readable Files
    /// </summary>
    public virtual int HumanReadableFileCount

    /// <summary>
    ///    Human Readable File Extensions of the Adapter
    /// </summary>
    public virtual List<string> HumanReadableFileExtensions

    /// <summary>
    ///    Human Readable File Names of the Adapter
    /// </summary>
    public virtual List<string> HumanReadableFileNames

    /// <summary>
    ///    Start of Human Readable File Names of the Adapter
    /// </summary>
    public virtual List<string> HumanReadableStartFileNames

    /// <summary>
    ///    Get the human readable file path
    ///    Can be overridden with a user defined function
    /// </summary>
    protected virtual string GetHumanReadableFilePath(string filePath)

    /// <summary>
    ///    Get the human readable file paths
    ///    Can be overridden with a user defined function
    /// </summary>
    protected virtual List<string> GetHumanReadableFilePaths(string filePath)

    /// <summary>
    ///    TransformStringToValue is a Utility method
    ///    Parse a string value to a double value in a
    ///    culture-independent (invariant) way.
    /// </summary>
    protected double? TransformStringToValue(string value)

4.6.3.1.2. AdapterContext Class

public class AdapterContext
{
    /// <summary>
    ///    Should the adapter import findings?
    /// </summary>
    public bool ImportFindings { get; }

    /// <summary>
    ///    File name of the report file
    /// </summary>
    public string Name { get; }

    /// <summary>
    ///    File name without extension of the report file
    /// </summary>
    public string NameWithoutExtension { get; }

    /// <summary>
    ///    File extension of the report file
    /// </summary>
    public string Extension { get; }

    /// <summary>
    ///    File path of the report file
    /// </summary>
    public string Path { get; }

    /// <summary>
    ///    Directory path of the report file
    /// </summary>
    public string DirectoryPath { get; }

    /// <summary>
    ///    File content of the report file
    /// </summary>
    public string Content { get; }

    /// <summary>
    ///    Modified date of the report file
    /// </summary>
    public DateTime CreationDate { get; }

    /// <summary>
    ///    Message bag, where errors and warnings can be thrown
    /// </summary>
    public AdapterMessageBag MessageBag { get; }

    /// <summary>
    ///    It loads the file path as an XDocument, which can be traversed via XPath
    ///    See https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/concepts/linq/linq-to-xml-overview for documentation.
    ///    The document is stored in a property and returned. The reading of the file is therefore only done once.
    /// </summary>
    public XDocument AsXDocument()

    /// <summary>
    ///    It loads the file path as an HtmlDocument (HtmlAgilityPack)
    ///    See https://html-agility-pack.net/ for documentation.
    ///    The document is stored in a property and returned. The reading of the file is therefore only done once.
    /// </summary>
    public HtmlDocument AsHtmlDocument(string subContent = null)

    /// <summary>
    ///    It loads the file path as an DataSet
    ///    The DataSet is stored in a property and returned. The reading of the file is therefore only done once.
    /// </summary>
    public DataSet AsDataSet()
}

4.6.3.1.3. AdapterMessageBag Class

public class AdapterMessageBag
{
    /// <summary>
    ///    ThrowError is a Utility method
    ///    Throws an Error message to be either ignored, displayed at
    ///    a notification (on data source import or refresh)
    ///    or shown in a validation dialog (if a report file is
    ///    imported as a test).
    ///    The import of the current filePath is aborted with an
    ///    internal exception
    /// </summary>
    public void ThrowError(string title, string description)

    /// <summary>
    ///    ThrowWarning is a Utility method
    ///    Throws an Warning message to be either ignored, displayed
    ///    at a notification (on data source import or refresh)
    ///    or shown in a validation dialog (if a report file is
    ///    imported as a test).
    ///    The import of the current filePath continues unimpeded by
    ///    the warning.
    /// </summary>
    public void ThrowWarning(string title, string description)

4.6.3.1.4. AdapterReadResult Class

public class AdapterReadResult
{
    /// <summary>
    ///    The imported data (aggregated numbers)
    /// </summary>
    public List<AdapterData> Data { get; }

    /// <summary>
    ///    The imported measures (which data should be defaulted if not imported)
    /// </summary>
    public List<AdapterMeasure> Measures { get; }

    /// <summary>
    ///    The imported findings (data details)
    /// </summary>
    public List<AdapterFinding> Findings { get; }
}

4.6.3.1.5. AdapterData Class

public class AdapterData
{
    /// <summary>
    ///     Date of the report
    /// </summary>
    public DateTime DateTime { get; set; }

    /// <summary>
    ///     Name of the Data Source
    ///     This property is optional and can remain null, in this case
    ///    the DataSource property of the CustomAdapter is used
    /// </summary>
    public string DataSource { get; set; } = null;

    /// <summary>
    ///     Path of the Artifact
    /// </summary>
    public string ArtifactPath { get; set; }

    /// <summary>
    ///     Name of the Artifact
    ///     This property is optional, the ArtifactName will be taken
    ///    from the Project Structure if available or derived from the
    ///    artifact path if not.
    /// </summary>
    public string ArtifactName { get; set; }

    /// <summary>
    ///     Name of the Measure
    /// </summary>
    public string MeasureName { get; set; }

    /// <summary>
    ///     Name of the Measurement
    /// </summary>
    public string MeasurementName { get; set; }

    /// <summary>
    ///     Name of the Variable
    /// </summary>
    public string VariableName { get; set; }

    /// <summary>
    ///     The Value
    ///     Has to be of the double type
    /// </summary>
    public double? Value { get; set; }
}

4.6.3.1.6. AdapterMeasure Class

public class AdapterMeasure
{
    /// <summary>
    ///     Date of the report
    /// </summary>
    public DateTime DateTime { get; set; }

    /// <summary>
    ///     Name of the Data Source
    ///     This property is optional and can remain null, in this case
    ///    the DataSource property of the CustomAdapter is used
    /// </summary>
    public string DataSource { get; set; } = null;

    /// <summary>
    ///     Path of the Artifact
    /// </summary>
    public string ArtifactPath { get; set; }

    /// <summary>
    ///     Name of the Measure
    /// </summary>
    public string MeasureName { get; set; }

    /// <summary>
    ///     Name of the Measurement
    /// </summary>
    public string MeasurementName { get; set; }

    /// <summary>
    ///     Name of the Variable
    /// </summary>
    public string VariableName { get; set; }
}

4.6.3.1.7. AdapterFinding Class

public class AdapterFinding
{
    /// <summary>
    ///     Date of the report
    /// </summary>
    public DateTime DateTime { get; set; }

    /// <summary>
    ///     Name of the Data Source
    ///     This property is optional and can remain null, in this case
    ///    the DataSource property of the CustomAdapter is used
    /// </summary>
    public string DataSource { get; set; } = null;

    /// <summary>
    ///     Path of the Artifact
    /// </summary>
    public string ArtifactPath { get; set; }

    /// <summary>
    ///     SubStructurePath of the Artifact
    /// </summary>
    public string ArtifactSubStructurePath { get; set; }

    /// <summary>
    ///     Structure path where the method/result/etc of the Finding is connected to
    /// </summary>
    public string FindingStructurePath { get; set; }

    /// <summary>
    ///     Result value of the Finding (e.g. Warning, Failed)
    /// </summary>
    public FindingResult Result { get; set; }

    /// <summary>
    ///     Display name of the structure of the Finding
    /// </summary>
    public string DisplayName { get; set; }

    /// <summary>
    ///     Description of the Finding (contains detailed issue information)
    /// </summary>
    public string Description { get; set; }

    /// <summary>
    ///     Anchor of the related human readable html file
    /// </summary>
    public string HumanReadableAnchor { get; set; }

    /// <summary>
    ///    Add multiple adapterData entries to create relations
    /// </summary>
    public void AddData(IEnumerable<AdapterData> data)

    /// <summary>
    ///    Add an adapterData entry to create a relation
    /// </summary>
    public void AddData(AdapterData data)
}

4.6.4. General Adapter Options

Tool adapters support the configuration of FilePath based Adapter Options for the following data fields:

  • ArtifactPath

  • DataSourceName

  • MeasurementName

  • ReportDateTime

The values for these fields can be extracted from the report file path with regex expressions.

In the adapter options, the data field has to be appended with a “FromFilePath”. (e.g. “ArtifactPathFromFilePath”) You can specify multiple definitions per data field. The definitions are checked in order and the first matching definition is used.

Each definition contains:

  • Regex

    A regular expression to match the file path.

  • Result

    The resulting value from the regex. Static values or dynamic regex results like $1 can be used.

  • IsFallback (optional, default is false)

    Should the definition be only used if there was no value read from the adapter itself.

  • Format

    Only relevant for ReportDateTime. DateTime-Format (e.g. “yyMMdd”)

Listing 4.21 Example of general adapter options defined for TptXmlAdapter for reading ‘ArtifactPath’, ‘MeasurementName’ and ‘ReportDateTime’ from file path
AdapterOptions:
- $type: MES.MQC.DataSourceLibrary.Adapters.Tools.TptXmlAdapter+AdapterOptions
  ArtifactPathFromFilePath:
    - Regex: ^.+\\(.+)_TPT[^\/]*\.xml$
      Result: $1
    - Regex: ^.+\\Model_([^\\]+).*$
      Result: $1
  MeasurementNameFromFilePath:
    - Regex: ^.+_(Report|Data)_([^\\]+).*$
      Result: $2
  ReportDateTimeFromFilePath:
    - Regex: ^.+\\([0-9]+)_(Report|Data)_.+$
      Format: yyMMdd
      Result: $1