# yireo/magento2-test-generator

> N/A

`composer require yireo/magento2-test-generator`

Canonical URL: https://packagento.com/yireo/magento2-test-generator

## At a glance

- **Vendor**: yireo (https://packagento.com/yireo.md)
- **Latest version**: 0.0.5 — released 2025-10-22
- **Pricing**: Free
- **Package type**: Magento 2 module
- **Status**: active, accepting new buyers

## Installation

Packagento is licence-gated, so even free packages need a licence on a project before Composer can resolve them.

1. **Sign in or create an account** at https://packagento.com/customer/account/.

2. **Add the package to your account.** Open https://packagento.com/yireo/magento2-test-generator and complete the free checkout. A licence is minted automatically.

3. **Create or pick a project, then activate the licence on it.**
   - Projects represent the Magento installs you deploy to. Manage them at https://packagento.com/projects/.
   - Activate the new licence on the project you'll deploy this package to. Activation is what generates the Composer credentials scoped to that project.

4. **Add the project credentials to your Magento codebase.**

   Grab the project's public + private key from https://packagento.com/projects/ (open the project, then its Credentials tab), and add them to `auth.json`:

   ```json
   {
     "http-basic": {
       "packagento.com": {
         "username": "ppk_live_...",
         "password": "psk_live_..."
       }
     }
   }
   ```

   Add the Packagento Composer repository to `composer.json`:

   ```json
   {
     "repositories": [
       { "type": "composer", "url": "https://packagento.com" }
     ]
   }
   ```

5. **Install and apply.**

   ```bash
   composer require yireo/magento2-test-generator:*
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush
   ```

## What it does

N/A

## README

**Use this module to kickstart unit tests or integration tests for your existing module.**

#### Installation
```bash
composer require yireo/magento2-test-generator
bin/magento module:enable Yireo_TestGenerator
```

#### Usage
Generate integration tests for the module `Yireo_Example` if they don't exist yet:
```bash
bin/magento yireo:test:generate Yireo_Example
```

Or generate integration tests, overriding existing tests as well (DANGEROUS) unless there is a token `@test-generator-skip-override` found in the test file contents:
```bash
bin/magento yireo:test:generate Yireo_Example --override-existing=1
```

Or generate unit tests:
```bash
bin/magento yireo:test:generate Yireo_Example --type=unit
```

Generate unit tests, overriding the original test, for a specific class only:
````bash
bin/magento yireo:test:generate --override-existing 1 --type unit -- 'LokiCheckout_AccountType' '\Loki\CheckoutAccountType\Config\Source\AccountTypeOptions'
````

#### AI generated tests
This module also offers to generate unit tests or integration tests by using AI. The tests generated might not always be perfect and might not even work. To the least, they offer you a kickstart instead of needing to code things yourself.

The following coding AIs are currently supported:

- OpenAI (ChatGPT)
- Anthropic (Claude AI)

Both require an API key to be used. Note that these AI platforms will bill you according to your usage. 

In the Store Configuration under **Yireo > Test Generator** you can enable each AI and configure an API key.

#### Extending test types
The Integration Tests can be created by using a custom generator. For instance, there is a `ConfigTestGenerator` which allows for a
specific config test case to be created, as long as the PHP class name matches with `*\Config\Config`.

```xml
<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
    <type name="Yireo\TestGenerator\Generator\IntegrationTest\AdditionalTestGeneratorListing">
        <arguments>
            <argument name="testGenerators" xsi:type="array">
                <item name="custom" xsi:type="object">YireoTraining\ExampleTestGenerator\Generator\IntegrationTest\CustomTestGenerator</item>
            </argument>
        </arguments>
    </type>
</config>
```

This generator class needs to implement `\Yireo\TestGenerator\Generator\IntegrationTest\SourceTestGeneratorInterface`. See the
`\Yireo\TestGenerator\Generator\IntegrationTest\ConfigTestGenerator` for a full example.

### Todo
- Move the AI mechanisms in separate modules
- Allow to configure the AI prompt yourself
- Add a dry-run flag

## Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

### [Unreleased]

### [0.0.5] - 22 October 2025
#### Fixed
- Fix wrong import of Console InputArgument, should be Symfony clas
- Fix issue with classes that require appState
- Add PHP 8.4 support
- Add proxy to generators to prevent weird issues from breaking the CLI
- Major rewrite for reusage of method code
- Fix generator instantiation
- Move generators into separate listing class
- Add Anthropic / Claude AI support
- Add enabled flag for OpenAI
- Add OpenAI ChatGPT code generator for unit tests
- Fix ConfigFixture arguments
- Refactoring

### [0.0.4] - 24 March 2025
- Add generators for OpenAI and ClaudeAI (it works, but mwoah)
- Major refactoring of namespace structure
- Add cross-class `AdditionalTestGenerator` (like routes, modules, page behaviour) 
- Generate test methods for each accessible method of target class

### [0.0.3] - 17 March 2025
- Allow for other generators to be created

### [0.0.2] - 12 September 2024
- Refinements

### [0.0.1] - 15 August 2024
#### Added
- Initial release

## Recent Versions

| Version | Released |
|---|---|
| 0.0.5 | 2025-10-22 |
| 0.0.3 | 2025-03-17 |
| 0.0.2 | 2024-08-15 |
| 0.0.1 | 2024-08-15 |

## Dependencies

### Require

| Package | Constraint |
|---|---|
| magento/framework | ^101.0.1\|^101.1\|^102.0\|^103.0 |
| mozex/anthropic-php | ^1.0 |
| nette/php-generator | ^4.1 |
| nette/utils | ^4.0 |
| openai-php/client | ^0.10.3 |

## Quality

Latest release (0.0.5) fails the Packagento QA pipeline. Verdicts below are per-cell (Magento line × PHP version) for the matrixed tools, and run-once for the static / security tiers.


### Compatibility

Each Magento line is installed on its supported PHP versions, then the module is built (DI compile + static-content deploy). Cells show passed / failed / untested; staircase gaps render as `–`.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | Pass | Pass | – | – |
| 2.4.8 | – | Pass | Pass | – |
| 2.4.9 | – | – | Pass | Pass |


### Code Quality

Advisory checks against the module's source. Never affect the Compatibility verdict — a phpcs finding can't make a module incompatible.

#### Static Analysis

Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Fail | 27 | 6 errors, 21 warnings (ruleset: Magento2) — 7 auto-fixable with phpcbf |
| PHPMD | Warning | 13 | 13 rule violations (ErrorControlOperator:6, CountInLoopExpression:3, CyclomaticComplexity:1, NPathComplexity:1, ExcessiveMethodLength:1) |
| Cpd | Warning | 4 | 4 duplicated chunks spanning 113 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |

#### PHPStan

Type-checks the module against a real Magento install. Re-runs per Magento + PHP version because resolvable symbols differ between releases.

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | 14 | 14 | – | – |
| 2.4.8 | – | 14 | 14 | – |
| 2.4.9 | – | – | 14 | 14 |


### Tests

Unit and integration suites run per Magento + PHP cell. Test failures speak to the module's behaviour, not its compatibility with a line, so they're reported here separately.

#### Unit Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |

#### Integration Tests

| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | – | – |
| 2.4.8 | – | N/A | N/A | – |
| 2.4.9 | – | – | N/A | N/A |


### Security

Dependency-advisory audit (composer audit) plus a source malware scan. A malware detection fails the version outright.

| Tool | Status | Findings | Summary |
|---|---|---|---|
| Composer audit | Pass | 0 |  |
| Malware scan | Pass | 0 |  |

## Licence and pricing

Free. A licence is still minted on checkout and bound to your project for Composer access — no payment step.

Refundable within 14 days of first purchase via https://packagento.com/account/refunds/.

## Install via Claude Code or any MCP client

The Packagento MCP server can run the licence + project + Composer steps above in one tool call:

```
purchase_and_install_packages(
  composer_names=["yireo/magento2-test-generator"],
  project_id="proj_xxx"
)
```

This handles cart, checkout, licence minting, project activation, and writes auth.json credentials. Connect a client with `claude mcp add packagento https://mcp.packagento.com`. Full setup at https://packagento.com/docs/mcp-setup.

## Vendor

yireo is a Magento 2 vendor on Packagento. See https://packagento.com/yireo.md for their full catalogue.