PHPUnit में यूनिट टेस्ट की स्वायत्तता

सभी को नमस्कार!

मेरा नाम एंटोन है और अब (इतना लंबा नहीं है, एक साल के बारे में) मैं एक बड़े और पुराने प्रोजेक्ट में PHP में विकास कर रहा हूं। परियोजना की गुणवत्ता सुनिश्चित करने के लिए, हम PHPUnit ढांचे पर ऑटोटेस्ट का उपयोग करते हैं। लेकिन, दुर्भाग्य से, ऐसा हुआ कि हमारे अधिकांश ऑटोटेस्ट कार्यात्मक हैं। हाल ही में, हमने महसूस किया कि अगर हम इसी तरह से ऑटोटेस्ट्स का उपयोग करना जारी रखते हैं, तो जल्द ही समस्याओं को हल करने में लगने वाला समय सीआई के पास न होने के कारण उपयोगी कोड लिखने में लगने वाले समय से अधिक हो जाएगा (वास्तव में नहीं, लेकिन यह बढ़ता है और यह नहीं है अच्छी तरह से)।

इस समस्या के एक व्यवस्थित समाधान के लिए, हमने एक दृष्टिकोण चुना जिसमें कई यूनिट परीक्षण और न्यूनतम संख्या में कार्यात्मक परीक्षण लिखना शामिल है। हमने यह भी निर्णय लिया कि स्काउट नियम के अनुसार आवश्यक मौजूदा कोड में परिवर्तन के हिस्से के रूप में, मौजूदा परीक्षणों को अपडेट करें। थोड़ी देर के लिए - यह सब समय हमने नई विशेषताओं को देखा - हमारे साथ सब कुछ ठीक था। लेकिन हाल ही में, एक कार्य ने पुराने कोड में एक बग को ठीक करने के लिए मुझसे उड़ान भरी। मैंने यूनिट टेस्ट लिखना शुरू किया और महसूस किया कि प्राचीन दुष्ट विरासत जाग गई। यह स्पष्ट हो गया कि यह कहीं का रास्ता है:

• मैंने कई घंटों तक कुछ परीक्षण मामलों को लिखा;
• मुझे महसूस हुआ कि इस दौरान मैंने एक बहुत, बहुत से दोहराए गए कोड लिखे;
• वास्तव में कोई उपयोगी काम नहीं किया;
• डि में बदलाव के मामले में, आपको परीक्षण कोड के बेकार अनुकूलन पर बहुत समय बिताना होगा।

यह लेख इस बारे में है कि मैंने कैसे वैधता कोड लिखने से इनकार करने की समस्या को हल किया। कट के तहत - परीक्षण के मामले का अंतिम रूप, अधिकांश यांत्रिक कोड के अपवाद के साथ

लेख का शीर्षक कंबन शैली में स्वचालन को संदर्भित करता है - एक तरफ, हमने स्वचालन किया, और दूसरी ओर, सभी प्रमुख निर्णय एक व्यक्ति द्वारा किए जाते हैं।

कैसे किया

<?php declare(strict_types=1);
namespace Company\Bundle\Tests\Unit\Service;

use PHPUnit_Framework_MockObject_MockObject;

/**
 * @method \Company\Bundle\Service\TestedService getTestedClass()
 * @property PHPUnit_Framework_MockObject_MockObject|\Company\AnotherBundle\Repository\DependencyRepository $dependencyRepository
 * @property ConstDependencyInjectionParameter $diConstParam
 */
class TestedServiceTest extends Intelligent_PHPUnit_Framework_TestCase
{
    /**
     * @throws \Exception
     */
    public function test_getData_DataDescripion_ResultDescription(): void
    {
        // data
        $this
            ->diConstParam
            ->set("value")
        ;

        // behaviour
        $this
            ->dependencyRepository
            ->expects($this->once())
            ->method('findData')
            ->with(10, 10)
            ->will($this->returnValue([]))
        ;

        // SUT
        $clazz = $this->getTestedClass();

        // act
        $res = $clazz->getData();

        // asserts
    }
}

जैसे थे

खराब था। निर्भरता के लिए मॉब्स की पीढ़ी से एक अंतहीन स्पेगेटी थी, परीक्षण के मामले में कंस्ट्रक्टर को एक लंबी कॉल। सामान्य तौर पर, यह बदसूरत था, और कहीं न कहीं लेख के निचले भाग में इस तरह के परीक्षण का एक उल्लेखनीय रूप से उदाहरण दिया गया है।

हमारी स्थितियों में थोड़ा दर्द

दुर्भाग्य से, हमारी परियोजना PHPUnit 3.x का उपयोग करती है। हां, मुझे पता है कि यह 2014 (!) वर्ष से पहले ही समर्थित होना बंद हो गया था, लेकिन, दुर्भाग्य से, हम इसे स्थानीय समय के पैमाने पर मना नहीं कर सकते।

हल किए गए मुद्दे

, — , , . , — (, , 20) -, , , unit- , .

, , « » :

1. setUp.
2. tearDown. , ,
3. -.

कोड के टुकड़े दोहराने पर विचार करें।

नकली पीढ़ी

$this->service = $this
    ->getMockBuilder(Service::class)
    ->disableOriginalConstructor()
    ->getMock()
;

एक नीरस काम को छिपाने के लिए PHP के पास एक अच्छा उम्मीदवार है - एक जादुई कार्य:

__प्राप्त

लेकिन हमें अभी भी उस प्रकार को व्यक्त करना होगा जिसे हम गीला कर रहे हैं। और फिर एक उपयुक्त उपकरण मिला - phpDoc:

@property प्रकार $ सेवा

@property \ FQCN \ Service | \ PHPUnit_Framework_MockObject_MockObject $ सेवा

सार वर्ग Intellegence_PHPUnit_Framework_TestCase के __get फ़ंक्शन के अंदर, मेटाप्रोग्रामिंग होती है, जो phpDoc को पार्स करती है और इसके आधार पर मोक्स बनाती है, जो परीक्षण वर्ग में $-> प्रॉपर्टीनाम पर उपलब्ध हैं। ध्यान दें, लेख में दिए गए सभी कोड थोड़ा छद्म कोड है, पूर्ण संस्करण रिपॉजिटरी में है:

abstract class Intelligent_PHPUnit_Framework_TestCase extends PHPUnit_Framework_TestCase {
   public function __get(string $name)
    {
        // propertyBag     ,        phpDoc property
        $property = $this->getPropertyBag()->get($name);
        if ($property === false) {
            throw new Exception("Invalid property name: ${name}");
        }

        return $property;
    }

    private function getPropertyBag(): PropertyBag
    {
            if ($this->propertyBag === null) {
               //     
               $this->propertyBag = (new DocCommentParser())
                   ->parse(
                        //    phpDoc   FQCN .   FQCN  ,      
                        get_class($this),
                        //     callback,   getMockBuilder -     unit-
                        function (string $className): PHPUnit_Framework_MockObject_MockObject {
                            return $this->createDefaultObjectMock($className);
                        }
                    );
            }

            return $this->propertyBag;
    }
}

, phpDoc . :

class DocCommentParser
{
    /**
     * @param string $className
     * @param callable $mockCreator
     * @throws Exception
     * @return PropertyBag
     */
    public function parse(
        string $className,
        callable $mockCreator
    ): PropertyBag {
        /** @var string[] $res */
        $r = new ReflectionClass($className);
        //   phpDoc
        $docComment = $r->getDocComment();

        if ($docComment === false) {
            return new PropertyBag([]);
        }

        return $this->parseDocString($docComment, $mockCreator);
    }

    private function parseDocString(
        string $docComment,
        callable $mockCreator
    ): PropertyBag {
        /** @var string[] $map */
        $map = [];
        /** @var string[] $constructorParams */
        $constructorParams = [];

        //   -  : property Type1|Type2 $propertyName
        //    mock,   DI     ,   
        preg_match_all('/@property\s*(?<mock>(\S*)\|(\S+)\s*\$(\S+))/', $docComment, $matches, PREG_SET_ORDER);
        foreach ($matches as $match) {
            if (array_key_exists('mock', $match) && !empty($match['mock'])) {
                //        -    
                //   
                if ($this->isMockObject($match[2])) {
                    $map[$match[4]] = $mockCreator($match[3]);
  
                    continue;
                }

                if ($this->isMockObject($match[3])) {
                    $map[$match[4]] = $mockCreator($match[2]);

                    continue;
                }
            }
        }

        return new PropertyBag($map);
    }
}

? , — FQCN phpDoc property . — , .

class ServiceTest extends PHPUnit_Framework_TestCase
{
    /** @var DependencyRepository|PHPUnit_Framework_MockObject_MockBuilder */
    private $repository;
    protected function setUp()
    {
        parent::setUp();
        $this
            ->repository = $this->getMockBuilder(DependencyRepository::class)
            ->disableOriginalConstructor()
            ->getMock()
        ;    
    }

    protected function tearDown()
    {
        $this->repository = null;
        parent::tearDown();
    }

    public function test_test()
    {
         // $this->repository = ...
    }
}

/** @property PHPUnit_Framework_MockObject_MockObject|\Company\AnotherBundle\Repository\DependencyRepository $repository */
class ServiceTest extends Intelligent_PHPUnit_Framework_TestCase
{
    public function test_test()
    {
         // $this->repository = ...
    }
}

3-4-5 ( ) — . , , , 7 — . , 20 — -.

. ! -, , .

:

public function test_case()
{
    // SUT
    //   , ,    DI    .
    // ,      DI.
    $this->clazz = $this->createTestClass(
        $dependency1,
        $dependency2,
        $dependency3 //, ...
    );
}

, . php __call, phpDoc method.

, , ?! , property! , . , property — . — , .

, :

/**
 * @method FQCN\TestedService getTestedClass()
 */
class ServiceTest
{
    public function test_case()
    {
         // SUT
         $clazz = $this->getTestedClass();
    }
}

__call:

abstract class Intelligent_PHPUnit_Framework_TestCase extends PHPUnit_Framework_TestCase
{
    private const GET_TESTED_CLASS_METHOD_NAME = 'getTestedClass';

    /**
     * @param string $method
     * @param array $params
     * @throws Exception
     * @return object
     */
    public function __call(string $method, array $params)
    {
        if ($method !== self::GET_TESTED_CLASS_METHOD_NAME) {
            throw new Exception("Invalid method name: ${method}");
        }

        if (!array_key_exists(self::GET_TESTED_CLASS_METHOD_NAME, $this->getMethodsMap())) {
            throw new Exception('Method ' . self::GET_TESTED_CLASS_METHOD_NAME . ' not annotated');
        }

        //  ,  PropertyBag        property -    
        $params = $this->getPropertyBag()->getConstructorParams();
        $paramValues = [];
        foreach ($params as $param) {
            $property = $this->__get($param);
            $paramValues[] = $property;
        }

        $reflection = new ReflectionClass($this->getMethodsMap()[self::GET_TESTED_CLASS_METHOD_NAME]);
        //         
        return $reflection->newInstanceArgs($paramValues);
    }
}

? property:

class DocCommentParser
{
    /**
     * @param string $className
     * @param callable $mockCreator
     * @throws Exception
     * @return PropertyBag
     */
    public function parse(
        string $className,
        callable $mockCreator
    ): PropertyBag {
        /** @var string[] $res */
        $r = new ReflectionClass($className);
        $docComment = $r->getDocComment();

        if ($docComment === false) {
            //     
            return new PropertyBag([], []);
        }

        return $this->parseDocString($docComment, $mockCreator);
    }

    private function parseDocString(
        string $docComment,
        callable $mockCreator
    ): PropertyBag {
        /** @var string[] $map */
        $map = [];
        /** @var string[] $constructorParams */
        $constructorParams = [];

        preg_match_all('/@property\s*(?<mock>(\S*)\|(\S+)\s*\$(\S+))/', $docComment, $matches, PREG_SET_ORDER);
        foreach ($matches as $match) {
            if (array_key_exists('mock', $match) && !empty($match['mock'])) {
                if ($this->isMockObject($match[2])) {
                    $map[$match[4]] = $mockCreator($match[3]);
                    //    
                    $constructorParams[] = $match[4];

                    continue;
                }

                if ($this->isMockObject($match[3])) {
                    $map[$match[4]] = $mockCreator($match[2]);
                    //    
                    $constructorParams[] = $match[4];

                    continue;
                }
            }
        }

        return new PropertyBag($map, $constructorParams);
    }
}

. , . , DI - , , , — ,

class ServiceTest extends PHPUnit_Framework_TestCase
{
    /** @var DependencyRepository|PHPUnit_Framework_MockObject_MockBuilder */
    private $repository;
    protected function setUp()
    {
        parent::setUp();
        $this
            ->repository = $this->getMockBuilder(DependencyRepository::class)
            ->disableOriginalConstructor()
            ->getMock()
        ;    
    }

    protected function tearDown()
    {
        $this->repository = null;
        parent::tearDown();
    }

    public function test_test()
    {
        $this->clazz = $this->createTestClass(repository);
    }

    private function createTestClass() {
        return new TestedService($repository)
    }
}

ConstDependencyInjectionParameter. , .