aws-samples / aws-analytics-reference-architecture
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
properties
npmignore
project
gitattributes
prefs
snap
  • 24 extensions are included in analyses: ts, sql, java, py, json, md, scala, txt, yml, yaml, gitignore, properties, sbt, js, xml, gradle, css, npmignore, project, gitattributes, bat, sh, prefs, snap
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (23 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 ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/bootstrap[-].*" (Library) (6 files).
    • exclude files with path like ".*[.]txt" (Text files) (9 files).
    • 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.

main11876 LOC (6%) 175 files
test3360 LOC (1%) 51 files
generated0 LOC (0%) 0 files
build and deployment172 LOC (<1%) 4 files
other165791 LOC (91%) 114 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 ".*".
  • 175 files match defined criteria (11,876 lines of code, 100.0% vs. main code):
    • 55 *.py files (5,370 lines of code)
    • 52 *.ts files (2,730 lines of code)
    • 42 *.java files (2,303 lines of code)
    • 12 *.scala files (1,127 lines of code)
    • 8 *.yaml files (242 lines of code)
    • 2 *.yml files (62 lines of code)
    • 2 *.sbt files (27 lines of code)
    • 1 *.css files (14 lines of code)
    • 1 *.js files (1 lines of code)
  • " *.py" is biggest, containing 45.22% of code.
  • " *.js" is smallest, containing 0.01% of code.


*.py5370 LOC (45%) 55 files
*.ts2730 LOC (22%) 52 files
*.java2303 LOC (19%) 42 files
*.scala1127 LOC (9%) 12 files
*.yaml242 LOC (2%) 8 files
*.yml62 LOC (<1%) 2 files
*.sbt27 LOC (<1%) 2 files
*.css14 LOC (<1%) 1 files
*.js1 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
snap
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/[Tt]est/.*".
    • files with paths like ".*[.][Tt]est[.].*".
    • files with paths like ".*[.]test[.].*".
    • files with paths like ".*/e2e/.*".
    • files with paths like ".*_test[.].*".
    • files with paths like ".*[.]snap".
    • files with any line of content like ".*/simpletest/.*".
  • 51 files match defined criteria (3,360 lines of code, 28.3% vs. main code):
    • 22 *.java files (1,463 lines of code)
    • 21 *.ts files (1,082 lines of code)
    • 1 *.snap files (419 lines of code)
    • 7 *.scala files (396 lines of code)
  • " *.java" is biggest, containing 43.54% of code.
  • " *.scala" is smallest, containing 11.79% of code.


*.java1463 LOC (43%) 22 files
*.ts1082 LOC (32%) 21 files
*.snap419 LOC (12%) 1 files
*.scala396 LOC (11%) 7 files
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 ".*/pom[.]xml".
    • files with paths like ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/package[.]json".
    • files with paths like ".*/[.]gitattributes".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]gradle".
  • 4 files match defined criteria (172 lines of code, 1.4% vs. main code):
    • 2 *.gradle files (99 lines of code)
    • 1 *.bat files (68 lines of code)
    • 1 *.sh files (5 lines of code)
  • " *.gradle" is biggest, containing 57.56% of code.
  • " *.sh" is smallest, containing 2.91% of code.


*.gradle99 LOC (57%) 2 files
*.bat68 LOC (39%) 1 files
*.sh5 LOC (2%) 1 files
Other Code
properties
Explore:   circles  |  sunburst
  • 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 ".*[.]txt".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[.]npmignore".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 114 files match defined criteria (165,791 lines of code, 1396.0% vs. main code):
    • 65 *.sql files (161,311 lines of code)
    • 22 *.json files (2,825 lines of code)
    • 23 *.md files (1,174 lines of code)
    • 2 *.xml files (474 lines of code)
    • 2 *.properties files (7 lines of code)
  • " *.sql" is biggest, containing 97.3% of code.
  • " *.properties" is smallest, containing 0% of code.


*.sql161311 LOC (97%) 65 files
*.json2825 LOC (1%) 22 files
*.md1174 LOC (<1%) 23 files
*.xml474 LOC (<1%) 2 files
*.properties7 LOC (<1%) 2 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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
  • *.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)
  • *.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
  • *.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
  • *.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
  • *.sbt 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
  • *.css files are analyzed with CssAnalyzer:
    • 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
  • *.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

2022-01-31 17:06