### Test Class with setUp() and tearDown()

Source: https://docs.phpunit.de/en/10.5/fixtures.html

This example demonstrates a basic test class using setUp() to initialize a test fixture and tearDown() to clean it up. The setUp() method is called before each test method, and tearDown() is called after.

```PHP
<?php declare(strict_types=1);
namespace example;

use PHPUnit\Framework\TestCase;

final class ExampleTest extends TestCase
{
    private ?Example $example;

    public function testSomething(): void
    {
        $this->assertSame(
            'the-result',
            $this->example->doSomething()
        );
    }

    protected function setUp(): void
    {
        $this->example = new Example(
            $this->createStub(Collaborator::class)
        );
    }

    protected function tearDown(): void
    {
        $this->example = null;
    }
}

```

--------------------------------

### Install Phive

Source: https://docs.phpunit.de/en/10.5/installation.html

Download and set up Phive, the PHAR Installation and Verification Environment. This involves downloading the phive.phar, verifying its signature, and making it executable.

```bash
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

```

--------------------------------

### Concrete Test Case Extending Abstract with setUp()

Source: https://docs.phpunit.de/en/10.5/fixtures.html

A concrete test case class that extends an abstract test case class with a setUp() method. It is crucial to call parent::setUp() to ensure the parent's setup logic is executed.

```PHP
<?php declare(strict_types=1);
namespace example;

use PHPUnit\Framework\TestCase;

final class ExampleTest extends MyTestCase
{
    protected function setUp(): void
    {
        // ...
    }
}

```

--------------------------------

### Install PHPUnit Locally with Composer

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs PHPUnit as a development dependency for your project. Ensure Composer is installed and in your PATH.

```bash
composer require --dev phpunit/phpunit

```

--------------------------------

### Verify PHPUnit Installation

Source: https://docs.phpunit.de/en/10.5/installation.html

Check the version of the installed PHPUnit. This command invokes the project-local installation of PHPUnit.

```bash
./tools/phpunit --version

```

--------------------------------

### Abstract Test Case with setUp()

Source: https://docs.phpunit.de/en/10.5/fixtures.html

An abstract test case class defining a setUp() method. This method can be extended by concrete test case classes.

```PHP
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

abstract class MyTestCase extends TestCase
{
    protected function setUp(): void
    {
        // ...
    }
}

```

--------------------------------

### Install PHP CLI and Extensions on Fedora

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs the PHP command-line interpreter and essential extensions for PHPUnit on Fedora systems.

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

```

--------------------------------

### Global PHPUnit Installation using PHAR

Source: https://docs.phpunit.de/en/10.5/installation.html

This snippet demonstrates how to download, make executable, and move the PHPUnit PHAR to a global bin directory for command-line access. It also shows how to verify the installation.

```bash
wget -O phpunit.phar https://phar.phpunit.de/phpunit-10.phar
chmod +x phpunit.phar
sudo mv phpunit.phar /usr/local/bin/phpunit
phpunit --version
```

--------------------------------

### Install PHPUnit with Phive

Source: https://docs.phpunit.de/en/10.5/installation.html

Install PHPUnit for your project using the Phive tool. This command downloads and sets up PHPUnit in the project's tools directory.

```bash
phive install phpunit

```

--------------------------------

### Install PHPUnit with Copy Option

Source: https://docs.phpunit.de/en/10.5/installation.html

Install PHPUnit and copy its PHAR file directly into the project's tools directory, rather than using a symbolic link from the Phive cache.

```bash
phive install --copy phpunit

```

--------------------------------

### Install PHP CLI and Extensions on Debian/Ubuntu

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs the PHP command-line interpreter and essential extensions for PHPUnit on Debian and Ubuntu systems.

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

```

--------------------------------

### PHPUnit assertIsList() Example

Source: https://docs.phpunit.de/en/10.5/assertions.html

Use assertIsList() to verify if an array has consecutive integer keys starting from 0. This example demonstrates a failing test with non-sequential keys.

```php
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

final class IsListTest extends TestCase
{
    public function testFailure(): void
    {
        $this->assertIsList([1 => 'foo', '3' => 'bar']);
    }
}

```

--------------------------------

### Invoke Local PHPUnit Installation

Source: https://docs.phpunit.de/en/10.5/installation.html

Executes the locally installed PHPUnit binary to run tests or check the version. Assumes PHPUnit was installed via Composer.

```bash
./vendor/bin/phpunit --version

```

--------------------------------

### Install PHP 8.1 using Homebrew on macOS

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs PHP version 8.1 using the homebrew-php formulae on macOS.

```bash
brew install shivammathur/php/php@8.1

```

--------------------------------

### Install Xdebug Extension using Homebrew on macOS

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs and enables the Xdebug extension for debugging on macOS.

```bash
brew install xdebug@8.1

```

--------------------------------

### Test Execution Output

Source: https://docs.phpunit.de/en/10.5/writing-tests-for-phpunit.html

Example output from running the basic Greeter test, showing a successful test run with one assertion.

```text
./tools/phpunit tests/GreeterTest.php
PHPUnit 10.5.48 by Sebastian Bergmann and contributors.

Runtime:       PHP 8.4.10

.                                                                   1 / 1 (100%)

Time: 00:00, Memory: 22.94 MB

OK (1 test, 1 assertion)

```

--------------------------------

### Install PCOV Extension using Homebrew on macOS

Source: https://docs.phpunit.de/en/10.5/installation.html

Installs and enables the PCOV extension for code coverage on macOS.

```bash
brew install pcov@8.1

```

--------------------------------

### PHPUnit assertIsResource() Example

Source: https://docs.phpunit.de/en/10.5/assertions.html

Use assertIsResource() to verify if a variable is a resource. This example shows a failure when null is asserted as a resource.

```php
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

final class IsResourceTest extends TestCase
{
    public function testFailure(): void
    {
        $this->assertIsResource(null);
    }
}

```

--------------------------------

### Tap PHP Homebrew Formulae on macOS

Source: https://docs.phpunit.de/en/10.5/installation.html

Adds the necessary Homebrew repositories for installing PHP and its extensions on macOS.

```bash
brew tap shivammathur/php
brew tap shivammathur/extensions

```

--------------------------------

### Setup Fixtures Before Each Test Method

Source: https://docs.phpunit.de/en/10.5/annotations.html

The `@before` annotation specifies methods to be executed before each test method within a class. This is useful for setting up test-specific fixtures.

```php
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

final class MyTest extends TestCase
{
    /**
     * @before
     */
    public function setupSomeFixtures(): void
    {
        // ...
    }

    /**
     * @before
     */
    public function setupSomeOtherFixtures(): void
    {
        // ...
    }
}

```

--------------------------------

### Check PHPUnit Version (PHAR)

Source: https://docs.phpunit.de/en/10.5/installation.html

Verify the installed PHPUnit version by running the downloaded PHAR archive with the --version flag.

```bash
php phpunit.phar --version
```

--------------------------------

### assertEquals() with Objects

Source: https://docs.phpunit.de/en/10.5/assertions.html

Demonstrates `assertEquals` with objects. Use when comparing object equality. The example shows a failure case where object properties differ.

```PHP
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;

final class EqualsWithObjectsTest extends TestCase
{
    public function testFailure(): void
    {
        $expected = new stdClass();
        $expected->foo = 'foo';
        $expected->bar = 'bar';

        $actual = new stdClass();
        $actual->foo = 'bar';
        $actual->baz = 'bar';

        $this->assertEquals($expected, $actual);
    }
}
```