apache / ratis-hadoop-projects
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
proto
properties
txt
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.

main8158 LOC (67%) 72 files
test1382 LOC (11%) 25 files
generated0 LOC (0%) 0 files
build and deployment2110 LOC (17%) 20 files
other491 LOC (4%) 12 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 ".*".
  • 72 files match defined criteria (8,158 LOC, 100.0% vs. main code):
    • 63 *.java files (4,850 LOC)
    • 5 *.xml files (2,916 LOC)
    • 4 *.proto files (392 LOC)
  • " *.java" is biggest, containing 59.45% of LOC.
  • " *.proto" is smallest, containing 4.81% of LOC.


*.java4850 LOC (59%) 63 files
*.xml2916 LOC (35%) 5 files
*.proto392 LOC (4%) 4 files
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[-].*".
  • 25 files match defined criteria (1,382 LOC, 16.9% vs. main code):
    • 23 *.java files (1,350 LOC)
    • 1 *.sh files (23 LOC)
    • 1 *.xml files (9 LOC)
  • " *.java" is biggest, containing 97.68% of LOC.
  • " *.xml" is smallest, containing 0.65% of LOC.


*.java1350 LOC (97%) 23 files
*.sh23 LOC (1%) 1 file
*.xml9 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 ".*[.]sh".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*/assembly/src[.]xml".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*/assembly[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 20 files match defined criteria (2,110 LOC, 25.9% vs. main code):
    • 7 *.xml files (1,745 LOC)
    • 12 *.sh files (297 LOC)
    • 1 *.yml files (68 LOC)
  • " *.xml" is biggest, containing 82.7% of LOC.
  • " *.yml" is smallest, containing 3.22% of LOC.


*.xml1745 LOC (82%) 7 files
*.sh297 LOC (14%) 12 files
*.yml68 LOC (3%) 1 file
Other Code
properties
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 ".*[.]properties".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/checkstyle.*".
    • files with paths like ".*/checkstyle[.]xml".
  • 12 files match defined criteria (491 LOC, 6.0% vs. main code):
    • 6 *.md files (289 LOC)
    • 4 *.properties files (104 LOC)
    • 1 *.xml files (66 LOC)
    • 1 *.sh files (32 LOC)
  • " *.md" is biggest, containing 58.86% of LOC.
  • " *.sh" is smallest, containing 6.52% of LOC.


*.md289 LOC (58%) 6 files
*.properties104 LOC (21%) 4 files
*.xml66 LOC (13%) 1 file
*.sh32 LOC (6%) 1 file
Analyzers
Info about analyzers used for source code examinations.


2023-08-11 02:21