Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 7 extensions are included in analyses: md, txt, c, sh, json, py, spec
- 2 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).
- The source code folder contains 11 files:
- 8 files are included in analyses.
- 3 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 ".*".
- 2 files match defined criteria (67 lines of code, 100.0% vs. main code):
- 1 *.spec files (53 lines of code)
- 1 *.py files (14 lines of code)
- " *.spec" is biggest, containing 79.1% of code.
- " *.py" is smallest, containing 20.9% 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/.*".
- 2 files match defined criteria (246 lines of code, 367.2% vs. main code):
- 1 *.sh files (192 lines of code)
- 1 *.c files (54 lines of code)
- " *.sh" is biggest, containing 78.05% of code.
- " *.c" is smallest, containing 21.95% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]md".
- files with paths like ".*[.]json".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- 4 files match defined criteria (139 lines of code, 207.5% vs. main code):
- 1 *.json files (72 lines of code)
- 3 *.md files (67 lines of code)
- " *.json" is biggest, containing 51.8% of code.
- " *.md" is smallest, containing 48.2% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.spec 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
- *.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
2022-04-15 05:06