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,65 @@
+using System.IO;
+using System.Threading.Tasks;
+using Xunit;
+using Verify = RyuSocks.Generator.Test.SourceGeneratorVerifier<RyuSocks.Generator.PacketGenerator>;
+
+namespace RyuSocks.Generator.Test
+{
+    public class PacketGeneratorTests
+    {
+        private const string DataDirectory = "data/PacketGenerator/";
+
+        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));
+
+        [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)
+        {
+            const int DefaultSourcesAmount = 3;
+            (string, string)[] generatedSources = new (string, string)[expectedGeneratedSourcePath.Length + DefaultSourcesAmount];
+
+            generatedSources[0] = GetGeneratedSourceFromFile("StringEncoding.g.cs");
+            generatedSources[1] = GetGeneratedSourceFromFile("PacketFieldAttribute.g.cs");
+            generatedSources[2] = GetGeneratedSourceFromFile("Packet.g.cs");
+
+            directory += "/";
+
+            for (int i = 0; i < expectedGeneratedSourcePath.Length; i++)
+            {
+                generatedSources[i + DefaultSourcesAmount] = GetGeneratedSourceFromFile(directory + expectedGeneratedSourcePath[i]);
+            }
+
+            await Verify.VerifyGeneratedSources(
+                GetSourceFromFile(directory + sourcePath),
+                generatedSources
+            );
+        }
+    }
+}

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,47 @@
+using Microsoft.CodeAnalysis;
+using Microsoft.CodeAnalysis.CSharp;
+using Microsoft.CodeAnalysis.CSharp.Testing;
+using Microsoft.CodeAnalysis.Testing;
+using System;
+using System.Collections.Generic;
+using System.Collections.Immutable;
+using System.Threading.Tasks;
+
+namespace RyuSocks.Generator.Test
+{
+    public static class SourceGeneratorVerifier<TSourceGenerator>
+        where TSourceGenerator : new()
+    {
+        public static Task VerifyGeneratedSources(string source, params (string filename, string content)[] generatedSources)
+        {
+            var test = new Test
+            {
+                TestCode = source
+            };
+
+            foreach ((string filename, string content) in generatedSources)
+            {
+                test.TestState.GeneratedSources.Add((typeof(TSourceGenerator), filename, content));
+            }
+
+            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/Namespaces/AnotherSpace.TestPacket.TestField.g.cs

@@ -0,0 +1,22 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+namespace AnotherSpace
+{
+    partial class TestPacket
+    {
+        public partial byte TestField
+        {
+            get
+            {
+                return this[4];
+            }
+            set
+            {
+                this[4] = value;
+            }
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Namespaces/AnotherSpace.TestPacket2.SecondField.g.cs

@@ -0,0 +1,22 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+namespace AnotherSpace
+{
+    partial class TestPacket2
+    {
+        private partial byte SecondField
+        {
+            get
+            {
+                return this[2];
+            }
+            set
+            {
+                this[2] = value;
+            }
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Namespaces/TestPacket.cs

@@ -0,0 +1,31 @@
+using RyuSocks.Packets;
+
+namespace TestSpace
+{
+    public partial class TestPacket : Packet
+    {
+        [PacketField(0)]
+        internal partial byte TestField { get; set; }
+    }
+
+    partial class TestPacket1 : Packet
+    {
+        [PacketField(1)]
+        public partial byte FirstField { get; set; }
+    }
+}
+
+namespace AnotherSpace
+{
+    partial class TestPacket : Packet
+    {
+        [PacketField(4)]
+        public partial byte TestField { get; set; }
+    }
+
+    internal partial class TestPacket2 : Packet
+    {
+        [PacketField(2)]
+        private partial byte SecondField { get; set; }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Namespaces/TestSpace.TestPacket.TestField.g.cs

@@ -0,0 +1,22 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+namespace TestSpace
+{
+    partial class TestPacket
+    {
+        internal partial byte TestField
+        {
+            get
+            {
+                return this[0];
+            }
+            set
+            {
+                this[0] = value;
+            }
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Namespaces/TestSpace.TestPacket1.FirstField.g.cs

@@ -0,0 +1,22 @@
+using RyuSocks.Packets;
+using System;
+using System.Buffers.Binary;
+using System.Text;
+
+namespace TestSpace
+{
+    partial class TestPacket1
+    {
+        public partial byte FirstField
+        {
+            get
+            {
+                return this[1];
+            }
+            set
+            {
+                this[1] = value;
+            }
+        }
+    }
+}

RyuSocks.Generator.Test/data/PacketGenerator/Packet.g.cs

@@ -0,0 +1,42 @@
+using System;
+
+namespace RyuSocks.Packets
+{
+    public abstract partial class Packet
+    {
+        /// <summary>
+        /// The contents of the packet.
+        /// </summary>
+        public byte[] Bytes { get; protected set; }
+
+        /// <inheritdoc cref="Bytes"/>
+        public byte this[int i]
+        {
+            get => Bytes[i];
+            set => Bytes[i] = value;
+        }
+
+        /// <summary>
+        /// Creates a new span over the packet.
+        /// </summary>
+        /// <seealso cref="Bytes"/>
+        /// <seealso cref="M:System.MemoryExtensions.AsSpan``1(``0[])"/>
+        public Span<byte> AsSpan() => Bytes;
+
+        /// <summary>
+        /// Creates a new Span over the portion of the packet beginning
+        /// at 'start' index and ending at 'end' index (exclusive).
+        /// </summary>
+        /// <param name="start">The index at which to begin the Span.</param>
+        /// <param name="length">The number of items in the Span.</param>
+        /// <seealso cref="M:System.MemoryExtensions.AsSpan``1(``0[],System.Int32,System.Int32)"/>
+        public Span<byte> AsSpan(int start, int length) => Bytes.AsSpan(start, length);
+
+        protected Packet() { }
+
+        protected Packet(byte[] bytes)
+        {
+            Bytes = bytes;
+        }
+    }
+}