Merge pull request #34 from clue-labs/tests

Add test instructions and Travis CI

Author: WyriHaximus

.gitignore

@@ -1,4 +1,2 @@
-.*
-*.lock
-vendor
-phpunit.xml
+vendor/
+composer.lock

.travis.yml

@@ -0,0 +1,31 @@
+language: php
+
+php:
+  - 5.4
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
+  - 7.2
+  - hhvm # ignore errors, see below
+
+# lock distro so new future defaults will not break the build
+dist: trusty
+
+matrix:
+  allow_failures:
+    - php: hhvm
+
+services:
+  - mysql
+
+sudo: false
+
+install:
+  - composer install --no-interaction
+
+before_script:
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS test;'
+
+script:
+  - DB_USER=root DB_PASSWD= ./vendor/bin/phpunit --coverage-text

README.md

@@ -1,5 +1,7 @@
 # MySQL
 
+[![Build Status](https://travis-ci.org/friends-of-reactphp/mysql.svg?branch=master)](https://travis-ci.org/friends-of-reactphp/mysql)
+
 Async, [Promise](https://github.com/reactphp/promise)-based MySQL database client
 for [ReactPHP](https://reactphp.org/).
 
@@ -60,6 +62,41 @@ This will install the latest supported version:
 $ composer require react/mysql:^0.2
 ```
 
+This project aims to run on any platform and thus does not require any PHP
+extensions and supports running on legacy PHP 5.4 through current PHP 7+ and
+HHVM.
+It's *highly recommended to use PHP 7+* for this project.
+
+## Tests
+
+To run the test suite, you first need to clone this repo and then install all
+dependencies [through Composer](https://getcomposer.org):
+
+```bash
+$ composer install
+```
+
+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!
+You can change your test database credentials by passing these ENV variables:
+
+```bash
+$ export DB_HOST=localhost
+$ export DB_PORT=3306
+$ export DB_USER=test
+$ export DB_PASSWD=test
+$ export DB_DBNAME=test
+```
+
+To run the test suite, go to the project root and run:
+
+```bash
+$ php vendor/bin/phpunit
+```
+
 ## License
 
 MIT, see [LICENSE file](LICENSE).

composer.json

@@ -9,11 +9,17 @@
         "react/dns": "0.4.*"
     },
     "require-dev": {
-        "phpunit/dbunit": "1.4.*"
+        "phpunit/dbunit": "1.4.*",
+        "ext-pdo_mysql": "*"
     },
     "autoload": {
         "psr-4": {
             "React\\MySQL\\": "src"
         }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "React\\Tests\\MySQL\\": "tests"
+        }
     }
 }

phpunit.xml.dist

@@ -9,7 +9,7 @@
          processIsolation="false"
          stopOnFailure="false"
          syntaxCheck="false"
-         bootstrap="tests/bootstrap.php"
+         bootstrap="vendor/autoload.php"
 >
     <testsuites>
         <testsuite name="React.MySQL Test Suite">
@@ -23,9 +23,10 @@
         </whitelist>
     </filter>
     <php>
-        <var name="db_dsn" value="mysql:dbname=test;host=localhost"/>
-        <var name="db_user" value="test" />
-        <var name="db_passwd" value="test" />
-        <var name="db_dbname" value="test" />
+        <env name="DB_HOST" value="localhost"/>
+        <env name="DB_PORT" value="3306"/>
+        <env name="DB_USER" value="test" />
+        <env name="DB_PASSWD" value="test" />
+        <env name="DB_DBNAME" value="test" />
     </php>
 </phpunit>

tests/BaseTestCase.php

@@ -11,16 +11,18 @@ protected function getConnection()
     {
         if ($this->conn === null) {
             if (self::$pdo == null) {
-                self::$pdo = new \PDO($GLOBALS['db_dsn'], $GLOBALS['db_user'], $GLOBALS['db_passwd']);
+                $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,
+                    `id`      INT(11)      NOT NULL AUTO_INCREMENT,
                     `name`    VARCHAR(255) NOT NULL,
-                    `isbn`    VARCHAR(255) NOT NULL,
-                    `author`  VARCHAR(255) NOT NULL,
-                    `created` INT(11)      NOT NULL,
+                    `isbn`    VARCHAR(255) NULL,
+                    `author`  VARCHAR(255) NULL,
+                    `created` INT(11)      NULL,
                     PRIMARY KEY (`id`)
                 )
             ');
@@ -39,9 +41,11 @@ protected function getDataSet()
     protected function getConnectionOptions()
     {
         return [
-            'dbname' => $GLOBALS['db_dbname'],
-            'user'   => $GLOBALS['db_user'],
-            'passwd' => $GLOBALS['db_passwd'],
+            'host'   => getenv('DB_HOST'),
+            'port'   => (int)getenv('DB_PORT'),
+            'dbname' => getenv('DB_DBNAME'),
+            'user'   => getenv('DB_USER'),
+            'passwd' => getenv('DB_PASSWD'),
         ];
     }
 }

tests/ConnectionTest.php

@@ -15,8 +15,9 @@ public function testConnectWithInvalidPass()
 
         $conn->connect(function ($err, $conn) use ($loop, $options) {
             $this->assertEquals(sprintf(
-                "Access denied for user '%s'@'localhost' (using password: YES)",
-                $options['user']
+                "Access denied for user '%s'@'%s' (using password: YES)",
+                $options['user'],
+                $options['host']
             ), $err->getMessage());
             $this->assertInstanceOf('React\MySQL\Connection', $conn);
             //$loop->stop();

tests/NoResultQueryTest.php

@@ -2,19 +2,13 @@
 
 namespace React\Tests\MySQL;
 
-use React\MySQL\Query;
-
 class NoResultQueryTest extends  BaseTestCase
 {
     public function testUpdateSimple()
     {
         $loop = \React\EventLoop\Factory::create();
 
-        $connection = new \React\MySQL\Connection($loop, array(
-            'dbname' => 'test',
-            'user'   => 'test',
-            'passwd' => 'test',
-        ));
+        $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
 
         $connection->connect(function () {});
         $that  = $this;
@@ -31,11 +25,7 @@ public function testInsertSimple()
     {
         $loop = \React\EventLoop\Factory::create();
 
-        $connection = new \React\MySQL\Connection($loop, array(
-            'dbname' => 'test',
-            'user'   => 'test',
-            'passwd' => 'test',
-        ));
+        $connection = new \React\MySQL\Connection($loop, $this->getConnectionOptions());
 
         $connection->connect(function () {});
 

tests/ResultQueryTest.php

@@ -18,12 +18,20 @@ public function testSimpleSelect()
             $loop->stop();
         });
         $loop->run();
+    }
+
+    public function testInvalidSelect()
+    {
+        $loop = \React\EventLoop\Factory::create();
 
+        $options = $this->getConnectionOptions();
+        $db = $options['dbname'];
+        $connection = new \React\MySQL\Connection($loop, $options);
         $connection->connect(function () {});
 
-        $connection->query('select * from invalid_table', function ($command, $conn) use ($loop) {
+        $connection->query('select * from invalid_table', function ($command, $conn) use ($loop, $db) {
             $this->assertEquals(true, $command->hasError());
-            $this->assertEquals("Table 'test.invalid_table' doesn't exist", $command->getError()->getMessage());
+            $this->assertEquals("Table '$db.invalid_table' doesn't exist", $command->getError()->getMessage());
 
             $loop->stop();
         });