golang / build
Source Code Overview

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

Source Code Analysis Scope
Files includes and excluded from analyses
mod
txt
proto
dockerignore
patch
plist
cfg
x
  • 22 extensions are included in analyses: go, md, sh, yaml, gitignore, bash, json, sql, html, mod, svg, css, txt, proto, js, ps1, py, dockerignore, patch, plist, cfg, x
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).
    • exclude files with path like ".*/testdata/.*" (Test data) (6 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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (3 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.

main62784 LOC (78%) 313 files
test15726 LOC (19%) 82 files
generated0 LOC (0%) 0 files
build and deployment534 LOC (<1%) 25 files
other1447 LOC (1%) 117 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
x
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 313 files match defined criteria (62,784 lines of code, 100.0% vs. main code):
    • 261 *.go files (58,459 lines of code)
    • 19 *.yaml files (900 lines of code)
    • 7 *.html files (841 lines of code)
    • 12 *.bash files (754 lines of code)
    • 4 *.css files (638 lines of code)
    • 4 *.proto files (562 lines of code)
    • 1 *.x files (296 lines of code)
    • 2 *.ps1 files (288 lines of code)
    • 1 *.py files (33 lines of code)
    • 1 *.js files (12 lines of code)
    • 1 *.cfg files (1 lines of code)
  • " *.go" is biggest, containing 93.11% of code.
  • " *.cfg" is smallest, containing 0% of code.


*.go58459 LOC (93%) 261 files
*.yaml900 LOC (1%) 19 files
*.html841 LOC (1%) 7 files
*.bash754 LOC (1%) 12 files
*.css638 LOC (1%) 4 files
*.proto562 LOC (<1%) 4 files
*.x296 LOC (<1%) 1 files
*.ps1288 LOC (<1%) 2 files
*.py33 LOC (<1%) 1 files
*.js12 LOC (<1%) 1 files
*.cfg1 LOC (<1%) 1 files
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 ".*/test_.*".
    • files with any line of content like ".*/simpletest/.*".
  • 82 files match defined criteria (15,726 lines of code, 25.0% vs. main code):
    • 81 *.go files (15,714 lines of code)
    • 1 *.bash files (12 lines of code)
  • " *.go" is biggest, containing 99.92% of code.
  • " *.bash" is smallest, containing 0.08% of code.


*.go15714 LOC (99%) 81 files
*.bash12 LOC (<1%) 1 files
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 ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]sh".
  • 25 files match defined criteria (534 lines of code, 0.9% vs. main code). All matches are in *.sh files.


*.sh534 LOC (100%) 25 files
Other Code
mod
plist
patch
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 ".*/[.]gitignore".
    • files with paths like ".*[.]json".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]patch".
    • files with paths like ".*[.]plist".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 117 files match defined criteria (1,447 lines of code, 2.3% vs. main code):
    • 95 *.md files (955 lines of code)
    • 3 *.json files (176 lines of code)
    • 5 *.mod files (174 lines of code)
    • 7 *.sql files (97 lines of code)
    • 1 *.plist files (27 lines of code)
    • 1 *.patch files (13 lines of code)
    • 5 *.svg files (5 lines of code)
  • " *.md" is biggest, containing 66% of code.
  • " *.svg" is smallest, containing 0.35% of code.


*.md955 LOC (65%) 95 files
*.json176 LOC (12%) 3 files
*.mod174 LOC (12%) 5 files
*.sql97 LOC (6%) 7 files
*.plist27 LOC (1%) 1 files
*.patch13 LOC (<1%) 1 files
*.svg5 LOC (<1%) 5 files
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
  • *.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
  • *.bash files are analyzed with ShellAnalyzer:
    • 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
  • *.proto 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
  • *.x 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
  • *.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
  • *.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
  • *.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
  • *.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

2022-02-03 02:02