microsoft / presidio
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
txt
ini
cfg
tpl
  • 15 extensions are included in analyses: py, md, yml, yaml, json, txt, ipynb, MD, sh, ini, cfg, html, gitignore, tpl, bat
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (20 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (83 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) (5 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.

main4420 LOC (44%) 110 files
test4875 LOC (49%) 83 files
generated0 LOC (0%) 0 files
build and deployment50 LOC (<1%) 2 files
other574 LOC (5%) 10 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 110 files match defined criteria (4,420 lines of code, 100.0% vs. main code):
    • 91 *.py files (3,823 lines of code)
    • 5 *.md files (327 lines of code)
    • 5 *.yml files (200 lines of code)
    • 5 *.yaml files (34 lines of code)
    • 3 *.cfg files (26 lines of code)
    • 1 *.html files (10 lines of code)
  • " *.py" is biggest, containing 86.49% of code.
  • " *.html" is smallest, containing 0.23% of code.


*.py3823 LOC (86%) 91 files
*.md327 LOC (7%) 5 files
*.yml200 LOC (4%) 5 files
*.yaml34 LOC (<1%) 5 files
*.cfg26 LOC (<1%) 3 files
*.html10 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[-]tests/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*_tests[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 83 files match defined criteria (4,875 lines of code, 110.3% vs. main code):
    • 80 *.py files (4,857 lines of code)
    • 3 *.yaml files (18 lines of code)
  • " *.py" is biggest, containing 99.63% of code.
  • " *.yaml" is smallest, containing 0.37% of code.


*.py4857 LOC (99%) 80 files
*.yaml18 LOC (<1%) 3 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
  • 2 files match defined criteria (50 lines of code, 1.1% vs. main code):
    • 1 *.yml files (32 lines of code)
    • 1 *.bat files (18 lines of code)
  • " *.yml" is biggest, containing 64% of code.
  • " *.bat" is smallest, containing 36% of code.


*.yml32 LOC (64%) 1 files
*.bat18 LOC (36%) 1 files
Other Code
ini
Explore:   circles  |  sunburst
  • 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 ".*[.]txt".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 10 files match defined criteria (574 lines of code, 13.0% vs. main code):
    • 4 *.json files (404 lines of code)
    • 3 *.md files (123 lines of code)
    • 3 *.ini files (47 lines of code)
  • " *.json" is biggest, containing 70.38% of code.
  • " *.ini" is smallest, containing 8.19% of code.


*.json404 LOC (70%) 4 files
*.md123 LOC (21%) 3 files
*.ini47 LOC (8%) 3 files
Analyzers
Info about analyzers used for source code examinations.
  • *.py files are analyzed with PythonAnalyzer:
    • 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
  • *.md 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
  • *.cfg files are analyzed with CfgAnalyzer:
    • 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
  • *.html files are analyzed with HtmlAnalyzer:
    • 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

2022-01-30 20:06