apache / incubator-stormcrawler
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
flux
gitattributes
rss
properties
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.

main10808 LOC (61%) 110 files
test4703 LOC (26%) 76 files
generated0 LOC (0%) 0 files
build and deployment1030 LOC (5%) 5 files
other949 LOC (5%) 20 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
flux
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 110 files match defined criteria (10,808 LOC, 100.0% vs. main code):
    • 105 *.java files (10,506 LOC)
    • 2 *.yaml files (147 LOC)
    • 1 *.flux files (115 LOC)
    • 2 *.xml files (40 LOC)
  • " *.java" is biggest, containing 97.21% of LOC.
  • " *.xml" is smallest, containing 0.37% of LOC.


*.java10506 LOC (97%) 105 files
*.yaml147 LOC (1%) 2 files
*.flux115 LOC (1%) 1 file
*.xml40 LOC (<1%) 2 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
rss
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/mock[a-zA-Z0-9_\- ]+/.*".
    • files with paths like ".*/[Mm]ocks/.*".
    • files with paths like ".*/test[.].*".
  • 76 files match defined criteria (4,703 LOC, 43.5% vs. main code):
    • 62 *.java files (4,105 LOC)
    • 8 *.xml files (388 LOC)
    • 4 *.html files (132 LOC)
    • 1 *.rss files (52 LOC)
    • 1 *.yaml files (26 LOC)
  • " *.java" is biggest, containing 87.28% of LOC.
  • " *.yaml" is smallest, containing 0.55% of LOC.


*.java4105 LOC (87%) 62 files
*.xml388 LOC (8%) 8 files
*.html132 LOC (2%) 4 files
*.rss52 LOC (1%) 1 file
*.yaml26 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 ".*[.]sh".
    • files with paths like ".*/assembly[.]xml".
    • files with paths like ".*/[.]gitattributes".
  • 5 files match defined criteria (1,030 LOC, 9.5% vs. main code). All matches are in *.xml files.


*.xml1030 LOC (100%) 5 files
Other Code
txt
properties
Explore:   circles  |  sunburst
  • 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".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]json".
  • 20 files match defined criteria (949 LOC, 8.8% vs. main code):
    • 6 *.txt files (383 LOC)
    • 4 *.md files (351 LOC)
    • 9 *.json files (211 LOC)
    • 1 *.properties files (4 LOC)
  • " *.txt" is biggest, containing 40.36% of LOC.
  • " *.properties" is smallest, containing 0.42% of LOC.


*.txt383 LOC (40%) 6 files
*.md351 LOC (36%) 4 files
*.json211 LOC (22%) 9 files
*.properties4 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 15:31