Source Code Analysis Scope
Files includes and excluded from analyses
ini
mako

scoping details...
  • 10 extensions are included in analyses: py, txt, md, yml, ini, gitignore, mako, toml, sh, yaml
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (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.
main551 LOC (49%) 14 files
test199 LOC (17%) 7 files
generated0 LOC (0%) 0 files
build and deployment192 LOC (17%) 5 files
other166 LOC (14%) 3 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
mako
Explore:   circles  |  sunburst

py474 LOC (86%) 12 files
yaml59 LOC (10%) 1 file
mako18 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 14 files match defined criteria (551 LOC, 100.0% vs. main code):
    • 12 py files (474 LOC)
    • 1 yaml files (59 LOC)
    • 1 mako files (18 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py199 LOC (100%) 7 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
  • 7 files match defined criteria (199 LOC, 36.1% vs. main code). All matches are in py files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gitignore108 LOC (56%) 1 file
yaml54 LOC (28%) 2 files
toml28 LOC (14%) 1 file
sh2 LOC (1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]sh".
    • files with paths like ".*/pyproject[.]toml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/docker[-]compose[.]yml".
  • 5 files match defined criteria (192 LOC, 34.8% vs. main code):
    • 1 gitignore files (108 LOC)
    • 2 yaml files (54 LOC)
    • 1 toml files (28 LOC)
    • 1 sh files (2 LOC)
Other Code
ini
Explore:   circles  |  sunburst

ini92 LOC (55%) 1 file
md74 LOC (44%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 3 files match defined criteria (166 LOC, 30.1% vs. main code):
    • 1 ini files (92 LOC)
    • 2 md files (74 LOC)
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.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
  • *.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
  • *.mako 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