Type
magento2-module
Keep magento persistently configured using files
magento2-module
None
None
None
None
None
None
A Magento module initially created by CTI Digital to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:
If you're interested to find out more about the background of the configurator, watch this lightning talk by Raj Chevli at Mage Titans in Manchester on YouTube.
This is a work in progress and by no means for use with production environments (and probably not even development environments either just yet).
If you are contributing the module, please run the following commands to stand the best chance with Travis CI liking your code. These test include PHP Code Sniffer, PHP Mess Detector, PHP Copy and Paste Detector, PHP Unit
php vendor/bin/phpcs --standard=vendor/magento/magento-coding-standard/Magento2/ruleset.xml vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console/ vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Api/ vendor/ctidigital/magento2-configurator/Component/ vendor/ctidigital/magento2-configurator/Exception/
php vendor/bin/phpmd vendor/ctidigital/magento2-configurator/Model/,vendor/ctidigital/magento2-configurator/Console/,vendor/ctidigital/magento2-configurator/Test/,vendor/ctidigital/magento2-configurator/Api/,vendor/ctidigital/magento2-configurator/Component/,vendor/ctidigital/magento2-configurator/Exception/ text cleancode,codesize,controversial,design,naming,unusedcode
php vendor/bin/phpcpd vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Api/ vendor/ctidigital/magento2-configurator/Component/ vendor/ctidigital/magento2-configurator/Exception/
php vendor/bin/phpunit vendor/ctidigital/magento2-configurator/Test/Unit/
<testsuite name="magento2-configurator">
<directory>../../../vendor/ctidigital/magento2-configurator/Test/Integration</directory>
</testsuite>
````
- You can run the tests from the correct place on the command line
/dev/tests/integration$ ../../../vendor/bin/phpunit --testsuite "magento2-configurator"
- You can also add the magento PHP developer tools to your path, so that you do not have to specify location of phpunit
export PATH=$PATH:/var/www/magento2/vendor/bin ````
If you're developing a new component, please ensure you have your corresponding unit test which extends ComponentAbstractTestCase
as that will test that your component has the required functions.
Do also include sample files with your component that works
We also use Travis CI to automate part of the testing process (we are still looking to add more to this!). It tests the following: * CodeSniffer * MessDetector * Copy & Paste Detection * Unit Tests * Run Configurator (we aim to run it on these versions) 1) Latest 3 minor versions 2) Latest release candidate (allowed to fail)
master.yaml
file in <mage_root>/app/etc/
. (see Samples/master.yaml
)CtiDigital_Configurator
,FireGento_FastSimpleImport
.bin/magento configurator:run --env="<environment>"
bin/magento configurator:list
bin/magento configurator:run --env="<environment>" --component="config"
bin/magento configurator:run --env="<environment>" -v
Component | Code Written | Tests Written | Sample Files |
---|---|---|---|
Websites | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
System Configuration | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Categories | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Products | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Attributes | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Attribute Sets | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Blocks | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Admin Roles | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Admin Users | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Pages | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Widgets | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Customer Groups | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Media | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Tax Rules | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
API Integrations | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Tax Rates | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Rewrites | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Review Ratings | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Related Products | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Up Sell Products | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Cross Sell Products | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
Customers | :white_check_mark: | :white_check_mark: | :white_check_mark: |
SQL | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Catalog Price Rules | :white_check_mark: | :x: | :white_check_mark: |
Shipping Table Rates | :white_check_mark: | :white_check_mark: | :white_check_mark: |
Customer Attributes | :white_check_mark: | :x: | :white_check_mark: |
Shopping Cart Price Rules | :x: | :x: | :x: |
Orders | :x: | :x: | :x: |
Tiered Prices | :x: | :x: | :x: |
MIT