Nell/eShopOnWeb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added possibility to chain includes. (#331)

Browse Source 
* Added possibility to chain includes.

* Removed interface.

* Removed the need for generating GUIDs as ids and added tests.
This commit is contained in:
mrukas
2019-12-16 15:42:04 +01:00
committed by Eric Fleming
parent 9695e9e3ba
commit 13fc6ea546
14 changed files with 478 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
tests/UnitTests/ApplicationCore/Helpers/Query/Book.cs Normal file
View File

@@ -0,0 +1,16 @@
using System;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query
{
public class Book
{
public string Title { get; set; }
public DateTime PublishingDate { get; set; }
public Person Author { get; set; }
public int GetNumberOfSales()
{
return 0;
}
}
}

48
tests/UnitTests/ApplicationCore/Helpers/Query/IncludeAggregatorTests/Include.cs Normal file
View File

@@ -0,0 +1,48 @@
using Microsoft.eShopWeb.ApplicationCore.Helpers.Query;
using Xunit;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query.IncludeAggregatorTests
{
public class Include
{
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeSimpleType()
{
var includeAggregator = new IncludeAggregator<Person>();
// There may be ORM libraries where including a simple type makes sense.
var includeQuery = includeAggregator.Include(p => p.Age);
Assert.Contains(includeQuery.Paths, path => path == nameof(Person.Age));
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeFunction()
{
var includeAggregator = new IncludeAggregator<Person>();
// This include does not make much sense, but it should at least do not modify the paths.
var includeQuery = includeAggregator.Include(p => p.FavouriteBook.GetNumberOfSales());
Assert.Contains(includeQuery.Paths, path => path == nameof(Person.FavouriteBook));
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeObject()
{
var includeAggregator = new IncludeAggregator<Person>();
var includeQuery = includeAggregator.Include(p => p.FavouriteBook.Author);
Assert.Contains(includeQuery.Paths, path => path == $"{nameof(Person.FavouriteBook)}.{nameof(Book.Author)}");
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeCollection()
{
var includeAggregator = new IncludeAggregator<Book>();
var includeQuery = includeAggregator.Include(o => o.Author.Friends);
Assert.Contains(includeQuery.Paths, path => path == $"{nameof(Book.Author)}.{nameof(Person.Friends)}");
}
}
}

80
tests/UnitTests/ApplicationCore/Helpers/Query/IncludeQueryTests/Include.cs Normal file
View File

@@ -0,0 +1,80 @@
using Microsoft.eShopWeb.ApplicationCore.Helpers.Query;
using Microsoft.eShopWeb.UnitTests.Builders;
using Xunit;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query.IncludeQueryTests
{
public class Include
{
private IncludeQueryBuilder _includeQueryBuilder = new IncludeQueryBuilder();
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeSimpleType()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
// There may be ORM libraries where including a simple type makes sense.
var newIncludeQuery = includeQuery.Include(b => b.Title);
Assert.Contains(newIncludeQuery.Paths, path => path == nameof(Book.Title));
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeFunction()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
// This include does not make much sense, but it should at least do not modify paths.
var newIncludeQuery = includeQuery.Include(b => b.GetNumberOfSales());
// The resulting paths should not include number of sales.
Assert.DoesNotContain(newIncludeQuery.Paths, path => path == nameof(Book.GetNumberOfSales));
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeObject()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var newIncludeQuery = includeQuery.Include(b => b.Author);
Assert.Contains(newIncludeQuery.Paths, path => path == nameof(Book.Author));
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeCollection()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var newIncludeQuery = includeQuery.Include(b => b.Author.Friends);
var expectedPath = $"{nameof(Book.Author)}.{nameof(Person.Friends)}";
Assert.Contains(newIncludeQuery.Paths, path => path == expectedPath);
}
[Fact]
public void Should_IncreaseNumberOfPathsByOne()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var numberOfPathsBeforeInclude = includeQuery.Paths.Count;
var newIncludeQuery = includeQuery.Include(b => b.Author.Friends);
var numberOfPathsAferInclude = newIncludeQuery.Paths.Count;
var expectedNumerOfPaths = numberOfPathsBeforeInclude + 1;
Assert.Equal(expectedNumerOfPaths, numberOfPathsAferInclude);
}
[Fact]
public void Should_NotModifyAnotherPath()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var pathsBeforeInclude = includeQuery.Paths;
var newIncludeQuery = includeQuery.Include(b => b.Author.Friends);
var pathsAfterInclude = newIncludeQuery.Paths;
Assert.Subset(pathsAfterInclude, pathsBeforeInclude);
}
}
}

78
tests/UnitTests/ApplicationCore/Helpers/Query/IncludeQueryTests/ThenInclude.cs Normal file
View File

@@ -0,0 +1,78 @@
using Microsoft.eShopWeb.ApplicationCore.Helpers.Query;
using Microsoft.eShopWeb.UnitTests.Builders;
using System.Linq;
using Xunit;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query.IncludeQueryTests
{
public class ThenInclude
{
private IncludeQueryBuilder _includeQueryBuilder = new IncludeQueryBuilder();
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeSimpleType()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var pathBeforeInclude = includeQuery.Paths.First();
// There may be ORM libraries where including a simple type makes sense.
var newIncludeQuery = includeQuery.ThenInclude(p => p.Age);
var pathAfterInclude = newIncludeQuery.Paths.First();
var expectedPath = $"{pathBeforeInclude}.{nameof(Person.Age)}";
Assert.Equal(expectedPath, pathAfterInclude);
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeFunction()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var pathBeforeInclude = includeQuery.Paths.First();
// This include does not make much sense, but it should at least not modify the paths.
var newIncludeQuery = includeQuery.ThenInclude(p => p.GetQuote());
var pathAfterInclude = newIncludeQuery.Paths.First();
Assert.Equal(pathBeforeInclude, pathAfterInclude);
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeObject()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var pathBeforeInclude = includeQuery.Paths.First();
var newIncludeQuery = includeQuery.ThenInclude(p => p.FavouriteBook);
var pathAfterInclude = newIncludeQuery.Paths.First();
var expectedPath = $"{pathBeforeInclude}.{nameof(Person.FavouriteBook)}";
Assert.Equal(expectedPath, pathAfterInclude);
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludeCollection()
{
var includeQuery = _includeQueryBuilder.WithObjectAsPreviousProperty();
var pathBeforeInclude = includeQuery.Paths.First();
var newIncludeQuery = includeQuery.ThenInclude(p => p.Friends);
var pathAfterInclude = newIncludeQuery.Paths.First();
var expectedPath = $"{pathBeforeInclude}.{nameof(Person.Friends)}";
Assert.Equal(expectedPath, pathAfterInclude);
}
[Fact]
public void Should_ReturnIncludeQueryWithCorrectPath_IfIncludePropertyOverCollection()
{
var includeQuery = _includeQueryBuilder.WithCollectionAsPreviousProperty();
var pathBeforeInclude = includeQuery.Paths.First();
var newIncludeQuery = includeQuery.ThenInclude(p => p.FavouriteBook);
var pathAfterInclude = newIncludeQuery.Paths.First();
var expectedPath = $"{pathBeforeInclude}.{nameof(Person.FavouriteBook)}";
Assert.Equal(expectedPath, pathAfterInclude);
}
}
}

55
tests/UnitTests/ApplicationCore/Helpers/Query/IncludeVisitorTests/Visit.cs Normal file
View File

@@ -0,0 +1,55 @@
using Microsoft.eShopWeb.ApplicationCore.Helpers.Query;
using System;
using System.Collections.Generic;
using System.Linq.Expressions;
using Xunit;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query.IncludeVisitorTests
{
public class Visit
{
[Fact]
public void Should_SetPath_IfPassedExpressionWithSimpleType()
{
var visitor = new IncludeVisitor();
Expression<Func<Book, string>> expression = (book) => book.Author.FirstName;
visitor.Visit(expression);
var expectedPath = $"{nameof(Book.Author)}.{nameof(Person.FirstName)}";
Assert.Equal(expectedPath, visitor.Path);
}
[Fact]
public void Should_SetPath_IfPassedExpressionWithObject()
{
var visitor = new IncludeVisitor();
Expression<Func<Book, Book>> expression = (book) => book.Author.FavouriteBook;
visitor.Visit(expression);
var expectedPath = $"{nameof(Book.Author)}.{nameof(Person.FavouriteBook)}";
Assert.Equal(expectedPath, visitor.Path);
}
[Fact]
public void Should_SetPath_IfPassedExpressionWithCollection()
{
var visitor = new IncludeVisitor();
Expression<Func<Book, List<Person>>> expression = (book) => book.Author.Friends;
visitor.Visit(expression);
var expectedPath = $"{nameof(Book.Author)}.{nameof(Person.Friends)}";
Assert.Equal(expectedPath, visitor.Path);
}
[Fact]
public void Should_SetPath_IfPassedExpressionWithFunction()
{
var visitor = new IncludeVisitor();
Expression<Func<Book, string>> expression = (book) => book.Author.GetQuote();
visitor.Visit(expression);
var expectedPath = nameof(Book.Author);
Assert.Equal(expectedPath, visitor.Path);
}
}
}

19
tests/UnitTests/ApplicationCore/Helpers/Query/Person.cs Normal file
View File

@@ -0,0 +1,19 @@
using System.Collections.Generic;
namespace Microsoft.eShopWeb.UnitTests.ApplicationCore.Helpers.Query
{
public class Person
{
public int Age { get; set; }
public string FirstName { get; set; }
public string LastName { get; set; }
public Book FavouriteBook { get; set; }
public List<Person> Friends { get; set; }
public string GetQuote()
{
return string.Empty;
}
}
}