Source Code Analysis Scope
Files includes and excluded from analyses
mod

scoping details...
  • 8 extensions are included in analyses: go, yml, md, py, txt, mod, gitignore, json
  • 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 ".*/testdata/.*" (Test data) (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.
main8682 LOC (35%) 50 files
test14515 LOC (59%) 38 files
generated73 LOC (<1%) 1 file
build and deployment206 LOC (<1%) 5 files
other929 LOC (3%) 4 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst

go7705 LOC (88%) 45 files
py912 LOC (10%) 3 files
yaml65 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 50 files match defined criteria (8,682 LOC, 100.0% vs. main code):
    • 45 go files (7,705 LOC)
    • 3 py files (912 LOC)
    • 2 yaml files (65 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

go14486 LOC (99%) 37 files
py29 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/test_.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/e2e/.*".
  • 38 files match defined criteria (14,515 LOC, 167.2% vs. main code):
    • 37 go files (14,486 LOC)
    • 1 py files (29 LOC)
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst

go73 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with any line of content like "//[ ]*Generated by .*".
  • 1 file matches defined criteria (73 LOC, 0.8% vs. main code). All matches are in go files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
mod
Explore:   circles  |  sunburst

yaml151 LOC (73%) 3 files
mod48 LOC (23%) 1 file
gitignore7 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 5 files match defined criteria (206 LOC, 2.4% vs. main code):
    • 3 yaml files (151 LOC)
    • 1 mod files (48 LOC)
    • 1 gitignore files (7 LOC)
Other Code
Explore:   circles  |  sunburst

md929 LOC (100%) 4 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
  • 4 files match defined criteria (929 LOC, 10.7% vs. main code). All matches are in md files.
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...
  • *.go files are analyzed with GoLangAnalyzer:
    • 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
  • *.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