aws-robotics / cloudwatch-common
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
in
cmake
  • 11 extensions are included in analyses: h, cpp, txt, in, cmake, hpp, yml, rst, xml, md, json
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 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) (12 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.

main4070 LOC (44%) 71 files
test2617 LOC (28%) 22 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other2441 LOC (26%) 11 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
in
cmake
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 71 files match defined criteria (4,070 lines of code, 100.0% vs. main code):
    • 36 *.h files (2,146 lines of code)
    • 13 *.cpp files (1,623 lines of code)
    • 6 *.hpp files (157 lines of code)
    • 8 *.in files (72 lines of code)
    • 8 *.cmake files (72 lines of code)
  • " *.h" is biggest, containing 52.73% of code.
  • " *.cmake" is smallest, containing 1.77% of code.


*.h2146 LOC (52%) 36 files
*.cpp1623 LOC (39%) 13 files
*.hpp157 LOC (3%) 6 files
*.in72 LOC (1%) 8 files
*.cmake72 LOC (1%) 8 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 ".*/[Tt]est/.*".
    • files with paths like ".*_test[.].*".
    • files with any line of content like ".*/simpletest/.*".
  • 22 files match defined criteria (2,617 lines of code, 64.3% vs. main code):
    • 21 *.cpp files (2,583 lines of code)
    • 1 *.h files (34 lines of code)
  • " *.cpp" is biggest, containing 98.7% of code.
  • " *.h" is smallest, containing 1.3% of code.


*.cpp2583 LOC (98%) 21 files
*.h34 LOC (1%) 1 files
Other Code
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](rst|rest|resttxt|rsttxt)".
    • files with paths like ".*/LICENSE[.][a-z0-9]+".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 11 files match defined criteria (2,441 lines of code, 60.0% vs. main code):
    • 4 *.rst files (2,265 lines of code)
    • 3 *.md files (97 lines of code)
    • 4 *.xml files (79 lines of code)
  • " *.rst" is biggest, containing 92.79% of code.
  • " *.xml" is smallest, containing 3.24% of code.


*.rst2265 LOC (92%) 4 files
*.md97 LOC (3%) 3 files
*.xml79 LOC (3%) 4 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.cpp 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
  • *.hpp 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
  • *.in files are analyzed with RustAnalyzer:
    • 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
  • *.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


2022-02-01 01:26