Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 11 extensions are included in analyses: tf, md, yaml, yml, sh, tpl, tfvars, py, json, gitignore, txt
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (20 files).
- exclude files with path like ".*/docs/.*" (Documentation) (33 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 401 files:
- 341 files are included in analyses.
- 60 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 ".*".
- 184 files match defined criteria (8,075 lines of code, 100.0% vs. main code):
- 157 *.tf files (7,716 lines of code)
- 20 *.yaml files (247 lines of code)
- 6 *.tpl files (57 lines of code)
- 1 *.yml files (55 lines of code)
- " *.tf" is biggest, containing 95.55% of code.
- " *.yml" is smallest, containing 0.68% 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 ".*/e2e/.*".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*/[Tt]est/.*".
- files with any line of content like ".*/simpletest/.*".
- 7 files match defined criteria (153 lines of code, 1.9% vs. main code):
- 5 *.tf files (141 lines of code)
- 2 *.tfvars files (12 lines of code)
- " *.tf" is biggest, containing 92.16% of code.
- " *.tfvars" is smallest, containing 7.84% of code.
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 ".*/[Ee]xamples/.*".
- files with paths like ".*[.]json".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- 150 files match defined criteria (14,772 lines of code, 182.9% vs. main code):
- 1 *.json files (5,625 lines of code)
- 61 *.md files (3,870 lines of code)
- 25 *.tf files (2,691 lines of code)
- 49 *.yaml files (2,229 lines of code)
- 10 *.sh files (260 lines of code)
- 2 *.py files (57 lines of code)
- 1 *.yml files (34 lines of code)
- 1 *.tfvars files (6 lines of code)
- " *.json" is biggest, containing 38.08% of code.
- " *.tfvars" is smallest, containing 0.04% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.tf 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
- *.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
- *.tpl 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
- *.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
2022-01-31 17:03