spotify / DataflowJavaSDK
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
properties
proto
gitattributes
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.

main51322 LOC (49%) 501 files
test46379 LOC (44%) 295 files
generated0 LOC (0%) 0 files
build and deployment688 LOC (<1%) 6 files
other5657 LOC (5%) 70 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
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 501 files match defined criteria (51,322 LOC, 100.0% vs. main code):
    • 498 *.java files (51,006 LOC)
    • 2 *.proto files (296 LOC)
    • 1 *.xml files (20 LOC)
  • " *.java" is biggest, containing 99.38% of LOC.
  • " *.xml" is smallest, containing 0.04% of LOC.


*.java51006 LOC (99%) 498 files
*.proto296 LOC (<1%) 2 files
*.xml20 LOC (<1%) 1 file
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 ".*/[Tt]est/.*".
    • files with paths like ".*/test_.*".
  • 295 files match defined criteria (46,379 LOC, 90.4% vs. main code):
    • 292 *.java files (46,254 LOC)
    • 1 *.sh files (77 LOC)
    • 1 *.xml files (38 LOC)
    • 1 *.avsc files (10 LOC)
  • " *.java" is biggest, containing 99.73% of LOC.
  • " *.avsc" is smallest, containing 0.02% of LOC.


*.java46254 LOC (99%) 292 files
*.sh77 LOC (<1%) 1 file
*.xml38 LOC (<1%) 1 file
*.avsc10 LOC (<1%) 1 file
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 ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*[.]sh".
  • 6 files match defined criteria (688 LOC, 1.3% vs. main code). All matches are in *.xml files.


*.xml688 LOC (100%) 6 files
Other Code
properties
txt
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 ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*/checkstyle.*".
  • 70 files match defined criteria (5,657 LOC, 11.0% vs. main code):
    • 48 *.java files (4,636 LOC)
    • 5 *.xml files (624 LOC)
    • 12 *.md files (382 LOC)
    • 3 *.properties files (13 LOC)
    • 2 *.txt files (2 LOC)
  • " *.java" is biggest, containing 81.95% of LOC.
  • " *.txt" is smallest, containing 0.04% of LOC.


*.java4636 LOC (81%) 48 files
*.xml624 LOC (11%) 5 files
*.md382 LOC (6%) 12 files
*.properties13 LOC (<1%) 3 files
*.txt2 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2025-01-17 11:38