README

Reusable module template for extending OXID eShop core functionality.

This module also comes with all the quality tools OXID recommends to use.

If you are looking for a module with code examples, please check out the examples-module.

Branch compatibility
The Idea
Goals
Install and try it out
Use as a base for own module
Things to be aware of
Running tests and quality tools
Additional info

Branch compatibility

b-7.3.x branch / v5.x version - compatible with OXID eShop compilation 7.3.x and the respective branch
b-7.2.x branch / v4.x version - compatible with OXID eShop compilation 7.2.x and the respective branch
b-7.1.x branch / v3.x version - compatible with OXID eShop compilation 7.1.x and the respective branch
b-7.0.x branch / v2.x version - compatible with OXID eShop compilation b-7.0.x
b-6.5.x branch / v1.0.0 version - compatible with OXID eShop compilation b-6.5.x
b-6.4.x branch is compatible with OXID eShop compilation b-6.4.x

The Idea

OXID eSales would like to provide a lightweight reusable module to be used as a template for developing own module solutions.

Goals

There are two main goals this repository is intended to help with:

The provided solution can be used as a base for your own module. It will help creating the personalized module base
The repository can be used for creating a clean skeleton with only preconfigured OXID recommended quality tools for your new module.

Install and try it out

Note: This installation method fits for trying out the module development basics, its not meant to be used as development base for your own module. Check further installation/usage methods.

This module is in working state and can be directly installed via composer:

composer require oxid-esales/module-template
./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_moduletemplate

and activate the module.

Use as a base for own module

In case you'd like to use this module as a template for your own module, this section is for you.

Important Instructions here are for the case you intend to develop a module for OXID eShop 7.3.x. For other versions, refer to the version specific branch.

Before starting to do something, please, read the whole section once, then decide on required questions, decide what you want to achieve, and follow the procedure.

Terms

First, lets decide on terms:

Module is installable to vendor/<yourPackageName> directory. The package name is lowercased and looks like: <yourVendorName>/<yourModuleName>, example: oxid-esales/module-template. Decide what will be your new module package name.
- Please note that combination of <yourVendorName> and <yourModuleRootDirectory> should be unique. Based on this information your module id will be composed and will look like: <yourVendorPrefix>_<yourModuleRootDirectory>. In our case it is oe_moduletemplate.
- It is recommended to use only alphanumeric characters, in case you need a separator you can use dash ("-") or underscore("_").
Decide on your module's namespace - <YourVendorName>\<YourModuleName>, example: OxidEsales\ModuleTemplate.
Decide on your module's ID - <YourVendorPrefix>_<yourModuleName alphanumeric part>, example: oe_moduletemplate.
- It is recommended to use only alphanumeric characters, in case you need a separator you can use underscore. More information about module id can be found here.

In the following examples, your information required places will be shown as placeholders: <yourPackageName>, it means you should put your package name at that place, without brackets, for example:

composer config repositories.<yourPackageName> path source/modules/<yourVendorName>/<yourModuleName>

will possibly look like:

composer config repositories.my-vendor-name/my-module-name path source/modules/mvn/mymodulerootdir

in our case it is:

composer config repositories.oxid-esales/module-template path source/modules/oe/module-template

Procedure

The following procedure describes how to create a base for your further module, and shows the basic installation for the development process:

1. Use the Template

Click on the "Use this template" button on the template main page to create your module repository from the given template.

Please make sure to NOT choose the 'take all branches' option, as this will clone the repository with everything we have in our repository. Having all branches also will trigger the github actions for all branches and you dont want this usually.

As an outcome of this step, you should have a repository with one "Initial commit" of our current latest repository state.

2. Personalize and cleanup the module

To personalize the module, use the "bin/personalize.sh" script. This script will prompt you for required information and do the work.

For this step, clone your module repository anywhere to your local directory and run the desired scripts.

// Clone your module repository anywhere
git clone <yourGitRepositoryUrl> myModule
cd myModule

// Run the personalize script
./bin/personalize.sh

// Search for the "TODO" keywords in the code and replace them with your information

// Commit and push your personalized module, after this, install it for development and continue from there 
git commit -am "Personalize the module"
git push origin

Also, you will need to adjust the README, CHANGELOG, LICENSE, metadata and the GitHub workflow file, with your credentials and names. For running SonarCloud as part of the steps in GitHub workflow you will need to configure SonarCloud and to create a secret environment variable for your repository called SONAR_TOKEN. The token itself is provided by SonarCloud.

3. Install the module for Development

For installing the module for development our recommended way, check the "Development installation section", or do it any other way you prefer, but make sure to reconfigure our preconfigured quality tools to fit your installation.

Development installation

We recommend developing the module as independent as possible. This means that the module for development should be installed as a root package, with its own strict dependencies if such are needed.

The next section shows how to install the module as a root package by using the OXID eShop SDK.

In case of different environment usage, please adjust by your own needs.

Development installation on OXID eShop SDK

The installation instructions below are shown for the current SDK for shop 7.3. Make sure your system meets the requirements of the SDK.

Ensure all docker containers are down to avoid port conflicts
Clone the SDK for the new project

echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_

Clone the repository to the source directory

git clone --recurse-submodules https://github.com/OXID-eSales/module-template.git --branch=b-7.3.x ./source

Run the recipe to setup the development environment, you can decide which shop edition to install. Omitting the flag installs EE.

./source/recipes/setup-development.sh -e CE

You should be able to access the shop with http://localhost.local and the admin panel with http://localhost.local/admin (credentials: noreply@oxid-esales.com / admin)

Things to be aware of

The module template is intended to act as a skeleton module so keep your eyes open for comments in the code.

NOTES:

Acceptance tests are way easier to write if you put an id on relevant fields and buttons in the templates.
If you can, try to develop on OXID eShop Enterprise Edition to get shop aware stuff right from the start.

Module migrations

migrations are intended to bump the database (and eventual existing data) to a new module version (this also goes for first time installation).
ensure migrations are stable against rerun

Migrations have to be run via console command (./vendor/bin/oe-eshop-doctrine_migration)

./vendor/bin/oe-eshop-doctrine_migration migrations:migrate oe_moduletemplate

For more information, check the developer documentation.

Where the module namespace points to

As already mentioned above, in the 7.x versions of OXID eShop, the module code only resides in the vendor directory so the namespace needs to point there. In our case this looks like

    "autoload": {
        "psr-4": {
            "OxidEsales\\ModuleTemplate\\": "src/"
        }
    },
    "autoload-dev": {
        "psr-4": {
            "OxidEsales\\ModuleTemplate\\Tests\\": "tests/",
            "OxidEsales\\EshopCommunity\\Tests\\": "./vendor/oxid-esales/oxideshop-ce/tests"
        }
    },

Running tests and quality tools

Check the scripts section in the composer.json of the module to get more insight of preconfigured quality tools available. Example:

$ composer phpcs
$ composer phpstan
$ composer phpmd

Integration/Acceptance tests

install this module into a running OXID eShop
run composer update in module root directory

$ composer update

After this done, check the "scripts" section of module composer.json file to see how we run tests.

$ composer tests-unit
$ composer tests-integration
$ composer tests-codeception

NOTE: From OXID eShop 7.0.x on database reset needs to be done with this command (please fill in your credentials)

$ bin/oe-console oe:database:reset --db-host=mysql --db-port=3306 --db-name=example --db-user=root --db-password=root --force

And just in case you need it, admin user can now also be created via commandline

$ bin/oe-console oe:admin:create-user --admin-email <admin-email> --admin-passowrd <admin-password>

for example

$ bin/oe-console oe:admin:create-user --admin-email admin@oxid-esales.com --admin-password admin

Writing Codeception tests

As a rule of thumb, use codeception tests to ensure the frontend is behaving as expected. Codeception tests take a while to run, so try to navigate the way between covering the relevant cases and overtesting.

We definitely need some acceptance tests if the module affects the frontend. If the module breaks the frontend, we need to see it asap.

The great thing about codeception tests is - they can create screenshot and html output in failure case, so you literally get a picture of the fail (tests/Coreception/_output/).

Github Actions Workflow

The module template comes complete with a github actions workflow. No need to rig up some separate continuous integration infrastructure to run tests, it's all there in github. You will see three files in .github/workflow directory. The workflow from .github/workflow/trigger.yaml starts on every push and pull_request to run the code quality checks and all the module tests.

In our experience it is useful to run the shop tests with the module installed and activated from time to time. For sure those shop tests have been written with only the shop itself in mind. Your module, depending on what it is doing, might completely change the shop behaviour. Which means those shop tests with a module might just explode in your face. Which is totally fine, as long as you can always explain WHY those tests are failing.

Real life example: There is one shop acceptance test case OxidEsales\EshopCommunity\Tests\Acceptance\Frontend\ShopSetUpTest: which is testing the frontend shop setup. Very good chance this test will fail if a module is around which extends the class chain. That test is for setting up a shop from scratch so it will simply not expect a module to be around. And we only need our module to safely work with a working shop. We definitely will decide to skip that ShopSetUpTest as we have a good explanation as to why it will not work. And having this special test case work with our module will give no benefit.

This is only one example, there might be other tests that fail with your module but fail because your module is changing the shop. In that case the suggestion would be to exclude the original test from the github actions run, copy that test case to your module tests and update to work with your module. This was for example the strategy used for our reverse proxy modules which are mandatory to not make the shop's acceptance tests fail. Unless those test cases that somehow bypass reverse proxy cache invalidation. To be on the safe side, we took over those few test cases to the module and plan to improve the shop tests as soon as possible. We'll gladly also take your PR with improved shop tests ;)

And then there are some few shop tests marked as @group quarantine in the doc block. Test in that group have stability issues so they'd better be excluded as well.

Ps: a failing shop test might also turn up issues in your module, in that case fix the module and let the test live ;)

Additional info

Useful links

Module with useful code examples - https://github.com/OXID-eSales/examples-module
Vendor home page - https://www.oxid-esales.com
Bug tracker - https://bugs.oxid-esales.com
Developer Documentation - https://docs.oxid-esales.com/developer/en/latest/
Quality Tools and Requirements - https://docs.oxid-esales.com/developer/en/latest/development/modules_components_themes/quality.html
Docker SDK - https://github.com/OXID-eSales/docker-eshop-sdk

Contact us

In case of issues / bugs, use "Issues" section on github, to report the problem.
Join our community forum
Use the contact form

In case you have any complaints, suggestions, business cases you'd like an example for please contact us. Pull request are also welcome. Every feedback we get will help us improve.

oxid-esales / module-template

Maintainers

Details