Wiki

Clone wiki

TraceabilityV2 / TraceCodeGenLib / Verify

Home

TraceCodeGenerator Lib

#Verify

Verify is a static class used for unit testing the relation between a trace class, and the functional class it was derived from.

What the verify class does is look at each property and method of the functional class, and verifies that the trace class warps each of them. This way, if the functional class is updated, we will know we need to regenerate the trace class because the verify unit test will fail.

When the verify test is ran, it will produce a lits of errors, with each error indicating what property or method was not traced, as well as a reason that it was not traced.

###public static VerificationErrorList VerifyTraceInheritence(Type baseClass, Type traceClass, SkipMap ignore = null)

####Type baseClass This is the functional class being tested.

####Type traceClass This is the trace class that wraps the functional class.

####skipMap Optional. If a SkipMap is passed in, then all properties and methods that intersect with the SkipMap will be not be checked.

#VerificationErrorList Contains any errors that were generated when comparing a base class and its trace class.

##Properties ###string BaseClassName The name of the base class that was checked.

###public string TraceClassName The name of the trace class that was checked.

###public List<VerificationError> Errors A list containing the specific errors, if any.

#VerificationError Represents an error where some member of the trace class does not properly represent the corresponding member of the base class.

##Properties ###public string MemberName The name of the member that generated the error.

###public IgnoreReason Reason The specific error / reason why the the member was flagged.

Updated