apache / shardingsphere-on-cloudSource Code Overview

Analysis scope, overview of main, test, generated, deployment, build, and other code.

Source Code Analysis Scope

Files includes and excluded from analyses

mod

txt

tpl

22 extensions are included in analyses: go, md, yaml, g4, html, rs, java, yml, js, css, tf, json, svg, toml, mod, sh, txt, dockerignore, xml, gitignore, rb, tpl
8 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (21 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (105 files).
exclude files with path like ".*/docs?/_?(build|themes?|templates?|static)/.*" (Sphinx) (0 files).
exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (0 files).
exclude files with path like ".*jquery[.].*[.]js" (jQuery library) (0 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).

The source code folder contains 591 files:

396 files are included in analyses.
195 files are excluded from analyses:

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.

295 files

56 files

1 file

2 files

43 files

Main Code

All manually created or maintained source code that defines logic of the product that is run in a production environment.

tpl

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

295 files match defined criteria (57,073 LOC, 100.0% vs. main code):

159 *.go files (37,622 LOC)
24 *.yaml files (7,710 LOC)
25 *.rs files (6,252 LOC)
36 *.g4 files (2,328 LOC)
4 *.js files (834 LOC)
14 *.tf files (751 LOC)
7 *.yml files (646 LOC)
22 *.java files (527 LOC)
1 *.rb files (349 LOC)
2 *.toml files (35 LOC)
1 *.tpl files (19 LOC)

" *.go" is biggest, containing 65.92% of LOC.
" *.tpl" is smallest, containing 0.03% of LOC.

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 ".*_test[.].*".
files with paths like ".*/[Tt]est/.*".
files with paths like ".*/e2e/.*".

56 files match defined criteria (7,824 LOC, 13.7% vs. main code). All matches are in *.go 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 (46 LOC, 0.1% vs. main code). All matches are in *.json 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 ".*/pom[.]xml".
files with paths like ".*/package[-]lock[.]json".
files with paths like ".*/package[.]json".
files with paths like ".*[.]sh".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".

2 files match defined criteria (66 LOC, 0.1% vs. main code):

1 *.xml files (51 LOC)
1 *.sh files (15 LOC)

" *.xml" is biggest, containing 77.27% of LOC.
" *.sh" is smallest, containing 22.73% of LOC.

Other Code

mod

txt

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 ".*[.]json".
files with paths like ".*/go[.]mod".
files with paths like ".*[.]txt".
files with paths like ".*/[.]dockerignore".
files with paths like ".*/LICENSE[.][a-z0-9]+".
files with paths like ".*[.]svg".
files with paths like ".*/[.]gitignore".
files with paths like ".*/[Ee]xamples/.*".

43 files match defined criteria (3,934 LOC, 6.9% vs. main code):

7 *.json files (2,677 LOC)
18 *.md files (731 LOC)
14 *.yaml files (316 LOC)
3 *.mod files (194 LOC)
1 *.txt files (16 LOC)

" *.json" is biggest, containing 68.05% of LOC.
" *.txt" is smallest, containing 0.41% of LOC.

Analyzers

Info about analyzers used for source code examinations.

*.go files are analyzed with GoLangAnalyzer:

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

*.yaml 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

*.rs files are analyzed with RustAnalyzer:

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

No dependency analysis

*.g4 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

*.js files are analyzed with JavaScriptAnalyzer:

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

No dependency analysis

*.tf 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

*.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

*.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)

*.rb files are analyzed with RubyAnalyzer:

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

Basic heuristic dependency analysis

*.toml 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

*.tpl 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

2023-08-11 02:23