🌍 #376 Fix conversion exception when a generator error couldn't be resolved

Author: nth-commit

src/GalaxyCheck.Tests.V3/DomainGen.cs

@@ -35,12 +35,17 @@ from testFunction in TestFunctions.Nullary()
     public static Stable.IGen<int> Size() =>
         Stable.Gen.Int32().Between(GalaxyCheck.Gens.Parameters.Size.Zero.Value, GalaxyCheck.Gens.Parameters.Size.Max.Value);
 
-    public static Stable.IGen<int> Seed() => Stable.Gen.Int32();
+    public static Stable.IGen<int> Seed() => Stable.Gen.Int32().NoShrink();
 
     public static Stable.IGen<int?> SeedWaypoint() => Seed().OrNullStruct();
 
     public static Stable.IGen<Property> ToProperty(this Stable.IGen<IGen<object>> metaGen) =>
         from gen in metaGen
         from testFunction in TestFunctions.Unary<object>()
         select new Property((IGen<Property.Test<object>>)Property.ForAll<object>(gen, testFunction));
+
+    public class SeedAttribute : Stable.GenAttribute
+    {
+        public override Stable.IGen Value => Seed();
+    }
 }

src/GalaxyCheck.Tests.V3/Features/Generators/Operators/AboutWhereOperator.cs

@@ -15,7 +15,7 @@ static void Test(int seed, int size)
             var filteredGen = baseGen.Where(testFunction);
 
             // Act
-            var sample = filteredGen.Sample(args => args with { Seed = seed, Size = size });
+            var sample = filteredGen.SampleTraversal(args => args with { Seed = seed, Size = size });
 
             // Assert
             sample.Should().OnlyContain(x => testFunction(x));
@@ -35,7 +35,7 @@ static void Test(int seed, int size)
             var filteredGen = baseGen.Where(testFunction);
 
             // Act
-            var act = () => filteredGen.Sample(args => args with { Seed = seed, Size = size });
+            var act = () => filteredGen.SampleTraversal(args => args with { Seed = seed, Size = size });
 
             // Assert
             act.Should().NotThrow<Exceptions.GenExhaustionException>();

src/GalaxyCheck.Tests.V3/Features/Generators/Reflection/AboutDynamicGeneration.cs

@@ -16,7 +16,7 @@ public void ItCanGenerateTheType(Type type)
         var gen = Gen.Create(type);
 
         // Act
-        var sample = gen.Sample();
+        var sample = gen.SampleTraversal();
 
         // Assert
         sample.Should().AllBeAssignableTo(type);

src/GalaxyCheck.Tests.V3/Features/Generators/Reflection/ObjectGraph/AboutErrorMessages.cs

@@ -0,0 +1,37 @@
+namespace GalaxyCheck.Tests.Features.Generators.Reflection.ObjectGraph;
+
+public class AboutErrorReproduction
+{
+    [Stable.Property]
+    [InlineData(typeof(ExampleObjects.UnconstructableClass), "")]
+    [InlineData(typeof(ClassWithNestedUnconstructableClass), " at path '$.Property'")]
+    [InlineData(typeof(ClassWithNestedNullableUnconstructableClass), " at path '$.Property'")]
+    [InlineData(typeof(List<ExampleObjects.UnconstructableClass>), " at path '$.[*]'")]
+    public Stable.Property WhenTypeIsUnresolvable(Type type, string expectedPathDescription)
+    {
+        return Stable.Property.ForAll(DomainGen.Seed(), seed =>
+        {
+            // Arrange
+            var gen = Gen.Create(type);
+
+            // Act
+            var action = () => gen.Sample(args => args with { Seed = seed });
+
+            // Assert
+            action
+                .Should()
+                .Throw<Exceptions.GenErrorException>()
+                .WithGenErrorMessage($"could not resolve type '*'{expectedPathDescription}");
+        });
+    }
+
+    private class ClassWithNestedUnconstructableClass
+    {
+        public ExampleObjects.UnconstructableClass Property { get; set; } = null!;
+    }
+
+    private class ClassWithNestedNullableUnconstructableClass
+    {
+        public ExampleObjects.UnconstructableClass? Property { get; set; } = null!;
+    }
+}

src/GalaxyCheck.Tests.V3/Features/Generators/Reflection/ObjectGraph/ExampleObjects.cs

@@ -0,0 +1,69 @@
+namespace GalaxyCheck.Tests.Features.Generators.Reflection.ObjectGraph;
+
+public static class ExampleObjects
+{
+    public class ClassWithFailingConstructor
+    {
+        private static readonly Exception _exception = new("Constructor failed");
+
+        public ClassWithFailingConstructor()
+        {
+            throw _exception;
+        }
+    }
+
+    public class ClassWithNestedFailingConstructor
+    {
+        public ClassWithFailingConstructor Property { get; set; } = null!;
+    }
+
+    public class ClassWithArrayOfFailingConstructors
+    {
+        public ClassWithFailingConstructor[] Property { get; set; } = null!;
+    }
+
+    public class ClassWithArrayOfNestedFailingConstructors
+    {
+        public ClassWithNestedFailingConstructor[] Property { get; set; } = null!;
+    }
+
+    public class ClassWithFailingConstructorAsConstructorParameter
+    {
+        public ClassWithFailingConstructor Property { get; set; }
+
+        public ClassWithFailingConstructorAsConstructorParameter(ClassWithFailingConstructor property)
+        {
+            Property = property;
+        }
+    }
+
+    public class ClassWithNestedFailingConstructorAsConstructorParameter
+    {
+        public ClassWithNestedFailingConstructor Property { get; set; }
+
+        public ClassWithNestedFailingConstructorAsConstructorParameter(ClassWithNestedFailingConstructor property)
+        {
+            Property = property;
+        }
+    }
+
+    public class ClassWithOneProperty
+    {
+        public int Property { get; set; }
+    }
+
+    public class ClassWithTwoProperties
+    {
+        public int Property1 { get; set; }
+        public int Property2 { get; set; }
+    }
+
+    public class ClassWithOneNestedProperty
+    {
+        public ClassWithOneProperty Property { get; set; } = null!;
+    }
+
+    public abstract class UnconstructableClass
+    {
+    }
+}

src/GalaxyCheck.Tests.V3/GalaxyCheck.Tests.V3.csproj

@@ -12,7 +12,7 @@
 
   <ItemGroup>
     <PackageReference Include="FluentAssertions" Version="6.11.0" />
-    <PackageReference Include="GalaxyCheck.Stable.Xunit" Version="0.0.0-5085494672" />
+    <PackageReference Include="GalaxyCheck.Stable.Xunit" Version="0.0.0-5131115847" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
     <PackageReference Include="Snapshooter.Xunit" Version="0.5.8" />
     <PackageReference Include="xunit" Version="2.4.2" />
@@ -31,8 +31,4 @@
     <ProjectReference Include="..\GalaxyCheck\GalaxyCheck.csproj" />
   </ItemGroup>
 
-  <ItemGroup>
-    <Folder Include="IntegrationTests" />
-  </ItemGroup>
-
 </Project>

src/GalaxyCheck.Tests.V3/TestProxy.cs

@@ -75,7 +75,7 @@ public static CheckResult<object> Check(this PropertyProxy propertyProxy, Func<C
     /// Samples a generator by traversing the example space. This is useful to ensure that not only the produced value satisfies some invariant, but
     /// also all shrunk values.
     /// </summary>
-    public static IReadOnlyCollection<T> Sample<T>(this IGen<T> gen, Func<SampleGenArgs, SampleGenArgs>? configure = null)
+    public static IReadOnlyCollection<T> SampleTraversal<T>(this IGen<T> gen, Func<SampleGenArgs, SampleGenArgs>? configure = null)
     {
         var args = SampleGenArgs.Default;
         if (configure != null)
@@ -84,12 +84,26 @@ public static IReadOnlyCollection<T> Sample<T>(this IGen<T> gen, Func<SampleGenA
         }
 
         return gen.Advanced
-            .SampleOneExampleSpace(seed: args.Seed, size: args.Size)
+            .SampleOneExampleSpace(seed: args.Seed, size: args.Size ?? 100)
             .Traverse()
             .Take(args.MaxSampleSize)
             .ToList();
     }
 
+    public static IReadOnlyCollection<T> Sample<T>(this IGen<T> gen, Func<SampleGenArgs, SampleGenArgs>? configure = null)
+    {
+        var args = SampleGenArgs.Default;
+        if (configure != null)
+        {
+            args = configure(args);
+        }
+
+        return gen
+            .Sample(seed: args.Seed, size: args.Size ?? 100)
+            .Take(args.MaxSampleSize)
+            .ToList();
+    }
+
     public record CheckPropertyArgs(int Seed, int? Size, string? Replay)
     {
         public static CheckPropertyArgs Default { get; } = new(0, null, null);

src/GalaxyCheck.Tests.V3/TestUtility/AssertionExtensions.cs

@@ -0,0 +1,13 @@
+using FluentAssertions.Specialized;
+
+namespace GalaxyCheck.Tests.TestUtility;
+
+public static class AssertionExtensions
+{
+    public static ExceptionAssertions<Exceptions.GenErrorException> WithGenErrorMessage(
+        this ExceptionAssertions<Exceptions.GenErrorException> assertions,
+        string messageBody)
+    {
+        return assertions.WithMessage("Error during generation: " + messageBody);
+    }
+}

src/GalaxyCheck/Gens/FactoryGen.cs

@@ -229,7 +229,7 @@ protected override IGen<T> Get
                 var context = ReflectedGenHandlerContext.Create(typeof(T), NullabilityInfo);
 
                 return ReflectedGenBuilder
-                    .Build(typeof(T), RegisteredGensByType, MemberOverrides, Error, context)
+                    .Build(typeof(T), RegisteredGensByType, MemberOverrides, context)
                     .Cast<T>();
             }
         }

src/GalaxyCheck/Gens/ReflectedGenHelpers/ErrorFactory.cs

@@ -1,6 +1,6 @@
-namespace GalaxyCheck.Gens.ReflectedGenHelpers
+using System;
+
+namespace GalaxyCheck.Gens.ReflectedGenHelpers
 {
     internal delegate IGen ErrorFactory(string message);
-
-    internal delegate IGen ContextualErrorFactory(string message, ReflectedGenHandlerContext context);
 }