development/4dev/tests/CoreLibsDebugRunningTimeTest.php

<?php

declare(strict_types=1);

namespace tests;

use PHPUnit\Framework\TestCase;

/**
 * Test class for Debug\RunningTime
 * @coversDefaultClass \CoreLibs\Debug\RunningTime
 * @testdox \CoreLibs\Debug\RunningTime method tests
 */
final class CoreLibsDebugRunningTimeTest extends TestCase
{
	public function hrRunningTimeProvider(): array
	{
		// 0: return time difference
		// 1: return time on first run in regex
		return [
			'default time' => [
				0 => null,
				1 => '/^\d{4}\.\d{1,}$/'
			],
			'nanoseconds' => [
				0 => 'ns',
				1 => '/^\d{10}$/'
			],
			'microseconds' => [
				0 => 'ys',
				1 => '/^\d{7}\.\d{1,}$/'
			],
			'milliseconds' => [
				0 => 'ms',
				1 => '/^\d{4}\.\d{1,}$/'
			],
			'seconds' => [
				0 => 's',
				1 => '/^\d{1}\.\d{4,}$/'
			],
			'invalid fallback to ms' => [
				0 => 'invalid',
				1 => '/^\d{4}\.\d{1,}$/'
			]
		];
	}

	public function runningTimeProvider(): array
	{
		return [
			'run time test' => [
				0 => '/^\d{1,}\.\d{1,}$/',
				1 => '/^Start: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} 0\.\d{8}, $/',
				2 => '/^Start: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} 0\.\d{8}, '
					. 'End: \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2} 0\.\d{8}, '
					. 'Run: \d{1,}\.\d{1,} s$/'
			]
		];
	}

	/**
	 * Undocumented function
	 *
	 * @cover ::hrRunningTime
	 * @dataProvider hrRunningTimeProvider
	 * @testdox hrRunningTime with $out_time matching $expected [$_dataName]
	 *
	 * @param string|null $out_time
	 * @param string $expected
	 * @return void
	 */
	public function testHrRunningTime(?string $out_time, string $expected): void
	{
		// reset for each run
		\CoreLibs\Debug\RunningTime::hrRunningTimeReset();
		$start = \CoreLibs\Debug\RunningTime::hrRunningTime();
		$this->assertEquals(
			0,
			$start,
			'assert first run 0'
		);
		time_nanosleep(1, 500);
		if ($out_time === null) {
			$second = \CoreLibs\Debug\RunningTime::hrRunningTime();
		} else {
			$second = \CoreLibs\Debug\RunningTime::hrRunningTime($out_time);
		}
		// print "E: " . $end . "\n";
		$this->assertMatchesRegularExpression(
			$expected,
			(string)$second,
			'assert second run regex'
		);
		if ($out_time === null) {
			$end_second = \CoreLibs\Debug\RunningTime::hrRunningTimeFromStart();
		} else {
			$end_second = \CoreLibs\Debug\RunningTime::hrRunningTimeFromStart($out_time);
		}
		$this->assertEquals(
			$end_second,
			$second,
			'assert end is equal second'
		);
		// sleep again, second messurement
		time_nanosleep(1, 500);
		if ($out_time === null) {
			$third = \CoreLibs\Debug\RunningTime::hrRunningTime();
		} else {
			$third = \CoreLibs\Debug\RunningTime::hrRunningTime($out_time);
		}
		// third call is not null
		$this->assertNotEquals(
			0,
			$third,
			'assert third call not null'
		);
		// third call is bigger than end
		$this->assertNotEquals(
			$second,
			$third,
			'assert third different second'
		);
		// last messurement, must match start - end + last
		if ($out_time === null) {
			$end = \CoreLibs\Debug\RunningTime::hrRunningTimeFromStart();
		} else {
			$end = \CoreLibs\Debug\RunningTime::hrRunningTimeFromStart($out_time);
		}
		$this->assertGreaterThan(
			$third,
			$end,
			'assert end greater third'
		);
		// new start
		\CoreLibs\Debug\RunningTime::hrRunningTimeReset();
		$new_start = \CoreLibs\Debug\RunningTime::hrRunningTime();
		$this->assertEquals(
			0,
			$new_start,
			'assert new run 0'
		);
	}

	/**
	 * Undocumented function
	 *
	 * @dataProvider runningTimeProvider
	 * @testdox runningTime matching return $expected_number and start $expected_start end $expected_end [$_dataName]
	 *
	 * @param string $expected_number
	 * @param string $expected_start
	 * @param string $expected_end
	 * @return void
	 */
	public function testRunningTime(string $expected_number, string $expected_start, string $expected_end): void
	{
		$start = \CoreLibs\Debug\RunningTime::runningTime(true);
		// print "Start: " . $start . "\n";
		$this->assertEquals(
			0,
			$start
		);
		// print "STRING: " . \CoreLibs\Debug\RunningTime::runningTimeString() . "\n";
		$this->assertMatchesRegularExpression(
			$expected_start,
			\CoreLibs\Debug\RunningTime::runningTimeString()
		);
		time_nanosleep(1, 500);
		$end = \CoreLibs\Debug\RunningTime::runningTime(true);
		// print "Start: " . $end . "\n";
		$this->assertMatchesRegularExpression(
			$expected_number,
			(string)$end
		);
		// print "STRING: " . \CoreLibs\Debug\RunningTime::runningTimeString() . "\n";
		$this->assertMatchesRegularExpression(
			$expected_end,
			\CoreLibs\Debug\RunningTime::runningTimeString()
		);
	}
}

// __END__