Lando + PHPStorm/IntelliJ IDEA + PHPUnit

lando-phpstorm-intellij-idea-phpunit.md

Lando + PHPStorm/IntelliJ IDEA + PHPUnit

Context

This gist is a follow-up to this Lando issue, updated for Docker Composer and Windows (but might also help macOS and Linux users).

Steps

Setup Docker

1. Open File | Settings | Build, Execution, Deployment | Docker
2. Click on the top-left "+"
3. Case a: If you have (and want to use) Docker for Windows: choose "Docker for Windows"
4. Case b (theorical, because unfortunately I could not get it to work): If your Lando instance is in WSL:
   1. Choose "WSL" and your Linux distribution
   2. Add one or more path mappings (in my case mapping /home/quentint to \\wsl$\Ubuntu\home\quentint was enough because my projects are stored in WSL's home directory)

PHP CLI Interpreter

1. Open File | Settings | Languages & Frameworks | PHP

2. Click on the three dots on the "CLI Interpreter" line
3. Click on the top-left "+" and create CLI Interpreter "From Docker, Vagrant, VM, WSL, Remote..."

4. Choose "Docker Compose"

5. Click on the "Configuration files" folder icon
6. Click on the top-right "+"

7. Select all YAML files in C:\Users\[user]\.lando\compose\[project]
8. Select "appserver" in the Service dropdown
9. Click OK to close the "Configure Remote PHP Interpreter" window
10. Choose "Connect to an existing container" in the "Lifecycle" section

11. Click OK to close the "CLI Interpreters" window
12. Click on the directory icon of the "Path mappings" section
13. Add a local path mapping your project root to /app and click OK to confirm

PHPUnit

1. Open File | Settings | Languages & Frameworks | PHP | Test Frameworks
2. Click the top-left "+" to add a test framework
3. Choose "PHPUnit by Remote Interpreter"
4. Choose your newly created interpreter and click OK to close the window

When using Composer (you should)

1. Choose "Use Composer autoloader"
2. Set "Path to script" to /app/vendor/autoload.php

When using Symfony

1. If not already there, create phpunit.xml.dist at the root of your project

<?xml version="1.0" encoding="UTF-8"?>
<!-- https://phpunit.readthedocs.io/en/latest/configuration.html -->
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" backupGlobals="false" colors="true"
         bootstrap="tests/bootstrap.php">
    <coverage processUncoveredFiles="true">
        <include>
            <directory suffix=".php">src</directory>
        </include>
    </coverage>
    <php>
        <ini name="error_reporting" value="-1"/>
        <server name="APP_ENV" value="test" force="true"/>
        <server name="SHELL_VERBOSITY" value="-1"/>
    </php>
    <testsuites>
        <testsuite name="Project Test Suite">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
    <!-- Run `composer require symfony/phpunit-bridge` before enabling this extension -->
    <!--
      <listeners>
          <listener class="Symfony\Bridge\PhpUnit\SymfonyTestsListener" />
      </listeners>
      -->
    <!-- Run `composer require symfony/panther` before enabling this extension -->
    <!--
      <extensions>
          <extension class="Symfony\Component\Panther\ServerExtension" />
      </extensions>
      -->
</phpunit>

2. If not present, add KERNEL_CLASS='App\Kernel' to your .env.test file
3. Open previous settings (File | Settings | Languages & Frameworks | PHP | Test Frameworks)
4. Check "Default configuration file"
5. Set path to /app/phpunit.xml.dist

Add Xdebug support

See this comment for detailed steps.

Run tests 😊

Isn't that path already mapped by Lando?
Trying this more portable solution from PhpStorm forums, I added it in service volumes like this and it works.

services:
  appserver:
    type: php:8.1
    via: cli
    webroot: .
    xdebug: "debug,coverage,develop"
    volumes:
      # Add directory for PhpStorm coverage XML report
      - ./build/coverage/xml/:/opt/phpstorm-coverage/

However it's strange that I see it as empty on the host, while files are present in the container.

It goes to show that I am still a Docker newb 😅

I haven't tried to use coverage so I'm not sure if that's a hardcoded path or something. I was seeing /opt paths in the command phpstorm was running if I didn't set the path mapping.