Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 23 extensions are included in analyses: py, js, json, md, gradle, java, txt, go, toml, rb, mod, xml, yml, gitignore, cs, csproj, cfg, bat, npmrc, yaml, in, properties, ts
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/testdata/.*" (Test data) (107 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
- exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (0 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) (3 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 333 files:
- 187 files are included in analyses.
- 146 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 ".*".
- 75 files match defined criteria (2,931 lines of code, 100.0% vs. main code):
- 72 *.py files (2,909 lines of code)
- 1 *.toml files (16 lines of code)
- 1 *.in files (4 lines of code)
- 1 *.cfg files (2 lines of code)
- " *.py" is biggest, containing 99.25% of code.
- " *.cfg" is smallest, containing 0.07% 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/.*".
- 96 files match defined criteria (6,138 lines of code, 209.4% vs. main code):
- 87 *.py files (6,095 lines of code)
- 5 *.go files (25 lines of code)
- 4 *.toml files (18 lines of code)
- " *.py" is biggest, containing 99.3% of code.
- " *.toml" is smallest, containing 0.29% 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 ".*[.]csproj".
- files with paths like ".*/pom[.]xml".
- files with paths like ".*/package[.]json".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/package[-]lock[.]json".
- files with paths like ".*[.]gradle".
- files with paths like ".*[.]bat".
- 1 file matches defined criteria (88 lines of code, 3.0% vs. main code). All matches are in *.gradle files.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]json".
- files with paths like ".*/go[.]mod".
- files with paths like ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]npmrc".
- files with paths like ".*[.]properties".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 15 files match defined criteria (1,163 lines of code, 39.7% vs. main code):
- 14 *.md files (1,162 lines of code)
- 1 *.json files (1 lines of code)
- " *.md" is biggest, containing 99.91% of code.
- " *.json" is smallest, containing 0.09% 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
- *.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
- *.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
2022-01-31 14:55