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: c, h, yaml, sh, cmake, py, txt, in, m, md, json, jq, html, properties, css, svg, gitignore, less, sql, xml, yml
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 files).
- exclude files with path like ".*/deps/.*" (Dependencies) (132 files).
- exclude files with path like ".*/docs/.*" (Documentation) (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) (0 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 246 files:
- 48 files are included in analyses.
- 198 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 ".*".
- 13 files match defined criteria (3,352 lines of code, 100.0% vs. main code):
- 8 *.py files (3,217 lines of code)
- 1 *.c files (71 lines of code)
- 2 *.h files (50 lines of code)
- 2 *.jq files (14 lines of code)
- " *.py" is biggest, containing 95.97% of code.
- " *.jq" is smallest, containing 0.42% 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 ".*/[Ss]pecs/.*".
- files with paths like ".*/[Tt]ests/.*".
- files with any line of content like ".*/simpletest/.*".
- 15 files match defined criteria (1,094 lines of code, 32.6% vs. main code):
- 14 *.yaml files (933 lines of code)
- 1 *.yml files (161 lines of code)
- " *.yaml" is biggest, containing 85.28% of code.
- " *.yml" is smallest, containing 14.72% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]json".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/COPYING[.][a-z0-9]+".
- files with paths like ".*[.]properties".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 7 files match defined criteria (183 lines of code, 5.5% vs. main code):
- 2 *.properties files (76 lines of code)
- 2 *.md files (42 lines of code)
- 1 *.sql files (39 lines of code)
- 2 *.json files (26 lines of code)
- " *.properties" is biggest, containing 41.53% of code.
- " *.json" is smallest, containing 14.21% 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
- *.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
- *.h files are analyzed with CppAnalyzer:
- 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
- *.jq 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-31 15:49