SciTools Support

Before we go back to SonarQube integration, let me explain how you run “CodeCheck” by SciTools from the command line. 

6.1. Export the checks you want to use from CodeCheck in a .ini file. 

Let’s say you want to only check the MISRA C 2012 standard, select those checks in codecheck 

You now need to do the opposite that we did earlier, you need to save this configuration to a .ini file, using the “Export Configuration to file” (DO NOT USE "Export Selected Checks to text file) 

Name the file MISRA-C-2012.ini.
If you are not sure whether you clicked the right button, MISRA-C-2012.ini should look like: 

[CodeCheckConfigNames] misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5CDirective%204.3%20Assembly%20language%20shall%20be%20encapsulated%20and%20isolated=2 misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5CDirective%204.4%20Sections%20of%20code%20should%20not%20be%20%22commented%20out%22=2 misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5CDirective%204.5%20Identifiers%20in%20the%20same%20name%20space%20with%20overlapping%20visibility%20should%20be%20typographically%20unambiguous=2 misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5CDirective%204.10%20Precautions%20shall%20be%20taken%20in%20order%20to%20prevent%20the%20contents%20of%20a%20header%20file%20being%20included%20more%20than%20once=2 misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5C2.1%20A%20project%20shall%20not%20contain%20unreachable%20code=2 misra%20c%202012%20complete\CheckState\Published%20Standards%5CMISRA%20C%202012%5C2.3%20A%20project%20shall%20not%20contain%20unused%20type%20declarations=2 - 

6.2. Set up an Environment variable for your ROOT

Remember you set up a ROOT in your udb file. I defined a LIBFREENECT2_ROOT for the root of my project, pointing to C:\Users\steph_000\Desktop\DEMOS\SonarQube\demo_project\libfreenect2-master.

I must declare an environment variable named UND_NAMED_ROOT_LIBFREENECT2_ROOT (it is UND_NAMED_ROOT_ plus whatever the name of your root was).

So for me, it looks like this:
set UND_NAMED_ROOT_LIBFREENECT2_ROOT=C:\Users\steph_000\Desktop\DEMOS\SonarQube\demo_project\libfreenect2-master

6.3. Running CodeCheck

To run CodeCheck from the command line:

und codecheck MISRA-C-2012.ini MISRA-C-2012-Results -db libfreenect2-master.udb

where:

• MISRA-C-2012.ini is the file you exported from SciTools.
• MISRA-C-2012-Results is the directory in which the results will be created
• libfreenect2-master.udb is your db file.

It may be a good idea to run the analysis before you run codecheck, but this is not necessary. If desired, use the following two commands (again, this is not necessary):

und analyze -db libfreenect2-master.udb
und codecheck MISRA-C-2012.ini MISRA-C-2012-Results -db libfreenect2-master.udb

After a successful analyze, you should see the following files in the MISRA-C-2012-Results directory:

• CodeCheckResultByFile.txt
• CodeCheckResultByTable.csv
• CodeCheckResultByViolation.txt

7. Transforming the Results of CodeCheck into a SonarQube readable XML.

Once again, you will need a script provided by Emenda. The script name is “create_sonarqube-cxx-report-from-scitools-analyis.pl”. It will transform the output of SciTools to something SonarQube can read:

Run the following command:

uperl create_sonarqube-cxx-report-from-scitools-analyis.pl .\MISRA-C-2012-Results\CodeCheckResultByTable.csv CodeCheckResultByTable.xml ALL.xml.key LIBFREENECT2_ROOT

where:

• .\MISRA-C-2012-Results\CodeCheckResultByTable.csv is the csv file created by the SciTools analysis.
• CodeCheckResultByTable.xml is a file that will be created and loaded by sonar-scanner
• ALL.xml.key was created earlier when you first exported all checks from SciTools.
• LIBFREENECT2_ROOT is the root name you defined earlier.

8. Setting up Sonar-Scanner

We now need to set up Sonar to scan our project. To do so, add a file named “sonar-project.properties” in your project root (the same that you defined as LIBFREENECT2_ROOT). This file should contain a line with sonar.cxx.other.reportPath pointing to the file that is created in the previous paragraph, i.e. CodeCheckResultByTable.xml.

Here is my project.properties file (what’s important is the last line!):

# must be unique in a given SonarQube instance 
sonar.projectKey=lib:free:kinect 
# this is the name and version displayed in the SonarQube UI. Was mandatory prior to SonarQube 6.1. 
sonar.projectName=Lib Free Kinect 
sonar.projectVersion=2.0 

# Path is relative to the sonar-project.properties file. Replace "\" by "/" on Windows. 
# Since SonarQube 4.2, this property is optional if sonar.modules is set. 
# If not set, SonarQube starts looking for source code from the directory containing 
 # the sonar-project.properties file. 
sonar.sources=. 

# Encoding of the source code. Default is default system encoding 
#sonar.sourceEncoding=UTF-8 

#Added for Project: 
sonar.cxx.includeDirectories=./include,./include/internal sonar.cxx.other.reportPath=./CodeCheckResultByTable.xml  

Well, this is it, you have everything in place. Now, if you want to run an analysis (thru Jenkins or others), here is the list of what you need to do:

a) Set you root:

set UND_NAMED_ROOT_LIBFREENECT2_ROOT=C:\Users\steph_000\Desktop\DEMOS\SonarQube\demo_project\libfreenect2-master

When done, you will be able to see the SciTools Issues in SonarQube:

You done!!!

Please send comments and questions to [email protected]

9. About the Author: Thanks for Reading.

Stephane Raynaud , Principal at Emenda USA. Stephane is an engineer that decided to pursue a career in software development and consulting. His first job was developing requirements for a drone program and prior to Emenda he had been running a multi million dollar consulting organization around C and C++. He is now applying his expertise and Emenda Best Practices to help software developers across North America build better code. ( [email protected] )