/// <summary>
/// Initializes a new instance of the <see cref="SelectExpandQueryOption"/> class.
/// </summary>
/// <param name="select">The $select query parameter value.</param>
/// <param name="expand">The $select query parameter value.</param>
/// <param name="context">The <see cref="ODataQueryContext"/> which contains the <see cref="IEdmModel"/> and some type information.</param>
public SelectExpandQueryOption(string select, string expand, ODataQueryContext context)
{
if (context == null)
{
throw Error.ArgumentNull("context");
}
if (String.IsNullOrEmpty(select) && String.IsNullOrEmpty(expand))
{
throw Error.Argument(SRResources.SelectExpandEmptyOrNull);
}
IEdmEntityType entityType = context.ElementType as IEdmEntityType;
if (entityType == null)
{
throw Error.Argument("context", SRResources.SelectNonEntity, context.ElementType.ToTraceString());
}
_entityType = entityType;
Context = context;
RawSelect = select;
RawExpand = expand;
Validator = new SelectExpandQueryValidator();
}
public void ValidateDoesNotThrow_IfExpansionDepthIsZero()
{
string expand = "Orders/Customer/Orders/Customer/Orders/Customer";
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(null, expand, _queryContext);
Assert.DoesNotThrow(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings { MaxExpansionDepth = 0 }));
}
public void ValidateDoesNotThrow_IfExpansionDepthIsZero()
{
string expand = "Orders/Customer/Orders/Customer/Orders/Customer";
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(null, expand, _queryContext);
Assert.DoesNotThrow(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings {
MaxExpansionDepth = 0
}));
}
public void ValidateThrowException_IfNotNavigable()
{
CustomersModelWithInheritance model = new CustomersModelWithInheritance();
model.Model.SetAnnotationValue(model.Customer, new ClrTypeAnnotation(typeof(Customer)));
ODataQueryContext queryContext = new ODataQueryContext(model.Model, typeof(Customer));
model.Model.SetAnnotationValue(model.Customer.FindProperty("Orders"), new QueryableRestrictionsAnnotation(new QueryableRestrictions{NotNavigable=true}));
string select = "Orders";
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(select, null, queryContext);
Assert.Throws<ODataException>(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings()),
"The property 'Orders' cannot be used for navigation.");
}
public void Validate_DepthChecks(string expand, int maxExpansionDepth)
{
// Arrange
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(null, expand, _queryContext);
// Act & Assert
Assert.Throws<ODataException>(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings { MaxExpansionDepth = maxExpansionDepth }),
String.Format(CultureInfo.CurrentCulture, "The request includes a $expand path which is too deep. The maximum depth allowed is {0}. " +
"To increase the limit, set the 'MaxExpansionDepth' property on EnableQueryAttribute or ODataValidationSettings.", maxExpansionDepth));
Assert.DoesNotThrow(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings { MaxExpansionDepth = maxExpansionDepth + 1 }));
}
public void ValidateThrowException_IfBaseOrDerivedClassPropertyNotNavigable(string className, string propertyName)
{
CustomersModelWithInheritance model = new CustomersModelWithInheritance();
model.Model.SetAnnotationValue(model.SpecialCustomer, new ClrTypeAnnotation(typeof(Customer)));
ODataQueryContext queryContext = new ODataQueryContext(model.Model, typeof(Customer));
EdmEntityType classType = (className == "Customer") ? model.Customer : model.SpecialCustomer;
model.Model.SetAnnotationValue(classType.FindProperty(propertyName), new QueryableRestrictionsAnnotation(new QueryableRestrictions { NotNavigable = true }));
string select = "NS.SpecialCustomer/" + propertyName;
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(select, null, queryContext);
Assert.Throws<ODataException>(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings()),
String.Format(CultureInfo.InvariantCulture, "The property '{0}' cannot be used for navigation.", propertyName));
}
public void Validate_DepthChecks(string expand, int maxExpansionDepth)
{
// Arrange
SelectExpandQueryValidator validator = new SelectExpandQueryValidator();
SelectExpandQueryOption selectExpandQueryOption = new SelectExpandQueryOption(null, expand, _queryContext);
// Act & Assert
Assert.Throws <ODataException>(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings {
MaxExpansionDepth = maxExpansionDepth
}),
String.Format(CultureInfo.CurrentCulture, "The request includes a $expand path which is too deep. The maximum depth allowed is {0}. " +
"To increase the limit, set the 'MaxExpansionDepth' property on EnableQueryAttribute or ODataValidationSettings.", maxExpansionDepth));
Assert.DoesNotThrow(
() => validator.Validate(selectExpandQueryOption, new ODataValidationSettings {
MaxExpansionDepth = maxExpansionDepth + 1
}));
}
