apache / incubator-sdap-nexus
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
ini
tpl
cql
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.

main18670 LOC (53%) 162 files
test2817 LOC (8%) 26 files
generated0 LOC (0%) 0 files
build and deployment35 LOC (<1%) 2 files
other13390 LOC (38%) 120 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
tpl
cql
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 162 files match defined criteria (18,670 LOC, 100.0% vs. main code):
    • 131 *.py files (15,580 LOC)
    • 15 *.yml files (1,433 LOC)
    • 7 *.xml files (1,102 LOC)
    • 1 *.ipynb files (200 LOC)
    • 3 *.yaml files (145 LOC)
    • 1 *.js files (90 LOC)
    • 2 *.html files (58 LOC)
    • 1 *.tpl files (57 LOC)
    • 1 *.cql files (5 LOC)
  • " *.py" is biggest, containing 83.45% of LOC.
  • " *.cql" is smallest, containing 0.03% of LOC.


*.py15580 LOC (83%) 131 files
*.yml1433 LOC (7%) 15 files
*.xml1102 LOC (5%) 7 files
*.ipynb200 LOC (1%) 1 file
*.yaml145 LOC (<1%) 3 files
*.js90 LOC (<1%) 1 file
*.html58 LOC (<1%) 2 files
*.tpl57 LOC (<1%) 1 file
*.cql5 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]ests/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*/[Tt]est/.*".
  • 26 files match defined criteria (2,817 LOC, 15.1% vs. main code):
    • 25 *.py files (2,797 LOC)
    • 1 *.yaml files (20 LOC)
  • " *.py" is biggest, containing 99.29% of LOC.
  • " *.yaml" is smallest, containing 0.71% of LOC.


*.py2797 LOC (99%) 25 files
*.yaml20 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 ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]bat".
  • 2 files match defined criteria (35 LOC, 0.2% vs. main code). All matches are in *.sh files.


*.sh35 LOC (100%) 2 files
Other Code
txt
ini
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]ini".
    • files with paths like ".*[.]json".
  • 120 files match defined criteria (13,390 LOC, 71.7% vs. main code):
    • 95 *.txt files (12,206 LOC)
    • 15 *.md files (949 LOC)
    • 4 *.ini files (86 LOC)
    • 4 *.json files (79 LOC)
    • 2 *.rst files (70 LOC)
  • " *.txt" is biggest, containing 91.16% of LOC.
  • " *.rst" is smallest, containing 0.52% of LOC.


*.txt12206 LOC (91%) 95 files
*.md949 LOC (7%) 15 files
*.ini86 LOC (<1%) 4 files
*.json79 LOC (<1%) 4 files
*.rst70 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 21:02