<?php

/*
 * This file is part of the Behat Testwork.
 * (c) Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Behat\Testwork\Tester;

use Behat\Testwork\Environment\Environment;
use Behat\Testwork\Specification\SpecificationIterator;
use Behat\Testwork\Tester\Result\TestResult;
use Behat\Testwork\Tester\Setup\Setup;
use Behat\Testwork\Tester\Setup\Teardown;

/**
 * Prepares and tests provided suite specifications against provided environment.
 *
 * @author Konstantin Kudryashov <ever.zet@gmail.com>
 *
 * @template TSpec
 */
interface SuiteTester
{
    /**
     * Sets up suite for a test.
     *
     * @param Environment           $env
     * @param SpecificationIterator<TSpec> $iterator
     * @param bool               $skip
     *
     * @return Setup
     */
    public function setUp(Environment $env, SpecificationIterator $iterator, $skip);

    /**
     * Tests provided suite specifications.
     *
     * @param Environment           $env
     * @param SpecificationIterator<TSpec> $iterator
     * @param bool               $skip
     *
     * @return TestResult
     */
    public function test(Environment $env, SpecificationIterator $iterator, $skip);

    /**
     * Tears down suite after a test.
     *
     * @param Environment           $env
     * @param SpecificationIterator<TSpec> $iterator
     * @param bool               $skip
     * @param TestResult            $result
     *
     * @return Teardown
     */
    public function tearDown(Environment $env, SpecificationIterator $iterator, $skip, TestResult $result);
}
