aws-samples / amazon-chime-voiceconnector-transcription
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
properties
txt
  • 9 extensions are included in analyses: java, md, json, svg, properties, gradle, txt, bat, yml
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (1 file).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (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) (0 files).
    • exclude files with path like ".*[.]txt" (Text files) (0 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.

main1385 LOC (49%) 25 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment157 LOC (5%) 2 files
other1234 LOC (44%) 5 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 ".*".
  • 25 files match defined criteria (1,385 lines of code, 100.0% vs. main code). All matches are in *.java files.


*.java1385 LOC (100%) 25 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 ".*[.]bat".
    • files with paths like ".*[.]gradle".
  • 2 files match defined criteria (157 lines of code, 11.3% vs. main code):
    • 1 *.gradle files (79 lines of code)
    • 1 *.bat files (78 lines of code)
  • " *.gradle" is biggest, containing 50.32% of code.
  • " *.bat" is smallest, containing 49.68% of code.


*.gradle79 LOC (50%) 1 files
*.bat78 LOC (49%) 1 files
Other Code
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
  • 5 files match defined criteria (1,234 lines of code, 89.1% vs. main code):
    • 2 *.json files (1,186 lines of code)
    • 2 *.md files (42 lines of code)
    • 1 *.properties files (6 lines of code)
  • " *.json" is biggest, containing 96.11% of code.
  • " *.properties" is smallest, containing 0.49% of code.


*.json1186 LOC (96%) 2 files
*.md42 LOC (3%) 2 files
*.properties6 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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)


2022-01-31 16:00