aws-samples / samples-aws-tools-powershell
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
  • 4 extensions are included in analyses: ps1, md, psd1, json
  • 1 criterion is used to exclude files from analysis:
    • 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.

main435 LOC (83%) 11 files
test0 LOC (0%) 0 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other89 LOC (16%) 3 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 ".*".
  • 11 files match defined criteria (435 lines of code, 100.0% vs. main code):
    • 9 *.ps1 files (418 lines of code)
    • 2 *.psd1 files (17 lines of code)
  • " *.ps1" is biggest, containing 96.09% of code.
  • " *.psd1" is smallest, containing 3.91% of code.


*.ps1418 LOC (96%) 9 files
*.psd117 LOC (3%) 2 files
Other Code
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".
  • 3 files match defined criteria (89 lines of code, 20.5% vs. main code). All matches are in *.md files.


*.md89 LOC (100%) 3 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.psd1 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 17:20