crealoz/easy-audit-free

A tool that permits to run different types of audits in Magento 2.

0.1.2 2024-12-18 07:45 UTC

Requires

• php: ^8.1
• ext-simplexml: *
• magento/framework: *
• phpunit/phpunit: *

OSL-3.0

• Christophe Ferreboeuf

README

This module is designed to provide auditing capabilities for Magento applications.

What is EasyAudit?

EasyAudit is a Magento module that provides auditing capabilities for Magento applications. It is designed to help developers and/or website owners identify potential issues in their codebase and improve the overall quality of their Magento applications.

Features

For more details on the processors used in the EasyAudit project, refer to the Existing Processors.

Installation

The package is available on Packagist, so you can install it via Composer:

composer require crealoz/easy-audit-free

If you want to install the module manually (for participation), follow these steps:

1. Clone the repository:

git clone [e-mail]:crealoz/easy-audit.git

1. Navigate to the project directory:

cd easy-audit

1. Install the module via Composer:

composer install

Usage

Audit can be run using magento CLI command:

php bin/magento crealoz:run:audit

or using the back-office.

How to add a new audit subject?

General considerations

There is a single entry point for the audit process, which is the \Crealoz\EasyAudit\Service\Audit class. This class is responsible for running the audit process and handling the audit results. The audit process will loop through the list of types of audit subjects and run the audit processes for each of them.

Create a new type of audit subject

For the moment, the audit process is divided into two types: xml, php and logic. If you want to create a new type, you need to create a new class that implements the TypeInterface interface. The class should be located in the Service\Type directory. The new class can extend the AbstractType class, which provides a default implementation for the TypeInterface.

The new class should be registered in the di.xml file, in the typeMapping arguments of the class Crealoz\EasyAudit\Service\Type\TypeFactory. Please note that the entry in the typeMapping arguments should be in the format type => class and type will be used to identify the type of the audit subject for the processors of \Crealoz\EasyAudit\Service\Audit.

Create a new audit subject

Create a new class that implements ProcessorInterface. The class should be located in the Service\Processor directory. It can extend the AbstractProcessor class, which provides a default implementation for the ProcessorInterface methods.

Register the new audit subject

In di.xml file, add a new item node to the processor arguments of the class Crealoz\EasyAudit\Service\Audit. Please note that the processors are divided by types (e.g. : di, view...) and if you want to create a new type. The logic have to be implemented and the new type have to implement the Crealoz\EasyAudit\Service\Processor\ProcessorInterface interface.

Adding a New File Getter

To add a new file getter similar to DiXmlGetter, follow these steps:

Step 1: Define the Virtual Type in di.xml

Add a new virtual type definition in your di.xml file. Replace NewFileGetter with your desired name, and update the path and pattern arguments as needed.

<virtualType name="Crealoz\EasyAudit\Service\FileSystem\NewFileGetter" type="Crealoz\EasyAudit\Service\FileSystem\FileGetter">
    <arguments>
        <argument name="path" xsi:type="string">your/path/here</argument>
        <argument name="pattern" xsi:type="string">/your-pattern-here/</argument>
    </arguments>
</virtualType>

Step 2: Register the New File Getter in FileGetterFactory

Add your new file getter to the fileGetters array in di.xml:

<type name="Crealoz\EasyAudit\Service\FileSystem\FileGetterFactory">
    <arguments>
        <argument name="fileGetters" xsi:type="array">
            <item name="newfilegetter" xsi:type="string">Crealoz\EasyAudit\Service\FileSystem\NewFileGetter</item>
        </argument>
    </arguments>
</type>

Contributing

Contributions are welcome. Please make sure to update tests as appropriate.