GoogleCloudPlatform / cloud-opensource-java

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

Source Code Analysis Scope

Files includes and excluded from analyses

properties

txt

cfg

cmd

22 extensions are included in analyses: java, md, xml, groovy, properties, sh, txt, ftl, cfg, gradle, yaml, gitignore, tf, css, bat, json, svg, js, ps1, tfvars, html, cmd
9 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 files).
exclude files with path like ".*/dependencies/.*" (Dependencies) (157 files).
exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/mvnw\.cmd" (Maven) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (30 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 ".*/testdata/.*" (Test data) (0 files).

The source code folder contains 368 files:

157 files are included in analyses.
211 files are excluded from analyses:

Explore all files....

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.

cfg

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

43 files match defined criteria (1,902 LOC, 100.0% vs. main code):

9 *.java files (718 LOC)
7 *.ftl files (512 LOC)
3 *.tf files (287 LOC)
1 *.css files (119 LOC)
13 *.groovy files (105 LOC)
1 *.ps1 files (86 LOC)
1 *.xml files (44 LOC)
6 *.cfg files (20 LOC)
1 *.js files (7 LOC)
1 *.tfvars files (4 LOC)

" *.java" is biggest, containing 37.75% of LOC.
" *.tfvars" is smallest, containing 0.21% 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/.*".

13 files match defined criteria (1,078 LOC, 56.7% vs. main code):

7 *.java files (977 LOC)
6 *.xml files (101 LOC)

" *.java" is biggest, containing 90.63% of LOC.
" *.xml" is smallest, containing 9.37% 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 ".*[.]sh".
files with paths like ".*[.]gradle".
files with paths like ".*[.]bat".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".

44 files match defined criteria (3,006 LOC, 158.0% vs. main code):

24 *.xml files (2,468 LOC)
14 *.sh files (357 LOC)
4 *.gradle files (92 LOC)
2 *.bat files (89 LOC)

" *.xml" is biggest, containing 82.1% of LOC.
" *.bat" is smallest, containing 2.96% of LOC.

Other Code

properties

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 ".*[.]txt".
files with paths like ".*[.]properties".
files with paths like ".*/[.]gitignore".
files with paths like ".*[.]json".
files with paths like ".*/[Ee]xamples/.*".

57 files match defined criteria (882 LOC, 46.4% vs. main code):

37 *.md files (791 LOC)
1 *.json files (40 LOC)
14 *.properties files (31 LOC)
4 *.txt files (11 LOC)
1 *.java files (9 LOC)

" *.md" is biggest, containing 89.68% of LOC.
" *.java" is smallest, containing 1.02% 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)

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

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

*.css files are analyzed with CssAnalyzer:

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

*.groovy files are analyzed with GroovyAnalyzer:

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

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

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

*.cfg files are analyzed with CfgAnalyzer:

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

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

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

2025-05-04 14:41