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: rst, json, py, txt, html, md, yml, css, js, ini, in, cfg, gitignore, toml, sh, cmd
- 8 criteria are used to exclude files from analysis:
- exclude files with path like ".*/docs/.*" (Documentation) (3 files).
- exclude files with path like ".*/dependencies/.*" (Dependencies) (2 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (1365 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 ".*/bin/.*" (Binaries for distribution) (2 files).
- exclude files with path like ".*[.]txt" (Text files) (7 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 6,950 files:
- 5,489 files are included in analyses.
- 1,461 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 ".*".
- 226 files match defined criteria (25,085 lines of code, 100.0% vs. main code):
- 216 *.py files (24,818 lines of code)
- 7 *.html files (226 lines of code)
- 1 *.cfg files (31 lines of code)
- 1 *.in files (6 lines of code)
- 1 *.toml files (4 lines of code)
- " *.py" is biggest, containing 98.94% of code.
- " *.toml" is smallest, containing 0.02% 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[-].*".
- files with any line of content like ".*/simpletest/.*".
- 365 files match defined criteria (46,038 lines of code, 183.5% vs. main code). All matches are in *.py files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]json".
- files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
- files with paths like ".*[.]ini".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- 4898 files match defined criteria (132,026 lines of code, 526.3% vs. main code):
- 4,875 *.rst files (131,373 lines of code)
- 19 *.json files (460 lines of code)
- 3 *.md files (186 lines of code)
- 1 *.ini files (7 lines of code)
- " *.rst" is biggest, containing 99.51% of code.
- " *.ini" is smallest, containing 0.01% 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
- *.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
- *.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
- *.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
2022-01-30 22:20