apache / dubbo-go-samples
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
proto
properties
mod
mk
txt
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.

main14725 LOC (40%) 366 files
test2487 LOC (6%) 84 files
generated10276 LOC (28%) 9 files
build and deployment2175 LOC (6%) 51 files
other6491 LOC (17%) 96 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 ".*".
  • 366 files match defined criteria (14,725 LOC, 100.0% vs. main code):
    • 187 *.go files (10,777 LOC)
    • 108 *.yml files (1,875 LOC)
    • 41 *.java files (1,104 LOC)
    • 17 *.proto files (461 LOC)
    • 8 *.yaml files (234 LOC)
    • 2 *.js files (189 LOC)
    • 1 *.css files (54 LOC)
    • 2 *.xml files (31 LOC)
  • " *.go" is biggest, containing 73.19% of LOC.
  • " *.xml" is smallest, containing 0.21% of LOC.


*.go10777 LOC (73%) 187 files
*.yml1875 LOC (12%) 108 files
*.java1104 LOC (7%) 41 files
*.proto461 LOC (3%) 17 files
*.yaml234 LOC (1%) 8 files
*.js189 LOC (1%) 2 files
*.css54 LOC (<1%) 1 file
*.xml31 LOC (<1%) 2 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 ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]ests/.*".
  • 84 files match defined criteria (2,487 LOC, 16.9% vs. main code):
    • 80 *.go files (2,356 LOC)
    • 3 *.sh files (89 LOC)
    • 1 *.java files (42 LOC)
  • " *.go" is biggest, containing 94.73% of LOC.
  • " *.java" is smallest, containing 1.69% of LOC.


*.go2356 LOC (94%) 80 files
*.sh89 LOC (3%) 3 files
*.java42 LOC (1%) 1 file
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 ".*/generated/.*".
    • files with any line of content like "//[ ]*Generated by .*".
    • files with paths like ".*[.](py|java|h|cc|cpp|m|rb|php)" AND any line of content like ".*Generated by the protocol buffer compiler[.][ ]+DO NOT EDIT[!].*".
  • 9 files match defined criteria (10,276 LOC, 69.8% vs. main code). All matches are in *.java files.


*.java10276 LOC (100%) 9 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 ".*/pom[.]xml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/docker[-]compose[.]yml".
    • files with paths like ".*[.]mk".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 51 files match defined criteria (2,175 LOC, 14.8% vs. main code):
    • 12 *.xml files (1,495 LOC)
    • 17 *.yml files (428 LOC)
    • 19 *.sh files (192 LOC)
    • 3 *.mk files (60 LOC)
  • " *.xml" is biggest, containing 68.74% of LOC.
  • " *.mk" is smallest, containing 2.76% of LOC.


*.xml1495 LOC (68%) 12 files
*.yml428 LOC (19%) 17 files
*.sh192 LOC (8%) 19 files
*.mk60 LOC (2%) 3 files
Other Code
mod
properties
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • 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 ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*/[Dd]emos?/.*".
    • files with paths like ".*[.]txt".
  • 96 files match defined criteria (6,491 LOC, 44.1% vs. main code):
    • 17 *.java files (2,914 LOC)
    • 59 *.md files (2,770 LOC)
    • 5 *.mod files (524 LOC)
    • 13 *.properties files (281 LOC)
    • 2 *.txt files (2 LOC)
  • " *.java" is biggest, containing 44.89% of LOC.
  • " *.txt" is smallest, containing 0.03% of LOC.


*.java2914 LOC (44%) 17 files
*.md2770 LOC (42%) 59 files
*.mod524 LOC (8%) 5 files
*.properties281 LOC (4%) 13 files
*.txt2 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.

2023-08-11 02:04