Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 17 extensions are included in analyses: cs, csproj, json, md, g4, ps1, resx, txt, xml, yml, wixproj, gitignore, wxi, gitattributes, wxs, nuspec, yaml
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 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 ".*[.]resx" (The resx resource files) (4 files).
- exclude files with path like ".*[.]txt" (Text files) (3 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 561 files:
- 521 files are included in analyses.
- 40 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 ".*".
- 379 files match defined criteria (24,519 lines of code, 100.0% vs. main code):
- 360 *.cs files (23,794 lines of code)
- 8 *.g4 files (270 lines of code)
- 4 *.ps1 files (186 lines of code)
- 3 *.yml files (85 lines of code)
- 1 *.yaml files (76 lines of code)
- 1 *.wixproj files (72 lines of code)
- 1 *.wxs files (29 lines of code)
- 1 *.wxi files (7 lines of code)
- " *.cs" is biggest, containing 97.04% of code.
- " *.wxi" is smallest, containing 0.03% 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]est/.*".
- files with paths like ".*[.][Tt]est[.].*".
- files with any line of content like ".*/simpletest/.*".
- 93 files match defined criteria (8,418 lines of code, 34.3% vs. main code):
- 83 *.cs files (8,193 lines of code)
- 9 *.csproj files (223 lines of code)
- 1 *.ps1 files (2 lines of code)
- " *.cs" is biggest, containing 97.33% of code.
- " *.ps1" is smallest, containing 0.02% 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 ".*[.]csproj".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitattributes".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]nuspec".
- 18 files match defined criteria (432 lines of code, 1.8% vs. main code):
- 17 *.csproj files (415 lines of code)
- 1 *.nuspec files (17 lines of code)
- " *.csproj" is biggest, containing 96.06% of code.
- " *.nuspec" is smallest, containing 3.94% 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 ".*[.]txt".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*/README[.][a-z0-9]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/LICENSE[.][a-z0-9]+".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 31 files match defined criteria (2,692 lines of code, 11.0% vs. main code):
- 18 *.json files (2,082 lines of code)
- 10 *.md files (542 lines of code)
- 3 *.xml files (68 lines of code)
- " *.json" is biggest, containing 77.34% of code.
- " *.xml" is smallest, containing 2.53% 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)
- *.g4 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
- *.ps1 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
- *.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
- *.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
- *.wixproj files are analyzed with XmlAnalyzer:
- 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
- *.wxs files are analyzed with XmlAnalyzer:
- 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
- *.wxi files are analyzed with XmlAnalyzer:
- 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-31 18:26