GoogleCloudPlatform / serverless-photosharing-workshop

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

Source Code Analysis Scope

Files includes and excluded from analyses

csproj

mod

properties

txt

18 extensions are included in analyses: tf, sh, js, java, json, cs, yaml, go, csproj, md, mod, gitignore, xml, html, properties, txt, css, py
4 criteria are used to exclude files from analysis:

exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 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 110 files:

90 files are included in analyses.
20 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.

51 files

2 files

18 files

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

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

12 *.tf files (904 LOC)
8 *.cs files (472 LOC)
7 *.java files (432 LOC)
10 *.js files (423 LOC)
4 *.go files (410 LOC)
5 *.yaml files (262 LOC)
3 *.html files (222 LOC)
1 *.py files (45 LOC)
1 *.css files (15 LOC)

" *.tf" is biggest, containing 28.38% of LOC.
" *.css" is smallest, containing 0.47% 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/.*".

2 files match defined criteria (146 LOC, 4.6% vs. main code). All matches are in *.java files.

Build and Deployment Code

Source code used to configure or support build and deployment process.

csproj

Explore: circles | sunburst

The following criteria are used to filter files:

files with paths like ".*/pom[.]xml".
files with paths like ".*[.]git[a-z]+".
files with paths like ".*/[.]gitignore".
files with paths like ".*/package[.]json".
files with paths like ".*[.]csproj".
files with paths like ".*[.]sh".

18 files match defined criteria (601 LOC, 18.9% vs. main code):

3 *.xml files (307 LOC)
11 *.sh files (249 LOC)
4 *.csproj files (45 LOC)

" *.xml" is biggest, containing 51.08% of LOC.
" *.csproj" is smallest, containing 7.49% of LOC.

Other Code

mod

properties

txt

Explore: circles | sunburst

The following criteria are used to filter files:

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

19 files match defined criteria (460 LOC, 14.4% vs. main code):

4 *.md files (314 LOC)
8 *.json files (99 LOC)
3 *.mod files (30 LOC)
3 *.properties files (14 LOC)
1 *.txt files (3 LOC)

" *.md" is biggest, containing 68.26% of LOC.
" *.txt" is smallest, containing 0.65% of LOC.

Analyzers

Info about analyzers used for source code examinations.

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

*.cs files are analyzed with CSharpAnalyzer:

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 namespace heuristics)

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

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

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

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

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

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

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

2025-05-04 15:20