diff --git a/general/app_flow.drawio.svg b/general/app_flow.drawio.svg new file mode 100644 index 0000000..d5d0ad1 --- /dev/null +++ b/general/app_flow.drawio.svg @@ -0,0 +1,268 @@ + + + + + + + + + +
+
+
+ User +
+
+
+ + + User + + + + + + + + + +
+
+
+ Http Request +
+
+
+ + + Http Request + + + + + + + + + +
+
+
+ WebApp +
+
+
+ + + WebApp + + + + + + + + + + + + + + + +
+
+
+ ??? +
+ Application +
+
+
+ + + ???... + + + + + + + +
+
+
+ Router +
+
+
+ + + Router + + + + + + + + + + +
+
+
+ Dispatcher +
+
+
+ + + Dispatcher + + + + + + + + + + + + +
+
+
+ Modules / +
+ Controller +
+
+
+ + + Modules /... + + + + + + + + + + + + + +
+
+
+ Mapper +
+
+
+ + + Mapper + + + + + + + +
+
+
+ Database +
+
+
+ + + Database + + + + + + + + + +
+
+
+ View +
+
+
+ + + View + + + + + + + +
+
+
+ Template +
+
+
+ + + Template + + + + + + + +
+
+
+ Response +
+
+
+ + + Response + + + + + + + +
+
+
+ Model +
+
+
+ + + Model + + + + + + + + + Viewer does not support full SVG 1.1 + + + + \ No newline at end of file diff --git a/general/app_flow.svg b/general/app_flow.svg deleted file mode 100644 index a9d9497..0000000 --- a/general/app_flow.svg +++ /dev/null @@ -1,2 +0,0 @@ - -
User
User
Http Request
Http Request
WebApp
WebApp
???
Application
???<br>Application
Router
Router
Dispatcher
Dispatcher
Modules /
Controller
[Not supported by viewer]
Mapper
Mapper
Database
Database
View
View
Template
Template
Response
Response \ No newline at end of file diff --git a/general/base_uml.svg b/general/base_uml.drawio.svg similarity index 100% rename from general/base_uml.svg rename to general/base_uml.drawio.svg diff --git a/general/structure.md b/general/structure.md index 692d27b..84da957 100644 --- a/general/structure.md +++ b/general/structure.md @@ -4,7 +4,7 @@ The user request gets passed through the entire application to all modules. The The routes usually reference endpoints in the module `controllers` which collects the model data through the model `mapper` and creates a partial response `view` with an assigned `template` and the collected model data. -![Application Flow](Developer-Guide/general/app_flow.svg) +![Application Flow](Developer-Guide/general/app_flow.drawio.svg) In the following only the WebApplication and Application are mentioned as the other components are explained in detail in their respective documentation. @@ -31,6 +31,6 @@ Furthermore the Application also performs a `CSRF` check, defines the `CSP`, aut ## Database -A short extract of the database structure can be seen below. Please note that this only contains the very basic tables from a fresh install without very limited modules and even then we only included the key tables for simplicity reasons. +A short extract of the database structure can be seen below. Please note that this only contains the very basic tables from a fresh install with very few modules and even then we only included the key tables for simplicity reasons. -![Application Flow](Developer-Guide/general/base_uml.svg) \ No newline at end of file +![Application Flow](Developer-Guide/general/base_uml.drawio.svg) \ No newline at end of file diff --git a/quality/inspections.md b/quality/inspections.md index 2170c44..31e252e 100644 --- a/quality/inspections.md +++ b/quality/inspections.md @@ -1,6 +1,30 @@ -# Inspections +# Code Inspections & Tests -Code inspections are very important in order to maintain the same code quality throughout the application. The Build repository contains all esential configuration files for the respective inspection tools. Every provided module will be evaluated based on the predefined code and quality standards. Only modules that pass all code, quality and unit tests are accepted. This also applies to updates and bug fixes. Any change will have to be re-evaluated. +Code inspections are very important in order to maintain the same code quality throughout the application. The `Build` repository and package managers such as `composer` and `npm` contain all esential configuration files for the respective inspection tools. The framework and every module will be evaluated based on the defined code and quality standards. Only code that passes all code, quality and test standards are accepted. Updates and bug fixes also must follow the standards. + +## How and what to test? + +In this project multiple levels of tests must be implemented such as unit tests, integration tests and system tests. + +The following testing requirements must be met: + +* 90% code coverage in the tests +* all tests must pass without warnings, errors and exceptions +* no warnings and errors during static code inspections +* no usage of deprecated function calls +* no code style violations +* every test should have a short description for the test report + +### Unit tests + +Every test must be in it's own test function. +Every public function must have a unit test + +### Integration tests + +### System tests + +## Test documentation ## Tools @@ -14,7 +38,7 @@ Tools used for the code inspection are: These tools are all installed by running the `setup.sh` script from the Build repository. -## PHPUnit +### PHPUnit This application uses PHPUnit as unit testing framework. Unit tests for specific classes need to be named in the same manner as the testing class. @@ -30,11 +54,11 @@ In order to also create a code coverage report run: php vendor/bin/phpunit -c tests/PHPUnit/phpunit_default.xml ``` -### Modules +#### Modules Every module needs to have a `Admin` directory containing a class called `AdminTest.php` which is used for testing the installation, activation, deactivation, uninstall and remove of the module. Tests that install, update, remove etc. a module need to have a group called `admin`. After running the `AdminTest.php` test the final state of the module should be installed and active, only this way it's possible to further test the controller and models. A code coverage of at least 80% is mandatory for every module for integration. -## PHPStan +### PHPStan With phpstan the code base is statically analyzed based on its configuration. This will help you to follow some of the "best" practices we enforce. @@ -42,11 +66,11 @@ With phpstan the code base is statically analyzed based on its configuration. Th php vendor/bin/phpstan analyse --autoload-file=phpOMS/Autoloader.php -l 8 -c Build/Config/phpstan.neon --error-format=prettyJson ./ > Build/test/phpstan.json ``` -## Jasmine +### Jasmine The javascript testing is done with jasmine. The javascript testing directory is structured the same way as the `Framework`. Unit tests for specific classes need to be named in the same manner as the testing class. -## PHP CS +### PHP CS Besides the code tests and static code analysis the code style is another very imporant inspection to ensure the code quality. @@ -54,7 +78,7 @@ Besides the code tests and static code analysis the code style is another very i php vendor/bin/phpcs ./ --standard="Build/Config/phpcs.xml" -s --report-junit=Build/test/junit_phpcs.xml ``` -## Git Hooks (Linux only) +### Git Hooks (Linux only) The git hooks perform various checks and validations during the `commit` and warn the developer about invalid code or code style/guideline violations. diff --git a/quality/release.md b/quality/release.md new file mode 100644 index 0000000..e69de29 diff --git a/standards/documentation.md b/standards/documentation.md index 5c28f53..11b4466 100644 --- a/standards/documentation.md +++ b/standards/documentation.md @@ -1,5 +1,13 @@ # Documentation +## User + +## Developer + +## Database + +### Diagramms + ## Php The php documentation is based on PhpDocumentor, therefore only valid PhpDocumentor comments are valid for files, classes, functions/methods and (member) variables.