apache / servicecomb-toolkitSource Code Overview

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

Source Code Analysis Scope

Files includes and excluded from analyses

properties

txt

cmd

12 extensions are included in analyses: java, yaml, mustache, xml, md, json, sh, html, properties, gitignore, txt, cmd
4 criteria are used to exclude files from analysis:

exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 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 1,061 files:

1,014 files are included in analyses.
47 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.

Main Code

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

cmd

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

546 files match defined criteria (15,574 LOC, 100.0% vs. main code):

459 *.java files (13,387 LOC)
80 *.mustache files (1,770 LOC)
4 *.html files (301 LOC)
2 *.xml files (61 LOC)
1 *.cmd files (55 LOC)

" *.java" is biggest, containing 85.96% of LOC.
" *.cmd" is smallest, containing 0.35% 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 ".*/[Tt]est/.*".
files with paths like ".*[-]tests/.*".

373 files match defined criteria (18,833 LOC, 120.9% vs. main code):

189 *.yaml files (9,623 LOC)
169 *.java files (8,961 LOC)
15 *.xml files (249 LOC)

" *.yaml" is biggest, containing 51.1% of LOC.
" *.xml" is smallest, containing 1.32% 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 ".*/pom[.]xml".
files with paths like ".*/assembly/src[.]xml".
files with paths like ".*[.]sh".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".

27 files match defined criteria (2,009 LOC, 12.9% vs. main code):

23 *.xml files (1,861 LOC)
4 *.sh files (148 LOC)

" *.xml" is biggest, containing 92.63% of LOC.
" *.sh" is smallest, containing 7.37% of LOC.

Other Code

properties

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*[.]json".
files with paths like ".*/[Dd]emos?/.*".
files with paths like ".*[.]properties".
files with paths like ".*/[Ee]xamples/.*".
files with paths like ".*[.]md".
files with paths like ".*/README[.][a-z0-9]+".
files with paths like ".*/[Ss]amples/.*".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]txt".

68 files match defined criteria (5,472 LOC, 35.1% vs. main code):

24 *.yaml files (2,276 LOC)
12 *.md files (1,545 LOC)
9 *.json files (1,121 LOC)
8 *.xml files (234 LOC)
4 *.properties files (164 LOC)
11 *.java files (132 LOC)

" *.yaml" is biggest, containing 41.59% of LOC.
" *.java" is smallest, containing 2.41% 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)

*.mustache files are analyzed with HtmlAnalyzer:

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

*.html files are analyzed with HtmlAnalyzer:

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

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

*.cmd 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-10 22:14