Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 19 extensions are included in analyses: json, py, txt, md, sql, xml, gitignore, rst, ipynb, cfg, bat, yaml, in, sh, js, fish, markdown, csh, html
- 9 criteria are used to exclude files from analysis:
- 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 ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (885 files).
- exclude files with path like ".*/docs/.*" (Documentation) (13 files).
- exclude files with path like ".*/extern(al)?/.*" (Dependencies) (0 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (0 files).
- exclude files with path like ".*[.]txt" (Text files) (7 files).
- exclude files with path like ".*venv/(lib|lib64)/python.*" (3rd party Python libraries) (0 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 1,348 files:
- 166 files are included in analyses.
- 1,182 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 ".*".
- 91 files match defined criteria (11,992 lines of code, 100.0% vs. main code):
- 83 *.py files (11,351 lines of code)
- 1 *.html files (383 lines of code)
- 3 *.yaml files (164 lines of code)
- 2 *.cfg files (68 lines of code)
- 1 *.js files (21 lines of code)
- 1 *.in files (5 lines of code)
- " *.py" is biggest, containing 94.65% of code.
- " *.in" is smallest, containing 0.04% 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 ".*_test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 3 files match defined criteria (27 lines of code, 0.2% vs. main code):
- 2 *.py files (21 lines of code)
- 1 *.sh files (6 lines of code)
- " *.py" is biggest, containing 77.78% of code.
- " *.sh" is smallest, containing 22.22% 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 ".*/package[.]json".
- files with paths like ".*[.]bat".
- 4 files match defined criteria (60 lines of code, 0.5% vs. main code):
- 3 *.bat files (33 lines of code)
- 1 *.sh files (27 lines of code)
- " *.bat" is biggest, containing 55% of code.
- " *.sh" is smallest, containing 45% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]markdown".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 68 files match defined criteria (51,536 lines of code, 429.8% vs. main code):
- 46 *.json files (47,632 lines of code)
- 3 *.ipynb files (3,081 lines of code)
- 9 *.md files (466 lines of code)
- 3 *.rst files (137 lines of code)
- 6 *.sql files (133 lines of code)
- 1 *.markdown files (87 lines of code)
- " *.json" is biggest, containing 92.42% of code.
- " *.markdown" is smallest, containing 0.17% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.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
- *.html files are analyzed with HtmlAnalyzer:
- 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
- *.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
- *.cfg files are analyzed with CfgAnalyzer:
- 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
- *.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
- *.in files are analyzed with RustAnalyzer:
- 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
2022-01-31 16:14