Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 11 extensions are included in analyses: swift, sh, c, yaml, md, h, txt, rb, gitignore, json, dockerignore
- 5 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 ".*/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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (1 file).
- The source code folder contains 76 files:
- 69 files are included in analyses.
- 7 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 ".*".
- 20 files match defined criteria (1,727 lines of code, 100.0% vs. main code):
- 16 *.swift files (1,680 lines of code)
- 4 *.yaml files (47 lines of code)
- " *.swift" is biggest, containing 97.28% of code.
- " *.yaml" is smallest, containing 2.72% 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 ".*/IntegrationTests?/.*".
- files with paths like ".*[-]tests[-].*".
- files with paths like ".*/test_.*".
- files with paths like ".*/tests_.*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*_tests[.].*".
- files with any line of content like ".*/simpletest/.*".
- 40 files match defined criteria (2,110 lines of code, 122.2% vs. main code):
- 22 *.swift files (1,126 lines of code)
- 9 *.sh files (610 lines of code)
- 5 *.c files (186 lines of code)
- 1 *.rb files (161 lines of code)
- 3 *.h files (27 lines of code)
- " *.swift" is biggest, containing 53.36% of code.
- " *.h" is smallest, containing 1.28% 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 ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]sh".
- files with paths like ".*/docker[-]compose[.]yaml".
- 5 files match defined criteria (155 lines of code, 9.0% vs. main code):
- 4 *.sh files (129 lines of code)
- 1 *.yaml files (26 lines of code)
- " *.sh" is biggest, containing 83.23% of code.
- " *.yaml" is smallest, containing 16.77% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]dockerignore".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- 4 files match defined criteria (504 lines of code, 29.2% vs. main code). All matches are in *.md files.
Analyzers
Info about analyzers used for source code examinations.
- *.swift files are analyzed with SwiftAnalyzer:
- 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
- *.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
2022-01-30 22:03