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
slim
cmd
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.

main6678 LOC (37%) 42 files
test0 LOC (0%) 0 files
generated903 LOC (5%) 1 file
build and deployment2466 LOC (13%) 56 files
other7746 LOC (43%) 88 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 ".*".
  • 42 files match defined criteria (6,678 LOC, 100.0% vs. main code):
    • 27 *.css files (5,987 LOC)
    • 5 *.xml files (256 LOC)
    • 1 *.slim files (250 LOC)
    • 5 *.java files (121 LOC)
    • 2 *.py files (54 LOC)
    • 2 *.js files (10 LOC)
  • " *.css" is biggest, containing 89.65% of LOC.
  • " *.js" is smallest, containing 0.15% of LOC.


*.css5987 LOC (89%) 27 files
*.xml256 LOC (3%) 5 files
*.slim250 LOC (3%) 1 file
*.java121 LOC (1%) 5 files
*.py54 LOC (<1%) 2 files
*.js10 LOC (<1%) 2 files
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, 13.5% 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 ".*/package[-]lock[.]json".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 56 files match defined criteria (2,466 LOC, 36.9% vs. main code):
    • 38 *.xml files (2,260 LOC)
    • 18 *.sh files (206 LOC)
  • " *.xml" is biggest, containing 91.65% of LOC.
  • " *.sh" is smallest, containing 8.35% of LOC.


*.xml2260 LOC (91%) 38 files
*.sh206 LOC (8%) 18 files
Other Code
txt
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • 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 ".*/asciidoc/.*".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]svg".
  • 88 files match defined criteria (7,746 LOC, 116.0% vs. main code):
    • 61 *.adoc files (5,698 LOC)
    • 2 *.json files (919 LOC)
    • 16 *.md files (515 LOC)
    • 2 *.svg files (296 LOC)
    • 5 *.txt files (294 LOC)
    • 1 *.properties files (23 LOC)
    • 1 *.html files (1 LOC)
  • " *.adoc" is biggest, containing 73.56% of LOC.
  • " *.html" is smallest, containing 0.01% of LOC.


*.adoc5698 LOC (73%) 61 files
*.json919 LOC (11%) 2 files
*.md515 LOC (6%) 16 files
*.svg296 LOC (3%) 2 files
*.txt294 LOC (3%) 5 files
*.properties23 LOC (<1%) 1 file
*.html1 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 22:08