Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 15 extensions are included in analyses: cpp, h, txt, md, sh, yml, clang-tidy, cc, 03, 04, in, gitignore, clang-format, cmake, json
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (6 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) (6 files).
- exclude files with path like ".*[.][0-9]+" (Binary files (e.g. multipart archives)) (2 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 54 files:
- 33 files are included in analyses.
- 21 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 ".*".
- 14 files match defined criteria (4,052 lines of code, 100.0% vs. main code):
- 6 *.h files (3,464 lines of code)
- 3 *.cpp files (489 lines of code)
- 3 *.yml files (42 lines of code)
- 1 *.in files (41 lines of code)
- 1 *.cmake files (16 lines of code)
- " *.h" is biggest, containing 85.49% of code.
- " *.cmake" is smallest, containing 0.39% 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 any line of content like ".*/simpletest/.*".
- 6 files match defined criteria (16,188 lines of code, 399.5% vs. main code):
- 1 *.h files (8,435 lines of code)
- 1 *.cc files (7,404 lines of code)
- 4 *.cpp files (349 lines of code)
- " *.h" is biggest, containing 52.11% of code.
- " *.cpp" is smallest, containing 2.16% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
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 ".*/[Ee]xamples/.*".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- 9 files match defined criteria (702 lines of code, 17.3% vs. main code):
- 6 *.md files (373 lines of code)
- 3 *.cpp files (329 lines of code)
- " *.md" is biggest, containing 53.13% of code.
- " *.cpp" is smallest, containing 46.87% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.cpp 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
- *.yml files are analyzed with YamlAnalyzer:
- 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)
- No unit size analysis
- No conditional complexity analysis
- No dependency analysis
- *.in files are analyzed with RustAnalyzer:
- 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
- *.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 18:27