mozilla / remote-settings
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
ini
vtt
cfg
wsgi
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.

main2810 LOC (23%) 31 files
test5697 LOC (46%) 36 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other3690 LOC (30%) 13 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
wsgi
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 31 files match defined criteria (2,810 LOC, 100.0% vs. main code):
    • 26 *.py files (2,663 LOC)
    • 3 *.toml files (125 LOC)
    • 1 *.wsgi files (16 LOC)
    • 1 *.cfg files (6 LOC)
  • " *.py" is biggest, containing 94.77% of LOC.
  • " *.cfg" is smallest, containing 0.21% of LOC.


*.py2663 LOC (94%) 26 files
*.toml125 LOC (4%) 3 files
*.wsgi16 LOC (<1%) 1 file
*.cfg6 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 ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
    • files with paths like ".*[-]tests/.*".
    • files with paths like ".*/testing[.].*".
  • 36 files match defined criteria (5,697 LOC, 202.7% vs. main code):
    • 34 *.py files (5,671 LOC)
    • 1 *.toml files (16 LOC)
    • 1 *.sh files (10 LOC)
  • " *.py" is biggest, containing 99.54% of LOC.
  • " *.sh" is smallest, containing 0.18% of LOC.


*.py5671 LOC (99%) 34 files
*.toml16 LOC (<1%) 1 file
*.sh10 LOC (<1%) 1 file
Other Code
ini
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]ini".
    • files with paths like ".*/[.]dockerignore".
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]svg".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
  • 13 files match defined criteria (3,690 LOC, 131.3% vs. main code):
    • 3 *.rst files (3,063 LOC)
    • 4 *.ini files (277 LOC)
    • 1 *.svg files (243 LOC)
    • 4 *.md files (100 LOC)
    • 1 *.json files (7 LOC)
  • " *.rst" is biggest, containing 83.01% of LOC.
  • " *.json" is smallest, containing 0.19% of LOC.


*.rst3063 LOC (83%) 3 files
*.ini277 LOC (7%) 4 files
*.svg243 LOC (6%) 1 file
*.md100 LOC (2%) 4 files
*.json7 LOC (<1%) 1 file
Analyzers
Info about analyzers used for source code examinations.

2025-05-11 19:46