Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 18 extensions are included in analyses: py, rst, yaml, md, gitignore, json, js, feature, xml, yml, cfg, txt, gitattributes, bat, html, toml, Project, tfstate
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
- exclude files with path like ".*/docs/.*" (Documentation) (21 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) (0 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 390 files:
- 339 files are included in analyses.
- 51 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 ".*".
- 216 files match defined criteria (16,661 lines of code, 100.0% vs. main code):
- 200 *.py files (14,510 lines of code)
- 10 *.yaml files (2,003 lines of code)
- 1 *.toml files (51 lines of code)
- 1 *.html files (44 lines of code)
- 2 *.cfg files (27 lines of code)
- 1 *.project files (18 lines of code)
- 1 *.tfstate files (8 lines of code)
- " *.py" is biggest, containing 87.09% of code.
- " *.tfstate" is smallest, containing 0.05% 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 ".*_test[.].*".
- files with paths like ".*/test_.*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*[.]feature".
- files with any line of content like ".*/simpletest/.*".
- 117 files match defined criteria (5,983 lines of code, 35.9% vs. main code):
- 112 *.py files (5,438 lines of code)
- 1 *.yml files (354 lines of code)
- 2 *.js files (140 lines of code)
- 2 *.feature files (51 lines of code)
- " *.py" is biggest, containing 90.89% of code.
- " *.feature" is smallest, containing 0.85% of code.
Generated Code
Automatically generated files, not manually changed after generation.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*[.]txt".
- 6 files match defined criteria (478 lines of code, 2.9% vs. main code):
- 2 *.json files (342 lines of code)
- 4 *.md files (136 lines of code)
- " *.json" is biggest, containing 71.55% of code.
- " *.md" is smallest, containing 28.45% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.yaml 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
- *.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
- *.html files are analyzed with HtmlAnalyzer:
- 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
- *.cfg files are analyzed with CfgAnalyzer:
- 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
- *.project 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
- *.tfstate files are analyzed with JsonAnalyzer:
- 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
2022-01-31 18:31