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: java, md, xml, patch, cc, pb, sh, py, txt, gitignore, h, json, yml, yaml
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
- exclude files with path like ".*/docs/.*" (Documentation) (3 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 ".*/extern(al)?/.*" (Dependencies) (5 files).
- exclude files with path like ".*/[Jj]avadoc/.*" (Generated documentation) (5 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (1 file).
- The source code folder contains 3,908 files:
- 2,368 files are included in analyses.
- 1,540 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 ".*".
- 283 files match defined criteria (22,098 lines of code, 100.0% vs. main code):
- 279 *.java files (21,645 lines of code)
- 2 *.cc files (378 lines of code)
- 1 *.py files (50 lines of code)
- 1 *.h files (25 lines of code)
- " *.java" is biggest, containing 97.95% of code.
- " *.h" is smallest, containing 0.11% 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 any line of content like ".*/simpletest/.*".
- 157 files match defined criteria (20,858 lines of code, 94.4% vs. main code):
- 153 *.java files (19,113 lines of code)
- 2 *.pb files (1,701 lines of code)
- 1 *.py files (39 lines of code)
- 1 *.cc files (5 lines of code)
- " *.java" is biggest, containing 91.63% of code.
- " *.cc" is smallest, containing 0.02% of code.
Generated Code
Automatically generated files, not manually changed after generation.
- The following criteria are used to filter files:
- files with paths like ".*/src/gen/.*".
- files with paths like ".*[.](py|java|h|cc|cpp|m|rb|php)" AND any line of content like ".*Generated by the protocol buffer compiler[.][ ]+DO NOT EDIT[!].*".
- 1910 files match defined criteria (407,190 lines of code, 1842.7% vs. main code):
- 1,909 *.java files (367,853 lines of code)
- 1 *.pb files (39,337 lines of code)
- " *.java" is biggest, containing 90.34% of code.
- " *.pb" is smallest, containing 9.66% 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 ".*/[.]gitignore".
- files with paths like ".*/pom[.]xml".
- 3 files match defined criteria (185 lines of code, 0.8% vs. main code). All matches are in *.sh 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 ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]patch".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 15 files match defined criteria (2,816 lines of code, 12.7% vs. main code):
- 9 *.xml files (2,109 lines of code)
- 6 *.md files (707 lines of code)
- " *.xml" is biggest, containing 74.89% of code.
- " *.md" is smallest, containing 25.11% 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)
- *.cc files are analyzed with CppAnalyzer:
- 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
- *.py files are analyzed with PythonAnalyzer:
- 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
- *.h files are analyzed with CppAnalyzer:
- 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
2022-02-03 08:23