aws-quickstart / qs-cfn-lint-rules
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
ini
jq
gitmodules
  • 13 extensions are included in analyses: yaml, html, json, py, yml, md, txt, sh, xml, ini, gitignore, jq, gitmodules
  • 6 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (3 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 ".*/bin/.*" (Binaries for distribution) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (2 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.

main1929 LOC (<1%) 36 files
test157378 LOC (41%) 538 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other219210 LOC (57%) 95 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
jq
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 36 files match defined criteria (1,929 lines of code, 100.0% vs. main code):
    • 35 *.py files (1,908 lines of code)
    • 1 *.jq files (21 lines of code)
  • " *.py" is biggest, containing 98.91% of code.
  • " *.jq" is smallest, containing 1.09% of code.


*.py1908 LOC (98%) 35 files
*.jq21 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 any line of content like ".*/simpletest/.*".
  • 538 files match defined criteria (157,378 lines of code, 8158.5% vs. main code):
    • 395 *.yaml files (144,192 lines of code)
    • 44 *.yml files (6,752 lines of code)
    • 77 *.html files (5,928 lines of code)
    • 19 *.py files (412 lines of code)
    • 3 *.sh files (94 lines of code)
  • " *.yaml" is biggest, containing 91.62% of code.
  • " *.sh" is smallest, containing 0.06% of code.


*.yaml144192 LOC (91%) 395 files
*.yml6752 LOC (4%) 44 files
*.html5928 LOC (3%) 77 files
*.py412 LOC (<1%) 19 files
*.sh94 LOC (<1%) 3 files
Other Code
ini
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[Ss]amples/.*".
    • files with paths like ".*[.]ini".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 95 files match defined criteria (219,210 lines of code, 11363.9% vs. main code):
    • 72 *.json files (214,571 lines of code)
    • 2 *.xml files (3,998 lines of code)
    • 17 *.md files (387 lines of code)
    • 3 *.yaml files (203 lines of code)
    • 1 *.ini files (51 lines of code)
  • " *.json" is biggest, containing 97.88% of code.
  • " *.ini" is smallest, containing 0.02% of code.


*.json214571 LOC (97%) 72 files
*.xml3998 LOC (1%) 2 files
*.md387 LOC (<1%) 17 files
*.yaml203 LOC (<1%) 3 files
*.ini51 LOC (<1%) 1 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
  • *.jq 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 22:57