Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 17 extensions are included in analyses: bzl, cc, h, py, tpl, sh, c, md, go, json, lds, gitignore, txt, bat, proto, yml, bash
- 6 criteria are used to exclude files from analysis:
- exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (1 file).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 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) (1 file).
- The source code folder contains 144 files:
- 106 files are included in analyses.
- 38 files are excluded from analyses:
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.
Main Code
All manually created or maintained source code that defines logic of the product that is run in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*".
- 45 files match defined criteria (10,958 lines of code, 100.0% vs. main code):
- 27 *.bzl files (7,649 lines of code)
- 2 *.go files (1,345 lines of code)
- 5 *.py files (1,019 lines of code)
- 7 *.tpl files (583 lines of code)
- 3 *.cc files (308 lines of code)
- 1 *.h files (54 lines of code)
- " *.bzl" is biggest, containing 69.8% of code.
- " *.h" is smallest, containing 0.49% of code.
Test Code
Used only for testing of the product. Normally not deployed in a production environment.
- The following criteria are used to filter files:
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*_test[.].*".
- files with paths like ".*/test_.*".
- files with paths like ".*_tests[.].*".
- files with any line of content like ".*/simpletest/.*".
- 8 files match defined criteria (4,167 lines of code, 38.0% vs. main code):
- 1 *.go files (1,642 lines of code)
- 2 *.py files (1,420 lines of code)
- 2 *.cc files (463 lines of code)
- 1 *.bash files (451 lines of code)
- 1 *.sh files (174 lines of code)
- 1 *.bzl files (17 lines of code)
- " *.go" is biggest, containing 39.4% of code.
- " *.bzl" is smallest, containing 0.41% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
- 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".
- files with paths like ".*[.]bat".
- 4 files match defined criteria (153 lines of code, 1.4% vs. main code):
- 3 *.sh files (133 lines of code)
- 1 *.bat files (20 lines of code)
- " *.sh" is biggest, containing 86.93% of code.
- " *.bat" is smallest, containing 13.07% of code.
Other Code
- 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 ".*/[Ee]xamples/.*".
- files with paths like ".*[.]txt".
- 49 files match defined criteria (712 lines of code, 6.5% vs. main code):
- 6 *.bzl files (380 lines of code)
- 4 *.md files (169 lines of code)
- 20 *.cc files (54 lines of code)
- 1 *.sh files (49 lines of code)
- 11 *.h files (38 lines of code)
- 2 *.lds files (11 lines of code)
- 4 *.c files (6 lines of code)
- 1 *.json files (5 lines of code)
- " *.bzl" is biggest, containing 53.37% of code.
- " *.json" is smallest, containing 0.7% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.bzl 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
- *.go files are analyzed with GoLangAnalyzer:
- 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
- *.py files are analyzed with PythonAnalyzer:
- 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
- *.tpl 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
- *.cc 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
2022-02-03 05:33