Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
100 changes: 62 additions & 38 deletions Doc/UUIDNext.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 16 additions & 0 deletions Doc/uuidnext.tools.uuidtoolkit.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,22 @@ Here is the bit layout of the UUID Version 7 created
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
```

### **CreateSequentialUuidForSqlServerFromSpecificDate(DateTimeOffset)**

Create a new sequential UUID Optimised for SQL Server with the given date as timestamp

```csharp
public static Guid CreateSequentialUuidForSqlServerFromSpecificDate(DateTimeOffset date)
```

#### Parameters

`date` [DateTimeOffset](https://docs.microsoft.com/en-us/dotnet/api/system.datetimeoffset)<br>
#### Returns

[Guid](https://docs.microsoft.com/en-us/dotnet/api/system.guid)<br>
### **CreateGuidFromBigEndianBytes(Span&lt;Byte&gt;)**

Create new UUID version 8 with the provided bytes with the variant and version bits set
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
using System;
using NFluent;
using UUIDNext.Tools;
using Xunit;

namespace UUIDNext.Test.Generator;

public abstract class UuidFromSpecificDateGeneratorTestBase : UuidTimestampGeneratorBaseTest
{
[Theory]
[MemberData(nameof(InvalidDates))]
public void CheckThatDateBeforeUnixEpochAreRejected(DateTimeOffset date)
{
var generator = NewGenerator();
Check.ThatCode(() => NewUuid(generator, date)).Throws<ArgumentOutOfRangeException>();
}

public static object[][] InvalidDates
=> [[new DateTimeOffset(new(1900, 1, 1))], [DateTimeOffset.FromUnixTimeMilliseconds(-1)], [DateTimeOffset.MinValue]];

[Fact]
public void EnsureThatUuidsFromTheSameTimestampAreIncreasing()
{
UuidWithTimestampComparer comparer = new();
DateTimeOffset date = new(new(2020, 2, 1));
var generator = NewGenerator();
Guid previousUuid = NewUuid(generator, date.AddMilliseconds(-1));
for (int i = 0; i < 100; i++)
{
var uuid = NewUuid(generator, date);
Check.That(comparer.Compare(previousUuid, uuid)).IsStrictlyLessThan(0);
previousUuid = uuid;
}
}

[Fact]
public void EnsureThatUuidsFromMultipleTimestampAreIncreasing()
{
UuidWithTimestampComparer comparer = new();

DateTimeOffset dateT = new(new(2028, 10, 12));
DateTimeOffset dateA = new(new(2030, 5, 1));
DateTimeOffset dateS = new(new(2037, 11, 24));

var generator = NewGenerator();

Guid previousUuidT = NewUuid(generator, dateT.AddMilliseconds(-1));
Guid previousUuidA = NewUuid(generator, dateA.AddMilliseconds(-1));
Guid previousUuidS = NewUuid(generator, dateS.AddMilliseconds(-1));

for (int i = 0; i < 100; i++)
{
var uuidT = NewUuid(generator, dateT);
var uuidA = NewUuid(generator, dateA);
var uuidS = NewUuid(generator, dateS);

Check.That(comparer.Compare(previousUuidT, uuidT)).IsStrictlyLessThan(0);
Check.That(comparer.Compare(previousUuidA, uuidA)).IsStrictlyLessThan(0);
Check.That(comparer.Compare(previousUuidS, uuidS)).IsStrictlyLessThan(0);

previousUuidT = uuidT;
previousUuidA = uuidA;
previousUuidS = uuidS;
}
}

[Fact]
public void EnsureTimestampAndVersionAreAlwaysCorrect()
{
UuidWithTimestampComparer comparer = new();
DateTime date = new(2020, 2, 1, 0, 0, 0, DateTimeKind.Utc);
var generator = NewGenerator();

int overflowCount = 0;
Guid previousUuid = NewUuid(generator, date.AddMilliseconds(-1));

// we loop 10_000 times to make sure that the sequence of the UUID v7 will overflow at
// least twice since the sequence is stored on 12 bits and its maximum value is thus 4095
int iterationCount = (int)(GetSequenceMaxValue() * 2.5);
for (int i = 0; i < iterationCount; i++)
{
var uuid = NewUuid(generator, date);
Check.That(UuidDecoder.GetVersion(uuid)).Is(Version);
var uuidDate = UuidTestHelper.DecodeDate(uuid);
Check.That(uuidDate).Is(date);

if (comparer.Compare(previousUuid, uuid) > 0)
overflowCount++;

previousUuid = uuid;
}

Check.That(overflowCount).IsGreaterOrEqualThan(2).And.IsLessOrEqualThan(5);
}
}
Loading