facebookincubator / Battery-Metrics
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
  • 9 extensions are included in analyses: java, md, gradle, xml, properties, txt, bat, gitignore, json
  • 5 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/docs/.*" (Documentation) (5 files).
    • exclude files with path like ".*/gradle/wrapper/.*" (Gradle) (1 file).
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (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).
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.

main5690 LOC (53%) 85 files
test4368 LOC (41%) 62 files
generated0 LOC (0%) 0 files
build and deployment355 LOC (3%) 12 files
other238 LOC (2%) 8 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 ".*".
  • 85 files match defined criteria (5,690 lines of code, 100.0% vs. main code):
    • 82 *.java files (5,676 lines of code)
    • 3 *.xml files (14 lines of code)
  • " *.java" is biggest, containing 99.75% of code.
  • " *.xml" is smallest, containing 0.25% of code.


*.java5676 LOC (99%) 82 files
*.xml14 LOC (<1%) 3 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/.*".
  • 62 files match defined criteria (4,368 lines of code, 76.8% vs. main code). All matches are in *.java files.


*.java4368 LOC (100%) 62 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 ".*/AndroidManifest[.]xml".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]bat".
  • 12 files match defined criteria (355 lines of code, 6.2% vs. main code):
    • 7 *.gradle files (261 lines of code)
    • 1 *.bat files (66 lines of code)
    • 4 *.xml files (28 lines of code)
  • " *.gradle" is biggest, containing 73.52% of code.
  • " *.xml" is smallest, containing 7.89% of code.


*.gradle261 LOC (73%) 7 files
*.bat66 LOC (18%) 1 files
*.xml28 LOC (7%) 4 files
Other Code
properties
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]md".
    • files with paths like ".*[.]properties".
    • files with paths like ".*[.]json".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*[.]txt".
  • 8 files match defined criteria (238 lines of code, 4.2% vs. main code):
    • 3 *.md files (155 lines of code)
    • 1 *.json files (72 lines of code)
    • 4 *.properties files (11 lines of code)
  • " *.md" is biggest, containing 65.13% of code.
  • " *.properties" is smallest, containing 4.62% of code.


*.md155 LOC (65%) 3 files
*.json72 LOC (30%) 1 files
*.properties11 LOC (4%) 4 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)
  • *.xml files are analyzed with XmlAnalyzer:
    • 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-04-15 01:22