[ksqlDb.RestApi.Client]: added the IgnoreInDDL function to the Fluent API tests #93

Author: tomasfabian

Tests/ksqlDB.RestApi.Client.IntegrationTests/KSql/Linq/JoinsTests.cs

@@ -34,6 +34,8 @@ public static async Task ClassInitialize()
 
     moviesProvider = new MoviesProvider(RestApiProvider);
 
+    await ClassCleanup();
+
     var response = await RestApiProvider.CreateStreamAsync<Order>(OrderEntityCreationMetadata, ifNotExists: true);
 
     await moviesProvider.DropTablesAsync();
@@ -93,7 +95,7 @@ public async Task Join()
   public async Task LeftJoin()
   {
     //Arrange
-    int expectedItemsCount = 2;
+    int expectedItemsCount = 1;
 
     var source = Context.CreatePushQuery<Movie>(MoviesTableName)
       .LeftJoin(
@@ -120,9 +122,9 @@ public async Task LeftJoin()
     Assert.AreEqual(MoviesProvider.Movie1.Title, actualValues[0].Title);
     Assert.AreEqual(MoviesProvider.LeadActor1.Title, actualValues[0].Title);
 
-    actualValues[1].Substr.Length.Should().Be(4);
-    actualValues[1].Release_Year.Should().BeOneOf(MoviesProvider.Movie1.Release_Year, MoviesProvider.Movie2.Release_Year);
-    actualValues[1].ActorTitle.Should().BeOneOf(null, MoviesProvider.Movie1.Title, MoviesProvider.Movie2.Title);
+    actualValues[0].Substr.Length.Should().Be(4);
+    actualValues[0].Release_Year.Should().BeOneOf(MoviesProvider.Movie1.Release_Year, MoviesProvider.Movie2.Release_Year);
+    actualValues[0].ActorTitle.Should().BeOneOf(null, MoviesProvider.Movie1.Title, MoviesProvider.Movie2.Title);
   }
 
   public record Movie2 : Record

Tests/ksqlDB.RestApi.Client.IntegrationTests/KSql/Linq/ModelBuilderTests.cs

@@ -6,6 +6,7 @@
 using ksqlDB.RestApi.Client.KSql.Linq;
 using ksqlDB.RestApi.Client.KSql.RestApi;
 using ksqlDB.RestApi.Client.KSql.RestApi.Enums;
+using ksqlDB.RestApi.Client.KSql.RestApi.Extensions;
 using ksqlDB.RestApi.Client.KSql.RestApi.Http;
 using ksqlDB.RestApi.Client.KSql.RestApi.Statements;
 using ksqlDB.RestApi.Client.KSql.RestApi.Statements.Properties;
@@ -42,6 +43,7 @@ public record Tweet : Record
       Message = "Hello world",
       IsRobot = true,
       Amount = 0.00042,
+      RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
     };
 
     public static readonly Tweet Tweet2 = new()
@@ -50,6 +52,7 @@ public record Tweet : Record
       Message = "Wall-e",
       IsRobot = false,
       Amount = 1,
+      RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
     };
 
     protected static async Task InitializeDatabase()
@@ -68,6 +71,8 @@ protected static async Task InitializeDatabase()
       };
       kSqlDbRestApiClient = new KSqlDbRestApiClient(new HttpClientFactory(httpClient), modelBuilder);
 
+      await ClassCleanup();
+
       var entityCreationMetadata = new EntityCreationMetadata(TopicName, 1)
       {
         EntityName = StreamName,
@@ -135,5 +140,25 @@ public async Task Select()
       expectedItemsCount.Should().Be(actualValues.Count);
       CollectionAssert.AreEqual(expectedValues, actualValues);
     }
+
+    [Test]
+    public async Task SelectPseudoColumns()
+    {
+      //Arrange
+      int expectedItemsCount = 2;
+
+      var source = QuerySource
+        .Select(c => new{ c.RowTime, c.RowOffset, c.Message })
+        .ToAsyncEnumerable();
+
+      //Act
+      var actualValues = await CollectActualValues(source, expectedItemsCount);
+
+      //Assert
+      expectedItemsCount.Should().Be(actualValues.Count);
+      actualValues[0].RowTime.Should().Be(Tweet1.RowTime);
+      actualValues[0].RowTime.Should().BeGreaterOrEqualTo(0);
+      actualValues[0].Message.Should().Be(Tweet1.Message);
+    }
   }
 }

Tests/ksqlDB.RestApi.Client.IntegrationTests/KSql/Linq/MoviesProvider.cs

@@ -55,26 +55,30 @@ actor_name VARCHAR
   {
     Id = 1,
     Release_Year = 1986,
-    Title = "Aliens"
+    Title = "Aliens",
+    RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
   };
 
   public static readonly Movie Movie2 = new()
   {
     Id = 2,
     Release_Year = 1988,
-    Title = "Die Hard"
+    Title = "Die Hard",
+    RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
   };
 
   public static readonly Lead_Actor LeadActor1 = new()
   {
     Actor_Name = "Sigourney Weaver",
-    Title = "Aliens"
+    Title = "Aliens",
+    RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
   };
 
   public static readonly Lead_Actor LeadActor2 = new()
   {
     Actor_Name = "Al Pacino",
-    Title = "The Godfather"
+    Title = "The Godfather",
+    RowTime = DateTimeOffset.UtcNow.ToUnixTimeSeconds()
   };
 
   public async Task<bool> InsertMovieAsync(Movie movie)

Tests/ksqlDB.RestApi.Client.IntegrationTests/Models/Record.cs

@@ -4,7 +4,11 @@ namespace ksqlDb.RestApi.Client.IntegrationTests.Models;
 
 public record Record
 {
-  [ksqlDB.RestApi.Client.KSql.RestApi.Statements.Annotations.Ignore]
   [PseudoColumn]
+  [IgnoreInDDL]
   public long RowTime { get; set; }
+
+  [ksqlDB.RestApi.Client.KSql.RestApi.Statements.Annotations.Ignore]
+  [PseudoColumn]
+  public long? RowOffset { get; set; }
 }

Tests/ksqlDB.RestApi.Client.Tests/FluentAPI/Builders/ModelBuilderTests.cs

@@ -84,6 +84,23 @@ public void Property_IgnoreInDML()
       entityMetadata!.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(Payment.Description)).IgnoreInDML.Should().BeTrue();
     }
 
+    [Test]
+    public void Property_IgnoreInDDL()
+    {
+      //Arrange
+
+      //Act
+      var fieldTypeBuilder = builder.Entity<Payment>()
+        .Property(b => b.Description)
+        .IgnoreInDDL();
+
+      //Assert
+      fieldTypeBuilder.Should().NotBeNull();
+      var entityMetadata = ((IMetadataProvider)builder).GetEntities().FirstOrDefault(c => c.Type == typeof(Payment));
+      entityMetadata.Should().NotBeNull();
+      entityMetadata!.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(Payment.Description)).IgnoreInDDL.Should().BeTrue();
+    }
+
     [Test]
     public void Property_HasColumnName()
     {

Tests/ksqlDB.RestApi.Client.Tests/KSql/RestApi/Generators/TypeGeneratorTests.cs

@@ -68,6 +68,22 @@ public void CreateType_ModelBuilder_HasColumnName()
       .Be($"CREATE TYPE {nameof(Address)} AS STRUCT<{columnName} INT, Street VARCHAR, City VARCHAR>;");
   }
 
+  [Test]
+  public void CreateType_ModelBuilder_IgnoreInDDL()
+  {
+    //Arrange
+    modelBuilder.Entity<Address>()
+      .Property(b => b.Number)
+      .IgnoreInDDL();
+
+    //Act
+    var statement = new TypeGenerator(modelBuilder).Print<Address>(new TypeProperties());
+
+    //Assert
+    statement.Should()
+      .Be($"CREATE TYPE {nameof(Address)} AS STRUCT<Street VARCHAR, City VARCHAR>;");
+  }
+
   [Test]
   public void CreateType_WithTypeName()
   {
@@ -146,6 +162,8 @@ public record Address
     public int Number { get; set; }
     public string Street { get; set; } = null!;
     public string City { get; set; } = null!;
+    [IgnoreInDDL]
+    public string Secret { get; set; } = null!;
   }
 
   public class Person

Tests/ksqlDB.RestApi.Client.Tests/KSql/RestApi/Statements/CreateEntityTests.cs

@@ -758,4 +758,34 @@ public void ModelBuilder_IgnoreProperty()
 	{nameof(Poco.Id)} INT PRIMARY KEY
 ) WITH ( KAFKA_TOPIC='{nameof(Poco)}', VALUE_FORMAT='Json', PARTITIONS='1', REPLICAS='1' );".ReplaceLineEndings());
   }
+
+  internal class IgnoreInDDL
+  {
+    [Key]
+    public int Id { get; set; }
+    [IgnoreInDDL]
+    [PseudoColumn]
+    public string RowTime { get; set; }
+  }
+
+  [Test]
+  public void Print_IgnoreInDDLAttribute()
+  {
+    //Arrange
+    var statementContext = new StatementContext
+    {
+      CreationType = CreationType.CreateOrReplace,
+      KSqlEntityType = KSqlEntityType.Table,
+    };
+
+    creationMetadata.KafkaTopic = nameof(IgnoreInDDL);
+
+    //Act
+    string statement = new CreateEntity(modelBuilder).Print<IgnoreInDDL>(statementContext, creationMetadata, null);
+
+    //Assert
+    statement.Should().Be($@"CREATE OR REPLACE TABLE {nameof(IgnoreInDDL)}s (
+	{nameof(IgnoreInDDL.Id)} INT PRIMARY KEY
+) WITH ( KAFKA_TOPIC='{nameof(IgnoreInDDL)}', VALUE_FORMAT='Json', PARTITIONS='1', REPLICAS='1' );".ReplaceLineEndings());
+  }
 }