Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ctidigital/magento2-configurator

Magento 2 Configurator
https://github.com/ctidigital/magento2-configurator

config configuration magento magento2 magento2-extension magento2-module php

Last synced: 27 days ago
JSON representation

Magento 2 Configurator

Awesome Lists containing this project

README 

        
# Magento 2 Configurator



[![Build Status](https://travis-ci.org/ctidigital/magento2-configurator.svg?branch=develop)](https://travis-ci.org/ctidigital/magento2-configurator)



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:



  - Install Magento from scratch with important database based configuration ready.

  - Share and collaborate configuration with other colleagues using your own versioning system.

  - Keep versions of your configurations using your own versioning system.

  - Split your configuration based on the environment you're developing on.



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).



## Testing Locally For Development

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/

```



## Integration tests

- Configure your [Magento integration test environment](http://devdocs.magento.com/guides/v2.0/test/integration/integration_test_setup.html).

- Add the XML below to dev/tests/integration/phpunit.xml.dist



````



    ../../../vendor/ctidigital/magento2-configurator/Test/Integration



 ````

 

- 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

````

## Unit tests 

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 



## Travis

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)



## Getting Started

1. Create a `master.yaml` file in `/app/etc/`. (see `Samples/master.yaml`)

2. Enable Modules `CtiDigital_Configurator`,`FireGento_FastSimpleImport`.

3. Run `bin/magento configurator:run --env=""`



### Usage



* Listing available components `bin/magento configurator:list`

* Running individual components `bin/magento configurator:run --env="" --component="config"`

* Extra logs `bin/magento configurator:run --env="" -v`



## Roadmap for components to do



| 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:                |



License

----



MIT



[CTI Digital]:http://www.ctidigital.com/

[YouTube]:https://www.youtube.com/watch?v=iFkhAzJl2k0

[Raj Chevli]:https://twitter.com/chevli