Merge pull request #39 from clue-labs/tests

jsor · web-flow · commit 7c97bdc269e6 · 2018-04-02T19:11:03.000+02:00
Simplify test structure, improve test isolation and remove dbunit
diff --git a/README.md b/README.md
@@ -107,7 +107,7 @@ The test suite contains a number of functional integration tests that send
 actual test SQL queries against your local database and thus rely on a local
 MySQL test database with appropriate write access.
 The test suite creates and modifies a test table in this database, so make sure
-to not a production database!
+to not use a production database!
 You can change your test database credentials by passing these ENV variables:
 
 ```bash
@@ -118,6 +118,15 @@ $ export DB_PASSWD=test
 $ export DB_DBNAME=test
 ```
 
+For example, to create an empty test database, you can also use a temporary
+[`mysql` Docker image](https://hub.docker.com/_/mysql/) like this:
+
+```bash
+$ docker run -it --rm --net=host \
+    -e MYSQL_RANDOM_ROOT_PASSWORD=yes -e MYSQL_DATABASE=test \
+    -e MYSQL_USER=test -e MYSQL_PASSWORD=test mysql
+```
+
 To run the test suite, go to the project root and run:
 
 ```bash
diff --git a/composer.json b/composer.json
@@ -9,8 +9,7 @@
         "react/socket": "^1.0 || ^0.8"
     },
     "require-dev": {
-        "phpunit/dbunit": "1.4.*",
-        "ext-pdo_mysql": "*"
+        "phpunit/phpunit": "^4.8.35"
     },
     "autoload": {
         "psr-4": {
diff --git a/data/book.sql b/data/book.sql
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -23,7 +23,7 @@
         </whitelist>
     </filter>
     <php>
-        <env name="DB_HOST" value="localhost"/>
+        <env name="DB_HOST" value="127.0.0.1"/>
         <env name="DB_PORT" value="3306"/>
         <env name="DB_USER" value="test" />
         <env name="DB_PASSWD" value="test" />
diff --git a/tests/BaseTestCase.php b/tests/BaseTestCase.php
@@ -2,44 +2,13 @@
 
 namespace React\Tests\MySQL;
 
-class BaseTestCase extends \PHPUnit_Extensions_Database_TestCase
-{
-    private static $pdo;
-    private $conn;
-
-    protected function getConnection()
-    {
-        if ($this->conn === null) {
-            if (self::$pdo == null) {
-                $conf = $this->getConnectionOptions();
-                $dsn = 'mysql:host=' . $conf['host'] . ';port=' . $conf['port'] . ';dbname=' . $conf['dbname'];
-                self::$pdo = new \PDO($dsn, $conf['user'], $conf['passwd']);
-            }
-
-            self::$pdo->query('
-                CREATE TABLE IF NOT EXISTS `book` (
-                    `id`      INT(11)      NOT NULL AUTO_INCREMENT,
-                    `name`    VARCHAR(255) NOT NULL,
-                    `isbn`    VARCHAR(255) NULL,
-                    `author`  VARCHAR(255) NULL,
-                    `created` INT(11)      NULL,
-                    PRIMARY KEY (`id`)
-                )
-            ');
-
-            $this->conn = $this->createDefaultDBConnection(self::$pdo, ':memory:');
-        }
-
-        return $this->conn;
-    }
-
-    protected function getDataSet()
-    {
-        return new \PHPUnit_Extensions_Database_DataSet_YamlDataSet(__DIR__ . '/dataset.yaml');
-    }
+use PHPUnit\Framework\TestCase;
 
+class BaseTestCase extends TestCase
+{
     protected function getConnectionOptions()
     {
+        // can be controlled through ENV or by changing defaults in phpunit.xml
         return [
             'host'   => getenv('DB_HOST'),
             'port'   => (int)getenv('DB_PORT'),
@@ -49,6 +18,20 @@ protected function getConnectionOptions()
         ];
     }
 
+    protected function getDataTable()
+    {
+        return <<<SQL
+CREATE TABLE `book` (
+    `id`      INT(11)      NOT NULL AUTO_INCREMENT,
+    `name`    VARCHAR(255) NOT NULL,
+    `isbn`    VARCHAR(255) NULL,
+    `author`  VARCHAR(255) NULL,
+    `created` INT(11)      NULL,
+    PRIMARY KEY (`id`)
+)
+SQL;
+    }
+
     protected function expectCallableOnce()
     {
         $mock = $this->getMockBuilder('stdClass')->setMethods(array('__invoke'))->getMock();
diff --git a/tests/ConnectionTest.php b/tests/ConnectionTest.php
@@ -30,12 +30,11 @@ public function testConnectWithInvalidPassRejectsWithAuthenticationError()
 
         $conn->on('error', $this->expectCallableOnce());
 
-        $conn->connect(function ($err, $conn) use ($loop, $options) {
-            $this->assertEquals(sprintf(
-                "Access denied for user '%s'@'%s' (using password: YES)",
-                $options['user'],
-                $options['host']
-            ), $err->getMessage());
+        $conn->connect(function ($err, $conn) use ($loop) {
+            $this->assertRegExp(
+                "/^Access denied for user '.*?'@'.*?' \(using password: YES\)$/",
+                $err->getMessage()
+            );
             $this->assertInstanceOf('React\MySQL\Connection', $conn);
             $this->assertEquals(Connection::STATE_AUTHENTICATE_FAILED, $conn->getState());
         });
diff --git a/tests/NoResultQueryTest.php b/tests/NoResultQueryTest.php
@@ -2,39 +2,70 @@
 
 namespace React\Tests\MySQL;
 
-class NoResultQueryTest extends  BaseTestCase
+class NoResultQueryTest extends BaseTestCase
 {
-    public function testUpdateSimple()
+    public function setUp()
     {
         $loop = \React\EventLoop\Factory::create();
 
         $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
+        $connection->connect(function () {});
+
+        // re-create test "book" table
+        $connection->query('DROP TABLE IF EXISTS book');
+        $connection->query($this->getDataTable());
+
+        $connection->close();
+        $loop->run();
+    }
+
+    public function testUpdateSimpleNonExistentReportsNoAffectedRows()
+    {
+        $loop = \React\EventLoop\Factory::create();
 
+        $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
         $connection->connect(function () {});
-        $that  = $this;
 
-        $connection->query('update book set created=999 where id=1', function ($command, $conn) use ($loop) {
+        $connection->query('update book set created=999 where id=999', function ($command, $conn) {
             $this->assertEquals(false, $command->hasError());
-            $this->assertEquals(1, $command->affectedRows);
-            $loop->stop();
+            $this->assertEquals(0, $command->affectedRows);
         });
+
+        $connection->close();
         $loop->run();
     }
 
-    public function testInsertSimple()
+    public function testInsertSimpleReportsFirstInsertId()
     {
         $loop = \React\EventLoop\Factory::create();
 
         $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
+        $connection->connect(function () {});
 
+        $connection->query("insert into book (`name`) values ('foo')", function ($command, $conn) {
+            $this->assertEquals(false, $command->hasError());
+            $this->assertEquals(1, $command->affectedRows);
+            $this->assertEquals(1, $command->insertId);
+        });
+
+        $connection->close();
+        $loop->run();
+    }
+
+    public function testUpdateSimpleReportsAffectedRow()
+    {
+        $loop = \React\EventLoop\Factory::create();
+
+        $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
         $connection->connect(function () {});
 
-        $connection->query("insert into book (`name`) values('foo')", function ($command, $conn) use ($loop) {
+        $connection->query("insert into book (`name`) values ('foo')");
+        $connection->query('update book set created=999 where id=1', function ($command, $conn) {
             $this->assertEquals(false, $command->hasError());
             $this->assertEquals(1, $command->affectedRows);
-            $this->assertEquals(3, $command->insertId);
-            $loop->stop();
         });
+
+        $connection->close();
         $loop->run();
     }
 }
diff --git a/tests/ResultQueryTest.php b/tests/ResultQueryTest.php
@@ -11,12 +11,19 @@ public function testSimpleSelect()
         $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
         $connection->connect(function () {});
 
-        $connection->query('select * from book', function ($command, $conn) use ($loop) {
+        // re-create test "book" table
+        $connection->query('DROP TABLE IF EXISTS book');
+        $connection->query($this->getDataTable());
+        $connection->query("insert into book (`name`) values ('foo')");
+        $connection->query("insert into book (`name`) values ('bar')");
+
+        $connection->query('select * from book', function ($command, $conn) {
             $this->assertEquals(false, $command->hasError());
-            $this->assertEquals(2, count($command->resultRows));
+            $this->assertCount(2, $command->resultRows);
             $this->assertInstanceOf('React\MySQL\Connection', $conn);
-            $loop->stop();
         });
+
+        $connection->close();
         $loop->run();
     }
 
@@ -29,38 +36,49 @@ public function testInvalidSelect()
         $connection = new \React\MySQL\Connection($loop, $options);
         $connection->connect(function () {});
 
-        $connection->query('select * from invalid_table', function ($command, $conn) use ($loop, $db) {
+        $connection->query('select * from invalid_table', function ($command, $conn) use ($db) {
             $this->assertEquals(true, $command->hasError());
             $this->assertEquals("Table '$db.invalid_table' doesn't exist", $command->getError()->getMessage());
-
-            $loop->stop();
         });
+
+        $connection->close();
         $loop->run();
     }
 
     public function testEventSelect()
     {
+        $this->expectOutputString('result.result.results.end.');
         $loop = \React\EventLoop\Factory::create();
 
         $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
         $connection->connect(function () {});
 
+        // re-create test "book" table
+        $connection->query('DROP TABLE IF EXISTS book');
+        $connection->query($this->getDataTable());
+        $connection->query("insert into book (`name`) values ('foo')");
+        $connection->query("insert into book (`name`) values ('bar')");
+
         $command = $connection->query('select * from book');
         $command->on('results', function ($results, $command, $conn) {
             $this->assertEquals(2, count($results));
             $this->assertInstanceOf('React\MySQL\Commands\QueryCommand', $command);
             $this->assertInstanceOf('React\MySQL\Connection', $conn);
+            echo 'results.';
         });
         $command->on('result', function ($result, $command, $conn) {
                 $this->assertArrayHasKey('id', $result);
                 $this->assertInstanceOf('React\MySQL\Commands\QueryCommand', $command);
                 $this->assertInstanceOf('React\MySQL\Connection', $conn);
+                echo 'result.';
             })
-            ->on('end', function ($command, $conn) use ($loop) {
+            ->on('end', function ($command, $conn) {
                 $this->assertInstanceOf('React\MySQL\Commands\QueryCommand', $command);
                 $this->assertInstanceOf('React\MySQL\Connection', $conn);
-                $loop->stop();
+                echo 'end.';
             });
+
+        $connection->close();
         $loop->run();
     }
 
@@ -70,13 +88,14 @@ public function testSelectAfterDelay()
 
         $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
 
-        $callback = function () use ($connection, $loop) {
-            $connection->query('select 1+1', function ($command, $conn) use ($loop) {
+        $callback = function () use ($connection) {
+            $connection->query('select 1+1', function ($command, $conn) {
                 $this->assertEquals(false, $command->hasError());
                 $this->assertEquals([['1+1' => 2]], $command->resultRows);
-                $loop->stop();
             });
+            $connection->close();
         };
+
         $timeoutCb = function () use ($loop) {
             $loop->stop();
             $this->fail('Test timeout');
@@ -85,7 +104,11 @@ public function testSelectAfterDelay()
         $connection->connect(function ($err, $conn) use ($callback, $loop, $timeoutCb) {
             $this->assertEquals(null, $err);
             $loop->addTimer(0.1, $callback);
-            $loop->addTimer(1, $timeoutCb);
+
+            $timeout = $loop->addTimer(1, $timeoutCb);
+            $conn->on('close', function () use ($loop, $timeout) {
+                $loop->cancelTimer($timeout);
+            });
         });
 
         $loop->run();
diff --git a/tests/dataset.yaml b/tests/dataset.yaml
