GoogleCloudPlatform / knfsd-cache-utils

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

Source Code Analysis Scope

Files includes and excluded from analyses

mod

hcl

txt

patch

bats

gitattributes

16 extensions are included in analyses: go, md, tf, yaml, json, sh, mod, gitignore, hcl, txt, patch, bats, gitattributes, sql, bash, mk
6 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 ".*/testdata/.*" (Test data) (13 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
exclude files with path like ".*/docs/.*" (Documentation) (13 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 364 files:

249 files are included in analyses.
115 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.

hcl

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

129 files match defined criteria (10,812 LOC, 100.0% vs. main code):

73 *.go files (7,237 LOC)
34 *.tf files (2,571 LOC)
16 *.yaml files (666 LOC)
5 *.hcl files (332 LOC)
1 *.sql files (6 LOC)

" *.go" is biggest, containing 66.93% of LOC.
" *.sql" is smallest, containing 0.06% of LOC.

Test Code

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

bats

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*_test[.].*".
files with paths like ".*/testing[.].*".
files with paths like ".*[-]tests/.*".
files with paths like ".*/test[.].*".
files with paths like ".*/[Tt]ests/.*".

30 files match defined criteria (2,203 LOC, 20.4% vs. main code):

23 *.go files (1,883 LOC)
3 *.tf files (147 LOC)
2 *.bats files (101 LOC)
1 *.sh files (54 LOC)
1 *.bash files (18 LOC)

" *.go" is biggest, containing 85.47% of LOC.
" *.bash" is smallest, containing 0.82% 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 ".*[.]mk".
files with paths like ".*/[.]gitattributes".

11 files match defined criteria (776 LOC, 7.2% vs. main code):

10 *.sh files (752 LOC)
1 *.mk files (24 LOC)

" *.sh" is biggest, containing 96.91% of LOC.
" *.mk" is smallest, containing 3.09% of LOC.

Other Code

patch

mod

txt

Explore: circles | sunburst

The following criteria are used to filter files:

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

79 files match defined criteria (5,736 LOC, 53.1% vs. main code):

41 *.md files (2,473 LOC)
1 *.json files (1,069 LOC)
5 *.patch files (597 LOC)
8 *.mod files (533 LOC)
9 *.go files (403 LOC)
9 *.tf files (363 LOC)
6 *.txt files (298 LOC)

" *.md" is biggest, containing 43.11% of LOC.
" *.txt" is smallest, containing 5.2% 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

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

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

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

*.sql files are analyzed with SqlAnalyzer:

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

2025-05-04 15:35