diff --git a/Admin/Install/Interfaces/DatabaseExchanger/import.tpl.php b/Admin/Install/Interfaces/DatabaseExchanger/import.tpl.php index 4fee90c..346fa5b 100755 --- a/Admin/Install/Interfaces/DatabaseExchanger/import.tpl.php +++ b/Admin/Install/Interfaces/DatabaseExchanger/import.tpl.php @@ -93,7 +93,7 @@ $isNew = $currentSetting->id === 0;
-
+
printHtml($lang['DatabaseExchanger']); ?> - printHtml($lang['Import']); ?>
@@ -132,7 +132,7 @@ $isNew = $currentSetting->id === 0;
- +
printHtml($lang['DatabaseExchanger']); ?> - printHtml($lang['Export']); ?>
@@ -181,7 +181,7 @@ $isNew = $currentSetting->id === 0; id . '&setting=' . $setting->id); + $url = UriFactory::build('{/base}/admin/exchange/import/view?id=' . $interface->id . '&setting=' . $setting->id); ?> $value) : ++$count; - $url = \phpOMS\Uri\UriFactory::build('{/base}/admin/exchange/export/profile?{?}&id=' . $value->id); ?> + $url = \phpOMS\Uri\UriFactory::build('{/base}/admin/exchange/export/view?{?}&id=' . $value->id); ?> $value) : ++$count; - $url = \phpOMS\Uri\UriFactory::build('{/base}/admin/exchange/import/profile?{?}&id=' . $value->id); ?> + $url = \phpOMS\Uri\UriFactory::build('{/base}/admin/exchange/import/view?{?}&id=' . $value->id); ?>
id; ?> diff --git a/Admin/Installer.php b/Admin/Installer.php index 6f2a7a8..f411154 100755 --- a/Admin/Installer.php +++ b/Admin/Installer.php @@ -21,7 +21,6 @@ use phpOMS\Message\Http\HttpRequest; use phpOMS\Message\Http\HttpResponse; use phpOMS\Module\InstallerAbstract; use phpOMS\Module\ModuleInfo; -use phpOMS\Uri\HttpUri; /** * Installer class. @@ -81,7 +80,7 @@ final class Installer extends InstallerAbstract $module = $app->moduleManager->get('Exchange'); $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $contents = \file_get_contents($path . '/interface.json'); if ($contents === false) { diff --git a/Admin/Routes/Web/Api.php b/Admin/Routes/Web/Api.php index 7233537..4b64a58 100755 --- a/Admin/Routes/Web/Api.php +++ b/Admin/Routes/Web/Api.php @@ -18,7 +18,7 @@ use phpOMS\Account\PermissionType; use phpOMS\Router\RouteVerb; return [ - '^.*/admin/exchange/import/profile.*$' => [ + '^.*/admin/exchange/import/view(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\ApiController:apiExchangeImport', 'verb' => RouteVerb::SET, @@ -29,7 +29,7 @@ return [ ], ], ], - '^.*/admin/exchange/export/profile.*$' => [ + '^.*/admin/exchange/export/view(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\ApiController:apiExchangeExport', 'verb' => RouteVerb::SET, diff --git a/Admin/Routes/Web/Backend.php b/Admin/Routes/Web/Backend.php index a74cb7c..7e48514 100755 --- a/Admin/Routes/Web/Backend.php +++ b/Admin/Routes/Web/Backend.php @@ -18,7 +18,7 @@ use phpOMS\Account\PermissionType; use phpOMS\Router\RouteVerb; return [ - '^.*/admin/exchange/import/list.*$' => [ + '^.*/admin/exchange/import/list(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeImportList', 'verb' => RouteVerb::GET, @@ -29,7 +29,7 @@ return [ ], ], ], - '^.*/admin/exchange/export/list.*$' => [ + '^.*/admin/exchange/export/list(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeExportList', 'verb' => RouteVerb::GET, @@ -40,7 +40,7 @@ return [ ], ], ], - '^.*/admin/exchange/import/profile.*$' => [ + '^.*/admin/exchange/import/view(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeImport', 'verb' => RouteVerb::GET, @@ -51,7 +51,7 @@ return [ ], ], ], - '^.*/admin/exchange/export/profile.*$' => [ + '^.*/admin/exchange/export/view(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeExport', 'verb' => RouteVerb::GET, @@ -62,7 +62,7 @@ return [ ], ], ], - '^.*/admin/exchange/log/list.*$' => [ + '^.*/admin/exchange/log/list(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeLogList', 'verb' => RouteVerb::GET, @@ -73,7 +73,7 @@ return [ ], ], ], - '^.*/admin/exchange/log\?.*$' => [ + '^.*/admin/exchange/log(\?.*$|$)' => [ [ 'dest' => '\Modules\Exchange\Controller\BackendController:viewExchangeLog', 'verb' => RouteVerb::GET, diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4f4653b..88c5d9c 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,16 @@ -# Development - ## Development environment - The setup and configuration of the development environment is in the hands of every developer themselves. However, it is recommended to follow the setup instructions in the [Developer-Guide](https://github.com/Karaka-Management/Developer-Guide/blob/develop/general/setup.md). +The setup and configuration of the development environment is in the hands of every developer themselves. However, it is recommended to follow the setup instructions in the [Developer-Guide](https://github.com/Karaka-Management/Developer-Guide/blob/develop/general/setup.md). ## Code of conduct -Every organization member and contributor to the organization must follow the [code of conduct](../Policies & Guidelines/Code of conduct.md). +Every organization member and contributor to the organization must follow the [Code of Conduct](../Policies%20&%20Guidelines/Code%20of%20Conduct.md). + +## Becoming a contributor + +For public repositories you can immediately start by creating forks and pull requests. For private repositories which are necessary to setup the complete developer environment, feel free to request access. Please not that we may not immediately give you access to private repositories and instead will give you smaller tasks regarding public repositories. Please contact info@jingga.app for more details. (**R1**) + +For all contributions our [Contributor License Agreement "CLA"](https://github.com/Karaka-Management/Organization-Guide/blob/master/Processes/HR/Hiring/Individual%20Contributor%20License%20Agreement.md) comes into effect. (**R2**) ## Code changes @@ -14,58 +18,106 @@ Every organization member and contributor to the organization must follow the [c Generally, the development philosophy is result orientated. This means that anyone can propose tasks, pick up existing tasks or right away implement their code changes. However, implementing code changes without consulting with a senior developer in advance has a much higher risk of code changes not getting admitted. The easiest way to discuss a code change idea in advance are the github [issues](https://github.com/Karaka-Management/Karaka/issues) or [discussions](https://github.com/Karaka-Management/Karaka/discussions). -Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty. +Developers are encouraged to pick open tasks with high priorities according to their own skill level. Senior developers may directly assign tasks to developers based on their importance. New developers may find it easier to start with a task that has a low priority as they often also have a lower difficulty. -Open tasks can be found in the project overview: [PROJECT.md](https://github.com/orgs/Karaka-Management/projects/10) +Open tasks can be found in the project overview: [Todos](https://github.com/orgs/Karaka-Management/projects/10) -Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task. +Tasks currently in development are prefixed in the priority column with an asterisk `*` and a name tag in the task description of the developer who is working on the task. -The open tasks are reviewed once a month by a senior developer. The senior developer updates the project overview if necessary and requests feedback regarding development status of important tasks under development. During this process important tasks may also get directly assigned to developers. This review is performed on a judgmental bases of the senior basis. +The open tasks are reviewed once a month by a senior developer. The senior developer updates the project overview if necessary and requests feedback regarding development status of important tasks under development. During this process important tasks may also get directly assigned to developers. This review is performed on a judgmental bases of the senior basis. -### Code style +### Quality -Code changes must follow the [style guidelines](https://github.com/Karaka-Management/Developer-Guide/tree/develop/standards). Additionally, the automatic code style inspection tools must return no errors, failures or warnings. Developers should test their changes with inspection tools and configurations mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) in advance before submitting them for review. +#### Code style -In rare cases errors, failures or warnings during the automatic inspection are acceptable. Reasons can be changes in the programming language, special cases which cannot, are difficult or must be individually configured in the inspection settings. If this is the case for a code change and if inspection configuration changes are necessary are decided by the senior developer performing the code review. +Code changes must follow the [style guidelines](https://github.com/Karaka-Management/Developer-Guide/tree/develop/standards) (**R3**). Additionally, the automatic code style inspection tools must return no errors, failures or warnings. Developers should test their changes with inspection tools and configurations mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) in advance before submitting them for review. (**R4**) -Automated checks which are run during the review process: +In rare cases errors, failures or warnings during the automatic inspection are acceptable. Reasons can be for example special cases which are difficult automatize or must be individually configured in the inspection settings. If this is the case for a code change and if inspection configuration changes are necessary are decided by the senior developer performing the code review. (**R5**) + +Automated checks which are run during the review process (**R4**): ```sh -php ./vendor/bin/phpcs --severity=1 ./ --standard="Build/Config/phpcs.xml" +php ./vendor/bin/phpcs ./ --standard="Build/Config/phpcs.xml" +php ./vendor/bin/php-cs-fixer fix ./ --config=Build/Config/.php-cs-fixer.php --allow-risky=yes +php ./vendor/bin/phpcbf --standard=Build/Config/phpcs.xml ./ +php ./vendor/bin/rector process --dry-run --config Build/Config/rector.php ./ npx eslint ./ -c ./Build/Config/.eslintrc.json ``` -### Tests +#### Tests -Code changes must follow the inspection guidelines (i.e. code coverage) mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md). Developers should check if the code changes comply with the inspection guidelines before submitting them. +Code changes must follow the inspection guidelines (i.e. code coverage) mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) (**R6**). Developers should test their changes with inspection tools and configurations mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) in advance before submitting them for review. (**R7**) -In rare cases it might be not possible to follow the inspection guidelines. In such cases the senior developer performing the code review may decide if the code change still gets accepted. +In rare cases it might be not possible to follow the inspection guidelines. In such cases the senior developer performing the code review may decide if the code change still gets accepted. (**R8**) -Automated tests which are run during the review process: +Automated tests which are run during the review process (**R7**): ```sh php ./vendor/bin/phpunit -c tests/PHPUnit/phpunit_default.xml -php ./vendor/bin/phpstan analyse --autoload-file=phpOMS/Autoloader.php -l 9 -c Build/Config/phpstan.neon ./ +php ./vendor/bin/phpstan analyse --no-progress -l 9 -c Build/Config/phpstan.neon ./ npx jasmine-node ./ ./cOMS/tests/test.sh ``` -Additional inspections which are run but might be ignored during the review depending on the use case are mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) as other checks. +Additional inspections which are run but might be ignored during the review depending on the use case are mentioned in the [inspection documentation](https://github.com/Karaka-Management/Developer-Guide/blob/develop/quality/inspections.md) as other checks. (**R7**) -### Demo +#### Performance -Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script try to simulate a real world use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. +Developers should occasionaly check performance statistics. At this point no target metrics are defined. -### Code review +Since the primary application is a web based application a similar tool as the Google lighthouse tool can be used to inspect the application for best practicies which can significantly improve the application performance. The sitespeed.io tool shows potential performance improvements and slow pages. With the php trace and profiler enabled in the `php.ini` file the VM automatically generates profiling and trace reports for every web request. These can be found in the webgrind logs directory and inspected in webgrind and dropped into the trace visualizer for a flame chart visualization. With mysqldumpslow you can inspect slow sql queries which may need optimization. + +1. Automatic trace and benchmark generation with every web request in `/var/www/html/webgrind/Logs` +2. Webgrind view `http://vm_ip:82` +3. Trace visualization `http://vm_ip:81` + 1. Download the latest trace from `http://vm_ip:82/Logs` + 2. Drag and drop that downloaded `*.xt` file in the trace visualizer +4. `sitespeed.io ./Build/Helper/Scripts/sitespeedDemoUrls.txt -b chrome --outputFolder /var/www/html/sitespeed` +5. Slow query inspection. + +```sh +mysqldumpslow -t 10 /var/log/mysql/mysql-slow.log +mysqldumpslow -t 10 -s l /var/log/mysql/mysql-slow.log +``` + +#### Code review In addition to the automatic code review performed by the various inspection tools such as (phpcs, phpstan, phpunit, eslint and custom scripts) a senior developer must check the proposed code change before it is merged with the respective `develop` branch. Only upon the approval by the reviewer a code change requests gets merged as no other developers have permission in the software to make such code merges. In case a code change request is not approved the reviewer states the reason for the decision, this may include some tips and requests which will allow the contributor to make improvements so that the code change may get approved. -If the code reviewer only finds minor issues with the proposed code change the reviewer may make small changes to the proposed code change and inform the contributor to speed up the implementation process. Code reviewers are encouraged to do this with new contributors to avoid long iteration processes and to not discourage new developers. However, communication is key and severe issues with code change requests or if the contributor already made multiple code change requests in the past the reviewer should not implement the improvements by himself and rather decline the code change requests with his reasoning. +If the code reviewer only finds minor issues with the proposed code change the reviewer may make small changes to the proposed code change and inform the contributor to speed up the implementation process. Code reviewers are encouraged to do this with new contributors to avoid long iteration processes and to not discourage new developers. However, communication is key and severe issues with code change requests or if the contributor already made multiple code change requests in the past the reviewer should not implement the improvements by himself and rather decline the code change requests with his reasoning. (**R5**+**R8**) + +#### Demo + +Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script try to simulate a real world use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. (**R9**) + +```sh +sudo -u www-data php -dxdebug.remote_enable=1 -dxdebug.start_with_request=yes -dxdebug.mode=coverage,develop,debug demoSetup/setup.php +``` + +#### Documentation + +Occasionally new code or code changes also require new documentation or documentation changes. Developers should make sure that the new code is also reflected in the existing documentation ([Developer-Guide](), [User-Guide]() and/or module documentation) or if additional documentation is necessary. + +#### Improvements, features, bugs + +If a developer (or employee in general) has an idea for an improvement, feature or finds a potential bug it should be reported at https://github.com/Karaka-Management/Karaka/issues. A senior developer has to check these issues and decide how to proceed with them. The decision how to proceed with the issue must be explained by the senior developer as a response in the issue. Possible steps are: + +* Accept the issue and put the task into the [Todos](https://github.com/orgs/Karaka-Management/projects/10) +* Dismiss the issue with an explanation ### Release flow +In case SCSS/CSS or JS files got changed they must get re-built locally before comitting the code change: + +```sh +npx esbuild Web/Backend/js/backend.js --bundle --outfile=Install/Application/Backend/js/backend.min.js --minify +scss cssOMS/styles.scss > cssOMS/styles.css +``` + +For JS you may also use the shorthand command `npm run build`. + Code changes must be performed in a new branch. A new branch can be created with: ```sh @@ -75,8 +127,70 @@ git checkout -b new-branch-name The name of the branch can be chosen freely however it is recommended to follow the following branch naming conventions: * `feature-*` for feature implementations +* `hotfix-*` for security related fixes/improvements * `bug-*` for bug fixes * `security-*` for security related fixes/improvements -* `general-*` for general improvements (i.e. code documentation improvements, code style improvements) +* `general-*` for general improvements (i.e. documentation, code style & performance improvements) -The senior developer who performs the code review merges the change request into the `develop` branch upon approval. \ No newline at end of file +```mermaid +%%{init: { 'gitGraph': {'mainBranchName': 'master'}} }%% + gitGraph + commit + branch hotfix-xxx + commit + checkout master + branch develop + checkout master + merge hotfix-xxx + checkout develop + branch bug-xxx + commit + commit + checkout hotfix-xxx + commit + checkout master + merge hotfix-xxx + checkout develop + merge bug-xxx + commit + checkout develop + branch feature-xxx + commit + commit + commit + checkout develop + merge feature-xxx + checkout master + merge develop + checkout develop + branch general-xxx + commit + checkout develop + merge general-xxx + branch security-xxx + commit + commit + checkout develop + merge security-xxx + checkout master + merge develop + +``` + +The senior developer who performs the code review merges the change request into the `develop` branch after their successful code review. Unsuccessful reviews lead to change requests by the original developer, other developers who can make the requested changes, changes by the senior developer who performed the review, or dismissal of the changed code. (**R10**) + +## Approved dependencies + +### Customer dependencies + +Developers may only rely on the dependencies defined in [Approved Customer Software]() when developing a solution. If new software should be added to this list or a different version is required developers should make a request with their team leader/head of department who forwards this requests if appropriate to the CTO and explain the reasoning for the different dependency needs. The CTO can decide if the dependency will be accepted. (**R11**) + +### Developer dependencies + +Developers may only rely on the dependencies defined in [IT Equipment & Software](). If new software should be added to this list or a different version is required developers should make a request with their team leader/head of department who forwards this requests if appropriate to the CTO and explain the reasoning for the different dependency needs. The CTO can decide if the dependency will be accepted. Changing the package managers such as `composer.json` or `package.json` is not allowed by anyone else than the CTO. (**R12**) + +## Other related documents + +* [Confidentiality Policy](../Policies%20&%20Guidelines/Confidentiality%20Policy.md) +* [Organization Activity Policy](../Policies%20&%20Guidelines/Organization%20Activity%20Policy.md) +* [Tutorials](./Development/Tutorials) \ No newline at end of file diff --git a/LICENSE.txt b/LICENSE.txt index 18d430e..4ba0161 100755 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -27,7 +27,7 @@ Version 2.0 Subject to the terms and conditions of this License, each Contributor grants to You after purchase a perpetual, worldwide, non-exclusive, irrevocable copyright license to prepare Derivative Works of, publicly display, publicly perform the Work and such Derivative Works in Source or Object form. You are not allowed to sublicense, reproduce, or distribute the Work and such Derivative Works in Source or Object form. -3. Redistribution. +3. Redistribution You may not reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form. diff --git a/Models/ExchangeLog.php b/Models/ExchangeLog.php index b99661f..c42a894 100755 --- a/Models/ExchangeLog.php +++ b/Models/ExchangeLog.php @@ -102,32 +102,6 @@ class ExchangeLog implements \JsonSerializable $this->createdAt = new \DateTimeImmutable('now'); } - /** - * Get type. - * - * @return int - * - * @since 1.0.0 - */ - public function getType() : int - { - return $this->type; - } - - /** - * Set type. - * - * @param int $type Exchange type - * - * @return void - * - * @since 1.0.0 - */ - public function setType(int $type) : void - { - $this->type = $type; - } - /** * Get fields. * diff --git a/Models/ExchangeSetting.php b/Models/ExchangeSetting.php index 5c6310d..8709ffe 100755 --- a/Models/ExchangeSetting.php +++ b/Models/ExchangeSetting.php @@ -124,9 +124,9 @@ class ExchangeSetting implements \JsonSerializable public function toArray() : array { return [ - 'id' => $this->id, - 'title' => $this->title, - 'exchange' => $this->exchange, + 'id' => $this->id, + 'title' => $this->title, + 'exchange' => $this->exchange, ]; } diff --git a/Models/ExchangeSettingMapper.php b/Models/ExchangeSettingMapper.php index 2c11396..f20e9f7 100755 --- a/Models/ExchangeSettingMapper.php +++ b/Models/ExchangeSettingMapper.php @@ -36,11 +36,11 @@ final class ExchangeSettingMapper extends DataMapperFactory * @since 1.0.0 */ public const COLUMNS = [ - 'exchange_settings_id' => ['name' => 'exchange_settings_id', 'type' => 'int', 'internal' => 'id'], - 'exchange_settings_title' => ['name' => 'exchange_settings_title', 'type' => 'string', 'internal' => 'title'], - 'exchange_settings_data' => ['name' => 'exchange_settings_data', 'type' => 'Json', 'internal' => 'data'], - 'exchange_settings_relations' => ['name' => 'exchange_settings_relations', 'type' => 'Json', 'internal' => 'relations'], - 'exchange_settings_exchange' => ['name' => 'exchange_settings_exchange', 'type' => 'int', 'internal' => 'exchange'], + 'exchange_settings_id' => ['name' => 'exchange_settings_id', 'type' => 'int', 'internal' => 'id'], + 'exchange_settings_title' => ['name' => 'exchange_settings_title', 'type' => 'string', 'internal' => 'title'], + 'exchange_settings_data' => ['name' => 'exchange_settings_data', 'type' => 'Json', 'internal' => 'data'], + 'exchange_settings_relations' => ['name' => 'exchange_settings_relations', 'type' => 'Json', 'internal' => 'relations'], + 'exchange_settings_exchange' => ['name' => 'exchange_settings_exchange', 'type' => 'int', 'internal' => 'exchange'], ]; /** diff --git a/Models/InterfaceManagerMapper.php b/Models/InterfaceManagerMapper.php index b79b2a7..ed35524 100755 --- a/Models/InterfaceManagerMapper.php +++ b/Models/InterfaceManagerMapper.php @@ -38,15 +38,15 @@ final class InterfaceManagerMapper extends DataMapperFactory * @since 1.0.0 */ public const COLUMNS = [ - 'exchange_interface_id' => ['name' => 'exchange_interface_id', 'type' => 'int', 'internal' => 'id'], - 'exchange_interface_title' => ['name' => 'exchange_interface_title', 'type' => 'string', 'internal' => 'title'], - 'exchange_interface_version' => ['name' => 'exchange_interface_version', 'type' => 'string', 'internal' => 'version'], - 'exchange_interface_export' => ['name' => 'exchange_interface_export', 'type' => 'bool', 'internal' => 'hasExport'], - 'exchange_interface_import' => ['name' => 'exchange_interface_import', 'type' => 'bool', 'internal' => 'hasImport'], - 'exchange_interface_website' => ['name' => 'exchange_interface_website', 'type' => 'string', 'internal' => 'website'], - 'exchange_interface_media' => ['name' => 'exchange_interface_media', 'type' => 'int', 'internal' => 'source'], - 'exchange_interface_created_at' => ['name' => 'exchange_interface_created_at', 'type' => 'DateTimeImmutable', 'internal' => 'createdAt', 'readonly' => true], - 'exchange_interface_created_by' => ['name' => 'exchange_interface_created_by', 'type' => 'int', 'internal' => 'createdBy', 'readonly' => true], + 'exchange_interface_id' => ['name' => 'exchange_interface_id', 'type' => 'int', 'internal' => 'id'], + 'exchange_interface_title' => ['name' => 'exchange_interface_title', 'type' => 'string', 'internal' => 'title'], + 'exchange_interface_version' => ['name' => 'exchange_interface_version', 'type' => 'string', 'internal' => 'version'], + 'exchange_interface_export' => ['name' => 'exchange_interface_export', 'type' => 'bool', 'internal' => 'hasExport'], + 'exchange_interface_import' => ['name' => 'exchange_interface_import', 'type' => 'bool', 'internal' => 'hasImport'], + 'exchange_interface_website' => ['name' => 'exchange_interface_website', 'type' => 'string', 'internal' => 'website'], + 'exchange_interface_media' => ['name' => 'exchange_interface_media', 'type' => 'int', 'internal' => 'source'], + 'exchange_interface_created_at' => ['name' => 'exchange_interface_created_at', 'type' => 'DateTimeImmutable', 'internal' => 'createdAt', 'readonly' => true], + 'exchange_interface_created_by' => ['name' => 'exchange_interface_created_by', 'type' => 'int', 'internal' => 'createdBy', 'readonly' => true], ]; /** @@ -73,8 +73,8 @@ final class InterfaceManagerMapper extends DataMapperFactory */ public const BELONGS_TO = [ 'createdBy' => [ - 'mapper' => AccountMapper::class, - 'external' => 'exchange_interface_created_by', + 'mapper' => AccountMapper::class, + 'external' => 'exchange_interface_created_by', ], ]; @@ -86,8 +86,8 @@ final class InterfaceManagerMapper extends DataMapperFactory */ public const OWNS_ONE = [ 'source' => [ - 'mapper' => CollectionMapper::class, - 'external' => 'exchange_interface_media', + 'mapper' => CollectionMapper::class, + 'external' => 'exchange_interface_media', ], ]; @@ -99,10 +99,10 @@ final class InterfaceManagerMapper extends DataMapperFactory */ public const HAS_MANY = [ 'settings' => [ - 'mapper' => ExchangeSettingMapper::class, - 'table' => 'exchange_settings', - 'self' => 'exchange_settings_exchange', - 'external' => null, + 'mapper' => ExchangeSettingMapper::class, + 'table' => 'exchange_settings', + 'self' => 'exchange_settings_exchange', + 'external' => null, ], ]; } diff --git a/Theme/Backend/exchange-export-list.tpl.php b/Theme/Backend/exchange-export-list.tpl.php index 1f87c35..6821f49 100755 --- a/Theme/Backend/exchange-export-list.tpl.php +++ b/Theme/Backend/exchange-export-list.tpl.php @@ -39,7 +39,7 @@ echo $this->data['nav']->render();
printHtml($value->title); ?> diff --git a/Theme/Backend/exchange-import-list.tpl.php b/Theme/Backend/exchange-import-list.tpl.php index 00737c8..0e4a0db 100755 --- a/Theme/Backend/exchange-import-list.tpl.php +++ b/Theme/Backend/exchange-import-list.tpl.php @@ -39,7 +39,7 @@ echo $this->data['nav']->render();
printHtml($value->title); ?> diff --git a/Theme/Backend/exchange-log-list.tpl.php b/Theme/Backend/exchange-log-list.tpl.php index 3bd6ad7..64e074f 100755 --- a/Theme/Backend/exchange-log-list.tpl.php +++ b/Theme/Backend/exchange-log-list.tpl.php @@ -106,7 +106,7 @@ echo $this->data['nav']->render(); ?> ?>
id; ?> - getType(); ?> + type; ?> subtype; ?> exchange->title; ?> createdBy->name1; ?> diff --git a/Theme/Backend/exchange-log.tpl.php b/Theme/Backend/exchange-log.tpl.php index 5bca94f..3d31814 100755 --- a/Theme/Backend/exchange-log.tpl.php +++ b/Theme/Backend/exchange-log.tpl.php @@ -27,10 +27,10 @@ echo $this->data['nav']->render();
getHtml('ID', '0', '0'); ?>id; ?> -
getHtml('Type'); ?>getType(); ?> +
getHtml('Type'); ?>type; ?>
getHtml('Subtype'); ?>subtype; ?>
getHtml('Created'); ?>createdAt->format('Y-m-d'); ?> -
getHtml('Creator'); ?>createdBy->name1; ?> +
getHtml('Creator'); ?>createdBy->name1; ?>
message; ?>
diff --git a/tests/Autoloader.php b/tests/Autoloader.php index 32f17c1..fe2e06a 100755 --- a/tests/Autoloader.php +++ b/tests/Autoloader.php @@ -75,8 +75,8 @@ final class Autoloader */ public static function defaultAutoloader(string $class) : void { - $class = \ltrim($class, '\\'); - $class = \strtr($class, '_\\', '//'); + $class = \ltrim($class, '\\'); + $class = \strtr($class, '_\\', '//'); if (\stripos($class, 'Web/Backend') !== false || \stripos($class, 'Web/Api') !== false) { $class = \is_dir(__DIR__ . '/Web') ? $class : \str_replace('Web/', 'MainRepository/Web/', $class); diff --git a/tests/Bootstrap.php b/tests/Bootstrap.php index ddc049d..5e3edd4 100755 --- a/tests/Bootstrap.php +++ b/tests/Bootstrap.php @@ -1,4 +1,15 @@ [ + 'db' => [ 'core' => [ 'masters' => [ - 'admin' => [ + 'admin' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -80,7 +91,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'insert' => [ + 'insert' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -90,7 +101,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'select' => [ + 'select' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -100,7 +111,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'update' => [ + 'update' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -110,7 +121,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'delete' => [ + 'delete' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -120,7 +131,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'schema' => [ + 'schema' => [ 'db' => 'mysql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '3306', /* db host port */ @@ -132,7 +143,7 @@ $CONFIG = [ ], ], 'postgresql' => [ - 'admin' => [ + 'admin' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -142,7 +153,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'insert' => [ + 'insert' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -152,7 +163,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'select' => [ + 'select' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -162,7 +173,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'update' => [ + 'update' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -172,7 +183,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'delete' => [ + 'delete' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -182,7 +193,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'schema' => [ + 'schema' => [ 'db' => 'pgsql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '5432', /* db host port */ @@ -194,37 +205,37 @@ $CONFIG = [ ], ], 'sqlite' => [ - 'admin' => [ + 'admin' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'insert' => [ + 'insert' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'select' => [ + 'select' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'update' => [ + 'update' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'delete' => [ + 'delete' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'schema' => [ + 'schema' => [ 'db' => 'sqlite', /* db type */ 'database' => __DIR__ . '/../Karaka/phpOMS/Localization/Defaults/localization.sqlite', /* db name */ 'weight' => 1000, /* db table prefix */ @@ -232,7 +243,7 @@ $CONFIG = [ ], ], 'mssql' => [ - 'admin' => [ + 'admin' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -242,7 +253,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'insert' => [ + 'insert' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -252,7 +263,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'select' => [ + 'select' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -262,7 +273,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'update' => [ + 'update' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -272,7 +283,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'delete' => [ + 'delete' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -282,7 +293,7 @@ $CONFIG = [ 'weight' => 1000, /* db table prefix */ 'datetimeformat' => 'Y-m-d H:i:s', ], - 'schema' => [ + 'schema' => [ 'db' => 'mssql', /* db type */ 'host' => '127.0.0.1', /* db host address */ 'port' => '1433', /* db host port */ @@ -322,16 +333,16 @@ $CONFIG = [ 'password' => '123456', ], ], - 'log' => [ + 'log' => [ 'file' => [ 'path' => __DIR__ . '/Logs', ], ], - 'page' => [ + 'page' => [ 'root' => '/', 'https' => false, ], - 'app' => [ + 'app' => [ 'path' => __DIR__, 'default' => [ 'app' => 'Backend', @@ -350,7 +361,7 @@ $CONFIG = [ ], ], ], - 'socket' => [ + 'socket' => [ 'master' => [ 'host' => '127.0.0.1', 'limit' => 300, @@ -360,7 +371,7 @@ $CONFIG = [ 'language' => [ 'en', ], - 'apis' => [ + 'apis' => [ ], ]; diff --git a/tests/Controller/ApiControllerTest.php b/tests/Controller/ApiControllerTest.php index 23eae7f..6f4ca8b 100755 --- a/tests/Controller/ApiControllerTest.php +++ b/tests/Controller/ApiControllerTest.php @@ -31,7 +31,6 @@ use phpOMS\Module\ModuleAbstract; use phpOMS\Module\ModuleManager; use phpOMS\Router\WebRouter; use phpOMS\System\File\Local\Directory; -use phpOMS\Uri\HttpUri; use phpOMS\Utils\TestUtils; /** @@ -58,13 +57,13 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase protected string $appName = 'Api'; }; - $this->app->dbPool = $GLOBALS['dbpool']; - $this->app->unitId = 1; - $this->app->accountManager = new AccountManager($GLOBALS['session']); - $this->app->appSettings = new CoreSettings(); - $this->app->moduleManager = new ModuleManager($this->app, __DIR__ . '/../../../../Modules/'); - $this->app->dispatcher = new Dispatcher($this->app); - $this->app->eventManager = new EventManager($this->app->dispatcher); + $this->app->dbPool = $GLOBALS['dbpool']; + $this->app->unitId = 1; + $this->app->accountManager = new AccountManager($GLOBALS['session']); + $this->app->appSettings = new CoreSettings(); + $this->app->moduleManager = new ModuleManager($this->app, __DIR__ . '/../../../../Modules/'); + $this->app->dispatcher = new Dispatcher($this->app); + $this->app->eventManager = new EventManager($this->app->dispatcher); $this->app->eventManager->importFromFile(__DIR__ . '/../../../../Web/Api/Hooks.php'); $this->app->sessionManager = new HttpSession(36000); $this->app->l11nManager = new L11nManager(); @@ -113,7 +112,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase $data = \json_decode(\file_get_contents(__DIR__ . '/../Interfaces/' . $exchange . '/interface.json'), true); $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('title', $data['name']); @@ -184,7 +183,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testInterfaceInstallInvalidData() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('invalid', '1'); @@ -200,7 +199,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testExport() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('id', '1'); @@ -217,7 +216,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testExportInvalidInterface() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('id', '9999'); @@ -234,7 +233,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testLanguageImport() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('id', '1'); @@ -268,7 +267,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testImportInvalidInterface() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $request->setData('id', '9999'); @@ -280,7 +279,7 @@ final class ApiControllerTest extends \PHPUnit\Framework\TestCase public function testInvalidapiExchangeSettingCreate() : void { $response = new HttpResponse(); - $request = new HttpRequest(new HttpUri('')); + $request = new HttpRequest(); $request->header->account = 1; $this->module->apiExchangeSettingCreate($request, $response); diff --git a/tests/Interfaces/OMS/Exporter.php b/tests/Interfaces/OMS/Exporter.php index 6f8e91d..ea62b2e 100755 --- a/tests/Interfaces/OMS/Exporter.php +++ b/tests/Interfaces/OMS/Exporter.php @@ -81,10 +81,10 @@ final class Exporter extends ExporterAbstract $log = new ExchangeLog(); $log->createdBy = $this->account; - $log->setType(ExchangeType::EXPORT); - $log->message = $this->l11n->getText($request->header->l11n->language, 'Exchange', '', 'LangFileExported'); - $log->subtype = 'language'; - $log->exchange = (int) $request->getData('id'); + $log->type = ExchangeType::EXPORT; + $log->message = $this->l11n->getText($request->header->l11n->language, 'Exchange', '', 'LangFileExported'); + $log->subtype = 'language'; + $log->exchange = (int) $request->getData('id'); $result['logs'][] = $log; } diff --git a/tests/Interfaces/OMS/Importer.php b/tests/Interfaces/OMS/Importer.php index e2758fd..d98e676 100755 --- a/tests/Interfaces/OMS/Importer.php +++ b/tests/Interfaces/OMS/Importer.php @@ -101,10 +101,10 @@ final class Importer extends ImporterAbstract $this->importLanguage($request); $log = new ExchangeLog(); $log->createdBy = $this->account; - $log->setType(ExchangeType::IMPORT); - $log->message = $this->l11n->getText($request->header->l11n->language, 'Exchange', '', 'LangFileImported'); - $log->subtype = 'language'; - $log->exchange = (int) $request->getData('id'); + $log->type = ExchangeType::IMPORT; + $log->message = $this->l11n->getText($request->header->l11n->language, 'Exchange', '', 'LangFileImported'); + $log->subtype = 'language'; + $log->exchange = (int) $request->getData('id'); $result['logs'][] = $log; } diff --git a/tests/Interfaces/OMS/Lang/en.lang.php b/tests/Interfaces/OMS/Lang/en.lang.php index 64e0110..559eae1 100755 --- a/tests/Interfaces/OMS/Lang/en.lang.php +++ b/tests/Interfaces/OMS/Lang/en.lang.php @@ -13,7 +13,7 @@ declare(strict_types=1); * @link https://jingga.app */ return [ - 'Language' => 'Language', - 'LangFileExported' => 'Language file got exported', - 'LangFileImported' => 'Language file got imported', + 'Language' => 'Language', + 'LangFileExported' => 'Language file got exported', + 'LangFileImported' => 'Language file got imported', ]; diff --git a/tests/Interfaces/OMS/export.tpl.php b/tests/Interfaces/OMS/export.tpl.php index a7799cf..a7f0af0 100755 --- a/tests/Interfaces/OMS/export.tpl.php +++ b/tests/Interfaces/OMS/export.tpl.php @@ -17,7 +17,7 @@ $lang = $this->getData('lang');
- +
printHtml($lang['Language']); ?> - OMS
diff --git a/tests/Interfaces/OMS/import.tpl.php b/tests/Interfaces/OMS/import.tpl.php index 8021c1e..28aee24 100755 --- a/tests/Interfaces/OMS/import.tpl.php +++ b/tests/Interfaces/OMS/import.tpl.php @@ -17,7 +17,7 @@ $lang = $this->getData('lang');
- +
printHtml($lang['Language']); ?> - OMS
diff --git a/tests/Models/ExchangeLogTest.php b/tests/Models/ExchangeLogTest.php index 723babf..1062cb5 100755 --- a/tests/Models/ExchangeLogTest.php +++ b/tests/Models/ExchangeLogTest.php @@ -43,20 +43,10 @@ final class ExchangeLogTest extends \PHPUnit\Framework\TestCase self::assertEquals('', $this->log->subtype); self::assertEquals(0, $this->log->exchange); self::assertEquals(0, $this->log->createdBy); - self::assertEquals(ExchangeType::IMPORT, $this->log->getType()); + self::assertEquals(ExchangeType::IMPORT, $this->log->type); self::assertInstanceOf('\DateTimeImmutable', $this->log->createdAt); } - /** - * @covers Modules\Exchange\Models\ExchangeLog - * @group module - */ - public function testTypeInputOutput() : void - { - $this->log->setType(ExchangeType::EXPORT); - self::assertEquals(ExchangeType::EXPORT, $this->log->getType()); - } - /** * @covers Modules\Exchange\Models\ExchangeLog * @group module @@ -77,7 +67,7 @@ final class ExchangeLogTest extends \PHPUnit\Framework\TestCase public function testSerialize() : void { $this->log->message = '123456'; - $this->log->setType(ExchangeType::EXPORT); + $this->log->type = ExchangeType::EXPORT; $serialized = $this->log->jsonSerialize(); unset($serialized['createdAt']);