Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 16 extensions are included in analyses: go, json, md, yaml, toml, yml, sh, ps1, txt, tf, mod, dockerignore, spec, plist, gitignore, gitmodules
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (10 files).
- exclude files with path like ".*/testdata/.*" (Test data) (1 file).
- 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) (1 file).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 1,120 files:
- 977 files are included in analyses.
- 143 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 ".*".
- 560 files match defined criteria (39,508 lines of code, 100.0% vs. main code):
- 508 *.go files (31,508 lines of code)
- 40 *.yaml files (7,152 lines of code)
- 3 *.ps1 files (555 lines of code)
- 3 *.tf files (117 lines of code)
- 1 *.spec files (95 lines of code)
- 4 *.toml files (73 lines of code)
- 1 *.yml files (8 lines of code)
- " *.go" is biggest, containing 79.75% of code.
- " *.yml" is smallest, containing 0.02% 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 ".*[-]test[-].*".
- files with paths like ".*/[Tt]est/.*".
- files with any line of content like ".*/simpletest/.*".
- 202 files match defined criteria (22,095 lines of code, 55.9% vs. main code):
- 198 *.go files (22,087 lines of code)
- 4 *.toml files (8 lines of code)
- " *.go" is biggest, containing 99.96% of code.
- " *.toml" is smallest, containing 0.04% 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 ".*[.]sh".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitmodules".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/docker[-]compose[.]yml".
- 7 files match defined criteria (328 lines of code, 0.8% vs. main code):
- 6 *.sh files (304 lines of code)
- 1 *.yml files (24 lines of code)
- " *.sh" is biggest, containing 92.68% of code.
- " *.yml" is smallest, containing 7.32% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/[Dd]emos?/.*".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/go[.]mod".
- files with paths like ".*[.]plist".
- files with paths like ".*/[.]dockerignore".
- 208 files match defined criteria (11,899 lines of code, 30.1% vs. main code):
- 134 *.json files (9,669 lines of code)
- 70 *.md files (2,084 lines of code)
- 1 *.mod files (67 lines of code)
- 2 *.go files (56 lines of code)
- 1 *.plist files (23 lines of code)
- " *.json" is biggest, containing 81.26% of code.
- " *.plist" is smallest, containing 0.19% 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
- *.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
- *.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
- *.spec 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
- *.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
- *.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 15:16