/// <summary>
/// Verifies the extension rule.
/// </summary>
/// <param name="context">The Interop service context</param>
/// <param name="info">out parameter to return violation information when rule does not pass</param>
/// <returns>true if rule passes; false otherwise</returns>
public override bool?Verify(ServiceContext context, out ExtensionRuleViolationInfo info)
{
if (context == null)
{
throw new ArgumentNullException("context");
}
bool?passed = null;
ExtensionRuleResultDetail detail = new ExtensionRuleResultDetail(this.Name);
var countRestrictions = AnnotationsHelper.GetCountRestrictions(context.MetadataDocument, context.VocCapabilities);
if (string.IsNullOrEmpty(countRestrictions.Item1))
{
detail.ErrorMessage = "Cannot find an entity-set which supports $count system query options.";
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
string entitySet = countRestrictions.Item1;
bool isNextLinkPropExist = false;
Int64 totalCount = 0;
string url = string.Format("{0}/{1}?$count=true", context.ServiceBaseUri.AbsoluteUri.TrimEnd('/'), entitySet);
Response resp = WebHelper.Get(new Uri(url), Constants.V4AcceptHeaderJsonFullMetadata, RuleEngineSetting.Instance().DefaultMaximumPayloadSize, context.RequestHeaders);
detail = new ExtensionRuleResultDetail(this.Name, url, "GET", StringHelper.MergeHeaders(Constants.V4AcceptHeaderJsonFullMetadata, context.RequestHeaders), resp);
if (resp.StatusCode.HasValue && resp.StatusCode == HttpStatusCode.OK)
{
JObject feed;
resp.ResponsePayload.TryToJObject(out feed);
var entries = JsonParserHelper.GetEntries(feed);
if (feed[Constants.V4OdataCount] != null)
{
totalCount = Convert.ToInt64(feed[Constants.V4OdataCount].Value <string>().StripOffDoubleQuotes());
if (entries.Count == totalCount)
{
passed = true;
}
else if (entries.Count < totalCount)
{
var jProps = feed.Children();
foreach (JProperty jProp in jProps)
{
if (jProp.Name == Constants.V4OdataNextLink)
{
isNextLinkPropExist = true;
break;
}
}
if (isNextLinkPropExist)
{
passed = true;
}
else
{
passed = false;
detail.ErrorMessage = string.Format("The feed has {0} entities totally, but it only display {1} entities and there is no NextLink annotation.", totalCount, entries.Count);
}
}
else
{
passed = null;
detail.ErrorMessage = string.Format("The response of feed {0} has only one page, so can not test partial results.", entitySet);
}
}
else
{
passed = null;
detail.ErrorMessage = string.Format("The response of feed {0} does not have \"@Odata.count\" annotation so it cannot get the total count of entities.", entitySet);
}
}
else
{
passed = null;
detail.ErrorMessage = "Cannot get response from above URI.";
}
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
/// <summary>
/// Verifies the extension rule.
/// </summary>
/// <param name="context">The Interop service context</param>
/// <param name="info">out parameter to return violation information when rule does not pass</param>
/// <returns>true if rule passes; false otherwise</returns>
public override bool?Verify(ServiceContext context, out ExtensionRuleViolationInfo info)
{
if (context == null)
{
throw new ArgumentNullException("context");
}
bool?passed = null;
ExtensionRuleResultDetail detail = new ExtensionRuleResultDetail(this.Name);
var restrictions = new Dictionary <string, Tuple <List <NormalProperty>, List <NavigProperty> > >();
if (!AnnotationsHelper.GetExpandRestrictions(context.MetadataDocument, context.VocCapabilities, ref restrictions))
{
detail.ErrorMessage = "Cannot find any appropriate entity-sets which supports $expand system query options.";
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
if (!AnnotationsHelper.IsSuitableNavigationProperty(NavigationRoughType.CollectionValued, ref restrictions))
{
detail.ErrorMessage = "Cannot find any collection-valued navigation properties in any entity-sets which supports $expand system query options.";
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
string entitySet = string.Empty;
string navigProp = string.Empty;
foreach (var r in restrictions)
{
if (string.IsNullOrEmpty(r.Key) ||
null == r.Value.Item1 || !r.Value.Item1.Any() ||
null == r.Value.Item2 || !r.Value.Item2.Any())
{
continue;
}
entitySet = r.Key;
foreach (var np in r.Value.Item2)
{
navigProp = np.NavigationPropertyName;
string nEntityTypeShortName = np.NavigationPropertyType.RemoveCollectionFlag().GetLastSegment();
var rest = AnnotationsHelper.GetCountRestrictions(context.MetadataDocument, context.VocCapabilities);
if (string.IsNullOrEmpty(rest.Item1) ||
null == rest.Item2 || !rest.Item2.Any() ||
null == rest.Item3 || !rest.Item3.Any())
{
continue;
}
break;
}
break;
}
if (string.IsNullOrEmpty(entitySet))
{
detail.ErrorMessage = "Cannot find an appropriate entity-set which supports $expand system query option.";
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
if (string.IsNullOrEmpty(navigProp))
{
detail.ErrorMessage = "Cannot get expanded entities because cannot get collection type of navigation property from metadata";
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}
string url = string.Format("{0}/{1}?$expand={2}($count=true)", context.ServiceBaseUri.OriginalString.TrimEnd('/'), entitySet, navigProp);
Uri uri = new Uri(url);
Response resp = WebHelper.Get(uri, Constants.V4AcceptHeaderJsonFullMetadata, RuleEngineSetting.Instance().DefaultMaximumPayloadSize, context.RequestHeaders);
detail = new ExtensionRuleResultDetail(this.Name, uri.AbsoluteUri, "GET", StringHelper.MergeHeaders(Constants.AcceptHeaderJson, context.RequestHeaders), resp);
detail.URI = url;
detail.ResponsePayload = resp.ResponsePayload;
detail.ResponseHeaders = resp.ResponseHeaders;
detail.HTTPMethod = "GET";
detail.ResponseStatusCode = resp.StatusCode.ToString();
if (resp != null && resp.StatusCode == HttpStatusCode.OK)
{
JObject feed;
resp.ResponsePayload.TryToJObject(out feed);
if (null == feed)
{
detail.ErrorMessage = "Cannot find any entity-sets in the service.\r\n";
info = new ExtensionRuleViolationInfo(uri, resp.ResponsePayload, detail);
return(passed);
}
JObject entry = null;
var entities = JsonParserHelper.GetEntries(feed);
foreach (var e in entities)
{
if (null != e[navigProp] && JTokenType.Array == e[navigProp].Type)
{
entry = e as JObject;
break;
}
}
if (null == entry)
{
detail.ErrorMessage = "Cannot find an appropriate entity which contains at least one collection-valued navigation property.\r\n";
info = new ExtensionRuleViolationInfo(uri, resp.ResponsePayload, detail);
return(passed);
}
if (null != entry && JTokenType.Object == entry.Type)
{
JArray jArr = entry[navigProp] as JArray;
int actualAmount = 0;
JsonParserHelper.GetEntitiesNumFromCollectionValuedNavigProp(entry[Constants.V4OdataId].ToString(), entry, navigProp, context.RequestHeaders, ref actualAmount);
if (null != entry[navigProp + Constants.V4OdataCount] && actualAmount == (int)entry[navigProp + Constants.V4OdataCount])
{
passed = true;
}
else
{
passed = false;
detail.ErrorMessage = "The service does not execute an accurate result on the system query option '$count' for expanded properties.";
}
}
}
else
{
passed = false;
detail.ErrorMessage = "The service does not support the system query option '$count' for expanded properties.";
}
info = new ExtensionRuleViolationInfo(context.Destination, context.ResponsePayload, detail);
return(passed);
}