Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 20 extensions are included in analyses: cs, csproj, py, txt, bat, sh, c, in, m4, fs, xml, md, json, nuspec, yml, gitignore, h, vb, resx, pl
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (1 file).
- exclude files with path like ".*[.]m4" (stuff autogenerated by autoconf - still C deps) (2 files).
- exclude files with path like ".*[.]resx" (The resx resource files) (1 file).
- 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) (2 files).
- The source code folder contains 221 files:
- 148 files are included in analyses.
- 73 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 ".*".
- 42 files match defined criteria (10,311 lines of code, 100.0% vs. main code):
- 36 *.cs files (9,038 lines of code)
- 2 *.c files (718 lines of code)
- 1 *.in files (306 lines of code)
- 1 *.pl files (213 lines of code)
- 1 *.h files (20 lines of code)
- 1 *.yml files (16 lines of code)
- " *.cs" is biggest, containing 87.65% of code.
- " *.yml" is smallest, containing 0.16% 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 any line of content like ".*/simpletest/.*".
- 72 files match defined criteria (4,916 lines of code, 47.7% vs. main code):
- 46 *.cs files (3,309 lines of code)
- 23 *.csproj files (1,442 lines of code)
- 1 *.bat files (77 lines of code)
- 1 *.in files (72 lines of code)
- 1 *.sh files (16 lines of code)
- " *.cs" is biggest, containing 67.31% of code.
- " *.sh" is smallest, containing 0.33% of code.
Generated Code
Automatically generated files, not manually changed after generation.
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 ".*[.]csproj".
- files with paths like ".*[.]bat".
- files with paths like ".*[.]nuspec".
- files with paths like ".*[.]sh".
- 10 files match defined criteria (506 lines of code, 4.9% vs. main code):
- 7 *.csproj files (391 lines of code)
- 1 *.bat files (56 lines of code)
- 1 *.sh files (39 lines of code)
- 1 *.nuspec files (20 lines of code)
- " *.csproj" is biggest, containing 77.27% of code.
- " *.nuspec" is smallest, containing 3.95% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]md".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 22 files match defined criteria (850 lines of code, 8.2% vs. main code):
- 5 *.csproj files (286 lines of code)
- 10 *.cs files (198 lines of code)
- 1 *.md files (169 lines of code)
- 3 *.py files (65 lines of code)
- 1 *.fs files (55 lines of code)
- 1 *.xml files (48 lines of code)
- 1 *.vb files (29 lines of code)
- " *.csproj" is biggest, containing 33.65% of code.
- " *.vb" is smallest, containing 3.41% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.cs files are analyzed with CSharpAnalyzer:
- 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 (based on namespace heuristics)
- *.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
- *.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
- *.pl files are analyzed with PerlAnalyzer:
- 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
- *.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
- *.yml 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 15:33