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: h, cpp, json, yml, props, ps1, gitignore, filters, txt, vcxproj, md, dockerfile, gitattributes, nuspec, cmd
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (2 files).
- The source code folder contains 130 files:
- 109 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 ".*".
- 65 files match defined criteria (4,342 lines of code, 100.0% vs. main code):
- 22 *.cpp files (2,360 lines of code)
- 29 *.h files (1,173 lines of code)
- 2 *.vcxproj files (318 lines of code)
- 2 *.filters files (209 lines of code)
- 3 *.yml files (121 lines of code)
- 1 *.ps1 files (81 lines of code)
- 5 *.props files (76 lines of code)
- 1 *.cmd files (4 lines of code)
- " *.cpp" is biggest, containing 54.35% of code.
- " *.cmd" is smallest, containing 0.09% 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 ".*[.][Tt]ests[.].*".
- files with paths like ".*[.]tests[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[.][Tt]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with paths like ".*[.]test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 32 files match defined criteria (5,289 lines of code, 121.8% vs. main code):
- 16 *.cpp files (3,542 lines of code)
- 11 *.h files (939 lines of code)
- 3 *.ps1 files (530 lines of code)
- 1 *.vcxproj files (173 lines of code)
- 1 *.filters files (105 lines of code)
- " *.cpp" is biggest, containing 66.97% of code.
- " *.filters" is smallest, containing 1.99% 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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]dockerfile".
- files with paths like ".*/docker[-]compose[.]yml".
- files with paths like ".*[.]nuspec".
- 3 files match defined criteria (78 lines of code, 1.8% vs. main code):
- 1 *.dockerfile files (32 lines of code)
- 1 *.nuspec files (30 lines of code)
- 1 *.yml files (16 lines of code)
- " *.dockerfile" is biggest, containing 41.03% of code.
- " *.yml" is smallest, containing 20.51% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/README[.][a-z0-9]+".
- 9 files match defined criteria (465 lines of code, 10.7% vs. main code):
- 6 *.json files (372 lines of code)
- 3 *.md files (93 lines of code)
- " *.json" is biggest, containing 80% of code.
- " *.md" is smallest, containing 20% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.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
- *.vcxproj files are analyzed with XmlAnalyzer:
- 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
- *.filters files are analyzed with XmlAnalyzer:
- 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
- *.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
- *.ps1 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
- *.props files are analyzed with XmlAnalyzer:
- 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
- *.cmd 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-30 14:32