private static string GetFailMessage(IComparerResult comparerResult)
{
UnitTestWriter unitTestWriter = new UnitTestWriter();
GetFailMessageElements(comparerResult).Write(unitTestWriter);
return(unitTestWriter.GetTextAsString());
}
public ApiTestData(IComparerResult comparerResult, string category, bool @explicit, bool handleWarningsAsErrors)
{
ComparerResult = comparerResult;
Category = category;
Explicit = @explicit;
HandleWarningsAsErrors = handleWarningsAsErrors;
}
public ApiTestData(IComparerResult comparerResult, string category, IList <string> ignoreList, bool @explicit)
{
_comparerResult = comparerResult;
_category = category;
_ignoreList = ignoreList;
_explicit = @explicit;
}
protected ComparerBase(T referenceType, T newType, IComparerContext comparerContext, ResultContext resultContext, string name)
{
_referenceType = referenceType;
_newType = newType;
_comparerContext = comparerContext;
_comparerResult = _comparerContext.CreateComparerResult(resultContext, name);
}
public static XElement GenerateXml(IComparerResult comparerResult)
{
if (comparerResult == null)
{
throw new ArgumentNullException("comparerResult");
}
return(new XElement(Root, GenerateXElement(comparerResult)));
}
public Builder(Assembly referenceAssembly, Assembly newAssembly)
{
Mock <IComparerContext> comparerContextMock = new Mock <IComparerContext> {
DefaultValue = DefaultValue.Mock
};
MockSetup.SetupMock(comparerContextMock);
_comparerResult = new AssemblyComparer(referenceAssembly, newAssembly, comparerContextMock.Object).Compare();
}
private static Element GetFailMessageElements(IComparerResult comparerResult)
{
Element element = new Element(string.Format("{0} {1}", comparerResult.ResultContext, comparerResult.Name));
element.Add("Added Elements:", comparerResult.AddedItems.Select(added => string.Format("{0} -- {1}", added.ItemName, added.ResultContext)));
element.Add("Removed Elements:", comparerResult.RemovedItems.Select(removed => string.Format("{0} -- {1}", removed.ItemName, removed.ResultContext)));
element.Add("Changed Flags:", comparerResult.ChangedFlags.Select(changed => string.Format("{0} from {1} to {2}", changed.PropertyName, changed.ReferenceValue, changed.NewValue)));
element.Add("Changed Attributes:", comparerResult.ChangedProperties.Select(changed => string.Format("{0} from {1} to {2}", changed.PropertyName, changed.ReferenceValue, changed.NewValue)));
element.Add("Changed Children:", comparerResult.ComparerResults.Select(GetFailMessageElements));
return element.HasElements ? element : null;
}
private static string GetFailMessage(IComparerResult comparerResult)
{
UnitTestWriter unitTestWriter = new UnitTestWriter();
Element failMessageElements = GetFailMessageElements(comparerResult);
if (failMessageElements != null)
{
failMessageElements.Write(unitTestWriter);
}
return(unitTestWriter.GetTextAsString());
}
private static Element GetFailMessageElements(IComparerResult comparerResult)
{
Element element = new Element(string.Format("{0} {1}", comparerResult.ResultContext, comparerResult.Name));
element.Add("Added Elements:", comparerResult.AddedItems.Select(added => string.Format("{0} -- {1}", added.ItemName, added.ResultContext)));
element.Add("Removed Elements:", comparerResult.RemovedItems.Select(removed => string.Format("{0} -- {1}", removed.ItemName, removed.ResultContext)));
element.Add("Changed Flags:", comparerResult.ChangedFlags.Select(changed => string.Format("{0} from {1} to {2}", changed.PropertyName, changed.ReferenceValue, changed.NewValue)));
element.Add("Changed Attributes:", comparerResult.ChangedProperties.Select(changed => string.Format("{0} from {1} to {2}", changed.PropertyName, changed.ReferenceValue, changed.NewValue)));
element.Add("Changed Children:", comparerResult.ComparerResults.Select(GetFailMessageElements));
return(element.HasElements ? element : null);
}
private static ITestCaseData GenerateTestCase(ApiTestData apiTestData)
{
IComparerResult comparerResult = apiTestData.ComparerResult;
bool fail = Fail(apiTestData, comparerResult);
TestCaseData testCaseData = new TestCaseData(!fail, GetFailMessage(comparerResult)).SetName(comparerResult.Name).SetCategory(apiTestData.Category);
if (apiTestData.Explicit)
{
testCaseData.MakeExplicit("Set explicit by ApiTestAttribute");
}
return(testCaseData);
}
private static XElement GenerateXElement(IComparerResult comparerResult)
{
XElement element = new XElement(ChangedElement);
element.Add(new XAttribute(Name, comparerResult.Name));
element.Add(new XAttribute(Context, comparerResult.ResultContext.ToString()));
element.Add(comparerResult.ChangedFlags.Select(changed => new XElement(ChangedAttribute, GenerateXAttribute(changed))));
element.Add(comparerResult.ChangedProperties.Select(changed => new XElement(ChangedAttribute, GenerateXAttribute(changed))));
element.Add(comparerResult.AddedItems.Select(added => new XElement(AddedElement, GenerateXAttribute(added))));
element.Add(comparerResult.RemovedItems.Select(removed => new XElement(RemovedElement, GenerateXAttribute(removed))));
element.Add(comparerResult.ComparerResults.Select(GenerateXElement));
return(element.HasElements ? element : null);
}
private static ITestCaseData GenerateTestCase(ApiTestData apiTestData)
{
IComparerResult comparerResult = apiTestData.ComparerResult;
bool fail = comparerResult.GetAllCount(Severity.Error) + comparerResult.GetAllCount(Severity.Warning) > 0;
TestCaseData testCaseData = new TestCaseData(!fail, fail ? GetFailMessage(comparerResult) : "").SetName(comparerResult.Name).SetCategory(apiTestData.Category);
if (apiTestData.IgnoreList.Contains(comparerResult.Name))
{
testCaseData.Ignore();
}
if (apiTestData.Explicit)
{
testCaseData.MakeExplicit("");
}
return(testCaseData);
}
private static Element GetFailMessageElements(IComparerResult comparerResult)
{
Element element = new Element(string.Format("{0} {1}", comparerResult.ResultContext, comparerResult.Name));
element.Add("Added Elements:", comparerResult.AddedItems.Select(added => string.Format("{0} -- {1} ({2})", added.ItemName, added.ResultContext, added.Severity)));
element.Add("Removed Elements:", comparerResult.RemovedItems.Select(removed => string.Format("{0} -- {1} ({2})", removed.ItemName, removed.ResultContext, removed.Severity)));
element.Add("Changed Flags:", comparerResult.ChangedFlags.Select(changed => string.Format("{0} from {1} to {2} ({3})", changed.PropertyName, changed.ReferenceValue, changed.NewValue, changed.Severity)));
element.Add("Changed Attributes:", comparerResult.ChangedProperties.Select(changed => string.Format("{0} from {1} to {2} ({3})", changed.PropertyName, changed.ReferenceValue, changed.NewValue, changed.Severity)));
// Do not list child elements for assemblies because all of the children will be placed in a separate test
if (comparerResult.ResultContext != ResultContext.Assembly)
{
element.Add("Changed Children:", comparerResult.ComparerResults.Select(GetFailMessageElements));
}
return(element.HasElements ? element : null);
}
/// <summary> Compares the versions of the API and generates the desired reports. </summary>
/// <returns> The amount of errors and warnings found. </returns>
public int CheckApi()
{
// Comparing
_comparerContext.LogInfo("Comparing assemblies.");
ComparerResult = _comparerContext.CreateComparer(_referenceVersion, _newVersion).Compare();
// Reporting
_comparerContext.LogInfo("Generating xml result.");
XElement element = XmlGenerator.GenerateXml(ComparerResult);
if (_xmlOutput != null)
{
_comparerContext.LogInfo("Exporting xml report.");
element.Save(_xmlOutput);
}
if (_htmlOutput != null)
{
_comparerContext.LogInfo("Exporting html report.");
XmlTransformer.TransformToHtml(element.CreateReader(), _htmlOutput);
}
return ComparerResult.GetAllCount(Severity.Error) + ComparerResult.GetAllCount(Severity.Warning);
}
/// <summary> Compares the assemblies and generates the desired reports. </summary>
/// <returns> The amount of errors and warnings found. </returns>
public int CheckApi()
{
// Comparing
_comparerContext.LogInfo("Comparing assemblies.");
_comparerResult = _comparerContext.CreateComparer(_referenceVersion, _newVersion).Compare();
// Reporting
_comparerContext.LogInfo("Generating xml result.");
XElement element = XmlGenerator.GenerateXml(_comparerResult);
if (_xmlOutput != null)
{
_comparerContext.LogInfo("Exporting xml report.");
element.Save(_xmlOutput);
}
if (_htmlOutput != null)
{
_comparerContext.LogInfo("Exporting html report.");
XmlTransformer.TransformToHtml(element.CreateReader(), _htmlOutput);
}
return(_comparerResult.GetAllCount(Severity.Error) + _comparerResult.GetAllCount(Severity.Warning));
}
public void AddComparerResult(IComparerResult comparerResult)
{
_comparerResults.Add(comparerResult);
}
private static string GetFailMessage(IComparerResult comparerResult)
{
UnitTestWriter unitTestWriter = new UnitTestWriter();
GetFailMessageElements(comparerResult).Write(unitTestWriter);
return unitTestWriter.GetTextAsString();
}
public ApiTestData(IComparerResult comparerResult, string category, IList<string> ignoreList, bool @explicit)
{
_comparerResult = comparerResult;
_category = category;
_ignoreList = ignoreList;
_explicit = @explicit;
}
public Builder(Assembly assembly1, Assembly assembly2, IList<string> list)
{
_comparerResult = new AssemblyComparer(assembly1, assembly2, new ComparerContext(s => { }, s => { }, list)).Compare();
}
private static bool Fail(ApiTestData apiTestData, IComparerResult comparerResult)
{
bool ignoreChildren = apiTestData.ComparerResult.ResultContext == ResultContext.Assembly;
return(comparerResult.GetAllCount(Severity.Error, ignoreChildren) > 0 || apiTestData.HandleWarningsAsErrors && comparerResult.GetAllCount(Severity.Warning, ignoreChildren) > 0);
}
public Builder(Assembly assembly1, Assembly assembly2, IList <string> list)
{
_comparerResult = new AssemblyComparer(assembly1, assembly2, new ComparerContext(s => { }, s => { }, list)).Compare();
}
public Builder(Assembly referenceAssembly, Assembly newAssembly)
{
Mock<IComparerContext> comparerContextMock = new Mock<IComparerContext> { DefaultValue = DefaultValue.Mock };
MockSetup.SetupMock(comparerContextMock);
_comparerResult = new AssemblyComparer(referenceAssembly, newAssembly, comparerContextMock.Object).Compare();
}
public void AddComparerResult(IComparerResult comparerResult)
{
_comparerResults.Add(comparerResult);
}
