gitlab-org / Step_Runner
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
hcl
gitattributes
txt
proto
mk
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.

main7848 LOC (55%) 93 files
test5544 LOC (39%) 59 files
generated0 LOC (0%) 0 files
build and deployment33 LOC (<1%) 1 file
other758 LOC (5%) 8 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
proto
hcl
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 93 files match defined criteria (7,848 LOC, 100.0% vs. main code):
    • 91 *.go files (7,603 LOC)
    • 1 *.proto files (224 LOC)
    • 1 *.hcl files (21 LOC)
  • " *.go" is biggest, containing 96.88% of LOC.
  • " *.hcl" is smallest, containing 0.27% of LOC.


*.go7603 LOC (96%) 91 files
*.proto224 LOC (2%) 1 file
*.hcl21 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[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/test[.].*".
    • files with paths like ".*/test_.*".
  • 59 files match defined criteria (5,544 LOC, 70.6% vs. main code). All matches are in *.go files.


*.go5544 LOC (100%) 59 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
mk
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 ".*/[.]gitattributes".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]mk".
  • 1 file matches defined criteria (33 LOC, 0.4% vs. main code). All matches are in *.mk files.


*.mk33 LOC (100%) 1 file
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 ".*/[.]gitignore".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
  • 8 files match defined criteria (758 LOC, 9.7% vs. main code):
    • 2 *.json files (414 LOC)
    • 4 *.md files (234 LOC)
    • 2 *.mod files (110 LOC)
  • " *.json" is biggest, containing 54.62% of LOC.
  • " *.mod" is smallest, containing 14.51% of LOC.


*.json414 LOC (54%) 2 files
*.md234 LOC (30%) 4 files
*.mod110 LOC (14%) 2 files
Analyzers
Info about analyzers used for source code examinations.


2025-05-16 13:30