kubernetes / kops
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
pub
txt
mod
dockerignore
eps
mk
proto
gitattributes
plist
  • 23 extensions are included in analyses: go, yaml, md, pub, tf, sh, json, txt, py, yml, mod, gitignore, dockerignore, bzl, eps, svg, css, mk, proto, gitattributes, plist, toml, Dockerfile
  • 10 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/testdata/.*" (Test data) (4 files).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (15 files).
    • exclude files with path like ".*/target/.*" (Compiled files) (1 file).
    • exclude files with path like ".*/extern(al)?/.*" (Dependencies) (2 files).
    • exclude files with path like ".*/[Pp]ackages\/.+\.\d+\/.*" (NuGet) (2 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (183 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 ".*[.]txt" (Text files) (22 files).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
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.

main227110 LOC (57%) 1197 files
test123005 LOC (31%) 618 files
generated0 LOC (0%) 0 files
build and deployment1128 LOC (<1%) 40 files
other41741 LOC (10%) 77 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 1197 files match defined criteria (227,110 lines of code, 100.0% vs. main code):
    • 1,119 *.go files (152,238 lines of code)
    • 68 *.yaml files (74,424 lines of code)
    • 4 *.py files (200 lines of code)
    • 1 *.yml files (170 lines of code)
    • 2 *.bzl files (49 lines of code)
    • 1 *.proto files (19 lines of code)
    • 1 *.toml files (6 lines of code)
    • 1 *.dockerfile files (4 lines of code)
  • " *.go" is biggest, containing 67.03% of code.
  • " *.dockerfile" is smallest, containing 0% of code.


*.go152238 LOC (67%) 1119 files
*.yaml74424 LOC (32%) 68 files
*.py200 LOC (<1%) 4 files
*.yml170 LOC (<1%) 1 files
*.bzl49 LOC (<1%) 2 files
*.proto19 LOC (<1%) 1 files
*.toml6 LOC (<1%) 1 files
*.dockerfile4 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
pub
mk
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/e2e/.*".
    • files with paths like ".*_tests[.].*".
    • files with paths like ".*[-]test[-].*".
    • files with paths like ".*[-]tests[-].*".
    • files with any line of content like ".*/simpletest/.*".
  • 618 files match defined criteria (123,005 lines of code, 54.2% vs. main code):
    • 58 *.tf files (51,498 lines of code)
    • 257 *.yaml files (39,149 lines of code)
    • 229 *.go files (31,865 lines of code)
    • 10 *.sh files (323 lines of code)
    • 1 *.yml files (72 lines of code)
    • 62 *.pub files (62 lines of code)
    • 1 *.mk files (36 lines of code)
  • " *.tf" is biggest, containing 41.87% of code.
  • " *.mk" is smallest, containing 0.03% of code.


*.tf51498 LOC (41%) 58 files
*.yaml39149 LOC (31%) 257 files
*.go31865 LOC (25%) 229 files
*.sh323 LOC (<1%) 10 files
*.yml72 LOC (<1%) 1 files
*.pub62 LOC (<1%) 62 files
*.mk36 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".
    • files with paths like ".*[.]mk".
    • files with paths like ".*/[.]gitattributes".
  • 40 files match defined criteria (1,128 lines of code, 0.5% vs. main code). All matches are in *.sh files.


*.sh1128 LOC (100%) 40 files
Other Code
mod
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 ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*/[Ee]xamples/.*".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*[.]svg".
  • 77 files match defined criteria (41,741 lines of code, 18.4% vs. main code):
    • 31 *.json files (39,721 lines of code)
    • 40 *.md files (1,293 lines of code)
    • 3 *.mod files (553 lines of code)
    • 3 *.go files (174 lines of code)
  • " *.json" is biggest, containing 95.16% of code.
  • " *.go" is smallest, containing 0.42% of code.


*.json39721 LOC (95%) 31 files
*.md1293 LOC (3%) 40 files
*.mod553 LOC (1%) 3 files
*.go174 LOC (<1%) 3 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
  • *.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
  • *.yml 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
  • *.bzl 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
  • *.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
  • *.toml 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
  • *.dockerfile 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

2022-02-03 09:01