opensearch-project / cross-cluster-replication
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
http
properties
policy
  • 11 extensions are included in analyses: kt, md, yml, json, gradle, txt, bat, gitignore, http, properties, policy
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (8 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/docs/.*" (Documentation) (1 file).
    • 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) (1 file).
    • 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.

main9470 LOC (60%) 142 files
test4840 LOC (30%) 29 files
generated0 LOC (0%) 0 files
build and deployment622 LOC (3%) 3 files
other732 LOC (4%) 9 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
http
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 142 files match defined criteria (9,470 lines of code, 100.0% vs. main code):
    • 141 *.kt files (9,331 lines of code)
    • 1 *.http files (139 lines of code)
  • " *.kt" is biggest, containing 98.53% of code.
  • " *.http" is smallest, containing 1.47% of code.


*.kt9331 LOC (98%) 141 files
*.http139 LOC (1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
policy
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with any line of content like ".*/simpletest/.*".
  • 29 files match defined criteria (4,840 lines of code, 51.1% vs. main code):
    • 28 *.kt files (4,837 lines of code)
    • 1 *.policy files (3 lines of code)
  • " *.kt" is biggest, containing 99.94% of code.
  • " *.policy" is smallest, containing 0.06% of code.


*.kt4837 LOC (99%) 28 files
*.policy3 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".
  • 3 files match defined criteria (622 lines of code, 6.6% vs. main code):
    • 2 *.gradle files (561 lines of code)
    • 1 *.bat files (61 lines of code)
  • " *.gradle" is biggest, containing 90.19% of code.
  • " *.bat" is smallest, containing 9.81% of code.


*.gradle561 LOC (90%) 2 files
*.bat61 LOC (9%) 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 ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*/[.]gitignore".
  • 9 files match defined criteria (732 lines of code, 7.7% vs. main code):
    • 6 *.md files (532 lines of code)
    • 3 *.json files (200 lines of code)
  • " *.md" is biggest, containing 72.68% of code.
  • " *.json" is smallest, containing 27.32% of code.


*.md532 LOC (72%) 6 files
*.json200 LOC (27%) 3 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


2022-02-01 04:37