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: txt, json, kt, kts, md, yml, gradle, properties, gitignore, bat, sh, yaml, css, svg, py, editorconfig
- 7 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 ".*/gradle/wrapper/.*" (Gradle) (2 files).
- exclude files with path like ".*/docs/.*" (Documentation) (16 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) (690 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 1,420 files:
- 435 files are included in analyses.
- 985 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 ".*".
- 171 files match defined criteria (8,570 lines of code, 100.0% vs. main code):
- 149 *.kt files (7,396 lines of code)
- 22 *.kts files (1,174 lines of code)
- " *.kt" is biggest, containing 86.3% of code.
- " *.kts" is smallest, containing 13.7% 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 ".*[-]tests/.*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*[-]test[-].*".
- files with paths like ".*/test[-]resources/.*".
- files with any line of content like ".*/simpletest/.*".
- 63 files match defined criteria (6,273 lines of code, 73.2% vs. main code):
- 62 *.kt files (6,173 lines of code)
- 1 *.kts files (100 lines of code)
- " *.kt" is biggest, containing 98.41% of code.
- " *.kts" is smallest, containing 1.59% 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 ".*[.]gradle".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]bat".
- 6 files match defined criteria (264 lines of code, 3.1% vs. main code):
- 5 *.gradle files (196 lines of code)
- 1 *.bat files (68 lines of code)
- " *.gradle" is biggest, containing 74.24% of code.
- " *.bat" is smallest, containing 25.76% 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 ".*[.]properties".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]editorconfig".
- 195 files match defined criteria (151,234 lines of code, 1764.7% vs. main code):
- 176 *.json files (150,156 lines of code)
- 8 *.md files (675 lines of code)
- 2 *.kt files (246 lines of code)
- 1 *.bat files (68 lines of code)
- 5 *.kts files (51 lines of code)
- 3 *.properties files (38 lines of code)
- " *.json" is biggest, containing 99.29% of code.
- " *.properties" is smallest, containing 0.03% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.kt files are analyzed with KotlinAnalyzer:
- 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 (based on imports and package statements)
- *.kts files are analyzed with KotlinAnalyzer:
- 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 (based on imports and package statements)
2022-01-31 18:23