awslabs / aws-crt-java
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
pro
txt
clang-format
cmake
gitmodules
clang-tidy
  • 24 extensions are included in analyses: java, html, c, yml, js, kt, sh, h, css, bat, md, kts, json, gitignore, xml, gradle, properties, py, pro, txt, clang-format, cmake, gitmodules, clang-tidy
  • 11 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (13 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (2 files).
    • exclude files with path like ".*/proguard[-]rules[.]pro" (ProGuard) (1 file).
    • exclude files with path like ".*/dist/.*" (Distributions) (3 files).
    • exclude files with path like "(?i).*/jquery.*[.]js" (jQuery files) (3 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (120 files).
    • exclude files with path like ".*/extern(al)?/.*" (Dependencies) (0 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.

main15716 LOC (26%) 181 files
test5954 LOC (9%) 39 files
generated37159 LOC (61%) 373 files
build and deployment546 LOC (<1%) 19 files
other852 LOC (1%) 11 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cmake
pro
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 181 files match defined criteria (15,716 lines of code, 100.0% vs. main code):
    • 35 *.c files (7,288 lines of code)
    • 99 *.java files (6,054 lines of code)
    • 13 *.kt files (1,297 lines of code)
    • 9 *.h files (435 lines of code)
    • 18 *.yml files (385 lines of code)
    • 5 *.kts files (227 lines of code)
    • 1 *.cmake files (29 lines of code)
    • 1 *.pro files (1 lines of code)
  • " *.c" is biggest, containing 46.37% of code.
  • " *.pro" is smallest, containing 0.01% of code.


*.c7288 LOC (46%) 35 files
*.java6054 LOC (38%) 99 files
*.kt1297 LOC (8%) 13 files
*.h435 LOC (2%) 9 files
*.yml385 LOC (2%) 18 files
*.kts227 LOC (1%) 5 files
*.cmake29 LOC (<1%) 1 files
*.pro1 LOC (<1%) 1 files
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
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 ".*/src/androidTest/.*".
    • files with any line of content like ".*/simpletest/.*".
  • 39 files match defined criteria (5,954 lines of code, 37.9% vs. main code). All matches are in *.java files.


*.java5954 LOC (100%) 39 files
Generated Code
Automatically generated files, not manually changed after generation.
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*/generated/.*".
  • 373 files match defined criteria (37,159 lines of code, 236.4% vs. main code). All matches are in *.java files.


*.java37159 LOC (100%) 373 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 ".*[.]sh".
    • files with paths like ".*[.]bat".
    • files with paths like ".*/pom[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/AndroidManifest[.]xml".
    • files with paths like ".*[.]gradle".
    • files with paths like ".*/[.]gitmodules".
  • 19 files match defined criteria (546 lines of code, 3.5% vs. main code):
    • 3 *.gradle files (227 lines of code)
    • 5 *.bat files (180 lines of code)
    • 11 *.sh files (139 lines of code)
  • " *.gradle" is biggest, containing 41.58% of code.
  • " *.sh" is smallest, containing 25.46% of code.


*.gradle227 LOC (41%) 3 files
*.bat180 LOC (32%) 5 files
*.sh139 LOC (25%) 11 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 ".*[.]properties".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 11 files match defined criteria (852 lines of code, 5.4% vs. main code):
    • 3 *.xml files (403 lines of code)
    • 4 *.md files (157 lines of code)
    • 2 *.json files (148 lines of code)
    • 1 *.java files (123 lines of code)
    • 1 *.properties files (21 lines of code)
  • " *.xml" is biggest, containing 47.3% of code.
  • " *.properties" is smallest, containing 2.46% of code.


*.xml403 LOC (47%) 3 files
*.md157 LOC (18%) 4 files
*.json148 LOC (17%) 2 files
*.java123 LOC (14%) 1 files
*.properties21 LOC (2%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.c files are analyzed with CStyleAnalyzer:
    • 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)
  • *.kt files are analyzed with KotlinAnalyzer:
    • 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 (based on imports and package statements)
  • *.h files are analyzed with CppAnalyzer:
    • 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
  • *.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
  • *.kts files are analyzed with KotlinAnalyzer:
    • 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 (based on imports and package statements)
  • *.cmake 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
  • *.pro 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


2022-01-31 18:27