development/4dev/tests/Create/CoreLibsCreateUidsTest.php

<?php

declare(strict_types=1);

namespace tests;

use PHPUnit\Framework\TestCase;

/**
 * Test class for Create\Uids
 * @coversDefaultClass \CoreLibs\Create\Uids
 * @testdox \CoreLibs\Create\Uids method tests
 */
final class CoreLibsCreateUidsTest extends TestCase
{
	/**
	 * Undocumented function
	 *
	 * @return array
	 */
	public function uniqIdProvider(): array
	{
		return [
			// number length
			'too short' => [
				0 => 1,
				1 => 4,
				2 => null
			],
			'valid length: 10' => [
				0 => 10,
				1 => 10,
				2 => null
			],
			'valid length: 9, auto length' => [
				0 => 9,
				1 => 8,
				2 => null
			],
			'valid length: 9, force length' => [
				0 => 9,
				1 => 9,
				2 => true,
			],
			'very long: 512' => [
				0 => 512,
				1 => 512,
				2 => null
			],
			// below is all legacy
			'md5 hash' => [
				0 => 'md5',
				1 => 32,
				2 => null
			],
			'sha256 hash' => [
				0 => 'sha256',
				1 => 64,
				2 => null
			],
			'ripemd160 hash' => [
				0 => 'ripemd160',
				1 => 40,
				2 => null
			],
			'adler32 hash' => [
				0 => 'adler32',
				1 => 8,
				2 => null
			],
			'not in list, set default length' => [
				0 => 'sha3-512',
				1 => 64,
				2 => null
			],
			'default hash not set' => [
				0 => null,
				1 => 64,
				2 => null
			],
			'invalid name' => [
				0 => 'iamnotavalidhash',
				1 => 64,
				2 => null
			],
			// auto calls
			'auto: ' . \CoreLibs\Create\Uids::DEFAULT_UNNIQ_ID_LENGTH => [
				0 => \CoreLibs\Create\Uids::DEFAULT_UNNIQ_ID_LENGTH,
				1 => 64,
				2 => null
			],
			'auto: ' . \CoreLibs\Create\Uids::STANDARD_HASH_LONG => [
				0 => \CoreLibs\Create\Uids::STANDARD_HASH_LONG,
				1 => strlen(hash(\CoreLibs\Create\Uids::STANDARD_HASH_LONG, 'A')),
				2 => null
			],
			'auto: ' . \CoreLibs\Create\Uids::STANDARD_HASH_SHORT => [
				0 => \CoreLibs\Create\Uids::STANDARD_HASH_SHORT,
				1 => strlen(hash(\CoreLibs\Create\Uids::STANDARD_HASH_SHORT, 'A')),
				2 => null
			],
		];
	}

	/**
	 * Undocumented function
	 *
	 * @return array
	 */
	public function uniqIdLongProvider(): array
	{
		return [
			'uniq id long: ' . \CoreLibs\Create\Uids::STANDARD_HASH_LONG => [
				strlen(hash(\CoreLibs\Create\Uids::STANDARD_HASH_LONG, 'A'))
			],
		];
	}


	/**
	 * must match 7e78fe0d-59b8-4637-af7f-e88d221a7d1e
	 *
	 * @covers ::uuidv4
	 * @covers ::validateUuidv4
	 * @testdox uuidv4 check that return is matching regex [$_dataName]
	 *
	 * @return void
	 */
	public function testUuidv4(): void
	{
		$uuid = \CoreLibs\Create\Uids::uuidv4();
		$this->assertMatchesRegularExpression(
			'/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/',
			$uuid,
			'Failed regex check'
		);
		$this->assertTrue(
			\CoreLibs\Create\Uids::validateUuuidv4($uuid),
			'Failed validate regex method'
		);
		$this->assertFalse(
			\CoreLibs\Create\Uids::validateUuuidv4('not-a-uuidv4'),
			'Failed wrong uuid validated as true'
		);
	}

	/**
	 * Undocumented function
	 *
	 * @covers ::uniqId
	 * @dataProvider uniqIdProvider
	 * @testdox uniqId $input will be length $expected (Force $flag) [$_dataName]
	 *
	 * @param int|string|null $input
	 * @param string $expected
	 * @param bool|null $flag
	 * @return void
	 */
	public function testUniqId(int|string|null $input, int $expected, ?bool $flag): void
	{
		if ($input === null) {
			$uniq_id_length = strlen(\CoreLibs\Create\Uids::uniqId());
		} elseif ($flag === null) {
			$uniq_id_length = strlen(\CoreLibs\Create\Uids::uniqId($input));
		} else {
			$uniq_id_length = strlen(\CoreLibs\Create\Uids::uniqId($input, $flag));
		}
		$this->assertEquals(
			$expected,
			$uniq_id_length
		);
	}

	/**
	 * Because we set a constant here, we can only run one test
	 * so we test invalid one to force check
	 *
	 * @covers ::uniqId
	 * @#dataProvider uniqIdProvider
	 * @testWith ["invalidhash", 64]
	 * @testdox uniqId use DEFAULT_HASH  set $input with length $expected [$_dataName]
	 *
	 * @return void
	 */
	public function testUnidIdDefaultHash(string $input, int $expected): void
	{
		define('DEFAULT_HASH', $input);
		$this->assertEquals(
			$expected,
			strlen(\CoreLibs\Create\Uids::uniqId())
		);
	}

	/**
	 * Short id, always 8 in length
	 *
	 * @covers ::uniqIdShort
	 * @testWith [8]
	 * @testdox uniqIdShort will be length $expected [$_dataName]
	 *
	 * @param integer $expected
	 * @return void
	 */
	public function testUniqIdShort(int $expected): void
	{
		$this->assertEquals(
			$expected,
			strlen(\CoreLibs\Create\Uids::uniqIdShort())
		);
	}

	/**
	 * Long Id, length can change
	 *
	 * @covers ::uniqIdLong
	 * @dataProvider uniqIdLongProvider
	 * @testdox uniqIdLong will be length $expected [$_dataName]
	 *
	 * @param integer $expected
	 * @return void
	 */
	public function testUniqIdLong(int $expected): void
	{
		$this->assertEquals(
			$expected,
			strlen(\CoreLibs\Create\Uids::uniqIdLong())
		);
	}
}

// __END__