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: java, md, py, go, js, xml, cs, sh, json, properties, txt, ipynb, gitignore, yaml, ini, csproj
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (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 ".*[.]txt" (Text files) (4 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 244 files:
- 226 files are included in analyses.
- 18 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 ".*".
- 145 files match defined criteria (21,563 lines of code, 100.0% vs. main code):
- 60 *.java files (7,358 lines of code)
- 25 *.go files (4,919 lines of code)
- 31 *.py files (3,519 lines of code)
- 12 *.cs files (3,308 lines of code)
- 14 *.js files (2,364 lines of code)
- 3 *.yaml files (95 lines of code)
- " *.java" is biggest, containing 34.12% of code.
- " *.yaml" is smallest, containing 0.44% of code.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
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 ".*/pom[.]xml".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]sh".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]csproj".
- files with paths like ".*/package[-]lock[.]json".
- 9 files match defined criteria (320 lines of code, 1.5% vs. main code):
- 7 *.sh files (290 lines of code)
- 2 *.csproj files (30 lines of code)
- " *.sh" is biggest, containing 90.62% of code.
- " *.csproj" is smallest, containing 9.38% 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 ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]ini".
- files with paths like ".*[.]json".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]properties".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 71 files match defined criteria (6,540 lines of code, 30.3% vs. main code):
- 3 *.ipynb files (2,327 lines of code)
- 36 *.md files (1,506 lines of code)
- 6 *.json files (1,131 lines of code)
- 13 *.xml files (987 lines of code)
- 5 *.py files (503 lines of code)
- 6 *.properties files (62 lines of code)
- 2 *.ini files (24 lines of code)
- " *.ipynb" is biggest, containing 35.58% of code.
- " *.ini" is smallest, containing 0.37% 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)
- *.go files are analyzed with GoLangAnalyzer:
- 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
- *.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
- *.cs files are analyzed with CSharpAnalyzer:
- 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 namespace heuristics)
- *.js files are analyzed with JavaScriptAnalyzer:
- 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
- No dependency analysis
- *.yaml 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
2022-01-31 19:31