spotify / flyte-flink-plugin
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
cfg
txt
proto
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.

main949 LOC (20%) 13 files
test530 LOC (11%) 5 files
generated1268 LOC (27%) 2 files
build and deployment5 LOC (<1%) 1 file
other1786 LOC (39%) 12 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 13 files match defined criteria (949 LOC, 100.0% vs. main code):
    • 9 *.go files (832 LOC)
    • 1 *.proto files (65 LOC)
    • 1 *.cfg files (29 LOC)
    • 1 *.py files (16 LOC)
    • 1 *.yaml files (7 LOC)
  • " *.go" is biggest, containing 87.67% of LOC.
  • " *.yaml" is smallest, containing 0.74% of LOC.


*.go832 LOC (87%) 9 files
*.proto65 LOC (6%) 1 file
*.cfg29 LOC (3%) 1 file
*.py16 LOC (1%) 1 file
*.yaml7 LOC (<1%) 1 file
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[.].*".
  • 5 files match defined criteria (530 LOC, 55.8% vs. main code). All matches are in *.go files.


*.go530 LOC (100%) 5 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/gen/.*[.]go".
  • 2 files match defined criteria (1,268 LOC, 133.6% vs. main code). All matches are in *.go files.


*.go1268 LOC (100%) 2 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".
  • 1 file matches defined criteria (5 LOC, 0.5% vs. main code). All matches are in *.sh files.


*.sh5 LOC (100%) 1 file
Other Code
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 12 files match defined criteria (1,786 LOC, 188.2% vs. main code):
    • 10 *.rst files (1,615 LOC)
    • 1 *.mod files (124 LOC)
    • 1 *.md files (47 LOC)
  • " *.rst" is biggest, containing 90.43% of LOC.
  • " *.md" is smallest, containing 2.63% of LOC.


*.rst1615 LOC (90%) 10 files
*.mod124 LOC (6%) 1 file
*.md47 LOC (2%) 1 file
Analyzers
Info about analyzers used for source code examinations.


2025-01-17 11:39