opensearch-project / index-management
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
http
txt
editorconfig
properties
policy
  • 15 extensions are included in analyses: kt, md, http, yml, json, gradle, xml, gitignore, py, txt, java, bat, editorconfig, properties, policy
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/docs/.*" (Documentation) (3 files).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (0 files).
    • exclude files with path like ".*[.]txt" (Text files) (0 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
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.

main23441 LOC (52%) 277 files
test17041 LOC (38%) 128 files
generated0 LOC (0%) 0 files
build and deployment604 LOC (1%) 5 files
other3406 LOC (7%) 35 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
http
policy
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 277 files match defined criteria (23,441 lines of code, 100.0% vs. main code):
    • 264 *.kt files (22,728 lines of code)
    • 9 *.http files (656 lines of code)
    • 1 *.py files (27 lines of code)
    • 1 *.yml files (20 lines of code)
    • 1 *.policy files (7 lines of code)
    • 1 *.java files (3 lines of code)
  • " *.kt" is biggest, containing 96.96% of code.
  • " *.java" is smallest, containing 0.01% of code.


*.kt22728 LOC (96%) 264 files
*.http656 LOC (2%) 9 files
*.py27 LOC (<1%) 1 files
*.yml20 LOC (<1%) 1 files
*.policy7 LOC (<1%) 1 files
*.java3 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
http
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 128 files match defined criteria (17,041 lines of code, 72.7% vs. main code):
    • 127 *.kt files (16,830 lines of code)
    • 1 *.http files (211 lines of code)
  • " *.kt" is biggest, containing 98.76% of code.
  • " *.http" is smallest, containing 1.24% of code.


*.kt16830 LOC (98%) 127 files
*.http211 LOC (1%) 1 files
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 ".*[.]bat".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]gradle".
  • 5 files match defined criteria (604 lines of code, 2.6% vs. main code):
    • 4 *.gradle files (536 lines of code)
    • 1 *.bat files (68 lines of code)
  • " *.gradle" is biggest, containing 88.74% of code.
  • " *.bat" is smallest, containing 11.26% of code.


*.gradle536 LOC (88%) 4 files
*.bat68 LOC (11%) 1 files
Other Code
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 ".*[.]properties".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]editorconfig".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 35 files match defined criteria (3,406 lines of code, 14.5% vs. main code):
    • 7 *.json files (3,034 lines of code)
    • 28 *.md files (372 lines of code)
  • " *.json" is biggest, containing 89.08% of code.
  • " *.md" is smallest, containing 10.92% of code.


*.json3034 LOC (89%) 7 files
*.md372 LOC (10%) 28 files
Analyzers
Info about analyzers used for source code examinations.
  • *.kt files are analyzed with KotlinAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis (based on imports and package statements)
  • *.http files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.yml files are analyzed with YamlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.policy files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.java files are analyzed with JavaAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Advanced heuristic dependency analysis (based on package names)


2022-02-01 04:59