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: cs, html, csproj, plist, json, xml, storyboard, xaml, svg, nuspec, md, txt, js, resx, yml, css, shproj, gitignore, xib, sh, axml
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (11 files).
- exclude files with path like ".*[.]resx" (The resx resource files) (6 files).
- exclude files with path like ".*/docs/.*" (Documentation) (144 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) (7 files).
- The source code folder contains 900 files:
- 684 files are included in analyses.
- 216 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 ".*".
- 353 files match defined criteria (21,591 lines of code, 100.0% vs. main code):
- 349 *.cs files (21,510 lines of code)
- 4 *.yml files (81 lines of code)
- " *.cs" is biggest, containing 99.62% of code.
- " *.yml" is smallest, containing 0.38% 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 ".*[.][Tt]ests/.*".
- files with paths like ".*[.][Tt]ests[.].*".
- files with any line of content like ".*/simpletest/.*".
- 20 files match defined criteria (1,072 lines of code, 5.0% vs. main code):
- 18 *.cs files (908 lines of code)
- 2 *.csproj files (164 lines of code)
- " *.cs" is biggest, containing 84.7% of code.
- " *.csproj" is smallest, containing 15.3% of code.
Generated Code
Automatically generated files, not manually changed after generation.
- The following criteria are used to filter files:
- files with paths like ".*[.]cs" AND any line of content like "[/][/][ ]*
- files with paths like ".*[.](html|html|xhtml)" AND any line of content like "[ ]*[<]meta name[=]"generator" .*".
- files with paths like ".*[.]designer[.](cs|vb)".
- 21 files match defined criteria (599 lines of code, 2.8% vs. main code). All matches are in *.cs files.
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 ".*[.]nuspec".
- files with paths like ".*[.]sh".
- files with paths like ".*/AndroidManifest[.]xml".
- 27 files match defined criteria (1,312 lines of code, 6.1% vs. main code):
- 16 *.csproj files (1,079 lines of code)
- 9 *.nuspec files (216 lines of code)
- 2 *.sh files (17 lines of code)
- " *.csproj" is biggest, containing 82.24% of code.
- " *.sh" is smallest, containing 1.3% of code.
Other Code
- The following criteria are used to filter files:
- files with paths like ".*[.]json".
- files with paths like ".*[.]md".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*[.]txt".
- files with paths like ".*[.]svg".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*[.]plist".
- files with paths like ".*[.]storyboard".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]xib".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 273 files match defined criteria (27,607 lines of code, 127.9% vs. main code):
- 27 *.json files (17,078 lines of code)
- 126 *.cs files (3,798 lines of code)
- 25 *.csproj files (3,023 lines of code)
- 12 *.storyboard files (2,399 lines of code)
- 32 *.plist files (671 lines of code)
- 20 *.xml files (245 lines of code)
- 7 *.md files (124 lines of code)
- 2 *.xib files (86 lines of code)
- 11 *.xaml files (80 lines of code)
- 6 *.svg files (66 lines of code)
- 3 *.shproj files (33 lines of code)
- 2 *.axml files (4 lines of code)
- " *.json" is biggest, containing 61.86% of code.
- " *.axml" is smallest, containing 0.01% 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)
- *.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 22:32