korosuke613 / etrobocon2019
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
  • 12 extensions are included in analyses: h, cpp, c, sh, md, yml, txt, json, cfg, gitignore, cmake, inc
  • 3 criteria are used to exclude files from analysis:
    • exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (7 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.

main2400 LOC (86%) 56 files
test181 LOC (6%) 7 files
generated0 LOC (0%) 0 files
build and deployment8 LOC (<1%) 3 files
other185 LOC (6%) 3 files
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
cmake
cfg
Explore:   circles  |  sunburst
  • The following criteria are used to filter files:
    • files with paths like ".*".
  • 56 files match defined criteria (2,400 lines of code, 100.0% vs. main code):
    • 12 *.c files (1,341 lines of code)
    • 27 *.h files (567 lines of code)
    • 13 *.cpp files (272 lines of code)
    • 1 *.cmake files (175 lines of code)
    • 1 *.yml files (22 lines of code)
    • 1 *.inc files (18 lines of code)
    • 1 *.cfg files (5 lines of code)
  • " *.c" is biggest, containing 55.88% of code.
  • " *.cfg" is smallest, containing 0.21% of code.


*.c1341 LOC (55%) 12 files
*.h567 LOC (23%) 27 files
*.cpp272 LOC (11%) 13 files
*.cmake175 LOC (7%) 1 files
*.yml22 LOC (<1%) 1 files
*.inc18 LOC (<1%) 1 files
*.cfg5 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 ".*/[Tt]est/.*".
  • 7 files match defined criteria (181 lines of code, 7.5% vs. main code):
    • 1 *.h files (99 lines of code)
    • 3 *.cpp files (51 lines of code)
    • 3 *.sh files (31 lines of code)
  • " *.h" is biggest, containing 54.7% of code.
  • " *.sh" is smallest, containing 17.13% of code.


*.h99 LOC (54%) 1 files
*.cpp51 LOC (28%) 3 files
*.sh31 LOC (17%) 3 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".
  • 3 files match defined criteria (8 lines of code, 0.3% vs. main code). All matches are in *.sh files.


*.sh8 LOC (100%) 3 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".
  • 3 files match defined criteria (185 lines of code, 7.7% vs. main code):
    • 1 *.json files (72 lines of code)
    • 1 *.txt files (59 lines of code)
    • 1 *.md files (54 lines of code)
  • " *.json" is biggest, containing 38.92% of code.
  • " *.md" is smallest, containing 29.19% of code.


*.json72 LOC (38%) 1 files
*.txt59 LOC (31%) 1 files
*.md54 LOC (29%) 1 files
Analyzers
Info about analyzers used for source code examinations.
  • *.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
  • *.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
  • *.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
  • *.cmake 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
  • *.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
  • *.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
  • *.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