BeforeFirstTestMethodErrored.php

<?php

declare (strict_types=1);

/*
 * This file is part of PHPUnit.
 *
 * (c) Sebastian Bergmann <sebastian@phpunit.de>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace PHPUnit\Event\Test;

use const PHP_EOL;
use function sprintf;
use PHPUnit\Event\Code;
use PHPUnit\Event\Code\Throwable;
use PHPUnit\Event\Event;
use PHPUnit\Event\Telemetry;

/**
 * @psalm-immutable
 *
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 */
final class BeforeFirstTestMethodErrored implements Event {
    private readonly Telemetry\Info $telemetryInfo;
    
    /**
     * @psalm-var class-string
     */
    private readonly string $testClassName;
    private readonly Code\ClassMethod $calledMethod;
    private readonly Throwable $throwable;
    
    /**
     * @psalm-param class-string $testClassName
     */
    public function __construct(Telemetry\Info $telemetryInfo, string $testClassName, Code\ClassMethod $calledMethod, Throwable $throwable) {
        $this->telemetryInfo = $telemetryInfo;
        $this->testClassName = $testClassName;
        $this->calledMethod = $calledMethod;
        $this->throwable = $throwable;
    }
    public function telemetryInfo() : Telemetry\Info {
        return $this->telemetryInfo;
    }
    
    /**
     * @psalm-return class-string
     */
    public function testClassName() : string {
        return $this->testClassName;
    }
    public function calledMethod() : Code\ClassMethod {
        return $this->calledMethod;
    }
    public function throwable() : Throwable {
        return $this->throwable;
    }
    public function asString() : string {
        $message = $this->throwable
            ->message();
        if (!empty($message)) {
            $message = PHP_EOL . $message;
        }
        return sprintf('Before First Test Method Errored (%s::%s)%s', $this->calledMethod
            ->className(), $this->calledMethod
            ->methodName(), $message);
    }

}