Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 15 extensions are included in analyses: txt, java, md, kts, tf, yml, xml, json, gitignore, gitattributes, dockerignore, sql, bat, proto, properties
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (4 files).
- exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (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) (46 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 167 files:
- 56 files are included in analyses.
- 111 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 ".*".
- 21 files match defined criteria (1,230 lines of code, 100.0% vs. main code):
- 7 *.tf files (757 lines of code)
- 9 *.kts files (371 lines of code)
- 3 *.yml files (44 lines of code)
- 1 *.java files (37 lines of code)
- 1 *.proto files (21 lines of code)
- " *.tf" is biggest, containing 61.54% of code.
- " *.proto" is smallest, containing 1.71% of code.
Generated Code
Automatically generated files, not manually changed after generation.
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 ".*/docker[-]compose[.]yml".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*[.]bat".
- files with paths like ".*/[.]gitignore".
- 2 files match defined criteria (203 lines of code, 16.5% vs. main code):
- 1 *.yml files (135 lines of code)
- 1 *.bat files (68 lines of code)
- " *.yml" is biggest, containing 66.5% of code.
- " *.bat" is smallest, containing 33.5% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]properties".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/[.]dockerignore".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 33 files match defined criteria (3,291 lines of code, 267.6% vs. main code):
- 13 *.md files (2,306 lines of code)
- 16 *.java files (928 lines of code)
- 2 *.xml files (26 lines of code)
- 1 *.sql files (16 lines of code)
- 1 *.json files (15 lines of code)
- " *.md" is biggest, containing 70.07% of code.
- " *.json" is smallest, containing 0.46% 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
- *.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)
- *.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
- *.java files are analyzed with JavaAnalyzer:
- 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 (based on package names)
- *.proto 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-01 02:42