Implemented 3 GeneratorIdCreators

These generatorId creators (better names are welcome) should make it easier to 'determine' a generator-id. See #65 for more info.

Author: RobThree

IdGen/DatacenterMachineIdGeneratorIdCreator.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace IdGen;
+
+public static class DatacenterMachineIdGeneratorIdCreator
+{
+    public static int Create(int datacenterid, int workerid, byte datacenterbits, byte workerbits)
+        => datacenterbits + workerbits > 31
+            ? throw new InvalidOperationException("The total number of datacenter and worker bits should not exceed 31")
+            : datacenterid < 0 || datacenterid >= (1 << datacenterbits)
+            ? throw new ArgumentOutOfRangeException(nameof(datacenterid), $"Datacenter Id should be between 0 and {(1 << datacenterbits) - 1}")
+            : workerid < 0 || workerid >= (1 << workerbits)
+            ? throw new ArgumentOutOfRangeException(nameof(workerid), $"Worker Id should be between 0 and {(1 << workerbits) - 1}")
+            : (datacenterid << workerbits) | workerid;
+}

IdGen/IPAddressGeneratorIdCreator.cs

@@ -0,0 +1,43 @@
+#if NETSTANDARD2_0_OR_GREATER
+
+using System;
+using System.Linq;
+using System.Net;
+using System.Net.Sockets;
+
+namespace IdGen;
+
+public enum IpAddressType
+{
+    IPv4 = 4,
+    IPv6 = 6,
+    IPvAny = 0
+}
+
+public static class IPAddressGeneratorIdCreator
+{
+    public static int Create(IpAddressType ipType, byte generatorIdBits)
+        => Create(GetLocalIp(ipType), generatorIdBits);
+
+    public static int Create(IpAddressType ipType, IdStructure idStructure)
+        => Create(GetLocalIp(ipType), idStructure.GeneratorIdBits);
+
+    public static int Create(IPAddress ip, IdStructure idStructure)
+        => Create(ip, idStructure.GeneratorIdBits);
+
+    public static int Create(IPAddress ip, byte generatorIdBits)
+    {
+        if (generatorIdBits is < 0 or > 31)
+        {
+            throw new ArgumentOutOfRangeException(nameof(generatorIdBits), Translations.ERR_GENERATORID_CANNOT_EXCEED_31BITS);
+        }
+
+        var ipbytes = ip.GetAddressBytes().Reverse().ToArray();
+        return BitConverter.ToInt32(ipbytes, 0) & ((1 << generatorIdBits) - 1) & 0x7FFFFFFF;
+    }
+
+    public static IPAddress GetLocalIp(IpAddressType ipAddressType)
+        => Dns.GetHostEntry(Dns.GetHostName()).AddressList.FirstOrDefault(i => ipAddressType == IpAddressType.IPvAny || i.AddressFamily == (ipAddressType == IpAddressType.IPv4 ? AddressFamily.InterNetwork : AddressFamily.InterNetworkV6))
+            ?? throw new InvalidOperationException("Unable to determine IP address");
+}
+#endif

IdGen/IdGen.csproj

@@ -39,7 +39,7 @@
 	</ItemGroup>
 
 	<ItemGroup>
-	  <PackageReference Include="PolySharp" Version="1.14.1">
+	  <PackageReference Include="PolySharp" Version="1.15.0">
 	    <PrivateAssets>all</PrivateAssets>
 	    <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
 	  </PackageReference>

IdGen/MacAddressGeneratorIdCreator.cs

@@ -0,0 +1,26 @@
+#if NETSTANDARD2_0_OR_GREATER
+
+using System;
+using System.Linq;
+using System.Net.NetworkInformation;
+
+namespace IdGen;
+
+public static class MacAddressGeneratorIdCreator
+{
+    public static int Create(byte generatorIdBits)
+    {
+        var nic = NetworkInterface.GetAllNetworkInterfaces().FirstOrDefault()
+            ?? throw new InvalidOperationException("Unable to determine MAC address");
+
+        return Create(nic.GetPhysicalAddress().GetAddressBytes().Reverse().ToArray(), generatorIdBits);
+    }
+
+    public static int Create(byte[] macAddress, byte generatorIdBits)
+        => generatorIdBits is < 0 or > 31
+            ? throw new ArgumentOutOfRangeException(nameof(generatorIdBits), Translations.ERR_GENERATORID_CANNOT_EXCEED_31BITS)
+            : macAddress.Length != 6
+            ? throw new ArgumentException("MAC address must be 6 bytes long", nameof(macAddress))
+            : BitConverter.ToInt32(macAddress, 0) & ((1 << generatorIdBits) - 1) & 0x7FFFFFFF;
+}
+#endif

IdGenTests/DatacenterMachineIdGeneratorIdCreatorTests.cs

@@ -0,0 +1,35 @@
+using IdGen;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+
+namespace IdGenTests;
+
+[TestClass]
+public class DatacenterMachineIdGeneratorIdCreatorTests
+
+{
+    [TestMethod]
+    public void Create_ShouldCreateCorrectId()
+    {
+        Assert.AreEqual(0, DatacenterMachineIdGeneratorIdCreator.Create(0, 0, 4, 4));
+        Assert.AreEqual(52394, DatacenterMachineIdGeneratorIdCreator.Create(204, 170, 8, 8));
+        Assert.AreEqual(2147483647, DatacenterMachineIdGeneratorIdCreator.Create(536870911, 3, 29, 2));
+        Assert.AreEqual(255, DatacenterMachineIdGeneratorIdCreator.Create(15, 15, 4, 4));
+        Assert.AreEqual(255, DatacenterMachineIdGeneratorIdCreator.Create(127, 1, 7, 1));
+    }
+
+    [TestMethod]
+    [ExpectedException(typeof(InvalidOperationException))]
+    public void Create_ShouldThrowOnMoreThan31TotalBits()
+        => DatacenterMachineIdGeneratorIdCreator.Create(0, 0, 30, 2);
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentOutOfRangeException))]
+    public void Create_ShouldThrowOnDatacenterIdExceedingBits()
+        => DatacenterMachineIdGeneratorIdCreator.Create(4, 0, 2, 8);
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentOutOfRangeException))]
+    public void Create_ShouldThrowOnWorkerIdExceedingBits()
+        => DatacenterMachineIdGeneratorIdCreator.Create(0, 4, 8, 2);
+}

IdGenTests/IPAddressGeneratorIdTests.cs

@@ -0,0 +1,36 @@
+using IdGen;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+using System.Net;
+
+namespace IdGenTests;
+
+[TestClass]
+public class IPAddressGeneratorIdCreatorTests
+{
+    [TestMethod]
+    public void Create_ShouldCreateCorrectId()
+    {
+        //IPv4
+        Assert.AreEqual(1084783405, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("192.168.123.45"), 31));
+        Assert.AreEqual(13, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("192.168.123.45"), 4));
+        Assert.AreEqual(1, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("192.168.0.1"), 16));
+
+        //IPv6
+        Assert.AreEqual(1084783405, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("::ffff:c0a8:7b2d"), 31));
+        Assert.AreEqual(13, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("::ffff:c0a8:7b2d"), 4));
+        Assert.AreEqual(1, IPAddressGeneratorIdCreator.Create(IPAddress.Parse("::ffff:0:1"), 16));
+
+        IPAddressGeneratorIdCreator.Create(IpAddressType.IPvAny, 16);
+    }
+
+    [TestMethod]
+    public void Create_ShouldCreateCorrectIdForLocalIP() =>
+        // This doesn't really test anything, but it's here to make sure GetLocalIp is invoked and doesn't throw
+        Assert.AreNotEqual(0, IPAddressGeneratorIdCreator.Create(IpAddressType.IPvAny, 7));
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentOutOfRangeException))]
+    public void Create_ShouldThrowOnMoreThan31Bits()
+        => IPAddressGeneratorIdCreator.Create(IPAddress.Parse("192.168.0.1"), 32);
+}

IdGenTests/MacAddressGeneratorIdCreatorTests.cs

@@ -0,0 +1,25 @@
+using IdGen;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using System;
+
+namespace IdGenTests;
+
+[TestClass]
+public class MacAddressGeneratorIdCreatorTests
+{
+    [TestMethod]
+    public void Create_ShouldCreateCorrectId()
+        // This doesn't really test anything, but it's here to make sure trying to gat a MacAddress doesn't throw
+        => Assert.AreNotEqual(0, MacAddressGeneratorIdCreator.Create(31));
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentOutOfRangeException))]
+    public void Create_ShouldThrowOnMoreThan31Bits()
+        => MacAddressGeneratorIdCreator.Create(32);
+
+
+    [TestMethod]
+    [ExpectedException(typeof(ArgumentException))]
+    public void Create_ShouldThrowOnIncorrectMacAddress()
+        => MacAddressGeneratorIdCreator.Create(new byte[3], 8);
+}