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: yaml, go, md, txt, sh, py, mod, gitignore, json, js, sql, yml, css, patch, html
- 10 criteria are used to exclude files from analysis:
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (13 files).
- exclude files with path like ".*/testdata/.*" (Test data) (13 files).
- exclude files with path like ".*/docs/.*" (Documentation) (7 files).
- exclude files with path like ".*/Godeps/.*" (Golang dependencies) (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).
- exclude files with path like ".*/Chart\.js" (Chart.js) (1 file).
- exclude files with path like ".*/angular([^.]*)\.js" (AngularJS) (1 file).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- exclude files with path like ".*[.]txt" (Text files) (20 files).
- The source code folder contains 638 files:
- 514 files are included in analyses.
- 124 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 ".*".
- 410 files match defined criteria (43,510 lines of code, 100.0% vs. main code):
- 211 *.yaml files (20,915 lines of code)
- 183 *.go files (20,251 lines of code)
- 13 *.py files (1,935 lines of code)
- 1 *.js files (295 lines of code)
- 1 *.html files (69 lines of code)
- 1 *.css files (45 lines of code)
- " *.yaml" is biggest, containing 48.07% of code.
- " *.css" is smallest, containing 0.1% 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 ".*[-]tests/.*".
- files with paths like ".*_test[.].*".
- files with paths like ".*/[Tt]est/.*".
- files with paths like ".*/test_.*".
- files with paths like ".*/test[-]data/.*".
- files with any line of content like ".*/simpletest/.*".
- 40 files match defined criteria (6,797 lines of code, 15.6% vs. main code):
- 35 *.go files (6,529 lines of code)
- 2 *.py files (144 lines of code)
- 3 *.yaml files (124 lines of code)
- " *.go" is biggest, containing 96.06% of code.
- " *.yaml" is smallest, containing 1.82% of code.
Build and Deployment Code
Source code used to configure or support build and deployment process.
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 ".*/go[.]mod".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]txt".
- files with paths like ".*/[Ee]xamples/.*".
- files with paths like ".*[.]patch".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 47 files match defined criteria (11,866 lines of code, 27.3% vs. main code):
- 5 *.json files (10,535 lines of code)
- 27 *.md files (980 lines of code)
- 10 *.mod files (213 lines of code)
- 1 *.patch files (65 lines of code)
- 1 *.yaml files (40 lines of code)
- 3 *.sql files (33 lines of code)
- " *.json" is biggest, containing 88.78% of code.
- " *.sql" is smallest, containing 0.28% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.yaml 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
- *.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
- *.js files are analyzed with JavaScriptAnalyzer:
- 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
- *.html files are analyzed with HtmlAnalyzer:
- 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
- *.css files are analyzed with CssAnalyzer:
- 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-02-03 09:11