Add custom exception to ensure unified error messages.

Author: TiSiE

src/Exception/ExceptionInterface.php

@@ -0,0 +1,22 @@
+<?php
+/**
+ * CROSS PHPunit Utils
+ *
+ * @filesource
+ * @copyright 2019 Cross Solution <https://www.cross-solution.de>
+ * @license MIT
+ */
+
+declare(strict_types=1);
+
+namespace Cross\TestUtils\Exception;
+
+/**
+ * Marker interface for package exceptions.
+ *
+ * @author Mathias Gelhausen <gelhausen@cross-solution.de>
+ */
+interface ExceptionInterface
+{
+
+}

src/Exception/InvalidUsageException.php

@@ -0,0 +1,23 @@
+<?php
+/**
+ * CROSS PHPunit Utils
+ *
+ * @filesource
+ * @copyright 2019 Cross Solution <https://www.cross-solution.de>
+ * @license MIT
+ */
+
+declare(strict_types=1);
+
+namespace Cross\TestUtils\Exception;
+
+/**
+ * Exception thrown if a helper trait is used the wrong way
+ *
+ * @author Mathias Gelhausen <gelhausen@cross-solution.de>
+ * @todo write tests
+ */
+class InvalidUsageException extends \PHPUnit_Framework_Exception implements ExceptionInterface
+{
+    use TemplatedMessageExceptionTrait;
+}

src/Exception/TemplatedMessageExceptionTrait.php

@@ -0,0 +1,38 @@
+<?php
+/**
+ * CROSS PHPunit Utils
+ *
+ * @filesource
+ * @copyright 2019 Cross Solution <https://www.cross-solution.de>
+ * @license MIT
+ */
+
+declare(strict_types=1);
+
+namespace Cross\TestUtils\Exception;
+
+/**
+ * Boilerplate for an exception with templated message.
+ *
+ * @author Mathias Gelhausen <gelhausen@cross-solution.de>
+ * @todo write tests
+ */
+trait TemplatedMessageExceptionTrait
+{
+    public static function create(...$args): \Exception
+    {
+        $ex      = end($args) instanceof \Throwable ? array_pop($args) : null;
+        $message = sprintf(...$args);
+
+        return new static($message, 0, $ex);
+    }
+
+    public static function fromTrait(string $trait, string $class, string $message, ...$args): \Exception
+    {
+        if (count($args)) {
+            $message = sprintf($message, ...$args);
+        }
+
+        return static::create('%s: %s: %s', $trait, $class, $message);
+    }
+}

test/TestUtilsTest/Exception/InvalidUsageExceptionTest.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * CROSS PHPunit Utils
+ *
+ * @filesource
+ * @copyright 2019 Cross Solution <https://www.cross-solution.de>
+ * @license MIT
+ */
+
+declare(strict_types=1);
+
+namespace Cross\TestUtilsTest\Exception;
+
+use Cross\TestUtils\Exception\ExceptionInterface;
+use Cross\TestUtils\Exception\InvalidUsageException;
+use Cross\TestUtils\Exception\TemplatedMessageExceptionTrait;
+
+use Cross\TestUtils\TestCase\TestUsesTraitsTrait;
+use Cross\TestUtils\TestCase\TestInheritanceTrait;
+
+/**
+ * Tests for \Cross\TestUtils\Exception\InvalidUsageException
+ *
+ * @covers \Cross\TestUtils\Exception\InvalidUsageException
+ * @author Mathias Gelhausen <gelhausen@cross-solution.de>
+ *
+ * @group Cross.TestUtils
+ * @group Cross.TestUtils.Exception
+ * @group Cross.TestUtils.Exception.InvalidUsageException
+ */
+class InvalidUsageExceptionTest extends \PHPUnit_Framework_TestCase
+{
+    use TestInheritanceTrait, TestUsesTraitsTrait;
+
+    private $target = InvalidUsageException::class;
+    private $inheritance = [ \PHPUnit_Framework_Exception::class, ExceptionInterface::class ];
+    private $usesTraits  = [ TemplatedMessageExceptionTrait::class ];
+
+}

test/TestUtilsTest/Exception/TemplatedMessageExceptionTraitTest.php

@@ -0,0 +1,50 @@
+<?php
+/**
+ * CROSS PHPunit Utils
+ *
+ * @filesource
+ * @copyright 2019 Cross Solution <https://www.cross-solution.de>
+ * @license MIT
+ */
+
+declare(strict_types=1);
+
+namespace Cross\TestUtilsTest\Exception;
+
+use Cross\TestUtils\Exception\InvalidUsageException;
+
+/**
+ * Tests for \Cross\TestUtils\Exception\TemplatedMessageExceptionTrait
+ *
+ * @covers \Cross\TestUtils\Exception\TemplatedMessageExceptionTrait
+ * @author Mathias Gelhausen <gelhausen@cross-solution.de>
+ *
+ * @group Cross.TestUtils
+ * @group Cross.TestUtils.Exception
+ * @group Cross.TestUtils.Exception.TemplatedMessageExceptionTrait
+ */
+class TemplatedMessageExceptionTraitTest extends \PHPUnit_Framework_TestCase
+{
+    public function testCreateWithoutPrevious()
+    {
+        $target = InvalidUsageException::create('%s %s', 'value1', 'value2');
+
+        static::assertEquals('value1 value2', $target->getMessage());
+    }
+
+    public function testCreateWithPrevious()
+    {
+        $ex = new \Exception;
+        $target = InvalidUsageException::create('%s', 'value1', $ex);
+
+        static::assertEquals('value1', $target->getMessage());
+        static::assertSame($ex, $target->getPrevious());
+    }
+
+    public function testFromTrait()
+    {
+        $target = InvalidUsageException::fromTrait('TRAIT', 'CLASS', '%s', 'value1');
+
+        static::assertEquals('TRAIT: CLASS: value1', $target->getMessage());
+    }
+}