guardian/multimedia-watchman
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
spec

scoping details...
  • 7 extensions are included in analyses: py, txt, sh, xml, gitignore, yml, spec
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*/git[-]history[.]txt" (Git history) (1 file).
    • exclude files with path like ".*/git[-][a-zA-Z0-9_]+[.]txt" (Git data exports for sokrates analyses) (1 file).
    • exclude files with path like ".*/_sokrates/.*" (Sokrates files) (0 files).
    • exclude files with path like ".*/_sokrates_landscape/.*" (Sokrates landscape files) (0 files).
    • exclude files with path like ".*/sokrates_.*?[.]json" (Sokrates conventions and configurations) (0 files).
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.
main512 LOC (66%) 10 files
test98 LOC (12%) 3 files
generated0 LOC (0%) 0 files
build and deployment139 LOC (18%) 3 files
other18 LOC (2%) 1 file
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
spec
Explore:   circles  |  sunburst

py422 LOC (82%) 7 files
spec50 LOC (9%) 1 file
xml26 LOC (5%) 1 file
yaml14 LOC (2%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 10 files match defined criteria (512 LOC, 100.0% vs. main code):
    • 7 py files (422 LOC)
    • 1 spec files (50 LOC)
    • 1 xml files (26 LOC)
    • 1 yaml files (14 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
Explore:   circles  |  sunburst

py98 LOC (100%) 3 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]ests/.*".
    • files with paths like ".*/test_.*".
  • 3 files match defined criteria (98 LOC, 19.1% vs. main code). All matches are in py files.
Build and Deployment Code
Source code used to configure or support build and deployment process.
Explore:   circles  |  sunburst

gitignore85 LOC (61%) 1 file
sh34 LOC (24%) 1 file
py20 LOC (14%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/requirements[a-zA-Z0-9._-]*[.]txt".
    • files with paths like ".*[.]sh".
    • files with paths like ".*/setup[.]py".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 3 files match defined criteria (139 LOC, 27.1% vs. main code):
    • 1 gitignore files (85 LOC)
    • 1 sh files (34 LOC)
    • 1 py files (20 LOC)
Other Code
Explore:   circles  |  sunburst

txt18 LOC (100%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
  • 1 file matches defined criteria (18 LOC, 3.5% vs. main code). All matches are in txt files.
About This Analysis
learn more about scopes (main, test, generated, build, 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.

learn more about used code analyzers...
  • *.py files are analyzed with PythonAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • Unit size analysis
    • Conditional complexity analysis
    • Basic heuristic dependency analysis
  • *.spec files are analyzed with DefaultLanguageAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Basic code cleaning (empty lines removed for LOC calculations and duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.xml files are analyzed with XmlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis
  • *.yaml files are analyzed with YamlAnalyzer:
    • All basic standard analyses supported (source code overview, duplication, file size, concerns, findings, metrics, controls)
    • Advanced code cleaning (empty lines and comments removed for LOC calculations, additional cleaning for duplication calculations)
    • No unit size analysis
    • No conditional complexity analysis
    • No dependency analysis