apache / incubator-training
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
cmd
slim
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.

main7621 LOC (36%) 47 files
test0 LOC (0%) 0 files
generated903 LOC (4%) 1 file
build and deployment2634 LOC (12%) 60 files
other9995 LOC (47%) 107 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
slim
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 47 files match defined criteria (7,621 LOC, 100.0% vs. main code):
    • 30 *.css files (6,896 LOC)
    • 5 *.xml files (281 LOC)
    • 1 *.slim files (250 LOC)
    • 6 *.java files (127 LOC)
    • 2 *.py files (54 LOC)
    • 2 *.js files (10 LOC)
    • 1 *.groovy files (3 LOC)
  • " *.css" is biggest, containing 90.49% of LOC.
  • " *.groovy" is smallest, containing 0.04% of LOC.


*.css6896 LOC (90%) 30 files
*.xml281 LOC (3%) 5 files
*.slim250 LOC (3%) 1 file
*.java127 LOC (1%) 6 files
*.py54 LOC (<1%) 2 files
*.js10 LOC (<1%) 2 files
*.groovy3 LOC (<1%) 1 file
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[-]lock[.]json".
  • 1 file matches defined criteria (903 LOC, 11.8% vs. main code). All matches are in *.json files.


*.json903 LOC (100%) 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 ".*[.]sh".
    • files with paths like ".*/docker[-]compose[.]yaml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/package[-]lock[.]json".
  • 60 files match defined criteria (2,634 LOC, 34.6% vs. main code):
    • 40 *.xml files (2,406 LOC)
    • 18 *.sh files (206 LOC)
    • 2 *.yaml files (22 LOC)
  • " *.xml" is biggest, containing 91.34% of LOC.
  • " *.yaml" is smallest, containing 0.84% of LOC.


*.xml2406 LOC (91%) 40 files
*.sh206 LOC (7%) 18 files
*.yaml22 LOC (<1%) 2 files
Other Code
txt
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]adoc".
    • files with paths like ".*/asciidoc/.*".
    • files with paths like ".*[.]svg".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Dd]emos?/.*".
    • files with paths like ".*[.]json".
  • 107 files match defined criteria (9,995 LOC, 131.2% vs. main code):
    • 74 *.adoc files (7,435 LOC)
    • 2 *.json files (919 LOC)
    • 18 *.md files (611 LOC)
    • 3 *.svg files (444 LOC)
    • 5 *.txt files (294 LOC)
    • 1 *.css files (222 LOC)
    • 1 *.xml files (40 LOC)
    • 1 *.properties files (23 LOC)
    • 1 *.java files (6 LOC)
    • 1 *.html files (1 LOC)
  • " *.adoc" is biggest, containing 74.39% of LOC.
  • " *.html" is smallest, containing 0.01% of LOC.


*.adoc7435 LOC (74%) 74 files
*.json919 LOC (9%) 2 files
*.md611 LOC (6%) 18 files
*.svg444 LOC (4%) 3 files
*.txt294 LOC (2%) 5 files
*.css222 LOC (2%) 1 file
*.xml40 LOC (<1%) 1 file
*.properties23 LOC (<1%) 1 file
*.java6 LOC (<1%) 1 file
*.html1 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-07 19:50