MatchesSnapshots::assertMatchesSnapshot() - Code Metrics - Inspection of "add a file hash driver" - spatie/phpunit-snapshot-assertions - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#30)

unknown

created 2017-10-01 12:15 UTC

MatchesSnapshots::assertMatchesSnapshot() A

↳ Parent: MatchesSnapshots

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	2

<?php

namespace Spatie\Snapshots;

use Exception;
use PHPUnit\Framework\ExpectationFailedException;
use PHPUnit_Framework_ExpectationFailedException;
use ReflectionClass;
use ReflectionObject;
use Spatie\Snapshots\Drivers\FileHashDriver;
use Spatie\Snapshots\Drivers\JsonDriver;
use Spatie\Snapshots\Drivers\VarDriver;
use Spatie\Snapshots\Drivers\XmlDriver;

trait MatchesSnapshots
{
    /** @var int */
    protected $snapshotIncrementor;

    /** @before */
    public function setUpSnapshotIncrementor()
    {
        $this->snapshotIncrementor = 0;
    }

    public function assertMatchesSnapshot($actual, Driver $driver = null)
    {
        $this->doSnapshotAssertion($actual, $driver ?? new VarDriver());
    }

    public function assertMatchesXmlSnapshot($actual)
    {
        $this->assertMatchesSnapshot($actual, new XmlDriver());
    }

    public function assertMatchesJsonSnapshot($actual)
    {
        $this->assertMatchesSnapshot($actual, new JsonDriver());
    }

    public function assertMatchesFileHashSnapshot($filePath)
    {
        if (! file_exists($filePath)) {
            throw new Exception('File does not exist');
        }

        $actual = sha1_file($filePath);

        $this->assertMatchesSnapshot($actual, new FileHashDriver());
    }

    /**
     * Determines the snapshot's id. By default, the test case's class and
     * method names are used.
     *
     * @return string
     */
    protected function getSnapshotId(): string
    {
        return (new ReflectionClass($this))->getShortName().'__'.
            $this->getName().'__'.
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $this->snapshotIncrementor;
    }

    /**
     * Determines the directory where snapshots are stored. By default a
     * `__snapshots__` directory is created at the same level as the test
     * class.
     *
     * @return string
     */
    protected function getSnapshotDirectory(): string
    {
        return dirname((new ReflectionClass($this))->getFileName()).
            DIRECTORY_SEPARATOR.
            '__snapshots__';
    }

    /**
     * Determines whether or not the snapshot should be updated instead of
     * matched.
     *
     * Override this method it you want to use a different flag or mechanism
     * than `-d --update-snapshots`.
     *
     * @return bool
     */
    protected function shouldUpdateSnapshots(): bool
    {
        return in_array('--update-snapshots', $_SERVER['argv'], true);
    }

    protected function doSnapshotAssertion($actual, Driver $driver)
    {
        $this->snapshotIncrementor++;

        $snapshot = Snapshot::forTestCase(
            $this->getSnapshotId(),
            $this->getSnapshotDirectory(),
            $driver
        );

        if (! $snapshot->exists()) {
            $this->createSnapshotAndMarkTestIncomplete($snapshot, $actual);
        }

        if ($this->shouldUpdateSnapshots()) {
            try {
                // We only want to update snapshots which need updating. If the snapshot doesn't
                // match the expected output, we'll catch the failure, create a new snapshot and
                // mark the test as incomplete.
                $snapshot->assertMatches($actual);
            } catch (ExpectationFailedException $exception) {
                $this->updateSnapshotAndMarkTestIncomplete($snapshot, $actual);
            } catch (PHPUnit_Framework_ExpectationFailedException $exception) {

                $this->updateSnapshotAndMarkTestIncomplete($snapshot, $actual);
            }
        }

        try {
            $snapshot->assertMatches($actual);
        } catch (ExpectationFailedException $exception) {
            $this->rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception);
        } catch (PHPUnit_Framework_ExpectationFailedException $exception) {

            $this->rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception);
        }
    }

    protected function createSnapshotAndMarkTestIncomplete(Snapshot $snapshot, $actual)
    {
        $snapshot->create($actual);

        $this->markTestIncomplete("Snapshot created for {$snapshot->id()}");

    }

    protected function updateSnapshotAndMarkTestIncomplete(Snapshot $snapshot, $actual)
    {
        $snapshot->create($actual);

        $this->markTestIncomplete("Snapshot updated for {$snapshot->id()}");

    }

    protected function rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception)
    {
        $newMessage = $exception->getMessage()."\n\n".
            'Snapshots can be updated by passing '.
            '`-d --update-snapshots` through PHPUnit\'s CLI arguments.';

        $exceptionReflection = new ReflectionObject($exception);

        $messageReflection = $exceptionReflection->getProperty('message');
        $messageReflection->setAccessible(true);
        $messageReflection->setValue($exception, $newMessage);

        throw $exception;
    }
}


1			<?php
2
3			namespace Spatie\Snapshots;
4
5			use Exception;
6			use PHPUnit\Framework\ExpectationFailedException;
7			use PHPUnit_Framework_ExpectationFailedException;
8			use ReflectionClass;
9			use ReflectionObject;
10			use Spatie\Snapshots\Drivers\FileHashDriver;
11			use Spatie\Snapshots\Drivers\JsonDriver;
12			use Spatie\Snapshots\Drivers\VarDriver;
13			use Spatie\Snapshots\Drivers\XmlDriver;
14
15			trait MatchesSnapshots
16			{
17			/** @var int */
18			protected $snapshotIncrementor;
19
20			/** @before */
21			public function setUpSnapshotIncrementor()
22			{
23			$this->snapshotIncrementor = 0;
24			}
25
26			public function assertMatchesSnapshot($actual, Driver $driver = null)
27			{
28			$this->doSnapshotAssertion($actual, $driver ?? new VarDriver());
29			}
30
31			public function assertMatchesXmlSnapshot($actual)
32			{
33			$this->assertMatchesSnapshot($actual, new XmlDriver());
34			}
35
36			public function assertMatchesJsonSnapshot($actual)
37			{
38			$this->assertMatchesSnapshot($actual, new JsonDriver());
39			}
40
41			public function assertMatchesFileHashSnapshot($filePath)
42			{
43			if (! file_exists($filePath)) {
44			throw new Exception('File does not exist');
45			}
46
47			$actual = sha1_file($filePath);
48
49			$this->assertMatchesSnapshot($actual, new FileHashDriver());
50			}
51
52			/**
53			* Determines the snapshot's id. By default, the test case's class and
54			* method names are used.
55			*
56			* @return string
57			*/
58			protected function getSnapshotId(): string
59			{
60			return (new ReflectionClass($this))->getShortName().'__'.
61			$this->getName().'__'.
			0 ignored issues – show Bug introduced 2017-03-27 13:08 UTC by Report Bug Copy Issue Report It seems like `getName()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
62			$this->snapshotIncrementor;
63			}
64
65			/**
66			* Determines the directory where snapshots are stored. By default a
67			* `__snapshots__` directory is created at the same level as the test
68			* class.
69			*
70			* @return string
71			*/
72			protected function getSnapshotDirectory(): string
73			{
74			return dirname((new ReflectionClass($this))->getFileName()).
75			DIRECTORY_SEPARATOR.
76			'__snapshots__';
77			}
78
79			/**
80			* Determines whether or not the snapshot should be updated instead of
81			* matched.
82			*
83			* Override this method it you want to use a different flag or mechanism
84			* than `-d --update-snapshots`.
85			*
86			* @return bool
87			*/
88			protected function shouldUpdateSnapshots(): bool
89			{
90			return in_array('--update-snapshots', $_SERVER['argv'], true);
91			}
92
93			protected function doSnapshotAssertion($actual, Driver $driver)
94			{
95			$this->snapshotIncrementor++;
96
97			$snapshot = Snapshot::forTestCase(
98			$this->getSnapshotId(),
99			$this->getSnapshotDirectory(),
100			$driver
101			);
102
103			if (! $snapshot->exists()) {
104			$this->createSnapshotAndMarkTestIncomplete($snapshot, $actual);
105			}
106
107			if ($this->shouldUpdateSnapshots()) {
108			try {
109			// We only want to update snapshots which need updating. If the snapshot doesn't
110			// match the expected output, we'll catch the failure, create a new snapshot and
111			// mark the test as incomplete.
112			$snapshot->assertMatches($actual);
113			} catch (ExpectationFailedException $exception) {
114			$this->updateSnapshotAndMarkTestIncomplete($snapshot, $actual);
115			} catch (PHPUnit_Framework_ExpectationFailedException $exception) {
			0 ignored issues – show Bug introduced 2017-03-27 13:28 UTC by Report Bug Copy Issue Report The class `PHPUnit_Framework_ExpectationFailedException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
116			$this->updateSnapshotAndMarkTestIncomplete($snapshot, $actual);
117			}
118			}
119
120			try {
121			$snapshot->assertMatches($actual);
122			} catch (ExpectationFailedException $exception) {
123			$this->rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception);
124			} catch (PHPUnit_Framework_ExpectationFailedException $exception) {
			0 ignored issues – show Bug introduced 2017-05-29 08:50 UTC by Report Bug Copy Issue Report The class `PHPUnit_Framework_ExpectationFailedException` does not exist. Is this class maybe located in a folder that is not analyzed, or in a newer version of your dependencies than listed in your composer.lock/composer.json? Loading history...
125			$this->rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception);
126			}
127			}
128
129			protected function createSnapshotAndMarkTestIncomplete(Snapshot $snapshot, $actual)
130			{
131			$snapshot->create($actual);
132
133			$this->markTestIncomplete("Snapshot created for {$snapshot->id()}");
			0 ignored issues – show Bug introduced 2017-05-29 08:50 UTC by Report Bug Copy Issue Report The method `markTestIncomplete()` does not exist on `Spatie\Snapshots\MatchesSnapshots`. Did you maybe mean `createSnapshotAndMarkTestIncomplete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
134			}
135
136			protected function updateSnapshotAndMarkTestIncomplete(Snapshot $snapshot, $actual)
137			{
138			$snapshot->create($actual);
139
140			$this->markTestIncomplete("Snapshot updated for {$snapshot->id()}");
			0 ignored issues – show Bug introduced 2017-05-29 08:50 UTC by Report Bug Copy Issue Report The method `markTestIncomplete()` does not exist on `Spatie\Snapshots\MatchesSnapshots`. Did you maybe mean `createSnapshotAndMarkTestIncomplete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
141			}
142
143			protected function rethrowExpectationFailedExceptionWithUpdateSnapshotsPrompt($exception)
144			{
145			$newMessage = $exception->getMessage()."\n\n".
146			'Snapshots can be updated by passing '.
147			'`-d --update-snapshots` through PHPUnit\'s CLI arguments.';
148
149			$exceptionReflection = new ReflectionObject($exception);
150
151			$messageReflection = $exceptionReflection->getProperty('message');
152			$messageReflection->setAccessible(true);
153			$messageReflection->setValue($exception, $newMessage);
154
155			throw $exception;
156			}
157			}
158

spatie / phpunit-snapshot-assertions

GitHub Access Token became invalid

Pull Request — master (#30)

MatchesSnapshots::assertMatchesSnapshot() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like