Skip to content

aleron75/ddd_loyalty_card

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Loyalty Card

A Magento extension to associate a loyalty card number to a customer.

Used as a sample to show how to apply the principles of hexagonal architecture.

Installation

In your composer.json add the following:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "[email protected]:aleron75/ddd_loyalty_card.git"
    }
  ],
  "require": {
    "ddd/loyalty-card": "dev-master"
  },
  "autoload-dev": {
    "psr-4": {
      "Ddd\\Loyalty\\": "vendor/ddd/loyalty-card/test"
    }
  }
}

Then, from the Magento root directory, run:

composer update

Then, from the Magento root directory, run:

bin/magento setup:upgrade

Extension structure

This extension has been developed according to the Advanced Web Application Architecture principles.

Here is a picture that explains how different components are layered:

How components are layered

The structure of the extension is that of a typical Magento extension, except for the Application and Domain folders under src and Adapter and UseCase folders under test.

Here is the main folder structure:

ddd/
└─ loyalty/
├─ src/
│  ├─ Application/
│  ├─ Controller/
│  ├─ Domain/
│  ├─ etc/
│  ├─ Model/
│  ├─ view/
│  └─ ViewModel/
└─ test/
   ├─ Adapter/
   ├─ Unit/
   └─ UseCase/

Application, Domain, Unit and UseCase folders belong to the Core layer, which is developed in pure framework-agnostic PHP.

The other folders and files belong to the Infrastructure layer.

The Adapter folder contains what in Magento are called Integration tests. They are written accordingly to the hexagonal architecture principles, so they are simpler compared to typical Magento integration tests.

In fact, integration tests are split into incoming adapter tests and outgoing adapter tests.

Please, refer to the slides accompanying the project for further details about how the extension is structured.

You can also read more on the series of insights on DDD published on my blog.

Run the unit tests

From the Magento root directory, run any of:

vendor/bin/phpunit --colors --bootstrap=vendor/autoload.php vendor/ddd/loyalty-card/test/Unit/
vendor/bin/phpunit --testdox --colors --bootstrap=vendor/autoload.php vendor/ddd/loyalty-card/test/Unit/

Run the use-case tests

From the Magento root directory, run any of:

vendor/bin/phpunit --colors --bootstrap=vendor/autoload.php vendor/ddd/loyalty-card/test/UseCase/
vendor/bin/phpunit --testdox --colors --bootstrap=vendor/autoload.php vendor/ddd/loyalty-card/test/UseCase/

Run the adapter tests

Note: prepare your integration test environment following the instructions here.

Create a magento_integration_tests additional database.

Copy the following files:

  • Loyalty/test/Adapter/phpunit.xml.dist into dev/tests/integation/phpunit.xml
  • Loyalty/test/Adapter/config-global.php.dist into dev/tests/integation/etc/config-global.php
  • Loyalty/test/Adapter/install-config-mysql.php.dist into dev/tests/integation/etc/install-config-mysql.php

On Magento 2.4.x, don't forget to add elasticsearch configuration in the dev/tests/integration/etc/install-config-mysql.php file; if you use Warden, here are the additional array keys to use:

'elasticsearch-host' => 'elasticsearch',
'elasticsearch-port' => '9200',
'elasticsearch-index-prefix' => 'magento2',
'elasticsearch-enable-auth' => '0',
'elasticsearch-timeout' => '15',

They are already inserted in the distributed file.

From the Magento root directory, run any of:

cd dev/tests/integration/ && ../../../vendor/bin/phpunit --testsuite "Ddd_Loyalty Adapter Tests" && cd ../../../
cd dev/tests/integration/ && ../../../vendor/bin/phpunit --testdox --testsuite "Ddd_Loyalty Adapter Tests" && cd ../../../

License

Refer to the LICENSE file.

Acknowledgements

I want to thank the following people that inspired this work and supported me directly or indirectly:

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published