Merge pull request #1467 from jim-parry/fix2

Provide time testing within tolerance
codeigniter4 · Nov 12, 2018 · d72700b · d72700b
2 parents b3bc80e + 72d5a98
commit d72700b
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 4 deletions.
diff --git a/system/Test/CIUnitTestCase.php b/system/Test/CIUnitTestCase.php
@@ -196,6 +196,42 @@ public function assertCloseEnough(int $expected, $actual, string $message = '',
 		$this->assertLessThanOrEqual($tolerance, $difference, $message);
 	}
 
+	/**
+	 * Custom function to test that two values are "close enough".
+	 * This is intended for extended execution time testing,
+	 * where the result is close but not exactly equal to the
+	 * expected time, for reasons beyond our control.
+	 *
+	 * @param integer $expected
+	 * @param mixed   $actual
+	 * @param string  $message
+	 * @param integer $tolerance
+	 *
+	 * @throws \Exception
+	 */
+	public function assertCloseEnoughString($expected, $actual, string $message = '', int $tolerance = 1)
+	{
+		$expected = (string) $expected;
+		$actual   = (string) $actual;
+		if (strlen($expected) !== strlen($actual))
+		{
+			return false;
+		}
+
+		try
+		{
+			$expected   = (int) substr($expected, -2);
+			$actual     = (int) substr($actual, -2);
+			$difference = abs($expected - $actual);
+
+			$this->assertLessThanOrEqual($tolerance, $difference, $message);
+		}
+		catch (\Exception $e)
+		{
+			return false;
+		}
+	}
+
 	/**
 	 * Loads up an instance of CodeIgniter
 	 * and gets the environment setup.

diff --git a/tests/system/CLI/CLITest.php b/tests/system/CLI/CLITest.php
@@ -42,11 +42,11 @@ public function testWait()
 	{
 		$time = time();
 		CLI::wait(1, true);
-		$this->assertEquals(1, time() - $time);
+		$this->assertCloseEnough(1, time() - $time);
 
 		$time = time();
 		CLI::wait(1);
-		$this->assertEquals(1, time() - $time);
+		$this->assertCloseEnough(1, time() - $time);
 
 		// Leaving the code fragment below in, to remind myself (or others)
 		// of what appears to be the most likely path to test this last

diff --git a/tests/system/I18n/TimeTest.php b/tests/system/I18n/TimeTest.php
@@ -198,7 +198,7 @@ public function testCreateFromFormatWithTimezoneString()
 	{
 		$time = Time::createFromFormat('F j, Y', 'January 15, 2017', 'Europe/London');
 
-		$this->assertEquals(date('2017-01-15 H:i:s'), $time->toDateTimeString());
+		$this->assertCloseEnoughString(date('2017-01-15 H:i:s'), $time->toDateTimeString());
 	}
 
 	public function testCreateFromFormatWithTimezoneObject()
@@ -207,7 +207,7 @@ public function testCreateFromFormatWithTimezoneObject()
 
 		$time = Time::createFromFormat('F j, Y', 'January 15, 2017', $tz);
 
-		$this->assertEquals(date('2017-01-15 H:i:s'), $time->toDateTimeString());
+		$this->assertCloseEnoughString(date('2017-01-15 H:i:s'), $time->toDateTimeString());
 	}
 
 	public function testCreateFromTimestamp()

diff --git a/user_guide_src/source/testing/overview.rst b/user_guide_src/source/testing/overview.rst
@@ -154,6 +154,17 @@ between expected and actual time is within the prescribed tolerance.::
 
 The above test will allow the actual time to be either 600 or 601 seconds.
 
+**assertCloseEnoughString($expected, $actual, $message='', $tolerance=1)**
+
+For extended execution time testing, tests that the absolute difference
+between expected and actual time, formatted as strings, is within the prescribed tolerance.::
+
+    $timer = new Timer();
+    $timer->start('longjohn', strtotime('-11 minutes'));
+    $this->assertCloseEnoughString(11 * 60, $timer->getElapsedTime('longjohn'));
+
+The above test will allow the actual time to be either 600 or 601 seconds.
+
 Accessing Protected/Private Properties
 --------------------------------------