// ------------------------------------------------------------
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License (MIT). See LICENSE in the repo root for license information.
// ------------------------------------------------------------
using System.Linq;
using Microsoft.OData.Edm;
using Microsoft.OData.Edm.Csdl;
using Microsoft.OpenApi.OData.Capabilities;
using Xunit;
namespace Microsoft.OpenApi.OData.Reader.Capabilities.Tests
{
public class FilterRestrictionsTests
{
[Fact]
public void KindPropertyReturnsFilterRestrictionsEnumMember()
{
// Arrange & Act
FilterRestrictions filter = new FilterRestrictions();
// Assert
Assert.Equal(CapabilitesTermKind.FilterRestrictions, filter.Kind);
}
[Fact]
public void UnknownAnnotatableTargetReturnsDefaultFilterRestrictionsValues()
{
// Arrange
FilterRestrictions filter = new FilterRestrictions();
EdmEntityType entityType = new EdmEntityType("NS", "Entity");
// Act
bool result = filter.Load(EdmCoreModel.Instance, entityType);
// Assert
Assert.False(result);
Assert.True(filter.IsFilterable);
Assert.Null(filter.Filterable);
Assert.Null(filter.RequiresFilter);
Assert.Null(filter.RequiredProperties);
Assert.Null(filter.NonFilterableProperties);
}
[Theory]
[InlineData(EdmVocabularyAnnotationSerializationLocation.Inline)]
[InlineData(EdmVocabularyAnnotationSerializationLocation.OutOfLine)]
public void TargetOnEntityTypeReturnsCorrectfilterRestrictionsValue(EdmVocabularyAnnotationSerializationLocation location)
{
// Arrange
const string template = @"
{0}
";
IEdmModel model = GetEdmModel(template, location);
Assert.NotNull(model); // guard
IEdmEntitySet calendars = model.EntityContainer.FindEntitySet("Calendars");
Assert.NotNull(calendars); // guard
// Act
FilterRestrictions filter = new FilterRestrictions();
bool result = filter.Load(model, calendars);
// Assert
Assert.True(result);
VerifyFilterRestrictions(filter);
}
[Theory]
[InlineData(EdmVocabularyAnnotationSerializationLocation.Inline)]
[InlineData(EdmVocabularyAnnotationSerializationLocation.OutOfLine)]
public void TargetOnEntitySetReturnsCorrectFilterRestrictionsValue(EdmVocabularyAnnotationSerializationLocation location)
{
// Arrange
const string template = @"
{0}
";
IEdmModel model = GetEdmModel(template, location);
Assert.NotNull(model); // guard
IEdmEntitySet calendars = model.EntityContainer.FindEntitySet("Calendars");
Assert.NotNull(calendars); // guard
// Act
FilterRestrictions filter = new FilterRestrictions();
bool result = filter.Load(model, calendars);
// Assert
Assert.True(result);
VerifyFilterRestrictions(filter);
}
private static IEdmModel GetEdmModel(string template, EdmVocabularyAnnotationSerializationLocation location)
{
string countAnnotation = @"
Id
Emails
";
if (location == EdmVocabularyAnnotationSerializationLocation.OutOfLine)
{
countAnnotation = string.Format(template, countAnnotation);
return CapabilitiesModelHelper.GetEdmModelOutline(countAnnotation);
}
else
{
return CapabilitiesModelHelper.GetEdmModelTypeInline(countAnnotation);
}
}
private static void VerifyFilterRestrictions(FilterRestrictions filter)
{
Assert.NotNull(filter);
Assert.NotNull(filter.Filterable);
Assert.False(filter.Filterable.Value);
Assert.NotNull(filter.RequiresFilter);
Assert.False(filter.RequiresFilter.Value);
Assert.NotNull(filter.RequiredProperties);
Assert.Single(filter.RequiredProperties);
Assert.Equal("Id", filter.RequiredProperties.First());
Assert.NotNull(filter.NonFilterableProperties);
Assert.Single(filter.NonFilterableProperties);
Assert.Equal("Emails", filter.NonFilterableProperties.First());
Assert.True(filter.IsRequiredProperty("Id"));
Assert.False(filter.IsRequiredProperty("ID"));
Assert.True(filter.IsNonFilterableProperty("Emails"));
Assert.False(filter.IsNonFilterableProperty("ID"));
}
}
}