Установка

Fedora

На момент написания Fedora 40 — это текущая версия этой дистрибуции Linux. Она поставляется с PHP 8.3 по умолчанию. Вот как установить интерпретатор командной строки PHP вместе с расширениями, необходимыми для PHPUnit:

sudo dnf install php-cli \
                 php-json \
                 php-mbstring \
                 php-process \
                 php-xml \
                 php-pecl-pcov \
                 php-pecl-xdebug

Если вы используете более старую версию Fedora, ознакомьтесь с репозиторием пакетов, поддерживаемым Remi Collet.

Debian

На момент написания Debian 12 — это текущая версия этой дистрибуции Linux. Она поставляется с PHP 8.2 по умолчанию. Вот как установить интерпретатор командной строки PHP вместе с расширениями, необходимыми для PHPUnit:

sudo apt install php-cli \
                 php-json \
                 php-mbstring \
                 php-xml \
                 php-pcov \
                 php-xdebug

Если вы используете более старую версию Debian, ознакомьтесь с репозиторием пакетов, поддерживаемым Ondřej Surý.

Ubuntu

На момент написания Ubuntu 24.04 — это текущая версия этой дистрибуции Linux. Она поставляется с PHP 8.3 по умолчанию. Вот как установить интерпретатор командной строки PHP вместе с расширениями, необходимыми для PHPUnit:

sudo apt install php-cli \
                 php-json \
                 php-mbstring \
                 php-xml \
                 php-pcov \
                 php-xdebug

Если вы используете более старую версию Ubuntu, ознакомьтесь с репозиторием пакетов, поддерживаемым Ondřej Surý.

macOS

Наиболее распространенный способ установки PHP на macOS — с помощью Homebrew. Приведенные ниже инструкции предполагают, что у вас уже настроена Homebrew.

Мы будем использовать формулы homebrew-php, поддерживаемые Shivam Mathur. Следующая команда получит эти формулы:

brew tap shivammathur/php

Следующая команда установит PHP 8.2:

brew install shivammathur/php/php@8.2

Следующие расширения, необходимые для PHPUnit, уже установлены и включены по умолчанию:

• dom

• json

• libxml

• mbstring

• xml

• xmlwriter

Если вам нужно собирать информацию о покрытии кода, вам необходимо дополнительно установить и включить одно из следующих расширений:

• pcov

• xdebug

Следующая команда установит и включит расширение pcov:

brew install pcov@8.2

Следующая команда установит и включит расширение xdebug:

brew install xdebug@8.2

Windows

Ручная загрузка PHAR

Вы можете просто загрузить выпуск PHPUnit, упакованный в архив PHP, и сразу же использовать его:

wget -O phpunit.phar https://phar.phpunit.de/phpunit-10.phar

php phpunit.phar --version
PHPUnit 10.0.0 by Sebastian Bergmann and contributors.

Обычно архив PHAR делается исполняемым:

chmod +x phpunit.phar

Теперь вы можете напрямую запустить PHAR:

./phpunit.phar --version
PHPUnit 10.0.0 by Sebastian Bergmann and contributors.

Все официальные выпуски, распространяемые проектом PHPUnit, подписаны менеджером выпуска. Подписи PGP и хэши SHA256 доступны для проверки на https://phar.phpunit.de/.

Вот пример того, как можно вручную проверить архив PHP выпуска PHPUnit, используя его подпись PGP:

wget -O phpunit.phar https://phar.phpunit.de/phpunit-10.phar
wget -O phpunit.phar.asc https://phar.phpunit.de/phpunit-10.phar.asc
gpg --keyserver pgp.uni-mainz.de --recv-keys 0x4AA394086372C20A
gpg phpunit.phar.asc

Обычно разные версии PHPUnit используются для каждого проекта. Это достигается путём размещения архива PHP PHPUnit в директории вашего проекта. Типичная структура каталогов для PHP-проекта выглядит так:

├── public
├── src
├── tests
└── tools

Директория public содержит статические ресурсы приложения (CSS, JavaScript, изображения и т. д.); это корень документа веб-сервера.

Директория src содержит исходный код PHP приложения. Директория tests содержит набор тестов приложения.

Директория tools содержит инструменты, такие как PHPUnit, упакованные в архивы PHP.

Вы можете вручную загрузить архив PHP PHPUnit в эту директорию tools, конечно:

wget -O phpunit.phar https://phar.phpunit.de/phpunit-10.phar
chmod +x phpunit.phar
mv phpunit.phar tools

Установка PHPUnit с Phive

Вы можете использовать Phive, среду для установки и проверки PHAR, для управления инструментами PHP-проекта, основанными на PHAR.

Вот как установить Phive:

wget https://phar.io/releases/phive.phar
wget https://phar.io/releases/phive.phar.asc
gpg --keyserver hkps.pool.sks-keyservers.net --recv-keys 0x9B2D5D79
gpg --verify phive.phar.asc phive.phar
chmod +x phive.phar
mv phive.phar /usr/local/bin/phive

После установки Phive PHPUnit можно установить следующим образом:

phive install phpunit

После выполнения команды, показанной выше, каталог проекта будет выглядеть так:

├── .phive
|   └── phars.xml
├── public
├── src
├── tests
└── tools
    └── phpunit -> ~/.phive/phars/phpunit-10.0.0.phar

Phive загрузил архив PHP для PHPUnit 10.0.0, поместил его в кеш, расположенный в вашем домашнем каталоге, и создал символическую ссылку оттуда на tools/phpunit.

Теперь вы можете вызвать локальную установку PHPUnit, выполнив ./tools/phpunit:

./tools/phpunit --version
PHPUnit 10.0.0 by Sebastian Bergmann and contributors.

Файл .phive/phars.xml, созданный в корневом каталоге вашего проекта, содержит метаданные о зависимостях инструментов вашего проекта:

<?xml version="1.0" encoding="UTF-8"?>
<phivexmlns="https://phar.io/phive">
<pharname="phpunit"
version="^10.0"installed="10.0.0"
location="./tools/phpunit"copy="true"/>
</phive>

.phive/phars.xml необходимо поместить под контроль версий.

^10.0 — это ограничение семантической версии: Phive всегда будет устанавливать последнюю версию PHPUnit, совместимую с PHPUnit 10.0.

Phive не только предоставляет удобный способ установки, управления и обновления инструментов, распространяемых в виде архива PHP. Phive также обеспечивает безопасность, автоматически проверяя подписи PGP при загрузке файлов PHAR.

Если вы хотите сохранить архив PHP PHPUnit под контролем версий, используйте опцию --copy Phive, чтобы скопировать архив PHP из своего кеша в домашнем каталоге в директорию инструментов вашего проекта:

phive install --copy phpunit

После выполнения команды, показанной выше, каталог проекта будет выглядеть так:

├── .phive
|   └── phars.xml
├── public
├── src
├── tests
└── tools
    └── phpunit

Обновление PHPUnit с помощью Phive

phive install phpunit добавляет зависимость от PHPUnit с ограничением версии, использующим оператор caret (^) для семантической версии: version="^10.0".

С этой конфигурацией Phive всегда будет устанавливать последнюю версию PHPUnit, совместимую с PHPUnit 10.0.

Это гарантирует, что вы «остаётесь в курсе» до тех пор, пока PHPUnit 10 является текущей стабильной версией PHPUnit и включает новые второстепенные версии, такие как PHPUnit 10.1. А когда наступит время и будет выпущен PHPUnit 11, Phive не будет автоматически и неожиданно его устанавливать.

<?xml version="1.0" encoding="UTF-8"?>
<phivexmlns="https://phar.io/phive">
<pharname="phpunit"
version="^9.6"installed="9.6.0"
location="./tools/phpunit"copy="true"/>
</phive>

phive outdated
Phive 0.15.2 - Copyright (C) 2015-2023 by Arne Blankerts, Sebastian Heuer and Contributors
Found 1 outdated PHARs in phive.xml:

Name       Version Constraint    Installed    Available

phpunit    ^9.6                  9.6.0        9.6.3

<?xml version="1.0" encoding="UTF-8"?>
<phivexmlns="https://phar.io/phive">
<pharname="phpunit"
version="^9.6"installed="9.6.3"
location="./tools/phpunit"copy="true"/>
</phive>

phive outdated
Phive 0.15.2 - Copyright (C) 2015-2023 by Arne Blankerts, Sebastian Heuer and Contributors
Congrats, no outdated phars found

phive install phpunit@^10.0
Phive 0.15.2 - Copyright (C) 2015-2024 by Arne Blankerts, Sebastian Heuer and Contributors
Linking /home/sb/.phive/phars/phpunit-10.5.15.phar to /path/to/tools/phpunit

Что внутри PHAR?

Для предотвращения проблем, возникающих, когда код, который тестируется, использует те же зависимости, что и PHPUnit, но требует различных версий, чем те, что сгруппированы в PHAR, были реализованы несколько мер.

Большинство единиц кода, включенных в дистрибутив PHPUnit PHAR, включая все зависимости, такие как директории поставщиков, перемещаются в новое и отдельное пространство имён, например. Классы, являющиеся частью публичного API PHPUnit, например PHPUnit\Framework\TestCase, освобождены от этого.

PHAR PHPUnit не использует динамическую загрузку для загрузки объединённых единиц кода. Вместо этого все единицы кода, включенные в PHAR, загружаются при запуске.

Вот статья об этих мерах более подробно.

Иногда вам нужно точно знать, какие версии зависимостей PHPUnit включены в дистрибутив PHPUnit PHAR, например, в контексте безопасности цепочки поставок программного обеспечения. Для этой цели дистрибутив PHPUnit PHAR предоставляет дополнительные параметры командной строки, которых нет у установленного с помощью Composer запускателя тестов.

При вызове PHAR PHPUnit с параметром командной строки --manifest он выведет текстовый манифест с информацией о версиях зависимостей PHPUnit, включенных в PHAR:

php phpunit-10.5.1.phar --manifest
phpunit/phpunit: 10.5.1
myclabs/deep-copy: 1.11.1
nikic/php-parser: v4.17.1
phar-io/manifest: 2.0.3
phar-io/version: 3.2.1
phpunit/php-code-coverage: 10.1.9
phpunit/php-file-iterator: 4.1.0
phpunit/php-invoker: 4.0.0
phpunit/php-text-template: 3.0.1
phpunit/php-timer: 6.0.0
sebastian/cli-parser: 2.0.0
sebastian/code-unit: 2.0.0
sebastian/code-unit-reverse-lookup: 3.0.0
sebastian/comparator: 5.0.1
sebastian/complexity: 3.1.0
sebastian/diff: 5.0.3
sebastian/environment: 6.0.1
sebastian/exporter: 5.1.1
sebastian/global-state: 6.0.1
sebastian/lines-of-code: 2.0.1
sebastian/object-enumerator: 5.0.0
sebastian/object-reflector: 3.0.0
sebastian/recursion-context: 5.0.0
sebastian/type: 4.0.0
sebastian/version: 4.0.1
theseer/tokenizer: 1.2.2

При вызове PHAR PHPUnit с параметром командной строки --sbom он выведет XML-сводку программного обеспечения (SBOM) с информацией о версиях зависимостей PHPUnit, включенных в PHAR:

php phpunit-10.5.1.phar --sbom
<?xml version="1.0"?>
<bom xmlns="http://cyclonedx.org/schema/bom/1.4">
 <components>
  <component type="library">
   <group>phpunit</group>
   <name>phpunit</name>
   <version>10.5.1</version>
   <description>The PHP Unit Testing framework.</description>
   <licenses>
    <license>
     <id>BSD-3-Clause</id>
    </license>
   </licenses>
   <purl>pkg:composer/phpunit/phpunit@10.5.1</purl>
  </component>
  .
  .
  .

При вызове PHAR PHPUnit с параметром командной строки --composer-lock он выведет файл composer.lock, который использовался для установки зависимостей PHPUnit во время сборки PHAR:

php phpunit-10.5.1.phar --composer-lock
{
    "_readme": [
        "This file locks the dependencies of your project to a known state",
        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
        "This file is @generated automatically"
    ],
    "content-hash": "e06728e5442edec84af96f94a889b4a7",
    .
    .
    .

Установка PHPUnit с помощью Composer

Приведенная ниже команда предполагает, что Composer уже установлен и его исполняемый файл composer находится на вашем $PATH. Установка Composer описана на сайте инструмента.

composer require --dev phpunit/phpunit

После выполнения показанной выше команды в каталоге проекта будет следующее содержимое:

├── composer.json
├── composer.lock
├── public
├── src
├── tests
└── vendor

Файл composer.json содержит метаданные о зависимостях вашего проекта, например. Этот файл должен быть под управлением системы контроля версий.

Файл composer.lock содержит список точных версий зависимостей, которые были установлены Composer. Хотя технически это не обязательно, считается лучшей практикой поместить этот файл под контроль версий.

Локальную установку PHPUnit можно вызвать следующим образом:

./vendor/bin/phpunit --version
PHPUnit 10.0.0 by Sebastian Bergmann and contributors.

Обновление PHPUnit с помощью Composer

composer require --dev phpunit/phpunit добавляет зависимость от PHPUnit для времени разработки с ограничением версии, использующим оператор caret (^) для семантической версии: "phpunit/phpunit": "^10.0".

С этой конфигурацией Composer всегда установит последнюю совместимую с PHPUnit 10.0 версию PHPUnit.

Это гарантирует, что вы будете «в курсе», пока PHPUnit 10 является текущей стабильной версией PHPUnit и включает новые второстепенные версии, такие как PHPUnit 10.1. А когда придёт время и будет выпущен PHPUnit 11, Composer не будет автоматически и неожиданно его устанавливать.

{
"require-dev":{
"phpunit/phpunit":"^9.6"
}
}

composer outdated --minor-only
Legend:
! patch or minor release available - update recommended
~ major release available - update possible

Direct dependencies required in composer.json:
phpunit/phpunit 9.6.0 ! 9.6.3 The PHP Unit Testing framework.

{
"require-dev":{
"phpunit/phpunit":"^9.6"
}
}

composer outdated
Legend:
! patch or minor release available - update recommended
~ major release available - update possible

Direct dependencies required in composer.json:
phpunit/phpunit                    9.6.3  ~ 10.0.7 The PHP Unit Testing framework.

{
"require-dev":{
"phpunit/phpunit":"^10.0"
}
}