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: py, h, cc, txt, md, rst, yml, yaml, gitignore, clang-format, toml, bat, sh, json, gitmodules
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/docs/.*" (Documentation) (6 files).
- 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) (4 files).
- The source code folder contains 103 files:
- 82 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 ".*".
- 34 files match defined criteria (11,158 lines of code, 100.0% vs. main code):
- 9 *.cc files (6,815 lines of code)
- 21 *.h files (4,204 lines of code)
- 3 *.py files (121 lines of code)
- 1 *.toml files (18 lines of code)
- " *.cc" is biggest, containing 61.08% of code.
- " *.toml" is smallest, containing 0.16% 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]est/.*".
- files with paths like ".*/test_.*".
- files with paths like ".*_tests[.].*".
- 19 files match defined criteria (1,572 lines of code, 14.1% vs. main code):
- 16 *.py files (1,082 lines of code)
- 2 *.cc files (383 lines of code)
- 1 *.h files (107 lines of code)
- " *.py" is biggest, containing 68.83% of code.
- " *.h" is smallest, containing 6.81% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*/[.]gitignore".
- 29 files match defined criteria (3,234 lines of code, 29.0% vs. main code):
- 22 *.py files (2,902 lines of code)
- 5 *.md files (240 lines of code)
- 2 *.yaml files (92 lines of code)
- " *.py" is biggest, containing 89.73% of code.
- " *.yaml" is smallest, containing 2.84% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.cc 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
- *.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
- *.py files are analyzed with PythonAnalyzer:
- 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
- Basic heuristic dependency analysis
- *.toml 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-25 20:18