microsoft / krabsetw
Source Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope
Files includes and excluded from analyses
filters
targets
vcxproj
nuspec
gitattributes
csproj
txt
  • 15 extensions are included in analyses: hpp, cpp, cs, md, filters, targets, vcxproj, nuspec, gitignore, gitattributes, csproj, h, txt, json, yml
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (4 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) (0 files).
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.

main7002 LOC (60%) 70 files
test3279 LOC (28%) 33 files
generated0 LOC (0%) 0 files
build and deployment106 LOC (<1%) 3 files
other1229 LOC (10%) 33 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
vcxproj
filters
targets
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 70 files match defined criteria (7,002 lines of code, 100.0% vs. main code):
    • 65 *.hpp files (6,579 lines of code)
    • 1 *.vcxproj files (232 lines of code)
    • 1 *.filters files (137 lines of code)
    • 2 *.cpp files (43 lines of code)
    • 1 *.targets files (11 lines of code)
  • " *.hpp" is biggest, containing 93.96% of code.
  • " *.targets" is smallest, containing 0.16% of code.


*.hpp6579 LOC (93%) 65 files
*.vcxproj232 LOC (3%) 1 files
*.filters137 LOC (1%) 1 files
*.cpp43 LOC (<1%) 2 files
*.targets11 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
vcxproj
csproj
filters
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with any line of content like ".*/simpletest/.*".
  • 33 files match defined criteria (3,279 lines of code, 46.8% vs. main code):
    • 15 *.cpp files (1,628 lines of code)
    • 15 *.cs files (1,252 lines of code)
    • 1 *.vcxproj files (219 lines of code)
    • 1 *.csproj files (121 lines of code)
    • 1 *.filters files (59 lines of code)
  • " *.cpp" is biggest, containing 49.65% of code.
  • " *.filters" is smallest, containing 1.8% of code.


*.cpp1628 LOC (49%) 15 files
*.cs1252 LOC (38%) 15 files
*.vcxproj219 LOC (6%) 1 files
*.csproj121 LOC (3%) 1 files
*.filters59 LOC (1%) 1 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
nuspec
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]nuspec".
    • files with paths like ".*[.]csproj".
  • 3 files match defined criteria (106 lines of code, 1.5% vs. main code). All matches are in *.nuspec files.


*.nuspec106 LOC (100%) 3 files
Other Code
vcxproj
csproj
filters
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*[.]txt".
  • 33 files match defined criteria (1,229 lines of code, 17.6% vs. main code):
    • 14 *.cpp files (448 lines of code)
    • 11 *.cs files (314 lines of code)
    • 1 *.vcxproj files (175 lines of code)
    • 1 *.csproj files (91 lines of code)
    • 4 *.md files (87 lines of code)
    • 1 *.filters files (61 lines of code)
    • 1 *.h files (53 lines of code)
  • " *.cpp" is biggest, containing 36.45% of code.
  • " *.h" is smallest, containing 4.31% of code.


*.cpp448 LOC (36%) 14 files
*.cs314 LOC (25%) 11 files
*.vcxproj175 LOC (14%) 1 files
*.csproj91 LOC (7%) 1 files
*.md87 LOC (7%) 4 files
*.filters61 LOC (4%) 1 files
*.h53 LOC (4%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.hpp 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
  • *.vcxproj 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
  • *.filters 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
  • *.cpp 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
  • *.targets 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-30 14:03