Welcome to PHPUnit Kit

Enhance your coding experience with seamless PHPUnit integration for Sublime Text.

Features

• Run a test method
• Run a test file
• Run the test suite
• Run the nearest test
• Run the last test
• Run multiple test methods using multiple cursors
• Run tests on a remote server via SSH :new:
• Run tests via Docker :new:
• Run tests via the sidebar menu :new:
• Run tests via the context menu :new:
• Auto-run tests on save
• Color output
• Quickly jump to the next and previous failures
• Quickly switch between the test and the file-under-test
• Toggle options from the command palette
• Toggle running tests on save :new:
• Fully customized CLI options configuration
• Support for:
  • Artisan - Artisan is the command-line interface included with Laravel.
  • Composer - Composer is a Dependency Manager for PHP.
  • iTerm2 - iTerm2 brings the terminal into the modern age.
  • Kitty - Kitty is a fast, feature-rich, cross-platform, GPU-based terminal.
  • ParaTest - ParaTest adds parallel testing support in PHPUnit.
  • Pest - Pest is a testing framework with a focus on simplicity.
  • xterm - A terminal emulator for the X Window System. :new:
  • cmd - A command-line interpreter for Windows. :new:
  • PowerShell - A cross-platform command-line shell. :new:
• Zero configuration required

Read Running PHPUnit Tests from Sublime Text for a quick introduction.

• Installation
• Setup
• Commands
• Key Bindings
• Strategies
• Configuration
  • CLI Options
  • PHPUnit Executable
  • PHP Executable
  • SSH
  • Docker
  • Auto Commands
  • Toggle Commands
  • Custom Toggle Commands
• NeoVintageous mappings
• Contributing
• Changelog
• Credits
• License

Installation

Method 1: Using Package Control

1. Open Sublime Text.
2. Press Ctrl+Shift+P (Windows/Linux) or Cmd+Shift+P (macOS) to open the Command Palette.
3. Type “Package Control: Install Package” and press Enter.
4. In the input field, type “PHPUnitKit” and select it from the list of available packages.

Method 2: Manual Installation

1. Visit the PHPUnitKit GitHub repository.
2. Click on the “Code” button and select “Download ZIP.”
3. Extract the downloaded ZIP file.
4. Open Sublime Text and go to Preferences -> Browse Packages... to open the Packages folder.
5. Copy the “PHPUnitKit” folder from the extracted ZIP and paste it into the Packages folder.

Method 3: Manual Git Repository Installation

1. Open a terminal or command prompt.
2. Navigate to the Sublime Text Packages directory:
   • On Windows: %APPDATA%\Sublime Text\Packages
   • On macOS: ~/Library/Application Support/Sublime Text/Packages
   • On Linux: ~/.config/sublime-text/Packages
3. Clone the plugin repository directly into the Packages directory using Git:

git clone https://github.com/gerardroche/sublime-phpunit.git PHPUnitKit

Setup

(Optional: Zero configuration required.)

To add your preferred keybindings, follow these steps:

1. Open the Sublime Text menu: Command Palette → Preferences: Key Bindings.
2. Add the following keybindings to the configuration file:

[
    { "keys": ["ctrl+shift+a"], "command": "phpunit_test_suite" },
    { "keys": ["ctrl+shift+c"], "command": "phpunit_test_cancel" },
    { "keys": ["ctrl+shift+f"], "command": "phpunit_test_file" },
    { "keys": ["ctrl+shift+l"], "command": "phpunit_test_last" },
    { "keys": ["ctrl+shift+n"], "command": "phpunit_test_nearest" },
    { "keys": ["ctrl+shift+r"], "command": "phpunit_test_results" },
    { "keys": ["ctrl+shift+s"], "command": "phpunit_test_switch" },
    { "keys": ["ctrl+shift+v"], "command": "phpunit_test_visit" }
]

Commands

Enhance your testing workflow with these commands for efficient testing directly from Sublime Text.

Key Bindings

Strategies

PHPUnitKit can run tests using different execution environments known as “strategies”.

Example: Using the Kitty Terminal Strategy

To set this strategy:

1. Open the Command Palette: Preferences: PHPUnit Settings
2. Add the following to your settings:

{
    "phpunit.strategy": "kitty"
}

Available strategies and their identifiers:

Configuration

To configure PHPUnitKit, follow these steps:

1. Open the Command Palette: Preferences: PHPUnit Settings

Available settings and their details:

These settings allow you to customize PHPUnitKit according to your preferences and requirements.

SSH Settings :rocket:

Configure SSH settings for running tests remotely:

Use these settings to configure PHPUnitKit's SSH options for seamless remote testing.

Docker Settings :rocket:

Configure Docker settings for running tests within containers:

Utilize these settings to configure PHPUnitKit for streamlined testing within Docker containers.

CLI Options

If you want some CLI options to stick around, you can configure them in your settings.

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.options": {
        "no-coverage": true,
        "no-progress": true,
        "colors=never": true,
        "order-by=": "defects",
        "coverage-html": "build/coverage",
        "d": ["display_errors=1", "xdebug.scream=0"],
    }
}

The above options will be passed to PHPUnit as CLI options:

-d "display_errors=1" \
-d "xdebug.scream=0" \
--no-coverage \
--no-progress \
--colors=never \
--order-by=defects \
--coverage-html build/coverage

Example: Ignore code coverage reporting configured in the XML configuration file

This can help keep your tests fast. You can toggle no-coverage from the command palette when you need it.

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.options": {
        "no-coverage": true,
    }
}

Example: Stop after first error, failure, warning, or risky test

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.options": {
        "stop-on-defect": true
    }
}

Example: Disable progress and output

This is useful if you are migrating from PHPUnit to Pest and want to hide superfluous output.

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.options": {
        "no-progress": true,
        "no-output": true,
    }
}

PHPUnit Executable

The path to the PHPUnit executable to use when running tests. Environment variables and user home directory ~ placeholder are expanded. The executable can be a string or a list of parameters.

Default: Auto discovery.

Examples

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.executable": "vendor/bin/phpunit",
    "phpunit.executable": "~/path/to/phpunit",
    "phpunit.executable": ["artisan", "test"]
}

PHP Executable

The path to the PHP executable to use when running tests. Environment variables and user home directory ~ placeholder are expanded.

Default: Auto discovery.

Examples

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.php_executable": "~/.phpenv/versions/8.2/bin/php"
}

SSH

Example: Run tests via SSH using Laravel Homestead

{
    "phpunit.ssh": true,
    "phpunit.ssh_options": {
        "-p": "22",
        "-tt": true
    },
    "phpunit.ssh_user": "vagrant",
    "phpunit.ssh_host": "homestead.test",
    "phpunit.ssh_paths": {
        "~/code/project1": "~/project1",
        "/home/code/project2": "/home/vagrant/project2",
    }
}

Docker

Example: Run tests via Docker

{
    "phpunit.docker": true,
    "phpunit.docker_command": ["docker", "exec", "-it", "my-container"],
    "phpunit.docker_paths": {
        "~/code/project1": "~/project1",
        "/home/code/project2": "/home/vagrant/project2",
    }
}

Auto Commands

You can configure the on_post_save event to run the “Test File” command when views are saved. This will instruct the runner to automatically run a test every time it is saved.

Example: Run Test File on Save

Command Palette → Preferences: PHPUnit Settings

{
    "phpunit.on_post_save": [
        "phpunit_test_file"
    ]
}

Toggle Commands

You can toggle many PHPUnit CLI options from the command palette by prefixing the command with “PHPUnit: Toggle.”

Execution

• PHPUnit: Toggle –process-isolation: Run each test in a separate PHP process.
• PHPUnit: Toggle –globals-backup: Backup and restore $GLOBALS for each test.
• PHPUnit: Toggle –static-backup: Backup and restore static properties for each test.
• PHPUnit: Toggle –strict-coverage: Be strict about code coverage metadata.
• PHPUnit: Toggle –strict-global-state: Be strict about changes to global state.
• PHPUnit: Toggle –disallow-test-output: Be strict about output during tests.
• PHPUnit: Toggle –enforce-time-limit: Enforce time limit based on test size.
• PHPUnit: Toggle –dont-report-useless-tests: Do not report tests that do not test anything.
• PHPUnit: Toggle –stop-on-defect: Stop after the first error, failure, warning, or risky test.
• PHPUnit: Toggle –stop-on-error: Stop after the first error.
• PHPUnit: Toggle –stop-on-failure: Stop after the first failure.
• PHPUnit: Toggle –stop-on-warning: Stop after the first warning.
• PHPUnit: Toggle –stop-on-risky: Stop after the first risky test.
• PHPUnit: Toggle –stop-on-deprecation: Stop after the first test that triggered a deprecation.
• PHPUnit: Toggle –stop-on-notice: Stop after the first test that triggered a notice.
• PHPUnit: Toggle –stop-on-skipped: Stop after the first skipped test.
• PHPUnit: Toggle –stop-on-incomplete: Stop after the first incomplete test.
• PHPUnit: Toggle –fail-on-warning: Signal failure using the shell exit code when a warning was triggered.
• PHPUnit: Toggle –fail-on-risky: Signal failure using the shell exit code when a test was considered risky.
• PHPUnit: Toggle –fail-on-deprecation: Signal failure using the shell exit code when a deprecation was triggered.
• PHPUnit: Toggle –fail-on-notice: Signal failure using the shell exit code when a notice was triggered.
• PHPUnit: Toggle –fail-on-skipped: Signal failure using the shell exit code when a test was skipped.
• PHPUnit: Toggle –fail-on-incomplete: Signal failure using the shell exit code when a test was marked incomplete.
• PHPUnit: Toggle –cache-result: Write test results to the cache file.
• PHPUnit: Toggle –do-not-cache-result: Do not write test results to the cache file.
• PHPUnit: Toggle –order-by=default: Run tests in order: default.
• PHPUnit: Toggle –order-by=defects: Run tests in order: defects.
• PHPUnit: Toggle –order-by=depends: Run tests in order: depends.
• PHPUnit: Toggle –order-by=duration: Run tests in order: duration.
• PHPUnit: Toggle –order-by=no-depends: Run tests in order: no-depends.
• PHPUnit: Toggle –order-by=random: Run tests in order: random.
• PHPUnit: Toggle –order-by=reverse: Run tests in order: reverse.
• PHPUnit: Toggle –order-by=size: Run tests in order: size.

Reporting

• PHPUnit: Toggle –no-progress: Disable output of test execution progress.
• PHPUnit: Toggle –no-results: Disable output of test results.
• PHPUnit: Toggle –no-output: Disable all output.
• PHPUnit: Toggle –display-incomplete: Display details for incomplete tests.
• PHPUnit: Toggle –display-skipped: Display details for skipped tests.
• PHPUnit: Toggle –display-deprecations: Display details for deprecations triggered by tests.
• PHPUnit: Toggle –display-errors: Display details for errors triggered by tests.
• PHPUnit: Toggle –display-notices: Display details for notices triggered by tests.
• PHPUnit: Toggle –display-warnings: Display details for warnings triggered by tests.
• PHPUnit: Toggle –reverse-list: Print defects in reverse order.
• PHPUnit: Toggle –teamcity: Replace default progress and result output with TeamCity format.
• PHPUnit: Toggle –testdox: Replace default result output with TestDox format.

Logging

• PHPUnit: Toggle –no-logging: Ignore logging configured in the XML configuration file.

Code Coverage

• PHPUnit: Toggle –path-coverage: Report path coverage in addition to line coverage.
• PHPUnit: Toggle –disable-coverage-ignore: Disable metadata for ignoring code coverage.
• PHPUnit: Toggle –no-coverage: Ignore code coverage reporting configured in the XML configuration file.

Custom Toggle Commands

You can create your own toggle commands. The phpunit_toggle_option command accepts the following arguments:

Example: Custom toggle commands

1. Open Sublime Text and go to Preferences -> Browse Packages... to open the Packages folder.
2. Create a file named “User/Default.sublime-commands”
3. Add the following commands to the configuration file:

[
       {
           "caption": "PHPUnit: Toggle --no-coverage",
           "command": "phpunit_toggle_option",
           "args": {
               "option": "no-coverage"
           }
       },
       {
           "caption": "PHPUnit: Toggle --order-by=depends,defects",
           "command": "phpunit_toggle_option",
           "args": {
               "option": "order-by=",
               "value": "depends,defects"
           }
       }
   ]

Example: Custom key binding to toggle coverage reporting generation

1. Open the Command Palette: Command Palette → Preferences: Key Bindings.
2. Add the following key binding to the configuration file:

[
       {
           "keys": ["ctrl+n"],
           "command": "phpunit_toggle_option",
           "args": {
               "option": "no-coverage"
           }
       },
   ]

NeoVintageous mappings

NeoVintageous is a Vim emulator for Sublime Text.

1. Open the Command Palette: Command Palette → NeoVintageous: Open neovintageous file.
2. Add your preferred mappings.

Example

nnoremap <leader>t :TestNearest<CR>
   nnoremap <leader>T :TestFile<CR>
   nnoremap <leader>a :TestSuite<CR>
   nnoremap <leader>l :TestLast<CR>
   nnoremap <leader>g :TestVisit<CR>

1. To apply the changes, reload the neovintageousrc from the Command Palette: Command Palette → NeoVintageous: Reload neovintageous file.

Contributing

See CONTRIBUTING.md.

Changelog

See CHANGELOG.md.

Credits

Based initially on, and inspired by the awesome work of maltize/sublime-text-2-ruby-tests, stuartherbert/sublime-phpunit, janko-m/vim-test, and many others.

License

Released under the GPL-3.0-or-later License.