GoogleCloudPlatform / cortex-data-foundation

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

Source Code Analysis Scope

Files includes and excluded from analyses

ini

txt

11 extensions are included in analyses: yaml, sql, py, sh, md, ini, txt, json, jinja, in, ipynb
5 criteria are used to exclude files from analysis:

exclude files with path like ".*/docs/.*" (Documentation) (21 files).
exclude files with path like ".*/dependencies/.*" (Dependencies) (8 files).
exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (1 file).
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 2,370 files:

2,298 files are included in analyses.
72 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.

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*".

2174 files match defined criteria (247,768 LOC, 100.0% vs. main code):

1,189 *.yaml files (158,901 LOC)
560 *.sql files (44,902 LOC)
415 *.py files (42,123 LOC)
1 *.ipynb files (1,159 LOC)
7 *.jinja files (665 LOC)
2 *.in files (18 LOC)

" *.yaml" is biggest, containing 64.13% of LOC.
" *.in" is smallest, containing 0.01% 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 ".*/jest[.][a-zA-Z0-9\.]+".

11 files match defined criteria (280 LOC, 0.1% vs. main code):

7 *.py files (224 LOC)
4 *.yaml files (56 LOC)

" *.py" is biggest, containing 80% of LOC.
" *.yaml" is smallest, containing 20% 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".

32 files match defined criteria (2,238 LOC, 0.9% vs. main code). All matches are in *.sh files.

Other Code

txt

ini

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 ".*/[Ss]amples/.*".
files with paths like ".*[.]json".
files with paths like ".*[.]ini".

81 files match defined criteria (4,676 LOC, 1.9% vs. main code):

39 *.sql files (2,486 LOC)
10 *.txt files (1,043 LOC)
9 *.json files (909 LOC)
14 *.ini files (128 LOC)
9 *.md files (110 LOC)

" *.sql" is biggest, containing 53.17% of LOC.
" *.md" is smallest, containing 2.35% of LOC.

Analyzers

Info about analyzers used for source code examinations.

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

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

*.py files are analyzed with PythonAnalyzer:

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

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

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

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

2025-05-04 15:45