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, kts, md, yml, py, xml, properties, gitignore, gitattributes, dockerignore, bat, editorconfig, json, yaml
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (27 files).
- exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
- exclude files with path like ".*/docs/.*" (Documentation) (2 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) (92 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 237 files:
- 52 files are included in analyses.
- 185 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 ".*".
- 29 files match defined criteria (1,682 lines of code, 100.0% vs. main code):
- 18 *.java files (1,035 lines of code)
- 11 *.kts files (647 lines of code)
- " *.java" is biggest, containing 61.53% of code.
- " *.kts" is smallest, containing 38.47% 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 ".*[-]tests/.*".
- files with paths like ".*[-]tests[-].*".
- files with paths like ".*/[Tt]est/.*".
- files with any line of content like ".*/simpletest/.*".
- 12 files match defined criteria (668 lines of code, 39.7% vs. main code):
- 8 *.java files (567 lines of code)
- 3 *.kts files (75 lines of code)
- 1 *.yaml files (26 lines of code)
- " *.java" is biggest, containing 84.88% of code.
- " *.yaml" is smallest, containing 3.89% 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 ".*/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".
- 1 file matches defined criteria (68 lines of code, 4.0% vs. main code). All matches are in *.bat files.
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 ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]editorconfig".
- 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)".
- 10 files match defined criteria (1,546 lines of code, 91.9% vs. main code):
- 7 *.md files (1,505 lines of code)
- 2 *.xml files (26 lines of code)
- 1 *.properties files (15 lines of code)
- " *.md" is biggest, containing 97.35% of code.
- " *.properties" is smallest, containing 0.97% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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)
- *.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-02-01 02:42