Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 21 extensions are included in analyses: yaml, py, md, svg, rst, js, txt, css, gitignore, yml, sh, json, mdx, jinja, c, in, toml, editorconfig, html, eslintignore, prettierignore
- 5 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (22 files).
- exclude files with path like ".*/docs/.*" (Documentation) (57 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).
- The source code folder contains 1,126 files:
- 1,028 files are included in analyses.
- 98 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 ".*".
- 882 files match defined criteria (54,344 lines of code, 100.0% vs. main code):
- 299 *.py files (36,345 lines of code)
- 574 *.yaml files (17,456 lines of code)
- 4 *.js files (289 lines of code)
- 2 *.css files (108 lines of code)
- 1 *.c files (105 lines of code)
- 1 *.toml files (36 lines of code)
- 1 *.in files (5 lines of code)
- " *.py" is biggest, containing 66.88% of code.
- " *.in" 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]ests/.*".
- files with paths like ".*/test_.*".
- files with paths like ".*_test[.].*".
- 92 files match defined criteria (7,582 lines of code, 14.0% vs. main code):
- 89 *.py files (7,557 lines of code)
- 3 *.yaml files (25 lines of code)
- " *.py" is biggest, containing 99.67% of code.
- " *.yaml" is smallest, containing 0.33% 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".
- 2 files match defined criteria (74 lines of code, 0.1% 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 ".*[.]txt".
- files with paths like ".*[.]mdx".
- files with paths like ".*/[.]prettierignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*[.]svg".
- files with paths like ".*/[.]eslintignore".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*[.]editorconfig".
- 52 files match defined criteria (1,401 lines of code, 2.6% vs. main code):
- 42 *.md files (1,089 lines of code)
- 9 *.svg files (262 lines of code)
- 1 *.json files (50 lines of code)
- " *.md" is biggest, containing 77.73% of code.
- " *.json" is smallest, containing 3.57% 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
- *.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
- *.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
- *.css files are analyzed with CssAnalyzer:
- 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
- *.c files are analyzed with CStyleAnalyzer:
- 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
- *.toml 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
- *.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-25 19:34