Analysis scope, overview of main, test, generated, deployment, build, and other code.
Source Code Analysis Scope
Files includes and excluded from analyses
- 15 extensions are included in analyses: bzl, java, xml, md, json, sh, scala, kt, txt, gitignore, proto, yml, gitattributes, tpl, bat
- 10 criteria are used to exclude files from analysis:
- exclude files with path like ".*/(3rd|[Tt]hird)[-_]?[Pp]arty/.*" (Dependencies) (7 files).
- exclude files with path like ".*/bin/.*" (Binaries for distribution) (0 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (5 files).
- exclude files with path like ".*/extern(al)?/.*" (Dependencies) (24 files).
- exclude files with path like ".*/[Jj]avadoc/.*" (Generated documentation) (0 files).
- exclude files with path like ".*/docs/.*" (Documentation) (4 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 250 files:
- 119 files are included in analyses.
- 131 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 ".*".
- 29 files match defined criteria (3,276 lines of code, 100.0% vs. main code):
- 28 *.bzl files (3,265 lines of code)
- 1 *.tpl files (11 lines of code)
- " *.bzl" is biggest, containing 99.66% of code.
- " *.tpl" is smallest, containing 0.34% 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]est/.*".
- files with paths like ".*_tests[.].*".
- files with paths like ".*/[Tt]ests/.*".
- files with paths like ".*_test[.].*".
- files with any line of content like ".*/simpletest/.*".
- 23 files match defined criteria (1,750 lines of code, 53.4% vs. main code):
- 10 *.bzl files (1,452 lines of code)
- 5 *.java files (152 lines of code)
- 5 *.sh files (121 lines of code)
- 3 *.kt files (25 lines of code)
- " *.bzl" is biggest, containing 82.97% of code.
- " *.kt" is smallest, containing 1.43% 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 ".*[.]bat".
- files with paths like ".*/AndroidManifest[.]xml".
- files with paths like ".*[.]git[a-z]+".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*/[.]gitattributes".
- 5 files match defined criteria (94 lines of code, 2.9% vs. main code). All matches are in *.sh files.
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".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 62 files match defined criteria (19,286 lines of code, 588.7% vs. main code):
- 13 *.json files (17,771 lines of code)
- 8 *.md files (1,015 lines of code)
- 12 *.java files (197 lines of code)
- 19 *.xml files (181 lines of code)
- 6 *.scala files (94 lines of code)
- 2 *.proto files (15 lines of code)
- 2 *.kt files (13 lines of code)
- " *.json" is biggest, containing 92.14% of code.
- " *.kt" is smallest, containing 0.07% 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
- *.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
2022-02-03 05:31