apache / guacamole-manual
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
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.

main464 LOC (3%) 11 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment97 LOC (<1%) 2 files
other13404 LOC (95%) 37 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 11 files match defined criteria (464 LOC, 100.0% vs. main code):
    • 2 *.py files (136 LOC)
    • 1 *.c files (106 LOC)
    • 3 *.java files (102 LOC)
    • 2 *.html files (55 LOC)
    • 1 *.css files (31 LOC)
    • 1 *.xml files (21 LOC)
    • 1 *.h files (13 LOC)
  • " *.py" is biggest, containing 29.31% of LOC.
  • " *.h" is smallest, containing 2.8% of LOC.


*.py136 LOC (29%) 2 files
*.c106 LOC (22%) 1 file
*.java102 LOC (21%) 3 files
*.html55 LOC (11%) 2 files
*.css31 LOC (6%) 1 file
*.xml21 LOC (4%) 1 file
*.h13 LOC (2%) 1 file
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 ".*/pom[.]xml".
  • 2 files match defined criteria (97 LOC, 20.9% vs. main code). All matches are in *.xml files.


*.xml97 LOC (100%) 2 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
  • 37 files match defined criteria (13,404 LOC, 2888.8% vs. main code):
    • 35 *.md files (12,481 LOC)
    • 1 *.rst files (915 LOC)
    • 1 *.json files (8 LOC)
  • " *.md" is biggest, containing 93.11% of LOC.
  • " *.json" is smallest, containing 0.06% of LOC.


*.md12481 LOC (93%) 35 files
*.rst915 LOC (6%) 1 file
*.json8 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2023-08-10 16:36