Skip to content

Add docs for dev console command tests #1686

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmuench merged 1 commit into from
Jun 19, 2025
Merged

Add docs for dev console command tests #1686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/docs/contributing/testing/unit-tests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,3 +66,30 @@ class YourCommandTest extends TestCase
}
}
```

## Testing `dev:console` Commands

Commands executed inside the interactive `dev:console` use their own base test
case. Instead of extending `N98\\Magento\\Command\\TestCase`, these tests must
extend `N98\\Magento\\Command\\Developer\\Console\\TestCase` which prepares
the REPL context.

```php
<?php
namespace N98\Magento\Command\Developer\Console;

class MakeCommandCommandTest extends TestCase
{
public function testExecute()
{
$command = new MakeCommandCommand();
$tester = $this->createCommandTester($command);

$tester->execute(['classpath' => 'foo.bar.baz']);
// add assertions here
}
}
```

See the files in `tests/N98/Magento/Command/Developer/Console/` for more
examples of testing commands that run within the `dev:console` environment.