protected override void CustomFieldTypeValidation(AssertPair <FieldDefinition, SPField> assert, SPField spObject, FieldDefinition definition)
{
var typedObject = spObject as SPFieldLookup;
var typedDefinition = definition.WithAssertAndCast <LookupFieldDefinition>("model", value => value.RequireNotNull());
// https://github.com/SubPointSolutions/spmeta2/issues/310
// AllowMultipleValues - TRUE - LookupMulti
// AllowMultipleValues - FALSE - Lookup
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var dstProp = d.GetExpressionValue(m => d.TypeAsString);
var isValid = typedDefinition.AllowMultipleValues
? typedObject.TypeAsString == "LookupMulti"
: typedObject.TypeAsString == "Lookup";
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = dstProp,
IsValid = isValid
});
});
}
protected override void CustomFieldTypeValidation(AssertPair<FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var typedObject = spObject.Context.CastTo<FieldLookup>(spObject);
var typedDefinition = definition.WithAssertAndCast<LookupFieldDefinition>("model", value => value.RequireNotNull());
// https://github.com/SubPointSolutions/spmeta2/issues/310
// AllowMultipleValues - TRUE - LookupMulti
// AllowMultipleValues - FALSE - Lookup
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var dstProp = d.GetExpressionValue(m => d.TypeAsString);
var isValid = typedDefinition.AllowMultipleValues
? typedObject.TypeAsString == "LookupMulti"
: typedObject.TypeAsString == "Lookup";
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = dstProp,
IsValid = isValid
};
});
}
protected override void CustomFieldTypeValidation(AssertPair <FieldDefinition, SPField> assert, SPField spObject, FieldDefinition definition)
{
var typedObject = spObject as TaxonomyField;
var typedDefinition = definition as TaxonomyFieldDefinition;
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var isValid = typedDefinition.IsMulti
? typedObject.TypeAsString == "TaxonomyFieldTypeMulti"
: typedObject.TypeAsString == "TaxonomyFieldType";
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
protected override void CustomFieldTypeValidation(AssertPair<FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var typedObject = spObject.Context.CastTo<TaxonomyField>(spObject);
var typedDefinition = definition as TaxonomyFieldDefinition;
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var isValid = typedDefinition.IsMulti
? typedObject.TypeAsString == "TaxonomyFieldTypeMulti"
: typedObject.TypeAsString == "TaxonomyFieldType";
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
protected override void CustomFieldTypeValidation(AssertPair<FieldDefinition, SPField> assert, SPField spObject, FieldDefinition definition)
{
var typedObject = spObject as SPFieldUser;
var typedDefinition = definition.WithAssertAndCast<UserFieldDefinition>("model", value => value.RequireNotNull());
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var dstProp = d.GetExpressionValue(m => d.TypeAsString);
var isValid = typedDefinition.AllowMultipleValues
? typedObject.TypeAsString == "UserMulti"
: typedObject.TypeAsString == "User";
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = dstProp,
IsValid = isValid
};
});
}
protected override void CustomFieldTypeValidation(AssertPair <FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var typedObject = spObject.Context.CastTo <FieldUser>(spObject);
var typedDefinition = definition.WithAssertAndCast <UserFieldDefinition>("model", value => value.RequireNotNull());
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var dstProp = d.GetExpressionValue(m => d.TypeAsString);
var isValid = typedDefinition.AllowMultipleValues
? typedObject.TypeAsString == "UserMulti"
: typedObject.TypeAsString == "User";
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = dstProp,
IsValid = isValid
});
});
}
protected override void CustomFieldTypeValidation(AssertPair <FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var typedObject = spObject.Context.CastTo <FieldLookup>(spObject);
var typedDefinition = definition.WithAssertAndCast <LookupFieldDefinition>("model", value => value.RequireNotNull());
// CSOM provision for DependentLookupFieldDefinition does not update FieldType
// seems to be a by design SharePoin issue
// https://github.com/SubPointSolutions/spmeta2/issues/753
if (SkipFieldTypeValidation)
{
assert.SkipProperty(m => m.FieldType, "Skipping. SkipFieldTypeValidation = true");
}
else
{
// https://github.com/SubPointSolutions/spmeta2/issues/310
// AllowMultipleValues - TRUE - LookupMulti
// AllowMultipleValues - FALSE - Lookup
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.FieldType);
var dstProp = d.GetExpressionValue(m => d.TypeAsString);
var isValid = typedDefinition.AllowMultipleValues
? typedObject.TypeAsString == "LookupMulti"
: typedObject.TypeAsString == "Lookup";
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = dstProp,
IsValid = isValid
});
});
}
}
protected void ValidateField(AssertPair<FieldDefinition, SPField> assert, SPField spObject, FieldDefinition definition)
{
assert
.ShouldNotBeNull(spObject)
.ShouldBeEqual(m => m.Title, o => o.Title)
//.ShouldBeEqual(m => m.InternalName, o => o.InternalName)
.ShouldBeEqual(m => m.Id, o => o.Id)
.ShouldBeEqual(m => m.Required, o => o.Required);
//.ShouldBeEqual(m => m.Description, o => o.Description)
//.ShouldBeEqual(m => m.FieldType, o => o.TypeAsString)
//.ShouldBeEqual(m => m.Group, o => o.Group);
if (!string.IsNullOrEmpty(definition.Group))
assert.ShouldBeEqual(m => m.Group, o => o.Group);
else
assert.SkipProperty(m => m.Group);
if (!string.IsNullOrEmpty(definition.StaticName))
assert.ShouldBeEqual(m => m.StaticName, o => o.StaticName);
else
assert.SkipProperty(m => m.StaticName);
if (!string.IsNullOrEmpty(definition.Description))
assert.ShouldBeEqual(m => m.Description, o => o.Description);
else
assert.SkipProperty(m => m.Description);
CustomFieldTypeValidation(assert, spObject, definition);
if (definition.AddFieldOptions.HasFlag(BuiltInAddFieldOptions.DefaultValue))
{
assert.SkipProperty(m => m.AddFieldOptions, "BuiltInAddFieldOptions.DefaultValue. Skipping.");
}
else
{
// TODO
}
if (definition.AddToDefaultView)
{
if (IsListScopedField)
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.AddToDefaultView);
var field = HostList.Fields[definition.Id];
var isValid = HostList.DefaultView
.ViewFields
.ToStringCollection()
.Contains(field.InternalName);
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "IsListScopedField = true. AddToDefaultView is ignored. Skipping.");
}
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "AddToDefaultView is false. Skipping.");
}
if (definition.AdditionalAttributes.Count == 0)
{
assert.SkipProperty(m => m.AdditionalAttributes, "AdditionalAttributes count is 0. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.AdditionalAttributes);
var isValid = true;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in s.AdditionalAttributes)
{
var sourceAttrName = attr.Name;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
if (string.IsNullOrEmpty(definition.RawXml))
{
assert.SkipProperty(m => m.RawXml, "RawXml is NULL or empty. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.RawXml);
var isValid = true;
var srcXmlNode = XDocument.Parse(s.RawXml).Root;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in srcXmlNode.Attributes())
{
var sourceAttrName = attr.Name.LocalName;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
// TODO, R&D to check InternalName changes in list-scoped fields
if (spObject.InternalName == definition.InternalName)
{
assert.ShouldBeEqual(m => m.InternalName, o => o.InternalName);
}
else
{
assert.SkipProperty(m => m.InternalName,
"Target InternalName is different to source InternalName. Could be an error if this is not a list scoped field");
}
assert.ShouldBeEqual(m => m.Hidden, o => o.Hidden);
if (definition.EnforceUniqueValues.HasValue)
assert.ShouldBeEqual(m => m.EnforceUniqueValues, o => o.EnforceUniqueValues);
else
assert.SkipProperty(m => m.EnforceUniqueValues, "EnforceUniqueValues is NULL");
if (!string.IsNullOrEmpty(definition.ValidationFormula))
assert.ShouldBeEqual(m => m.ValidationFormula, o => o.ValidationFormula);
else
assert.SkipProperty(m => m.ValidationFormula, string.Format("ValidationFormula value is not set. Skippping."));
if (!string.IsNullOrEmpty(definition.ValidationMessage))
assert.ShouldBeEqual(m => m.ValidationMessage, o => o.ValidationMessage);
else
assert.SkipProperty(m => m.ValidationMessage, string.Format("ValidationFormula value is not set. Skippping."));
if (!string.IsNullOrEmpty(definition.DefaultValue))
assert.ShouldBePartOf(m => m.DefaultValue, o => o.DefaultValue);
else
assert.SkipProperty(m => m.DefaultValue, string.Format("Default value is not set. Skippping."));
if (!string.IsNullOrEmpty(definition.DefaultFormula))
assert.ShouldBePartOf(m => m.DefaultFormula, o => o.DefaultFormula);
else
assert.SkipProperty(m => m.DefaultFormula, string.Format("Default formula is not set. Skippping."));
if (!string.IsNullOrEmpty(spObject.JSLink) &&
(spObject.JSLink == "SP.UI.Taxonomy.js|SP.UI.Rte.js(d)|SP.Taxonomy.js(d)|ScriptForWebTaggingUI.js(d)" ||
spObject.JSLink == "choicebuttonfieldtemplate.js" ||
spObject.JSLink == "clienttemplates.js"))
{
assert.SkipProperty(m => m.JSLink, string.Format("OOTB read-ony JSLink value:[{0}]", spObject.JSLink));
}
else
{
assert.ShouldBePartOf(m => m.JSLink, o => o.JSLink);
}
if (definition.ShowInDisplayForm.HasValue)
assert.ShouldBeEqual(m => m.ShowInDisplayForm, o => o.ShowInDisplayForm);
else
assert.SkipProperty(m => m.ShowInDisplayForm, "ShowInDisplayForm is NULL");
if (definition.ShowInEditForm.HasValue)
assert.ShouldBeEqual(m => m.ShowInEditForm, o => o.ShowInEditForm);
else
assert.SkipProperty(m => m.ShowInEditForm, "ShowInEditForm is NULL");
if (definition.ShowInListSettings.HasValue)
assert.ShouldBeEqual(m => m.ShowInListSettings, o => o.ShowInListSettings);
else
assert.SkipProperty(m => m.ShowInListSettings, "ShowInListSettings is NULL");
if (definition.ShowInNewForm.HasValue)
assert.ShouldBeEqual(m => m.ShowInNewForm, o => o.ShowInNewForm);
else
assert.SkipProperty(m => m.ShowInNewForm, "ShowInNewForm is NULL");
if (definition.ShowInVersionHistory.HasValue)
assert.ShouldBeEqual(m => m.ShowInVersionHistory, o => o.ShowInVersionHistory);
else
assert.SkipProperty(m => m.ShowInVersionHistory, "ShowInVersionHistory is NULL");
if (definition.ShowInViewForms.HasValue)
assert.ShouldBeEqual(m => m.ShowInViewForms, o => o.ShowInViewForms);
else
assert.SkipProperty(m => m.ShowInViewForms, "ShowInViewForms is NULL");
assert
.ShouldBeEqual(m => m.Indexed, o => o.Indexed);
if (definition.AllowDeletion.HasValue)
assert.ShouldBeEqual(m => m.AllowDeletion, o => o.AllowDeletion);
else
assert.SkipProperty(m => m.AllowDeletion, "AllowDeletion is NULL");
/// localization
if (definition.TitleResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.TitleResource);
var isValid = true;
foreach (var userResource in s.TitleResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var value = d.TitleResource.GetValueForUICulture(culture);
isValid = userResource.Value == value;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.TitleResource, "TitleResource is NULL or empty. Skipping.");
}
if (definition.DescriptionResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.DescriptionResource);
var isValid = true;
foreach (var userResource in s.DescriptionResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var value = d.DescriptionResource.GetValueForUICulture(culture);
isValid = userResource.Value == value;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is NULL or empty. Skipping.");
}
}
protected virtual void CustomFieldTypeValidation(AssertPair<FieldDefinition, SPField> assert, SPField spObject,
FieldDefinition definition)
{
assert.ShouldBeEqual(m => m.FieldType, o => o.TypeAsString);
}
protected void ValidateField(AssertPair <FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
assert
.ShouldNotBeNull(spObject)
.ShouldBeEqual(m => m.Title, o => o.Title)
//.ShouldBeEqual(m => m.InternalName, o => o.InternalName)
.ShouldBeEqual(m => m.Id, o => o.Id)
.ShouldBeEqual(m => m.FieldType, o => o.TypeAsString)
.ShouldBeEqual(m => m.Group, o => o.Group);
// TODO, R&D to check InternalName changes in list-scoped fields
if (spObject.InternalName == definition.InternalName)
{
assert.ShouldBeEqual(m => m.InternalName, o => o.InternalName);
}
else
{
assert.SkipProperty(m => m.InternalName,
"Target InternalName is different to source InternalName. Could be an error if this is not a list scoped field");
}
assert.ShouldBeEqual(m => m.ValidationFormula, o => o.ValidationFormula);
assert.ShouldBeEqual(m => m.ValidationMessage, o => o.ValidationMessage);
// taxonomy field seems to prodice issues w/ Required/Description validation
if (!SkipRequredPropValidation)
{
assert.ShouldBeEqual(m => m.Required, o => o.Required);
}
else
{
assert.SkipProperty(m => m.Required, "Skipping Required prop validation.");
}
if (!SkipDescriptionPropValidation)
{
assert.ShouldBeEqual(m => m.Description, o => o.Description);
}
else
{
assert.SkipProperty(m => m.Description, "Skipping Description prop validation.");
}
assert.ShouldBeEqual(m => m.Hidden, o => o.Hidden);
if (!string.IsNullOrEmpty(definition.DefaultValue))
{
assert.ShouldBePartOf(m => m.DefaultValue, o => o.DefaultValue);
}
else
{
assert.SkipProperty(m => m.DefaultValue, string.Format("Default value is not set. Skippping."));
}
if (!string.IsNullOrEmpty(spObject.JSLink) &&
(spObject.JSLink == "SP.UI.Taxonomy.js|SP.UI.Rte.js(d)|SP.Taxonomy.js(d)|ScriptForWebTaggingUI.js(d)" ||
spObject.JSLink == "choicebuttonfieldtemplate.js" ||
spObject.JSLink == "clienttemplates.js"))
{
assert.SkipProperty(m => m.JSLink, string.Format("OOTB read-ony JSLink value:[{0}]", spObject.JSLink));
}
else
{
assert.ShouldBePartOf(m => m.JSLink, o => o.JSLink);
}
if (definition.ShowInDisplayForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInDisplayForm, o => o.GetShowInDisplayForm());
}
else
{
assert.SkipProperty(m => m.ShowInDisplayForm, "ShowInDisplayForm is NULL");
}
if (definition.ShowInEditForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInEditForm, o => o.GetShowInEditForm());
}
else
{
assert.SkipProperty(m => m.ShowInEditForm, "ShowInEditForm is NULL");
}
if (definition.ShowInListSettings.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInListSettings, o => o.GetShowInListSettings());
}
else
{
assert.SkipProperty(m => m.ShowInListSettings, "ShowInListSettings is NULL");
}
if (definition.ShowInNewForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInNewForm, o => o.GetShowInNewForm());
}
else
{
assert.SkipProperty(m => m.ShowInNewForm, "ShowInNewForm is NULL");
}
if (definition.ShowInVersionHistory.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInVersionHistory, o => o.GetShowInVersionHistory());
}
else
{
assert.SkipProperty(m => m.ShowInVersionHistory, "ShowInVersionHistory is NULL");
}
if (definition.ShowInViewForms.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInViewForms, o => o.GetShowInViewForms());
}
else
{
assert.SkipProperty(m => m.ShowInViewForms, "ShowInViewForms is NULL");
}
assert
.ShouldBeEqual(m => m.Indexed, o => o.Indexed);
if (definition.AllowDeletion.HasValue)
{
assert.ShouldBeEqual(m => m.AllowDeletion, o => o.GetAllowDeletion());
}
else
{
assert.SkipProperty(m => m.AllowDeletion, "AllowDeletion is NULL");
}
}
protected void ValidateField(AssertPair <FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var context = spObject.Context;
CustomFieldTypeValidation(assert, spObject, definition);
assert
.ShouldNotBeNull(spObject)
.ShouldBeEqual(m => m.Title, o => o.Title)
.ShouldBeEqual(m => m.Id, o => o.Id);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.Group, o => o.Group);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.StaticName, o => o.StaticName);
assert.SkipProperty(m => m.DefaultFormula, "Not supported in CSOM API yet");
if (!string.IsNullOrEmpty(definition.DefaultFormula))
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.DefaultFormula);
var isValid = false;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
var defaultValueNode = dstXmlNode.Descendants("DefaultFormula").FirstOrDefault();
if (defaultValueNode == null)
{
isValid = false;
}
else
{
isValid = defaultValueNode.Value == s.DefaultFormula;
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.DefaultFormula, "DefaultFormula is null or empty. Skipping.");
}
if (definition.AddFieldOptions.HasFlag(BuiltInAddFieldOptions.DefaultValue))
{
assert.SkipProperty(m => m.AddFieldOptions, "BuiltInAddFieldOptions.DefaultValue. Skipping.");
}
else
{
// TODO
}
if (definition.AddToDefaultView)
{
if (IsListScopedField)
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.AddToDefaultView);
var field = HostList.Fields.GetById(definition.Id);
var defaultView = HostList.DefaultView;
context.Load(defaultView);
context.Load(defaultView, v => v.ViewFields);
context.Load(field);
context.ExecuteQueryWithTrace();
var isValid = HostList.DefaultView
.ViewFields
.Contains(field.InternalName);
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "IsListScopedField = true. AddToDefaultView is ignored. Skipping.");
}
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "AddToDefaultView is false. Skipping.");
}
if (definition.AdditionalAttributes.Count == 0)
{
assert.SkipProperty(m => m.AdditionalAttributes, "AdditionalAttributes count is 0. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.AdditionalAttributes);
var isValid = true;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in s.AdditionalAttributes)
{
var sourceAttrName = attr.Name;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
if (string.IsNullOrEmpty(definition.RawXml))
{
assert.SkipProperty(m => m.RawXml, "RawXml is NULL or empty. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.RawXml);
var isValid = true;
var srcXmlNode = XDocument.Parse(s.RawXml).Root;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in srcXmlNode.Attributes())
{
var sourceAttrName = attr.Name.LocalName;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
// TODO, R&D to check InternalName changes in list-scoped fields
if (spObject.InternalName == definition.InternalName)
{
assert.ShouldBeEqual(m => m.InternalName, o => o.InternalName);
}
else
{
assert.SkipProperty(m => m.InternalName,
"Target InternalName is different to source InternalName. Could be an error if this is not a list scoped field");
}
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.ValidationFormula, o => o.ValidationFormula);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.ValidationMessage, o => o.ValidationMessage);
// taxonomy field seems to prodice issues w/ Required/Description validation
if (!SkipRequredPropValidation)
{
assert.ShouldBeEqual(m => m.Required, o => o.Required);
}
else
{
assert.SkipProperty(m => m.Required);
}
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.Description, o => o.Description);
assert.ShouldBeEqual(m => m.Hidden, o => o.Hidden);
assert.ShouldBePartOfIfNotNullOrEmpty(m => m.DefaultValue, o => o.DefaultValue);
if (!string.IsNullOrEmpty(spObject.JSLink) &&
(spObject.JSLink == "SP.UI.Taxonomy.js|SP.UI.Rte.js(d)|SP.Taxonomy.js(d)|ScriptForWebTaggingUI.js(d)" ||
spObject.JSLink == "choicebuttonfieldtemplate.js" ||
spObject.JSLink == "clienttemplates.js"))
{
assert.SkipProperty(m => m.JSLink, string.Format("OOTB read-ony JSLink value:[{0}]", spObject.JSLink));
}
else
{
assert.ShouldBePartOf(m => m.JSLink, o => o.JSLink);
}
assert.ShouldBeEqualIfHasValue(m => m.EnforceUniqueValues, o => o.EnforceUniqueValues);
assert.ShouldBeEqualIfHasValue(m => m.ShowInDisplayForm, o => o.GetShowInDisplayForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInEditForm, o => o.GetShowInEditForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInListSettings, o => o.GetShowInListSettings());
assert.ShouldBeEqualIfHasValue(m => m.ShowInNewForm, o => o.GetShowInNewForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInVersionHistory, o => o.GetShowInVersionHistory());
assert.ShouldBeEqualIfHasValue(m => m.ShowInViewForms, o => o.GetShowInViewForms());
assert.ShouldBeEqual(m => m.Indexed, o => o.Indexed);
assert.ShouldBeEqualIfHasValue(m => m.AllowDeletion, o => o.GetAllowDeletion());
var supportsLocalization = ReflectionUtils.HasProperties(spObject, new[]
{
"TitleResource", "DescriptionResource"
});
if (supportsLocalization)
{
if (definition.TitleResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.TitleResource);
var isValid = true;
foreach (var userResource in s.TitleResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var resourceObject = ReflectionUtils.GetPropertyValue(spObject, "TitleResource");
var value = ReflectionUtils.GetMethod(resourceObject, "GetValueForUICulture")
.Invoke(resourceObject, new[] { culture.Name }) as ClientResult <string>;
context.ExecuteQuery();
isValid = userResource.Value == value.Value;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.TitleResource, "TitleResource is NULL or empty. Skipping.");
}
if (definition.DescriptionResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.DescriptionResource);
var isValid = true;
foreach (var userResource in s.DescriptionResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var resourceObject = ReflectionUtils.GetPropertyValue(spObject, "DescriptionResource");
var value = ReflectionUtils.GetMethod(resourceObject, "GetValueForUICulture")
.Invoke(resourceObject, new[] { culture.Name }) as ClientResult <string>;
context.ExecuteQuery();
isValid = userResource.Value == value.Value;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is NULL or empty. Skipping.");
}
}
else
{
TraceService.Critical((int)LogEventId.ModelProvisionCoreCall,
"CSOM runtime doesn't have Web.TitleResource and Web.DescriptionResource() methods support. Skipping validation.");
assert.SkipProperty(m => m.TitleResource, "TitleResource is null or empty. Skipping.");
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is null or empty. Skipping.");
}
assert.SkipProperty(m => m.PushChangesToLists,
"Covered by 'Regression.Scenarios.Fields.PushChangesToLists' test category");
}
// protected Site HostSite { get; set; }
protected virtual void CustomFieldTypeValidation(AssertPair <FieldDefinition, Field> assert, Field spObject,
FieldDefinition definition)
{
assert.ShouldBeEqual(m => m.FieldType, o => o.TypeAsString);
}
protected void ValidateField(AssertPair<FieldDefinition, Field> assert, Field spObject, FieldDefinition definition)
{
var context = spObject.Context;
CustomFieldTypeValidation(assert, spObject, definition);
assert
.ShouldNotBeNull(spObject)
.ShouldBeEqual(m => m.Title, o => o.Title)
.ShouldBeEqual(m => m.Id, o => o.Id);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.Group, o => o.Group);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.StaticName, o => o.StaticName);
if (definition.AddFieldOptions.HasFlag(BuiltInAddFieldOptions.DefaultValue))
{
assert.SkipProperty(m => m.AddFieldOptions, "BuiltInAddFieldOptions.DefaultValue. Skipping.");
}
else
{
// TODO
}
if (definition.AddToDefaultView)
{
if (IsListScopedField)
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.AddToDefaultView);
var field = HostList.Fields.GetById(definition.Id);
var defaultView = HostList.DefaultView;
context.Load(defaultView);
context.Load(defaultView, v => v.ViewFields);
context.Load(field);
context.ExecuteQueryWithTrace();
var isValid = HostList.DefaultView
.ViewFields
.Contains(field.InternalName);
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "IsListScopedField = true. AddToDefaultView is ignored. Skipping.");
}
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "AddToDefaultView is false. Skipping.");
}
if (definition.AdditionalAttributes.Count == 0)
{
assert.SkipProperty(m => m.AdditionalAttributes, "AdditionalAttributes count is 0. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.AdditionalAttributes);
var isValid = true;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in s.AdditionalAttributes)
{
var sourceAttrName = attr.Name;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
if (string.IsNullOrEmpty(definition.RawXml))
{
assert.SkipProperty(m => m.RawXml, "RawXml is NULL or empty. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.RawXml);
var isValid = true;
var srcXmlNode = XDocument.Parse(s.RawXml).Root;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in srcXmlNode.Attributes())
{
var sourceAttrName = attr.Name.LocalName;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
// TODO, R&D to check InternalName changes in list-scoped fields
if (spObject.InternalName == definition.InternalName)
{
assert.ShouldBeEqual(m => m.InternalName, o => o.InternalName);
}
else
{
assert.SkipProperty(m => m.InternalName,
"Target InternalName is different to source InternalName. Could be an error if this is not a list scoped field");
}
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.ValidationFormula, o => o.ValidationFormula);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.ValidationMessage, o => o.ValidationMessage);
// taxonomy field seems to prodice issues w/ Required/Description validation
if (!SkipRequredPropValidation)
assert.ShouldBeEqual(m => m.Required, o => o.Required);
else
assert.SkipProperty(m => m.Required);
assert.ShouldBeEqualIfNotNullOrEmpty(m => m.Description, o => o.Description);
assert.ShouldBeEqual(m => m.Hidden, o => o.Hidden);
assert.ShouldBePartOfIfNotNullOrEmpty(m => m.DefaultValue, o => o.DefaultValue);
if (!string.IsNullOrEmpty(spObject.JSLink) &&
(spObject.JSLink == "SP.UI.Taxonomy.js|SP.UI.Rte.js(d)|SP.Taxonomy.js(d)|ScriptForWebTaggingUI.js(d)" ||
spObject.JSLink == "choicebuttonfieldtemplate.js" ||
spObject.JSLink == "clienttemplates.js"))
{
assert.SkipProperty(m => m.JSLink, string.Format("OOTB read-ony JSLink value:[{0}]", spObject.JSLink));
}
else
{
assert.ShouldBePartOf(m => m.JSLink, o => o.JSLink);
}
assert.ShouldBeEqualIfHasValue(m => m.EnforceUniqueValues, o => o.EnforceUniqueValues);
assert.ShouldBeEqualIfHasValue(m => m.ShowInDisplayForm, o => o.GetShowInDisplayForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInEditForm, o => o.GetShowInEditForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInListSettings, o => o.GetShowInListSettings());
assert.ShouldBeEqualIfHasValue(m => m.ShowInNewForm, o => o.GetShowInNewForm());
assert.ShouldBeEqualIfHasValue(m => m.ShowInVersionHistory, o => o.GetShowInVersionHistory());
assert.ShouldBeEqualIfHasValue(m => m.ShowInViewForms, o => o.GetShowInViewForms());
assert.ShouldBeEqual(m => m.Indexed, o => o.Indexed);
assert.ShouldBeEqualIfHasValue(m => m.AllowDeletion, o => o.GetAllowDeletion());
var supportsLocalization = ReflectionUtils.HasProperties(spObject, new[]
{
"TitleResource", "DescriptionResource"
});
if (supportsLocalization)
{
if (definition.TitleResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.TitleResource);
var isValid = true;
foreach (var userResource in s.TitleResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var resourceObject = ReflectionUtils.GetPropertyValue(spObject, "TitleResource");
var value = ReflectionUtils.GetMethod(resourceObject, "GetValueForUICulture")
.Invoke(resourceObject, new[] { culture.Name }) as ClientResult<string>;
context.ExecuteQuery();
isValid = userResource.Value == value.Value;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.TitleResource, "TitleResource is NULL or empty. Skipping.");
}
if (definition.DescriptionResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.DescriptionResource);
var isValid = true;
foreach (var userResource in s.DescriptionResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var resourceObject = ReflectionUtils.GetPropertyValue(spObject, "DescriptionResource");
var value = ReflectionUtils.GetMethod(resourceObject, "GetValueForUICulture")
.Invoke(resourceObject, new[] { culture.Name }) as ClientResult<string>;
context.ExecuteQuery();
isValid = userResource.Value == value.Value;
if (!isValid)
break;
}
return new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
};
});
}
else
{
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is NULL or empty. Skipping.");
}
}
else
{
TraceService.Critical((int)LogEventId.ModelProvisionCoreCall,
"CSOM runtime doesn't have Web.TitleResource and Web.DescriptionResource() methods support. Skipping validation.");
assert.SkipProperty(m => m.TitleResource, "TitleResource is null or empty. Skipping.");
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is null or empty. Skipping.");
}
}
protected void ValidateField(AssertPair <FieldDefinition, SPField> assert, SPField spObject, FieldDefinition definition)
{
assert
.ShouldNotBeNull(spObject)
.ShouldBeEqual(m => m.Title, o => o.Title)
//.ShouldBeEqual(m => m.InternalName, o => o.InternalName)
.ShouldBeEqual(m => m.Id, o => o.Id)
.ShouldBeEqual(m => m.Required, o => o.Required);
//.ShouldBeEqual(m => m.Description, o => o.Description)
//.ShouldBeEqual(m => m.FieldType, o => o.TypeAsString)
//.ShouldBeEqual(m => m.Group, o => o.Group);
if (!string.IsNullOrEmpty(definition.Group))
{
assert.ShouldBeEqual(m => m.Group, o => o.Group);
}
else
{
assert.SkipProperty(m => m.Group);
}
if (!string.IsNullOrEmpty(definition.StaticName))
{
assert.ShouldBeEqual(m => m.StaticName, o => o.StaticName);
}
else
{
assert.SkipProperty(m => m.StaticName);
}
if (!string.IsNullOrEmpty(definition.Description))
{
assert.ShouldBeEqual(m => m.Description, o => o.Description);
}
else
{
assert.SkipProperty(m => m.Description);
}
CustomFieldTypeValidation(assert, spObject, definition);
if (definition.AddFieldOptions.HasFlag(BuiltInAddFieldOptions.DefaultValue))
{
assert.SkipProperty(m => m.AddFieldOptions, "BuiltInAddFieldOptions.DefaultValue. Skipping.");
}
else
{
// TODO
}
if (definition.AddToDefaultView)
{
if (IsListScopedField)
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(m => m.AddToDefaultView);
var field = HostList.Fields[definition.Id];
var isValid = HostList.DefaultView
.ViewFields
.ToStringCollection()
.Contains(field.InternalName);
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "IsListScopedField = true. AddToDefaultView is ignored. Skipping.");
}
}
else
{
assert.SkipProperty(m => m.AddToDefaultView, "AddToDefaultView is false. Skipping.");
}
if (definition.AdditionalAttributes.Count == 0)
{
assert.SkipProperty(m => m.AdditionalAttributes, "AdditionalAttributes count is 0. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.AdditionalAttributes);
var isValid = true;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in s.AdditionalAttributes)
{
var sourceAttrName = attr.Name;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
if (string.IsNullOrEmpty(definition.RawXml))
{
assert.SkipProperty(m => m.RawXml, "RawXml is NULL or empty. Skipping.");
}
else
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.RawXml);
var isValid = true;
var srcXmlNode = XDocument.Parse(s.RawXml).Root;
var dstXmlNode = XDocument.Parse(d.SchemaXml).Root;
foreach (var attr in srcXmlNode.Attributes())
{
var sourceAttrName = attr.Name.LocalName;
var sourceAttrValue = attr.Value;
var destAttrValue = dstXmlNode.GetAttributeValue(sourceAttrName);
isValid = sourceAttrValue == destAttrValue;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
// TODO, R&D to check InternalName changes in list-scoped fields
if (spObject.InternalName == definition.InternalName)
{
assert.ShouldBeEqual(m => m.InternalName, o => o.InternalName);
}
else
{
assert.SkipProperty(m => m.InternalName,
"Target InternalName is different to source InternalName. Could be an error if this is not a list scoped field");
}
assert.ShouldBeEqual(m => m.Hidden, o => o.Hidden);
if (definition.EnforceUniqueValues.HasValue)
{
assert.ShouldBeEqual(m => m.EnforceUniqueValues, o => o.EnforceUniqueValues);
}
else
{
assert.SkipProperty(m => m.EnforceUniqueValues, "EnforceUniqueValues is NULL");
}
if (!string.IsNullOrEmpty(definition.ValidationFormula))
{
assert.ShouldBeEqual(m => m.ValidationFormula, o => o.ValidationFormula);
}
else
{
assert.SkipProperty(m => m.ValidationFormula, string.Format("ValidationFormula value is not set. Skippping."));
}
if (!string.IsNullOrEmpty(definition.ValidationMessage))
{
assert.ShouldBeEqual(m => m.ValidationMessage, o => o.ValidationMessage);
}
else
{
assert.SkipProperty(m => m.ValidationMessage, string.Format("ValidationFormula value is not set. Skippping."));
}
if (!string.IsNullOrEmpty(definition.DefaultValue))
{
assert.ShouldBePartOf(m => m.DefaultValue, o => o.DefaultValue);
}
else
{
assert.SkipProperty(m => m.DefaultValue, string.Format("Default value is not set. Skippping."));
}
if (!string.IsNullOrEmpty(spObject.JSLink) &&
(spObject.JSLink == "SP.UI.Taxonomy.js|SP.UI.Rte.js(d)|SP.Taxonomy.js(d)|ScriptForWebTaggingUI.js(d)" ||
spObject.JSLink == "choicebuttonfieldtemplate.js" ||
spObject.JSLink == "clienttemplates.js"))
{
assert.SkipProperty(m => m.JSLink, string.Format("OOTB read-ony JSLink value:[{0}]", spObject.JSLink));
}
else
{
assert.ShouldBePartOf(m => m.JSLink, o => o.JSLink);
}
if (definition.ShowInDisplayForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInDisplayForm, o => o.ShowInDisplayForm);
}
else
{
assert.SkipProperty(m => m.ShowInDisplayForm, "ShowInDisplayForm is NULL");
}
if (definition.ShowInEditForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInEditForm, o => o.ShowInEditForm);
}
else
{
assert.SkipProperty(m => m.ShowInEditForm, "ShowInEditForm is NULL");
}
if (definition.ShowInListSettings.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInListSettings, o => o.ShowInListSettings);
}
else
{
assert.SkipProperty(m => m.ShowInListSettings, "ShowInListSettings is NULL");
}
if (definition.ShowInNewForm.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInNewForm, o => o.ShowInNewForm);
}
else
{
assert.SkipProperty(m => m.ShowInNewForm, "ShowInNewForm is NULL");
}
if (definition.ShowInVersionHistory.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInVersionHistory, o => o.ShowInVersionHistory);
}
else
{
assert.SkipProperty(m => m.ShowInVersionHistory, "ShowInVersionHistory is NULL");
}
if (definition.ShowInViewForms.HasValue)
{
assert.ShouldBeEqual(m => m.ShowInViewForms, o => o.ShowInViewForms);
}
else
{
assert.SkipProperty(m => m.ShowInViewForms, "ShowInViewForms is NULL");
}
assert
.ShouldBeEqual(m => m.Indexed, o => o.Indexed);
if (definition.AllowDeletion.HasValue)
{
assert.ShouldBeEqual(m => m.AllowDeletion, o => o.AllowDeletion);
}
else
{
assert.SkipProperty(m => m.AllowDeletion, "AllowDeletion is NULL");
}
/// localization
if (definition.TitleResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.TitleResource);
var isValid = true;
foreach (var userResource in s.TitleResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var value = d.TitleResource.GetValueForUICulture(culture);
isValid = userResource.Value == value;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.TitleResource, "TitleResource is NULL or empty. Skipping.");
}
if (definition.DescriptionResource.Any())
{
assert.ShouldBeEqual((p, s, d) =>
{
var srcProp = s.GetExpressionValue(def => def.DescriptionResource);
var isValid = true;
foreach (var userResource in s.DescriptionResource)
{
var culture = LocalizationService.GetUserResourceCultureInfo(userResource);
var value = d.DescriptionResource.GetValueForUICulture(culture);
isValid = userResource.Value == value;
if (!isValid)
{
break;
}
}
return(new PropertyValidationResult
{
Tag = p.Tag,
Src = srcProp,
Dst = null,
IsValid = isValid
});
});
}
else
{
assert.SkipProperty(m => m.DescriptionResource, "DescriptionResource is NULL or empty. Skipping.");
}
}