microsoft / azure-maven-plugins
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
cmd
  • 14 extensions are included in analyses: java, xml, groovy, json, md, jsp, yml, yaml, properties, ps1, gitignore, txt, html, cmd
  • 8 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (6 files).
    • exclude files with path like ".*/cache/.*" (Caches) (5 files).
    • exclude files with path like ".*/docs/.*" (Documentation) (3 files).
    • exclude files with path like ".*/mvnw\.cmd" (Maven) (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 ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
    • exclude files with path like ".*[.]txt" (Text files) (0 files).
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.

main28473 LOC (71%) 427 files
test3043 LOC (7%) 90 files
generated0 LOC (0%) 0 files
build and deployment0 LOC (0%) 0 files
other8151 LOC (20%) 114 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 ".*".
  • 427 files match defined criteria (28,473 lines of code, 100.0% vs. main code):
    • 412 *.java files (28,018 lines of code)
    • 2 *.ps1 files (196 lines of code)
    • 8 *.yaml files (171 lines of code)
    • 5 *.yml files (88 lines of code)
  • " *.java" is biggest, containing 98.4% of code.
  • " *.yml" is smallest, containing 0.31% of code.


*.java28018 LOC (98%) 412 files
*.ps1196 LOC (<1%) 2 files
*.yaml171 LOC (<1%) 8 files
*.yml88 LOC (<1%) 5 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 any line of content like ".*/simpletest/.*".
    • files with paths like ".*/src/it/.*".
  • 90 files match defined criteria (3,043 lines of code, 10.7% vs. main code):
    • 41 *.java files (2,813 lines of code)
    • 38 *.groovy files (175 lines of code)
    • 9 *.jsp files (45 lines of code)
    • 2 *.html files (10 lines of code)
  • " *.java" is biggest, containing 92.44% of code.
  • " *.html" is smallest, containing 0.33% of code.


*.java2813 LOC (92%) 41 files
*.groovy175 LOC (5%) 38 files
*.jsp45 LOC (1%) 9 files
*.html10 LOC (<1%) 2 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 ".*/[.]gitignore".
    • files with paths like ".*[.]properties".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/checkstyle[.]xml".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 114 files match defined criteria (8,151 lines of code, 28.6% vs. main code):
    • 80 *.xml files (6,457 lines of code)
    • 20 *.json files (1,028 lines of code)
    • 8 *.md files (573 lines of code)
    • 6 *.properties files (93 lines of code)
  • " *.xml" is biggest, containing 79.22% of code.
  • " *.properties" is smallest, containing 1.14% of code.


*.xml6457 LOC (79%) 80 files
*.json1028 LOC (12%) 20 files
*.md573 LOC (7%) 8 files
*.properties93 LOC (1%) 6 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)
  • *.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
  • *.yaml 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
  • *.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


2022-01-30 15:00