Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 12 extensions are included in analyses: go, yaml, md, sh, yml, json, txt, tpl, mod, gitignore, py, MD
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (5 files).
- exclude files with path like ".*/docs/.*" (Documentation) (19 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 354 files:
- 296 files are included in analyses.
- 58 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 ".*".
- 169 files match defined criteria (19,059 lines of code, 100.0% vs. main code):
- 110 *.go files (16,061 lines of code)
- 56 *.yaml files (2,770 lines of code)
- 3 *.tpl files (228 lines of code)
- " *.go" is biggest, containing 84.27% of code.
- " *.tpl" is smallest, containing 1.2% 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 ".*_test[.].*".
- files with paths like ".*/e2e/.*".
- files with any line of content like ".*/simpletest/.*".
- 67 files match defined criteria (6,798 lines of code, 35.7% vs. main code):
- 35 *.go files (4,478 lines of code)
- 17 *.yaml files (1,010 lines of code)
- 6 *.sh files (987 lines of code)
- 8 *.yml files (250 lines of code)
- 1 *.py files (73 lines of code)
- " *.go" is biggest, containing 65.87% of code.
- " *.py" is smallest, containing 1.07% 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 ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]json".
- files with paths like ".*/go[.]mod".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- 54 files match defined criteria (1,587 lines of code, 8.3% vs. main code):
- 33 *.yaml files (726 lines of code)
- 3 *.json files (334 lines of code)
- 15 *.md files (330 lines of code)
- 1 *.mod files (178 lines of code)
- 2 *.sh files (19 lines of code)
- " *.yaml" is biggest, containing 45.75% of code.
- " *.sh" is smallest, containing 1.2% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.go files are analyzed with GoLangAnalyzer:
- 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
- *.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
2022-02-03 09:21