awsdocs / aws-lambda-developer-guide
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
csproj
txt
mod
  • 18 extensions are included in analyses: md, sh, json, java, yml, xml, js, gradle, cs, csproj, gitignore, go, py, ps1, rb, txt, yaml, mod
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 files).
    • exclude files with path like ".*/bin/.*" (Binaries for distribution) (3 files).
    • 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) (0 files).
    • exclude files with path like ".*[.]txt" (Text files) (1 file).
    • exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
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.

main3140 LOC (8%) 75 files
test785 LOC (2%) 24 files
generated0 LOC (0%) 0 files
build and deployment1381 LOC (3%) 96 files
other32805 LOC (86%) 437 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 ".*".
  • 75 files match defined criteria (3,140 lines of code, 100.0% vs. main code):
    • 27 *.yml files (1,321 lines of code)
    • 30 *.java files (788 lines of code)
    • 9 *.js files (511 lines of code)
    • 2 *.yaml files (266 lines of code)
    • 2 *.cs files (155 lines of code)
    • 1 *.go files (42 lines of code)
    • 1 *.rb files (20 lines of code)
    • 2 *.ps1 files (20 lines of code)
    • 1 *.py files (17 lines of code)
  • " *.yml" is biggest, containing 42.07% of code.
  • " *.py" is smallest, containing 0.54% of code.


*.yml1321 LOC (42%) 27 files
*.java788 LOC (25%) 30 files
*.js511 LOC (16%) 9 files
*.yaml266 LOC (8%) 2 files
*.cs155 LOC (4%) 2 files
*.go42 LOC (1%) 1 files
*.rb20 LOC (<1%) 1 files
*.ps120 LOC (<1%) 2 files
*.py17 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
csproj
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*_test[.].*".
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*[.][Tt]ests/.*".
    • files with paths like ".*[.][Tt]ests[.].*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 24 files match defined criteria (785 lines of code, 25.0% vs. main code):
    • 16 *.java files (555 lines of code)
    • 2 *.cs files (98 lines of code)
    • 1 *.go files (42 lines of code)
    • 1 *.py files (33 lines of code)
    • 2 *.csproj files (30 lines of code)
    • 1 *.rb files (16 lines of code)
    • 1 *.js files (11 lines of code)
  • " *.java" is biggest, containing 70.7% of code.
  • " *.js" is smallest, containing 1.4% of code.


*.java555 LOC (70%) 16 files
*.cs98 LOC (12%) 2 files
*.go42 LOC (5%) 1 files
*.py33 LOC (4%) 1 files
*.csproj30 LOC (3%) 2 files
*.rb16 LOC (2%) 1 files
*.js11 LOC (1%) 1 files
Build and Deployment Code
Source code used to configure or support build and deployment process.
csproj
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/package[.]json".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]csproj".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]gradle".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 96 files match defined criteria (1,381 lines of code, 44.0% vs. main code):
    • 89 *.sh files (1,142 lines of code)
    • 5 *.gradle files (207 lines of code)
    • 2 *.csproj files (32 lines of code)
  • " *.sh" is biggest, containing 82.69% of code.
  • " *.csproj" is smallest, containing 2.32% of code.


*.sh1142 LOC (82%) 89 files
*.gradle207 LOC (14%) 5 files
*.csproj32 LOC (2%) 2 files
Other Code
mod
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]json".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/go[.]mod".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 437 files match defined criteria (32,805 lines of code, 1044.7% vs. main code):
    • 343 *.md files (30,258 lines of code)
    • 79 *.json files (1,824 lines of code)
    • 14 *.xml files (717 lines of code)
    • 1 *.mod files (6 lines of code)
  • " *.md" is biggest, containing 92.24% of code.
  • " *.mod" is smallest, containing 0.02% of code.


*.md30258 LOC (92%) 343 files
*.json1824 LOC (5%) 79 files
*.xml717 LOC (2%) 14 files
*.mod6 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.yml 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
  • *.java files are analyzed with JavaAnalyzer:
    • 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
    • Advanced heuristic dependency analysis (based on package names)
  • *.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
  • *.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
  • *.cs files are analyzed with CSharpAnalyzer:
    • 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
    • Advanced heuristic dependency analysis (based on namespace heuristics)
  • *.go files are analyzed with GoLangAnalyzer:
    • 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
  • *.rb files are analyzed with RubyAnalyzer:
    • 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
    • Basic heuristic dependency analysis
  • *.ps1 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
  • *.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

2022-01-31 22:49