Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 13 extensions are included in analyses: c, h, txt, sh, md, cpp, yml, json, gitignore, clang-format, gitattributes, cmake, clang-tidy
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/extern(al)?/.*" (Dependencies) (3 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 files).
- exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
- exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
- exclude files with path like ".*[.]txt" (Text files) (3 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 49 files:
- 29 files are included in analyses.
- 20 files are excluded from analyses:
Overview of Analyzed Files
Basic stats on analyzed files
Intro
For analysis purposes we separate files in scope into several categories: main, test, generated, deployment and build, and other.
- The main category contains all manually created source code files that are being used in the production.
- Files in the main category are used as input for other analyses: logical decomposition, concerns, duplication, file size, unit size, and conditional complexity.
- Test source code files are used only for testing of the product. These files are normally not deployed to production.
- Build and deployment source code files are used to configure or support build and deployment process.
- Generated source code files are automatically generated files that have not been manually changed after generation.
- While a source code folder may contain a number of files, we are primarily interested in the source code files that are being written and maintained by developers.
- Files containing binaries, documentation, or third-party libraries, for instance, are excluded from analysis. The exception are third-party libraries that have been changed by developers.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*".
- 16 files match defined criteria (2,873 lines of code, 100.0% vs. main code):
- 7 *.c files (2,482 lines of code)
- 8 *.h files (382 lines of code)
- 1 *.cmake files (9 lines of code)
- " *.c" is biggest, containing 86.39% of code.
- " *.cmake" is smallest, containing 0.31% of code.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*_tests[.].*".
- files with paths like ".*/tests_.*".
- files with paths like ".*_test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 5 files match defined criteria (1,437 lines of code, 50.0% vs. main code):
- 4 *.c files (1,317 lines of code)
- 1 *.cpp files (120 lines of code)
- " *.c" is biggest, containing 91.65% of code.
- " *.cpp" is smallest, containing 8.35% of code.
Generated Code
Automatically generated files, not manually changed after generation.
- The following criteria are used to filter files:
- files with paths like ".*[.](py|java|h|cc|cpp|m|rb|php)" AND any line of content like ".*Generated by the protocol buffer compiler[.][ ]+DO NOT EDIT[!].*".
- 2 files match defined criteria (545 lines of code, 19.0% vs. main code):
- 1 *.cpp files (299 lines of code)
- 1 *.h files (246 lines of code)
- " *.cpp" is biggest, containing 54.86% of code.
- " *.h" is smallest, containing 45.14% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
- The following criteria are used to filter files:
- files with paths like ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*/[.]gitignore".
- 2 files match defined criteria (29 lines of code, 1.0% vs. main code). All matches are in *.sh files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- 4 files match defined criteria (92 lines of code, 3.2% vs. main code):
- 3 *.md files (83 lines of code)
- 1 *.json files (9 lines of code)
- " *.md" is biggest, containing 90.22% of code.
- " *.json" is smallest, containing 9.78% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.c files are analyzed with CStyleAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- No dependency analysis
- *.h files are analyzed with CppAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
- Unit size analysis
- Conditional complexity analysis
- Advanced heuristic dependency analysis
- *.cmake files are analyzed with DefaultLanguageAnalyzer:
- All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
- Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
2022-01-31 19:25