Source Code Analysis Scope
Files includes and excluded from analyses
proto
properties

scoping details...
  • 14 extensions are included in analyses: java, md, gradle, txt, yml, css, xml, sh, proto, json, inc, gitignore, js, properties
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (18 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/testdata/.*" (Test data) (15 files).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (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.
main60590 LOC (58%) 701 files
test41863 LOC (40%) 314 files
generated902 LOC (<1%) 22 files
build and deployment500 LOC (<1%) 20 files
other521 LOC (<1%) 10 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst

java60293 LOC (99%) 694 files
css112 LOC (<1%) 2 files
yaml95 LOC (<1%) 1 file
proto52 LOC (<1%) 1 file
inc23 LOC (<1%) 2 files
js15 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 701 files match defined criteria (60,590 LOC, 100.0% vs. main code):
    • 694 java files (60,293 LOC)
    • 2 css files (112 LOC)
    • 1 yaml files (95 LOC)
    • 1 proto files (52 LOC)
    • 2 inc files (23 LOC)
    • 1 js files (15 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
proto
Explore:   circles  |  sunburst

java41736 LOC (99%) 312 files
proto110 LOC (<1%) 1 file
xml17 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/testing[.].*".
  • 314 files match defined criteria (41,863 LOC, 69.1% vs. main code):
    • 312 java files (41,736 LOC)
    • 1 proto files (110 LOC)
    • 1 xml files (17 LOC)
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst

java902 LOC (100%) 22 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/generated/.*".
  • 22 files match defined criteria (902 LOC, 1.5% vs. main code). All matches are in java files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gradle271 LOC (54%) 12 files
yaml157 LOC (31%) 3 files
sh28 LOC (5%) 2 files
xml25 LOC (5%) 2 files
gitignore19 LOC (3%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]gradle".
    • files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
    • files with paths like ".*/config/checkstyle/.*".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
  • 20 files match defined criteria (500 LOC, 0.8% vs. main code):
    • 12 gradle files (271 LOC)
    • 3 yaml files (157 LOC)
    • 2 sh files (28 LOC)
    • 2 xml files (25 LOC)
    • 1 gitignore files (19 LOC)
Other Code
Explore:   circles  |  sunburst

md329 LOC (63%) 6 files
json182 LOC (34%) 2 files
txt10 LOC (1%) 2 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 ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]properties".
  • 10 files match defined criteria (521 LOC, 0.9% vs. main code):
    • 6 md files (329 LOC)
    • 2 json files (182 LOC)
    • 2 txt files (10 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...
  • *.java files are analyzed with JavaAnalyzer:
    • 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 package names)
  • *.css files are analyzed with CssAnalyzer:
    • 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
  • *.proto 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
  • *.inc files are analyzed with PhpAnalyzer:
    • 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
  • *.js files are analyzed with JavaScriptAnalyzer:
    • 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
    • No dependency analysis