Automatically generate properties for packet fields

.github/workflows/tests.yml

@@ -10,10 +10,11 @@ concurrency:
 
 jobs:
   unit:
-    name: Unit tests (${{ matrix.config }})
+    name: Unit tests (${{ matrix.project }} - ${{ matrix.config }})
     runs-on: ubuntu-latest
     strategy:
       matrix:
+        project: [RyuSocks.Test, RyuSocks.Generator.Test]
         config: [Debug, Release]
     steps:
       - uses: actions/checkout@v4
@@ -29,7 +30,7 @@ jobs:
         uses: TSRBerry/unstable-commands@v1
         with:
           commands: dotnet test -c "${{ matrix.config }}"
-          working-directory: RyuSocks.Test
+          working-directory: ${{ matrix.project }}
           timeout-minutes: 10
           retry-codes: 139
 

Directory.Packages.props

@@ -8,6 +8,7 @@
         <PackageVersion Include="FluentFTP" Version="50.1.0" />
         <PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.11.0" />
         <PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.12.0" />
+        <PackageVersion Include="Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing" Version="1.1.2" />
         <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.12.0" />
         <PackageVersion Include="Moq" Version="4.20.70" />
         <PackageVersion Include="NetCoreServer" Version="8.0.7" />

RyuSocks.Generator.Test/PacketGeneratorTests.cs

@@ -0,0 +1,162 @@
+using Microsoft.CodeAnalysis.Testing;
+using System.Diagnostics.CodeAnalysis;
+using System.IO;
+using System.Threading.Tasks;
+using Xunit;
+using Verify = RyuSocks.Generator.Test.SourceGeneratorVerifier<RyuSocks.Generator.PacketGenerator>;
+
+namespace RyuSocks.Generator.Test
+{
+    [ExcludeFromCodeCoverage]
+    public class PacketGeneratorTests
+    {
+        private const string DataDirectory = "data/PacketGenerator/";
+        private const int DefaultSourcesAmount = 3;
+
+        private static string GetSourceFromFile(string path) => File.ReadAllText(DataDirectory + path);
+        private static (string filename, string content) GetGeneratedSourceFromFile(string path) =>
+            (Path.GetFileName(path), File.ReadAllText(DataDirectory + path));
+
+        private static (string, string)[] GetDefaultGeneratedSources(int otherExpectedSourcesLength)
+        {
+
+            (string, string)[] generatedSources = new (string, string)[DefaultSourcesAmount + otherExpectedSourcesLength];
+
+            generatedSources[0] = GetGeneratedSourceFromFile("StringEncoding.g.cs");
+            generatedSources[1] = GetGeneratedSourceFromFile("PacketFieldAttribute.g.cs");
+            generatedSources[2] = GetGeneratedSourceFromFile("Packet.g.cs");
+
+            return generatedSources;
+        }
+
+        [Theory]
+        [InlineData("SimpleProps", "TestPacket.cs",
+            "TestPacket.Byte1.g.cs", "TestPacket.SByte1.g.cs",
+            "TestPacket.UShort1.g.cs", "TestPacket.Short1.g.cs",
+            "TestPacket.UInt1.g.cs", "TestPacket.Int1.g.cs",
+            "TestPacket.ULong1.g.cs", "TestPacket.Long1.g.cs",
+            "TestPacket.String1.g.cs", "TestPacket.String2.g.cs", "TestPacket.String3.g.cs")]
+        [InlineData("SimplePropsOffsetMember", "TestPacket.cs",
+            "TestPacket.Byte1.g.cs", "TestPacket.SByte1.g.cs",
+            "TestPacket.UShort1.g.cs", "TestPacket.Short1.g.cs",
+            "TestPacket.UInt1.g.cs", "TestPacket.Int1.g.cs",
+            "TestPacket.ULong1.g.cs", "TestPacket.Long1.g.cs",
+            "TestPacket.String1.g.cs", "TestPacket.String2.g.cs", "TestPacket.String3.g.cs")]
+        [InlineData("Namespaces", "TestPacket.cs",
+            "TestSpace.TestPacket.TestField.g.cs", "TestSpace.TestPacket1.FirstField.g.cs",
+            "AnotherSpace.TestPacket.TestField.g.cs", "AnotherSpace.TestPacket2.SecondField.g.cs")]
+        [InlineData("StringEncodings", "TestPacket.cs",
+            "LittleEndian.ASCIIPacket.String1.g.cs", "LittleEndian.ASCIIPacket.String2.g.cs", "LittleEndian.ASCIIPacket.String3.g.cs", "LittleEndian.ASCIIPacket.String4.g.cs",
+            "LittleEndian.UnicodePacket.String1.g.cs", "LittleEndian.UnicodePacket.String2.g.cs", "LittleEndian.UnicodePacket.String3.g.cs", "LittleEndian.UnicodePacket.String4.g.cs",
+            "LittleEndian.UTF7Packet.String1.g.cs", "LittleEndian.UTF7Packet.String2.g.cs", "LittleEndian.UTF7Packet.String3.g.cs", "LittleEndian.UTF7Packet.String4.g.cs",
+            "LittleEndian.UTF8Packet.String1.g.cs", "LittleEndian.UTF8Packet.String2.g.cs", "LittleEndian.UTF8Packet.String3.g.cs", "LittleEndian.UTF8Packet.String4.g.cs",
+            "LittleEndian.UTF32Packet.String1.g.cs", "LittleEndian.UTF32Packet.String2.g.cs", "LittleEndian.UTF32Packet.String3.g.cs", "LittleEndian.UTF32Packet.String4.g.cs",
+            "BigEndian.ASCIIPacket.String1.g.cs", "BigEndian.ASCIIPacket.String2.g.cs", "BigEndian.ASCIIPacket.String3.g.cs", "BigEndian.ASCIIPacket.String4.g.cs",
+            "BigEndian.UnicodePacket.String1.g.cs", "BigEndian.UnicodePacket.String2.g.cs", "BigEndian.UnicodePacket.String3.g.cs", "BigEndian.UnicodePacket.String4.g.cs",
+            "BigEndian.UTF7Packet.String1.g.cs", "BigEndian.UTF7Packet.String2.g.cs", "BigEndian.UTF7Packet.String3.g.cs", "BigEndian.UTF7Packet.String4.g.cs",
+            "BigEndian.UTF8Packet.String1.g.cs", "BigEndian.UTF8Packet.String2.g.cs", "BigEndian.UTF8Packet.String3.g.cs", "BigEndian.UTF8Packet.String4.g.cs",
+            "BigEndian.UTF32Packet.String1.g.cs", "BigEndian.UTF32Packet.String2.g.cs", "BigEndian.UTF32Packet.String3.g.cs", "BigEndian.UTF32Packet.String4.g.cs")]
+        public async Task GeneratedSources_AsExpected(string directory, string sourcePath, params string[] expectedGeneratedSourcePath)
+        {
+            (string, string)[] generatedSources = GetDefaultGeneratedSources(expectedGeneratedSourcePath.Length);
+            directory += "/";
+
+            for (int i = 0; i < expectedGeneratedSourcePath.Length; i++)
+            {
+                generatedSources[DefaultSourcesAmount + i] = GetGeneratedSourceFromFile(directory + expectedGeneratedSourcePath[i]);
+            }
+
+            await Verify.VerifyGeneratedSources(
+                GetSourceFromFile(directory + sourcePath),
+                generatedSources
+            );
+        }
+
+        [Fact]
+        public async Task Generator_Fails_BadConstructorArgs()
+        {
+            const string Directory = "Exceptions/";
+            (string, string)[] generatedSources = GetDefaultGeneratedSources(0);
+            DiagnosticResult[] expectedDiagnostics = [
+                // Generator failed to generate source
+                DiagnosticResult.CompilerWarning("CS8785"),
+                // Argument 1: Cannot convert from float to int
+                DiagnosticResult.CompilerError("CS1503").WithSpan(7, 18, 7, 22).WithArguments("1", "float", "int"),
+                // Partial property must have an implementation part
+                DiagnosticResult.CompilerError("CS9248").WithSpan(8, 25, 8, 30).WithArguments("TestPacket.Byte1"),
+            ];
+
+            await Verify.VerifyGeneratedSources(
+                GetSourceFromFile(Directory + "BadConstructorArgs.cs"),
+                generatedSources,
+                expectedDiagnostics
+            );
+        }
+
+        [Fact]
+        public async Task GeneratedSources_WorksWithGeneratedTypes()
+        {
+            const int ExpectedGeneratedSourcesLength = 11;
+            const string Directory = "GeneratedTypes/";
+            (string, string)[] generatedSources = GetDefaultGeneratedSources(ExpectedGeneratedSourcesLength);
+            DiagnosticResult[] expectedDiagnostics = [
+                // Type not found
+                DiagnosticResult.CompilerError("CS0246").WithSpan(9, 20, 9, 37).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte1.g.cs", 8, 20, 8, 37).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte1.g.cs", 12, 21, 12, 38).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(12, 22, 12, 40).WithArguments("GeneratedEnumSByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.SByte1.g.cs", 8, 22, 8, 40).WithArguments("GeneratedEnumSByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.SByte1.g.cs", 12, 21, 12, 39).WithArguments("GeneratedEnumSByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(15, 23, 15, 42).WithArguments("GeneratedEnumUShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.UShort1.g.cs", 8, 23, 8, 42).WithArguments("GeneratedEnumUShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.UShort1.g.cs", 12, 21, 12, 40).WithArguments("GeneratedEnumUShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(18, 21, 18, 39).WithArguments("GeneratedEnumShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Short1.g.cs", 8, 21, 8, 39).WithArguments("GeneratedEnumShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Short1.g.cs", 12, 21, 12, 39).WithArguments("GeneratedEnumShort"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(21, 31, 21, 48).WithArguments("GeneratedEnumUInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.UInt1.g.cs", 8, 31, 8, 48).WithArguments("GeneratedEnumUInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.UInt1.g.cs", 12, 21, 12, 38).WithArguments("GeneratedEnumUInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(24, 13, 24, 29).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int1.g.cs", 8, 13, 8, 29).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int1.g.cs", 12, 21, 12, 37).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(27, 13, 27, 31).WithArguments("GeneratedEnumULong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.ULong1.g.cs", 8, 13, 8, 31).WithArguments("GeneratedEnumULong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.ULong1.g.cs", 12, 21, 12, 39).WithArguments("GeneratedEnumULong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(30, 20, 30, 37).WithArguments("GeneratedEnumLong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Long1.g.cs", 8, 20, 8, 37).WithArguments("GeneratedEnumLong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Long1.g.cs", 12, 21, 12, 38).WithArguments("GeneratedEnumLong"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(33, 20, 33, 37).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte2.g.cs", 8, 20, 8, 37).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte2.g.cs", 12, 21, 12, 38).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(36, 13, 36, 29).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int2.g.cs", 8, 13, 8, 29).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int2.g.cs", 12, 13, 12, 29).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int2.g.cs", 12, 45, 12, 61).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Int2.g.cs", 16, 30, 16, 46).WithArguments("GeneratedEnumInt"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan(39, 23, 39, 40).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte3.g.cs", 8, 23, 8, 40).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte3.g.cs", 12, 13, 12, 30).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte3.g.cs", 12, 46, 12, 63).WithArguments("GeneratedEnumByte"),
+                DiagnosticResult.CompilerError("CS0246").WithSpan("RyuSocks.Generator/RyuSocks.Generator.PacketGenerator/TestPacket.Byte3.g.cs", 16, 30, 16, 47).WithArguments("GeneratedEnumByte"),
+            ];
+
+            generatedSources[DefaultSourcesAmount] = GetGeneratedSourceFromFile(Directory + "TestPacket.Byte1.g.cs");
+            generatedSources[DefaultSourcesAmount + 1] = GetGeneratedSourceFromFile(Directory + "TestPacket.SByte1.g.cs");
+            generatedSources[DefaultSourcesAmount + 2] = GetGeneratedSourceFromFile(Directory + "TestPacket.UShort1.g.cs");
+            generatedSources[DefaultSourcesAmount + 3] = GetGeneratedSourceFromFile(Directory + "TestPacket.Short1.g.cs");
+            generatedSources[DefaultSourcesAmount + 4] = GetGeneratedSourceFromFile(Directory + "TestPacket.UInt1.g.cs");
+            generatedSources[DefaultSourcesAmount + 5] = GetGeneratedSourceFromFile(Directory + "TestPacket.Int1.g.cs");
+            generatedSources[DefaultSourcesAmount + 6] = GetGeneratedSourceFromFile(Directory + "TestPacket.ULong1.g.cs");
+            generatedSources[DefaultSourcesAmount + 7] = GetGeneratedSourceFromFile(Directory + "TestPacket.Long1.g.cs");
+            generatedSources[DefaultSourcesAmount + 8] = GetGeneratedSourceFromFile(Directory + "TestPacket.Byte2.g.cs");
+            generatedSources[DefaultSourcesAmount + 9] = GetGeneratedSourceFromFile(Directory + "TestPacket.Int2.g.cs");
+            generatedSources[DefaultSourcesAmount + 10] = GetGeneratedSourceFromFile(Directory + "TestPacket.Byte3.g.cs");
+
+            await Verify.VerifyGeneratedSources(
+                GetSourceFromFile(Directory + "TestPacket.cs"),
+                generatedSources,
+                expectedDiagnostics
+            );
+        }
+    }
+}

RyuSocks.Generator.Test/RyuSocks.Generator.Test.csproj

@@ -0,0 +1,29 @@
+<Project Sdk="Microsoft.NET.Sdk">
+    <PropertyGroup>
+        <TargetFramework>net9.0</TargetFramework>
+    </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="coverlet.collector">
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+            <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />
+        <PackageReference Include="Microsoft.CodeAnalysis.CSharp.SourceGenerators.Testing" PrivateAssets="all" />
+        <PackageReference Include="Microsoft.NET.Test.Sdk" />
+        <PackageReference Include="xunit.v3" />
+        <PackageReference Include="xunit.runner.visualstudio">
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+            <PrivateAssets>all</PrivateAssets>
+        </PackageReference>
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\RyuSocks.Generator\RyuSocks.Generator.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <Compile Remove="data\**" />
+      <None Include="data\**" CopyToOutputDirectory="Always"/>
+    </ItemGroup>
+</Project>

RyuSocks.Generator.Test/SourceGeneratorVerifier.cs

@@ -0,0 +1,53 @@
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Testing;
+using Microsoft.CodeAnalysis.Testing;
+using System;
+using System.Collections.Immutable;
+using System.Diagnostics.CodeAnalysis;
+using System.Threading.Tasks;
+
+namespace RyuSocks.Generator.Test
+{
+    [ExcludeFromCodeCoverage]
+    public static class SourceGeneratorVerifier<TSourceGenerator>
+        where TSourceGenerator : new()
+    {
+        public static Task VerifyGeneratedSources(string source, (string filename, string content)[] generatedSources, DiagnosticResult[] expectedDiagnostics = null)
+        {
+            var test = new Test
+            {
+                TestCode = source
+            };
+
+            foreach ((string filename, string content) in generatedSources)
+            {
+                test.TestState.GeneratedSources.Add((typeof(TSourceGenerator), filename, content));
+            }
+
+            if (expectedDiagnostics != null)
+            {
+                test.ExpectedDiagnostics.AddRange(expectedDiagnostics);
+            }
+
+            return test.RunAsync();
+        }
+
+        public class Test : CSharpSourceGeneratorTest<TSourceGenerator, DefaultVerifier>
+        {
+            protected override CompilationOptions CreateCompilationOptions()
+            {
+                var compilationOptions = base.CreateCompilationOptions();
+                return compilationOptions.WithSpecificDiagnosticOptions(
+                    compilationOptions.SpecificDiagnosticOptions.SetItems(GetNullableWarningsFromCompiler()));
+            }
+
+            private static ImmutableDictionary<string, ReportDiagnostic> GetNullableWarningsFromCompiler()
+            {
+                string[] args = ["/warnaserror:nullable"];
+                var commandLineArguments = CSharpCommandLineParser.Default.Parse(args, baseDirectory: Environment.CurrentDirectory, sdkDirectory: Environment.CurrentDirectory);
+                return commandLineArguments.CompilationOptions.SpecificDiagnosticOptions;
+            }
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Exceptions/BadConstructorArgs.cs

@@ -0,0 +1,9 @@
+using RyuSocks.Packets;
+
+public partial class TestPacket : Packet
+{
+    private int SecondOffset => 1;
+
+    [PacketField(1.5f)]
+    public partial byte Byte1 { get; set; }
+}

RyuSocks.Generator.Test/data/PacketGenerator/GeneratedTypes/TestPacket.Byte1.g.cs

@@ -0,0 +1,19 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+partial class TestPacket
+{
+    public partial GeneratedEnumByte Byte1
+    {
+        get
+        {
+            return (GeneratedEnumByte)this[0];
+        }
+        set
+        {
+            this[0] = (byte)value;
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/GeneratedTypes/TestPacket.Byte2.g.cs

@@ -0,0 +1,19 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+partial class TestPacket
+{
+    public partial GeneratedEnumByte Byte2
+    {
+        get
+        {
+            return (GeneratedEnumByte)this[this.AnOffset];
+        }
+        set
+        {
+            this[this.AnOffset] = (byte)value;
+        }
+    }
+}