Skip to content

[Uid] Add MockUuidFactory for deterministic UUID generation in tests #61807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nicolas-grekas merged 1 commit into from
Sep 25, 2025
Merged

[Uid] Add MockUuidFactory for deterministic UUID generation in tests #61807

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/Symfony/Component/Uid/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Add microsecond precision to UUIDv7
* Default to `UuidV7` when using `UuidFactory`
* Add `MockUuidFactory` to allow deterministic and mockable UUID generation for testing purposes

7.3
---
Expand Down
140 changes: 140 additions & 0 deletions src/Symfony/Component/Uid/Factory/MockUuidFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
<?php

/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Symfony\Component\Uid\Factory;

use Symfony\Component\Uid\Exception\InvalidArgumentException;
use Symfony\Component\Uid\Exception\LogicException;
use Symfony\Component\Uid\TimeBasedUidInterface;
use Symfony\Component\Uid\Uuid;
use Symfony\Component\Uid\UuidV1;
use Symfony\Component\Uid\UuidV3;
use Symfony\Component\Uid\UuidV4;
use Symfony\Component\Uid\UuidV5;
use Symfony\Component\Uid\UuidV6;

class MockUuidFactory extends UuidFactory
{
private \Iterator $sequence;

/**
* @param iterable<string|Uuid> $uuids
*/
public function __construct(
iterable $uuids,
private Uuid|string|null $timeBasedNode = null,
private Uuid|string|null $nameBasedNamespace = null,
) {
$this->sequence = match (true) {
\is_array($uuids) => new \ArrayIterator($uuids),
$uuids instanceof \Iterator => $uuids,
$uuids instanceof \Traversable => new \IteratorIterator($uuids),
};
}

public function create(): Uuid
{
if (!$this->sequence->valid()) {
throw new LogicException('No more UUIDs in sequence.');
}
$uuid = $this->sequence->current();
$this->sequence->next();

return match (true) {
$uuid instanceof Uuid => $uuid,
\is_string($uuid) => Uuid::fromString($uuid),
default => throw new InvalidArgumentException(\sprintf('Next UUID in sequence is not a valid UUID string or object: "%s" given.', get_debug_type($uuid))),
};
}

public function randomBased(): RandomBasedUuidFactory
{
return new class($this->create(...)) extends RandomBasedUuidFactory {
public function __construct(
private \Closure $create,
) {
}

public function create(): UuidV4
{
if (!($uuid = ($this->create)()) instanceof UuidV4) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence is not a UuidV4: "%s" given.', get_debug_type($uuid)));
}

return $uuid;
}
};
}

public function timeBased(Uuid|string|null $node = null): TimeBasedUuidFactory
{
if (\is_string($node ??= $this->timeBasedNode)) {
$node = Uuid::fromString($node);
}

return new class($this->create(...), $node) extends TimeBasedUuidFactory {
public function __construct(
private \Closure $create,
private ?Uuid $node = null,
) {
}

public function create(?\DateTimeInterface $time = null): Uuid&TimeBasedUidInterface
{
$uuid = ($this->create)();

if (!($uuid instanceof Uuid && $uuid instanceof TimeBasedUidInterface)) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence is not a Uuid and TimeBasedUidInterface: "%s" given.', get_debug_type($uuid)));
}

if (null !== $time && $uuid->getDateTime() !== $time) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence does not match the expected time: "%s" != "%s".', $uuid->getDateTime()->format('@U.uT'), $time->format('@U.uT')));
}

if (null !== $this->node && ($uuid instanceof UuidV1 || $uuid instanceof UuidV6) && $uuid->getNode() !== substr($this->node->toRfc4122(), -12)) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence does not match the expected node: "%s" != "%s".', $uuid->getNode(), substr($this->node->toRfc4122(), -12)));
}

return $uuid;
}
};
}

public function nameBased(Uuid|string|null $namespace = null): NameBasedUuidFactory
{
if (null === $namespace ??= $this->nameBasedNamespace) {
throw new LogicException(\sprintf('A namespace should be defined when using "%s()".', __METHOD__));
}

return new class($this->create(...), $namespace) extends NameBasedUuidFactory {
public function __construct(
private \Closure $create,
private Uuid|string $namespace,
) {
}

public function create(string $name): UuidV5|UuidV3
{
if (!($uuid = ($this->create)()) instanceof UuidV5 && !$uuid instanceof UuidV3) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence is not a UuidV5 or UuidV3: "%s".', get_debug_type($uuid)));
}

$factory = new UuidFactory(nameBasedClass: $uuid::class, nameBasedNamespace: $this->namespace);

if ($uuid->toRfc4122() !== $expectedUuid = $factory->nameBased()->create($name)->toRfc4122()) {
throw new InvalidArgumentException(\sprintf('Next UUID in sequence does not match the expected named UUID: "%s" != "%s".', $uuid->toRfc4122(), $expectedUuid));
}

return $uuid;
}
};
}
}
Loading
Loading