Fix Generated sonar-project.properties Configuration

[jungleraptor]

Fixes test and header files not being analyzed by sonarcloud.

From the sonarcloud documentation:

The sonar.tests property is used to identify the directories containing test source files. Identifying test files helps the analyzers to tune their rules. For example, the analyzers can enable test-specific rules and disable rules that don't make sense in the context of testing.

The C/C++/Objective-C analyzer currently analyzes main and test source files in the same way. Consequently, sonar.tests is not yet supported; the analyzer ignores it.

If you wish to analyze test source files, you should include them in the sonar.sources property.

Since we were putting all of our test files under sonar.test.inclusions, they were being ignored by the scanner.

This changes the sonar.inclusions property to sonar.sources, and appends the test paths to it instead of sonar.tests. With these changes, header and test files are properly analyzed by the sonar-scanner.

[RReichert]

Other than the slight refactor, I see no issue. Would be nice to see a PR that uses this cmake changes to see that this actually solves the issue, but I'm okay without it as well.

I'm still shocked that this was what was required to make the header files visible. To me its completely illogical that that is how sonarcloud expects things, there is no distinction between project code and test code.

[RReichert]

Would you be able to refactor this to:

  _extract_sonarcloud_project_files(source_source_files source_include_directories ${source_targets})
  _extract_sonarcloud_project_files(test_source_files test_include_directories ${test_targets})

  set(sonarcloud_project_properties_content "sonar.sourceEncoding=UTF-8\n")
  set(source_files ${source_source_files} ${source_include_directories} ${test_source_files})
  list(JOIN source_files ",${_sonarcloud_newline}" sonar_sources)
  string(APPEND sonarcloud_project_properties_content "sonar.sources=${_sonarcloud_newline}${sonar_sources}\n")

I believe this keeps the same logic, but it just makes it clearer that project source files are source_source_files and test files are actually test_source_files and for the purposes of sonarcloud's implementation we combine them under sonar.sources.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
No Duplication information