firebase / codelab-friendlychat-android
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
  • 13 extensions are included in analyses: xml, kt, gradle, gitignore, json, properties, bat, md, yml, pro, java, txt, sh
  • 7 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (9 files).
    • exclude files with path like ".*/proguard[-]rules[.]pro" (ProGuard) (2 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (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 ".*/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.

main655 LOC (26%) 14 files
test26 LOC (1%) 2 files
generated0 LOC (0%) 0 files
build and deployment419 LOC (16%) 12 files
other1413 LOC (56%) 49 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 ".*".
  • 14 files match defined criteria (655 lines of code, 100.0% vs. main code). All matches are in *.kt files.


*.kt655 LOC (100%) 14 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 ".*/src/androidTest/.*".
    • files with any line of content like ".*/simpletest/.*".
    • files with paths like ".*/mock[-].*".
  • 2 files match defined criteria (26 lines of code, 4.0% vs. main code). All matches are in *.java files.


*.java26 LOC (100%) 2 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 ".*[.]gradle".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/AndroidManifest[.]xml".
    • files with paths like ".*[.]bat".
    • files with paths like ".*[.]sh".
  • 12 files match defined criteria (419 lines of code, 64.0% vs. main code):
    • 8 *.gradle files (210 lines of code)
    • 3 *.bat files (204 lines of code)
    • 1 *.sh files (5 lines of code)
  • " *.gradle" is biggest, containing 50.12% of code.
  • " *.sh" is smallest, containing 1.19% of code.


*.gradle210 LOC (50%) 8 files
*.bat204 LOC (48%) 3 files
*.sh5 LOC (1%) 1 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 ".*[.]json".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
  • 49 files match defined criteria (1,413 lines of code, 215.7% vs. main code):
    • 3 *.md files (707 lines of code)
    • 38 *.xml files (572 lines of code)
    • 5 *.json files (96 lines of code)
    • 3 *.properties files (38 lines of code)
  • " *.md" is biggest, containing 50.04% of code.
  • " *.properties" is smallest, containing 2.69% of code.


*.md707 LOC (50%) 3 files
*.xml572 LOC (40%) 38 files
*.json96 LOC (6%) 5 files
*.properties38 LOC (2%) 3 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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)


2022-02-03 05:38