Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 14 extensions are included in analyses: html, kt, xml, md, gradle, txt, gitignore, pro, properties, css, java, bat, yml, json
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (6 files).
- exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
- exclude files with path like ".*/docs/.*" (Documentation) (726 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 ".*/proguard[-]rules[.]pro" (ProGuard) (2 files).
- exclude files with path like ".*[.]txt" (Text files) (3 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 1,224 files:
- 326 files are included in analyses.
- 898 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 ".*".
- 210 files match defined criteria (10,769 lines of code, 100.0% vs. main code):
- 209 *.kt files (10,768 lines of code)
- 1 *.pro files (1 lines of code)
- " *.kt" is biggest, containing 99.99% of code.
- " *.pro" is smallest, containing 0.01% 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]est/.*".
- files with paths like ".*/src/androidTest/.*".
- files with any line of content like ".*/simpletest/.*".
- 55 files match defined criteria (7,120 lines of code, 66.1% vs. main code):
- 54 *.kt files (7,024 lines of code)
- 1 *.java files (96 lines of code)
- " *.kt" is biggest, containing 98.65% of code.
- " *.java" is smallest, containing 1.35% 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 ".*[.]bat".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/AndroidManifest[.]xml".
- files with paths like ".*[.]gradle".
- 5 files match defined criteria (241 lines of code, 2.2% vs. main code):
- 4 *.gradle files (180 lines of code)
- 1 *.bat files (61 lines of code)
- " *.gradle" is biggest, containing 74.69% of code.
- " *.bat" is smallest, containing 25.31% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- 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 ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 56 files match defined criteria (2,711 lines of code, 25.2% vs. main code):
- 10 *.md files (1,435 lines of code)
- 44 *.xml files (1,248 lines of code)
- 2 *.properties files (28 lines of code)
- " *.md" is biggest, containing 52.93% of code.
- " *.properties" is smallest, containing 1.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)
- *.pro 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-01-31 15:15