apache / rocketmq-e2eSource Code Overview

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

Source Code Analysis Scope

Files includes and excluded from analyses

feature

properties

mod

txt

csproj

15 extensions are included in analyses: java, feature, xml, go, cs, md, properties, gitignore, sh, yml, yaml, mod, txt, csproj, json
5 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (12 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/bin/.*" (Binaries for distribution) (4 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 220 files:

197 files are included in analyses.
23 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.

61 files

116 files

6 files

14 files

Main Code

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

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

61 files match defined criteria (3,918 LOC, 100.0% vs. main code):

46 *.java files (2,903 LOC)
9 *.xml files (552 LOC)
6 *.go files (463 LOC)

" *.java" is biggest, containing 74.09% of LOC.
" *.go" is smallest, containing 11.82% of LOC.

Test Code

Used only for testing of the product. Normally not deployed in a production environment.

feature

csproj

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/.*".
files with paths like ".*[-]tests/.*".
files with paths like ".*[.]feature".

116 files match defined criteria (10,620 LOC, 271.1% vs. main code):

71 *.java files (7,480 LOC)
28 *.feature files (1,624 LOC)
8 *.cs files (1,001 LOC)
4 *.go files (266 LOC)
4 *.xml files (227 LOC)
1 *.csproj files (22 LOC)

" *.java" is biggest, containing 70.43% of LOC.
" *.csproj" is smallest, containing 0.21% of LOC.

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 ".*[.]sh".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*/pom[.]xml".
files with paths like ".*[.]csproj".

6 files match defined criteria (740 LOC, 18.9% vs. main code). All matches are in *.xml files.

Other Code

properties

mod

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]json".
files with paths like ".*/go[.]mod".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]properties".
files with paths like ".*[.]txt".

14 files match defined criteria (422 LOC, 10.8% vs. main code):

6 *.md files (227 LOC)
7 *.properties files (155 LOC)
1 *.mod files (40 LOC)

" *.md" is biggest, containing 53.79% of LOC.
" *.mod" is smallest, containing 9.48% of LOC.

Analyzers

Info about analyzers used for source code examinations.

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

*.xml files are analyzed with XmlAnalyzer:

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

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

2023-08-11 02:31