test: eliminate phpunit-8 deprecation warnings

After enabling phpunit-7, phpunit-8 starts to work too, but gives
several deprecation warnings:

* Using of `assertContains()` for search in a string.
* Using of `@expectedException` and related annotations.

Functionality that is deprecated in phpunit-8 will be disabled in
phpunit-9. Since we plan to use phpunit-9 for testing on php-7.3 and
php-7.4, it worth to fix the warnings now.

This commit updates the test suite to use the new constructions and
provides the compatibility layer for phpunit-6, which does not contain
`assertStringContainsString()` method.

The commit also disables caching of testing results, which was enabled
by default in phpunit-8 (see [1]). The test suite is quite small and the
feature does not add any value. The reason for disabling is to protect
ourself from side effects of this caching: to be honest I don't know how
it may change testing results.

[1]: https://phpunit.de/announcements/phpunit-8.html

Author: Totktonada

test/AssertTest.php

@@ -36,7 +36,8 @@ function assert_f()
 			$this->assertFalse(True);
 		} catch (TarantoolException $e) {
 			// print($e->getMessage());
-			$this->assertContains("Failed to read", $e->getMessage());
+			$this->assertStringContainsString(
+				"Failed to read", $e->getMessage());
 		}
 
 		/* We can reconnect and everything will be ok */

test/CreateTest.php

@@ -47,27 +47,29 @@ public function test_01_01_double_disconnect() {
 			$a->disconnect();
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessageRegExp /Name or service not known|nodename nor servname provided|Temporary failure in name resolution/
-		 */
 		public function test_02_create_error_host() {
-			(new Tarantool('very_bad_host'))->connect();
+			$c = new Tarantool('very_bad_host');
+
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessageRegExp(
+				'/Name or service not known' .
+				'|nodename nor servname provided' .
+				'|Temporary failure in name resolution/');
+			$c->connect();
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessageRegExp /Connection refused|Network is unreachable/
-		 */
 		public function test_03_00_create_error_port() {
-			(new Tarantool('127.0.0.1', 65500))->connect();
+			$c = new Tarantool('127.0.0.1', 65500);
+
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessageRegExp(
+				'/Connection refused|Network is unreachable/');
+			$c->connect();
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage Invalid primary port value
-		 */
 		public function test_03_01_create_error_port() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage('Invalid primary port value');
 			new Tarantool('localhost', 123456);
 		}
 
@@ -99,38 +101,38 @@ public function test_05_flush_construct() {
 			$c->flush_schema();
 		}
 
-		/**
-		 * @expectedException TarantoolClientError
-		 * @expectedExceptionMessage Incorrect password supplied for user
-		 */
 		public function test_06_bad_credentials() {
 				$c = new Tarantool('localhost', self::$port);
 				$c->connect();
 				$this->assertTrue($c->ping());
+
+				$this->expectException(TarantoolClientError::class);
+				$this->expectExceptionMessage(
+					'Incorrect password supplied for user');
 				$c->authenticate('test', 'bad_password');
 		}
 
-		/**
-		 * @expectedException TarantoolClientError
-		 * @expectedExceptionMessage Incorrect password supplied for user
-		 */
 		public function test_07_bad_guest_credentials() {
 			$c = new Tarantool('localhost', self::$port);
 			$c->connect();
 			$this->assertTrue($c->ping());
+
+			$this->expectException(TarantoolClientError::class);
+			$this->expectExceptionMessage(
+				'Incorrect password supplied for user');
 			$c->authenticate('guest', 'guest');
 		}
 
-		/**
-		 * @expectedException TarantoolClientError
-		 * @expectedExceptionMessage Incorrect password supplied for user
-		 */
 		/**
 		 * Comment this, since behaviour of authentication with 'empty password' has changed
 		public function test_07_01_bad_guest_credentials() {
 			$c = new Tarantool('localhost', self::$port);
 			$c->connect();
 			$this->assertTrue($c->ping());
+
+			$this->expectException(TarantoolClientError::class);
+			$this->expectExceptionMessage(
+				'Incorrect password supplied for user');
 			$c->authenticate('guest', '');
 		}
 		*/

test/DMLTest.php

@@ -78,12 +78,11 @@ public function test_02_select_diff() {
 			$this->devastate(100);
 		}
 
-		/**
-		 * @expectedException TarantoolClientError
-		 * @expectedExceptionMessage Duplicate key exists
-		 **/
 		public function test_03_insert_error() {
 			self::$tarantool->insert("test", array(1, 2, "smth"));
+
+			$this->expectException(TarantoolClientError::class);
+			$this->expectExceptionMessage('Duplicate key exists');
 			self::$tarantool->insert("test", array(1, 2, "smth"));
 		}
 
@@ -170,11 +169,9 @@ public function test_07_update_no_error() {
 			self::$tarantool->update("test", 0, array());
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage No field 'nosuchfield' defined
-		 */
 		public function test_08_update_error_nosuchfield() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage("No field 'nosuchfield' defined");
 			self::$tarantool->update("test", 0, array(
 				array(
 					"field" => "nosuchfield",
@@ -183,11 +180,9 @@ public function test_08_update_error_nosuchfield() {
 			));
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage Five fields
-		 */
 		public function test_08_update_error() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage('Five fields');
 			self::$tarantool->update("test", 0, array(
 				array(
 					"field" => 2,
@@ -198,11 +193,9 @@ public function test_08_update_error() {
 			));
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage Field OP must be provided
-		 */
 		public function test_09_update_error() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage('Field OP must be provided');
 			self::$tarantool->update("test", 0, array(
 					array(
 							"field" => 2,
@@ -212,11 +205,9 @@ public function test_09_update_error() {
 			));
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage Field OP must be provided
-		 */
 		public function test_10_update_error() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage('Field OP must be provided');
 			self::$tarantool->update("test", 0, array(
 					array(
 							"field" => 2,
@@ -225,11 +216,9 @@ public function test_10_update_error() {
 			));
 		}
 
-		/**
-		 * @expectedException TarantoolException
-		 * @expectedExceptionMessage Three fields must be provided
-		 */
 		public function test_11_update_error() {
+			$this->expectException(TarantoolException::class);
+			$this->expectExceptionMessage('Three fields must be provided');
 			self::$tarantool->update("test", 0,
 				array(
 					array(
@@ -374,7 +363,7 @@ public function test_17_02_it_exception($spc, $itype, $xcmsg) {
 				self::$tarantool->select($spc, null, null, null, null, $itype);
 				$this->assertFalse(True);
 			} catch (TarantoolException $e) {
-				$this->assertContains($xcmsg, $e->getMessage());
+				$this->assertStringContainsString($xcmsg, $e->getMessage());
 			}
 		}
 
@@ -386,7 +375,7 @@ public function test_17_03_it_good($spc, $itype) {
 				self::$tarantool->select($spc, null, null, null, null, $itype);
 				$this->assertTrue(True);
 			} catch (Exception $e) {
-				$this->assertContains($xcmsg, $e->getMessage());
+				$this->assertStringContainsString($xcmsg, $e->getMessage());
 			}
 		}
 

test/MsgPackTest.php

@@ -29,27 +29,21 @@ public function test_00_msgpack_call() {
         $this->assertEquals($resp[0][0], 2);
     }
 
-    /**
-     * @expectedException TarantoolException
-     * @expectedExceptionMessage Bad key type for PHP Array
-     **/
     public function test_01_msgpack_array_key() {
+        $this->expectException(TarantoolException::class);
+        $this->expectExceptionMessage('Bad key type for PHP Array');
         self::$tarantool->select("msgpack", array(2));
     }
 
-    /**
-     * @expectedException TarantoolException
-     * @expectedExceptionMessage Bad key type for PHP Array
-     **/
     public function test_02_msgpack_float_key() {
+        $this->expectException(TarantoolException::class);
+        $this->expectExceptionMessage('Bad key type for PHP Array');
         self::$tarantool->select("msgpack", array(1));
     }
 
-    /**
-     * @expectedException TarantoolException
-     * @expectedExceptionMessage Bad key type for PHP Array
-     **/
     public function test_03_msgpack_array_of_float_as_key() {
+        $this->expectException(TarantoolException::class);
+        $this->expectExceptionMessage('Bad key type for PHP Array');
         self::$tarantool->select("msgpack", array(3));
     }
 

test/PhpUnitCompat.php

@@ -7,15 +7,30 @@
  * different phpunit versions (phpunit-6 and phpunit-7 at the
  * moment).
  *
- * Now it implements the workaround for phpunit-7 requirement to
- * use `void` return type declarations for the following methods
- * (see [1]).
+ * Now it contains workarounds for two problems:
+ *
+ * - phpunit-7 requirement to use `void` return type declaration
+ *   for several methods.
+ * - phpunit-8 deprecation warning re using assertContains() for
+ *   search a substring in a string.
+ *
+ * Usage: add `use TestCaseCompat;` in a TestCase derived class
+ * and follow instructions and examples below.
+ *
+ * `void` return type declaration
+ * ------------------------------
+ *
+ * phpunit-7 requires to use `void` return type declaration for
+ * the following methods (and several others, which we don't use):
  *
  * - setUpBeforeClass()
  * - tearDownAfterClass()
  * - setUp()
  * - tearDown()
  *
+ * See the announcement [1] for more information about changes in
+ * this phpunit version.
+ *
  * The problem is that php-7.0 does not support `void` return type
  * declaration, so a trick is necessary to support both php-7.0
  * and phpunit-7+ for, say, php-7.3+.
@@ -24,9 +39,6 @@
  * test case class and specify do*() methods instead of ones
  * listed above (see the example below).
  *
- * For now it is the only problem, which is solved by the
- * `TestCaseCompat` trait, but it may be expanded in a future.
- *
  * Example:
  *
  *  | use PHPUnit\Framework\TestCase;
@@ -53,10 +65,15 @@
  *  |     }
  *  | }
  *
- * Use `TestCaseCompat` trait and consider others as
- * implementation details.
- *
  * [1]: https://phpunit.de/announcements/phpunit-7.html
+ *
+ * assertContains() for strings
+ * ----------------------------
+ *
+ * phpunit-8 warns about using of assertContains() for search a
+ * substring in a string. Add `use TestCaseCompat;` to a TestCase
+ * derived class and use assertStringContainsString() on any
+ * phpunit-6+ version.
  */
 
 use PHPUnit\Framework\TestCase;
@@ -157,6 +174,32 @@ protected function tearDown()
     }
 }
 
+/*
+ * AssertStringContainsStringTrait (private).
+ *
+ * phpunit-6 does not contain assertStringContainsString() method,
+ * while phpunit-8 warns about using assertContains() for search a
+ * substring in a string.
+ *
+ * This trait adds assertStringContainsString() method for
+ * phpunit-6.
+ */
+if ($testCaseRef->hasMethod('assertStringContainsString')) {
+    trait AssertStringContainsStringTrait
+    {
+        /* Nothing to define. */
+    }
+} else {
+    trait AssertStringContainsStringTrait
+    {
+        public static function assertStringContainsString(
+            $needle, $haystack, $message = '')
+        {
+            self::assertContains($needle, $haystack, $message);
+        }
+    }
+}
+
 /*
  * TestCaseCompat (public).
  *
@@ -165,4 +208,5 @@ protected function tearDown()
 trait TestCaseCompat
 {
     use SetUpTearDownTrait;
+    use AssertStringContainsStringTrait;
 }

test/shared/phpunit.xml

@@ -2,6 +2,7 @@
   colors ="true"
   verbose="true"
   bootstrap="test/bootstrap.php"
+  cacheResult="false"
 >
   <testsuites>
     <testsuite name="Basic PHP Tests">