Source Code Analysis Scope
Files includes and excluded from analyses
properties

scoping details...
  • 12 extensions are included in analyses: java, properties, gradle, xml, md, txt, yml, css, gitignore, jsp, bat, sh
  • 9 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (5 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (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.
main14826 LOC (79%) 108 files
test2966 LOC (15%) 16 files
generated0 LOC (0%) 0 files
build and deployment610 LOC (3%) 14 files
other186 LOC (1%) 19 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

java14748 LOC (99%) 103 files
xml67 LOC (<1%) 3 files
yaml9 LOC (<1%) 1 file
jsp2 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 108 files match defined criteria (14,826 LOC, 100.0% vs. main code):
    • 103 java files (14,748 LOC)
    • 3 xml files (67 LOC)
    • 1 yaml files (9 LOC)
    • 1 jsp files (2 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

java2937 LOC (99%) 14 files
xml29 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*UnitTests[.][a-zA-Z0-9_]+".
  • 16 files match defined criteria (2,966 LOC, 20.0% vs. main code):
    • 14 java files (2,937 LOC)
    • 2 xml files (29 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gradle220 LOC (36%) 8 files
yaml135 LOC (22%) 3 files
xml132 LOC (21%) 1 file
gitignore62 LOC (10%) 1 file
bat61 LOC (10%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]gradle".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
  • 14 files match defined criteria (610 LOC, 4.1% vs. main code):
    • 8 gradle files (220 LOC)
    • 3 yaml files (135 LOC)
    • 1 xml files (132 LOC)
    • 1 gitignore files (62 LOC)
    • 1 bat files (61 LOC)
Other Code
properties
Explore:   circles  |  sunburst

properties142 LOC (76%) 17 files
txt33 LOC (17%) 1 file
md11 LOC (5%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
  • 19 files match defined criteria (186 LOC, 1.3% vs. main code):
    • 17 properties files (142 LOC)
    • 1 txt files (33 LOC)
    • 1 md files (11 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)
  • *.xml 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
  • *.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
  • *.jsp files are analyzed with JspAnalyzer:
    • 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