korosuke613 / etrobocon2017
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
cfg
cmake
  • 13 extensions are included in analyses: cpp, h, sh, c, txt, md, cfg, yml, inc, gitignore, cmake, json, pl
  • 3 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).
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.

main4237 LOC (61%) 113 files
test1689 LOC (24%) 25 files
generated0 LOC (0%) 0 files
build and deployment19 LOC (<1%) 5 files
other971 LOC (14%) 11 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 113 files match defined criteria (4,237 lines of code, 100.0% vs. main code):
    • 49 *.cpp files (2,620 lines of code)
    • 55 *.h files (1,489 lines of code)
    • 2 *.inc files (52 lines of code)
    • 4 *.c files (38 lines of code)
    • 1 *.yml files (23 lines of code)
    • 2 *.cfg files (15 lines of code)
  • " *.cpp" is biggest, containing 61.84% of code.
  • " *.cfg" is smallest, containing 0.35% of code.


*.cpp2620 LOC (61%) 49 files
*.h1489 LOC (35%) 55 files
*.inc52 LOC (1%) 2 files
*.c38 LOC (<1%) 4 files
*.yml23 LOC (<1%) 1 files
*.cfg15 LOC (<1%) 2 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/.*".
  • 25 files match defined criteria (1,689 lines of code, 39.9% vs. main code):
    • 18 *.cpp files (1,573 lines of code)
    • 1 *.pl files (60 lines of code)
    • 5 *.h files (50 lines of code)
    • 1 *.sh files (6 lines of code)
  • " *.cpp" is biggest, containing 93.13% of code.
  • " *.sh" is smallest, containing 0.36% of code.


*.cpp1573 LOC (93%) 18 files
*.pl60 LOC (3%) 1 files
*.h50 LOC (2%) 5 files
*.sh6 LOC (<1%) 1 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 ".*[.]sh".
    • files with paths like ".*[.]git[a-z]+".
    • files with paths like ".*/[.]gitignore".
  • 5 files match defined criteria (19 lines of code, 0.4% vs. main code). All matches are in *.sh files.


*.sh19 LOC (100%) 5 files
Other Code
txt
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*[.]txt".
    • files with paths like ".*[.]json".
    • files with paths like ".*[.]md".
    • files with paths like ".*/README[.][a-z0-9]+".
    • files with paths like ".*/[.]gitignore".
    • files with paths like ".*/[Ee]xamples/.*".
  • 11 files match defined criteria (971 lines of code, 22.9% vs. main code):
    • 3 *.md files (623 lines of code)
    • 3 *.cpp files (145 lines of code)
    • 3 *.txt files (123 lines of code)
    • 1 *.json files (72 lines of code)
    • 1 *.sh files (8 lines of code)
  • " *.md" is biggest, containing 64.16% of code.
  • " *.sh" is smallest, containing 0.82% of code.


*.md623 LOC (64%) 3 files
*.cpp145 LOC (14%) 3 files
*.txt123 LOC (12%) 3 files
*.json72 LOC (7%) 1 files
*.sh8 LOC (<1%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.cpp files are analyzed with CppAnalyzer:
    • 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
  • *.h files are analyzed with CppAnalyzer:
    • 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
  • *.inc files are analyzed with PhpAnalyzer:
    • 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
  • *.c files are analyzed with CStyleAnalyzer:
    • 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
    • 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
  • *.cfg files are analyzed with CfgAnalyzer:
    • 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-05-14 00:22