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: java, js, html, tf, md, sql, properties, xml, less, txt, yml, css, svg, json, gitignore, sh, tfvars
- 7 criteria are used to exclude files from analysis:
- exclude files with path like ".*[.]min[.]js" (Minimized JS library) (3 files).
- exclude files with path like ".*/[.][a-zA-Z0-9_]+.*" (Hidden files and folders) (2 files).
- exclude files with path like ".*/docs/.*" (Documentation) (10 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 ".*[.]txt" (Text files) (3 files).
- exclude files with path like ".*/sokrates_conventions[.]json" (Sokrates scoping conventions) (1 file).
- The source code folder contains 154 files:
- 101 files are included in analyses.
- 53 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 ".*".
- 32 files match defined criteria (1,527 lines of code, 100.0% vs. main code):
- 13 *.tf files (736 lines of code)
- 12 *.html files (420 lines of code)
- 4 *.less files (328 lines of code)
- 2 *.yml files (35 lines of code)
- 1 *.tfvars files (8 lines of code)
- " *.tf" is biggest, containing 48.2% of code.
- " *.tfvars" is smallest, containing 0.52% of code.
Generated Code
Automatically generated files, not manually changed after generation.
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 ".*/pom[.]xml".
- files with paths like ".*/docker[-]compose[.]yml".
- 2 files match defined criteria (16 lines of code, 1.0% vs. main code):
- 1 *.yml files (12 lines of code)
- 1 *.sh files (4 lines of code)
- " *.yml" is biggest, containing 75% of code.
- " *.sh" is smallest, containing 25% 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 ".*[.]txt".
- files with paths like ".*/[.]gitignore".
- files with paths like ".*[.]json".
- files with paths like ".*/[Ss]amples/.*".
- files with paths like ".*[.]svg".
- files with paths like ".*[.]properties".
- files with paths like ".*[.](xml|xsd|robot|sql|pgsql|dashboard|profile|ipynb|raml|avsc|al)".
- 59 files match defined criteria (11,588 lines of code, 758.9% vs. main code):
- 2 *.svg files (9,158 lines of code)
- 36 *.java files (1,376 lines of code)
- 5 *.xml files (399 lines of code)
- 7 *.sql files (307 lines of code)
- 2 *.md files (293 lines of code)
- 7 *.properties files (55 lines of code)
- " *.svg" is biggest, containing 79.03% of code.
- " *.properties" is smallest, containing 0.47% of code.
Analyzers
Info about analyzers used for source code examinations.
- *.tf 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
- *.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
- *.less files are analyzed with LessAnalyzer:
- 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
- *.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
- *.tfvars 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-01-31 16:42