added more assert* methods to Asserts module. Fix #2973

Author: DavertMik

src/Codeception/Module/Asserts.php

@@ -41,6 +41,7 @@ public function assertNotEquals($expected, $actual, $message = '')
      * @param        $expected
      * @param        $actual
      * @param string $message
+     * @return mixed|void
      */
     public function assertSame($expected, $actual, $message = '')
     {
@@ -261,6 +262,85 @@ public function assertFileNotExists($filename, $message = '')
         parent::assertFileNotExists($filename, $message);
     }
 
+    /**
+     * @param $expected
+     * @param $actual
+     * @param $description
+     */
+    public function assertGreaterOrEquals($expected, $actual, $description = null)
+    {
+        parent::assertGreaterThanOrEqual($expected, $actual, $description);
+    }
+
+    /**
+     * @param $expected
+     * @param $actual
+     * @param $description
+     */
+    public function assertLessOrEquals($expected, $actual, $description = null)
+    {
+        parent::assertLessThanOrEqual($expected, $actual, $description);
+    }
+
+    /**
+     * @param $actual
+     * @param $description
+     */
+    public function assertIsEmpty($actual, $description = null)
+    {
+        parent::assertEmpty($actual, $description);
+    }
+
+    /**
+     * @param $key
+     * @param $actual
+     * @param $description
+     */
+    public function assertArrayHasKey($key, $actual, $description = null)
+    {
+        parent::assertArrayHasKey($key, $actual, $description);
+    }
+
+    /**
+     * @param $key
+     * @param $actual
+     * @param $description
+     */
+    public function assertArrayNotHasKey($key, $actual, $description = null)
+    {
+        parent::assertArrayNotHasKey($key, $actual, $description);
+    }
+
+    /**
+     * @param $class
+     * @param $actual
+     * @param $description
+     */
+    public function assertInstanceOf($class, $actual, $description = null)
+    {
+        parent::assertInstanceOf($class, $actual, $description);
+    }
+
+    /**
+     * @param $class
+     * @param $actual
+     * @param $description
+     */
+    public function assertNotInstanceOf($class, $actual, $description = null)
+    {
+        parent::assertNotInstanceOf($class, $actual, $description);
+    }
+
+    /**
+     * @param $type
+     * @param $actual
+     * @param $description
+     */
+    public function assertInternalType($type, $actual, $description = null)
+    {
+        parent::assertInternalType($type, $actual, $description);
+    }
+
     /**
      * Fails the test with message.
      *
@@ -270,4 +350,60 @@ public function fail($message)
     {
         parent::fail($message);
     }
+
+    /**
+     * Handles and checks exception called inside callback function.
+     * Either exception class name or exception instance should be provided.
+     *
+     * ```php
+     * <?php
+     * $I->expectException(MyException::class, function() {
+     *     $this->doSomethingBad();
+     * });
+     *
+     * $I->expectException(new MyException(), function() {
+     *     $this->doSomethingBad();
+     * });
+     * ```
+     * If you want to check message or exception code, you can pass them with exception instance:
+     * ```php
+     * <?php
+     * // will check that exception MyException is thrown with "Don't do bad things" message
+     * $I->expectException(new MyException("Don't do bad things"), function() {
+     *     $this->doSomethingBad();
+     * });
+     * ```
+     *
+     * @param $exception string or \Exception
+     * @param $callback
+     */
+    public function expectException($exception, $callback)
+     {
+         $code = null;
+         $msg = null;
+         if (is_object($exception)) {
+             /** @var $exception \Exception  **/
+             $class = get_class($exception);
+             $msg = $exception->getMessage();
+             $code = $exception->getCode();
+         } else {
+             $class = $exception;
+         }
+         try {
+             $callback();
+         } catch (\Exception $e) {
+             if (!$e instanceof $class) {
+                 $this->fail(sprintf("Exception of class $class expected to be thrown, but %s caught", get_class($e)));
+             }
+             if (null !== $msg and $e->getMessage() !== $msg) {
+                 $this->fail(sprintf("Exception of $class expected to be '$msg', but actual message was '%s'", $e->getMessage()));
+             }
+             if (null !== $code and $e->getCode() !== $code) {
+                 $this->fail(sprintf("Exception of $class expected to have code $code, but actual code was %s", $e->getCode()));
+             }
+             $this->assertTrue(true); // increment assertion counter
+             return;
+         }
+         $this->fail("Expected exception to be thrown, but nothing was caught");
+     }
 }

tests/unit/Codeception/Module/AssertsTest.php

@@ -7,7 +7,7 @@ public function testAsserts()
         $module->assertEquals(1,1);
         $module->assertContains(1,[1,2]);
         $module->assertSame(1,1);
-        $module->assertNotSame(1,true);
+        $module->assertNotSame(1, '1');
         $module->assertRegExp('/^[\d]$/','1');
         $module->assertNotRegExp('/^[a-z]$/','1');
         $module->assertEmpty([]);
@@ -20,6 +20,24 @@ public function testAsserts()
         $module->assertFalse(false);
         $module->assertFileExists(__FILE__);
         $module->assertFileNotExists(__FILE__ . '.notExist');
+        $module->assertInstanceOf('Exception', new Exception());
+        $module->assertInternalType('integer', 5);
+        $module->assertArrayHasKey('one', ['one' => 1, 'two' => 2]);
+    }
+
+    public function testExceptions()
+    {
+        $module = new \Codeception\Module\Asserts(make_container());
+        $module->expectException('Exception', function() { throw new Exception; });
+        $module->expectException(new Exception('here'), function() { throw new Exception('here'); });
+        $module->expectException(new Exception('here', 200), function() { throw new Exception('here', 200); });
+    }
+
+    public function testExceptionFails()
+    {
+        $module = new \Codeception\Module\Asserts(make_container());
+        $this->expectException('PHPUnit_Framework_AssertionFailedError');
+        $module->expectException(new Exception('here', 200), function() { throw new Exception('here', 2); });
     }
 
 }