guardian/security-hq
Code Volume
Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
mjs
editorconfig
properties
snap

scoping details...
  • 16 extensions are included in analyses: scala, md, json, yaml, yml, gitignore, js, txt, ts, sbt, sh, xml, mjs, editorconfig, properties, snap
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (1 file).
    • exclude files with path like ".*/git[-]commit[-]trailers[.]txt" (Git history trailers) (1 file).
    • exclude files with path like ".*/docs/.*" (Documentation) (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.
main3504 LOC (38%) 41 files
test4734 LOC (52%) 22 files
generated0 LOC (0%) 0 files
build and deployment444 LOC (4%) 14 files
other405 LOC (4%) 11 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
mjs
Explore:   circles  |  sunburst

scala2892 LOC (82%) 33 files
ts471 LOC (13%) 1 file
yaml106 LOC (3%) 3 files
xml23 LOC (<1%) 2 files
mjs8 LOC (<1%) 1 file
js4 LOC (<1%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 41 files match defined criteria (3,504 LOC, 100.0% vs. main code):
    • 33 scala files (2,892 LOC)
    • 1 ts files (471 LOC)
    • 3 yaml files (106 LOC)
    • 2 xml files (23 LOC)
    • 1 mjs files (8 LOC)
    • 1 js files (4 LOC)
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
snap
Explore:   circles  |  sunburst

scala2727 LOC (57%) 17 files
snap1958 LOC (41%) 1 file
yaml26 LOC (<1%) 1 file
ts15 LOC (<1%) 1 file
js8 LOC (<1%) 2 files

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*/jest[.][a-zA-Z0-9\.]+".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*[.]snap".
    • files with paths like ".*[-]test[-].*".
  • 22 files match defined criteria (4,734 LOC, 135.1% vs. main code):
    • 17 scala files (2,727 LOC)
    • 1 snap files (1,958 LOC)
    • 1 yaml files (26 LOC)
    • 1 ts files (15 LOC)
    • 2 js files (8 LOC)
Build and Deployment Code
Source code used to configure or support build and deployment process.
editorconfig
Explore:   circles  |  sunburst

yaml139 LOC (31%) 6 files
gitignore138 LOC (31%) 3 files
sbt108 LOC (24%) 2 files
sh50 LOC (11%) 2 files
editorconfig9 LOC (2%) 1 file

scope details...
  • The following criteria are used to filter files:
    • files with paths like ".*[.]editorconfig".
    • files with paths like "(.*/)?[.]editorconfig".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]sbt".
    • files with paths like ".*/[.]github/workflows/.*[.]ya?ml".
    • files with paths like ".*/docker[-]compose[.]yml".
  • 14 files match defined criteria (444 LOC, 12.7% vs. main code):
    • 6 yaml files (139 LOC)
    • 3 gitignore files (138 LOC)
    • 2 sbt files (108 LOC)
    • 2 sh files (50 LOC)
    • 1 editorconfig files (9 LOC)
Other Code
properties
Explore:   circles  |  sunburst

md321 LOC (79%) 7 files
json83 LOC (20%) 3 files
properties1 LOC (<1%) 1 file

scope details...
  • 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 ".*[.]json".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
  • 11 files match defined criteria (405 LOC, 11.6% vs. main code):
    • 7 md files (321 LOC)
    • 3 json files (83 LOC)
    • 1 properties files (1 LOC)
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...
  • *.scala files are analyzed with ScalaAnalyzer:
    • 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
  • *.ts files are analyzed with TypeScriptAnalyzer:
    • 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
    • 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
  • *.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
  • *.mjs 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
  • *.js files are analyzed with JavaScriptAnalyzer:
    • 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
    • No dependency analysis