Nuclex.Support/Source/Cloning/CloneFactoryTest.cs
2017-01-21 21:33:55 +00:00

598 lines
25 KiB
C#

#region CPL License
/*
Nuclex Framework
Copyright (C) 2002-2017 Nuclex Development Labs
This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.
You should have received a copy of the IBM Common Public
License along with this library
*/
#endregion
#if UNITTEST
using System;
using NUnit.Framework;
namespace Nuclex.Support.Cloning {
/// <summary>Base class for unit tests verifying the clone factory</summary>
internal abstract class CloneFactoryTest {
#region class DerivedReferenceType
/// <summary>A derived reference type being used for testing</summary>
protected class DerivedReferenceType : TestReferenceType {
/// <summary>Field holding an integer value for testing</summary>
public int DerivedField;
/// <summary>Property holding an integer value for testing</summary>
public int DerivedProperty { get; set; }
}
#endregion // class DerivedReferenceType
#region class TestReferenceType
/// <summary>A reference type being used for testing</summary>
protected class TestReferenceType {
/// <summary>Field holding an integer value for testing</summary>
public int TestField;
/// <summary>Property holding an integer value for testing</summary>
public int TestProperty { get; set; }
}
#endregion // class TestReferenceType
#region struct TestValueType
/// <summary>A value type being used for testing</summary>
protected struct TestValueType {
/// <summary>Field holding an integer value for testing</summary>
public int TestField;
/// <summary>Property holding an integer value for testing</summary>
public int TestProperty { get; set; }
}
#endregion // struct TestValueType
#region struct HierarchicalValueType
/// <summary>A value type containiner other complex types used for testing</summary>
protected struct HierarchicalValueType {
/// <summary>Field holding an integer value for testing</summary>
public int TestField;
/// <summary>Property holding an integer value for testing</summary>
public int TestProperty { get; set; }
/// <summary>Value type field for testing</summary>
public TestValueType ValueTypeField;
/// <summary>Value type property for testing</summary>
public TestValueType ValueTypeProperty { get; set; }
/// <summary>Reference type field for testing</summary>
public TestReferenceType ReferenceTypeField;
/// <summary>Reference type property for testing</summary>
public TestReferenceType ReferenceTypeProperty { get; set; }
/// <summary>An array field of reference types</summary>
public TestReferenceType[,][] ReferenceTypeArrayField;
/// <summary>An array property of reference types</summary>
public TestReferenceType[,][] ReferenceTypeArrayProperty { get; set; }
/// <summary>A reference type field that's always null</summary>
public TestReferenceType AlwaysNullField;
/// <summary>A reference type property that's always null</summary>
public TestReferenceType AlwaysNullProperty { get; set; }
/// <summary>A property that only has a getter</summary>
public TestReferenceType GetOnlyProperty { get { return null; } }
/// <summary>A property that only has a setter</summary>
public TestReferenceType SetOnlyProperty { set { } }
/// <summary>A read-only field</summary>
public readonly TestValueType ReadOnlyField;
/// <summary>Field typed as base class holding a derived instance</summary>
public TestReferenceType DerivedField;
/// <summary>Field typed as base class holding a derived instance</summary>
public TestReferenceType DerivedProperty { get; set; }
}
#endregion // struct HierarchicalValueType
#region struct HierarchicalReferenceType
/// <summary>A value type containiner other complex types used for testing</summary>
protected class HierarchicalReferenceType {
/// <summary>Field holding an integer value for testing</summary>
public int TestField;
/// <summary>Property holding an integer value for testing</summary>
public int TestProperty { get; set; }
/// <summary>Value type field for testing</summary>
public TestValueType ValueTypeField;
/// <summary>Value type property for testing</summary>
public TestValueType ValueTypeProperty { get; set; }
/// <summary>Reference type field for testing</summary>
public TestReferenceType ReferenceTypeField;
/// <summary>Reference type property for testing</summary>
public TestReferenceType ReferenceTypeProperty { get; set; }
/// <summary>An array field of reference types</summary>
public TestReferenceType[,][] ReferenceTypeArrayField;
/// <summary>An array property of reference types</summary>
public TestReferenceType[,][] ReferenceTypeArrayProperty { get; set; }
/// <summary>A reference type field that's always null</summary>
public TestReferenceType AlwaysNullField;
/// <summary>A reference type property that's always null</summary>
public TestReferenceType AlwaysNullProperty { get; set; }
/// <summary>A property that only has a getter</summary>
public TestReferenceType GetOnlyProperty { get { return null; } }
/// <summary>A property that only has a setter</summary>
public TestReferenceType SetOnlyProperty { set { } }
/// <summary>A read-only field</summary>
public readonly TestValueType ReadOnlyField;
/// <summary>Field typed as base class holding a derived instance</summary>
public TestReferenceType DerivedField;
/// <summary>Field typed as base class holding a derived instance</summary>
public TestReferenceType DerivedProperty { get; set; }
}
#endregion // struct HierarchicalReferenceType
#region class ClassWithoutDefaultConstructor
/// <summary>A class that does not have a default constructor</summary>
public class ClassWithoutDefaultConstructor {
/// <summary>
/// Initializes a new instance of the class without default constructor
/// </summary>
/// <param name="dummy">Dummy value that will be saved by the instance</param>
public ClassWithoutDefaultConstructor(int dummy) {
this.dummy = dummy;
}
/// <summary>Dummy value that has been saved by the instance</summary>
public int Dummy {
get { return this.dummy; }
}
/// <summary>Dummy value that has been saved by the instance</summary>
private int dummy;
}
#endregion // class ClassWithoutDefaultConstructor
/// <summary>
/// Verifies that a cloned object exhibits the expected state for the type of
/// clone that has been performed
/// </summary>
/// <param name="original">Original instance the clone was created from</param>
/// <param name="clone">Cloned instance that will be checked for correctness</param>
/// <param name="isDeepClone">Whether the cloned instance is a deep clone</param>
/// <param name="isPropertyBasedClone">
/// Whether a property-based clone was performed
/// </param>
protected static void VerifyClone(
HierarchicalReferenceType original, HierarchicalReferenceType clone,
bool isDeepClone, bool isPropertyBasedClone
) {
Assert.AreNotSame(original, clone);
if(isPropertyBasedClone) {
Assert.AreEqual(0, clone.TestField);
Assert.AreEqual(0, clone.ValueTypeField.TestField);
Assert.AreEqual(0, clone.ValueTypeField.TestProperty);
Assert.AreEqual(0, clone.ValueTypeProperty.TestField);
Assert.IsNull(clone.ReferenceTypeField);
Assert.IsNull(clone.DerivedField);
if(isDeepClone) {
Assert.AreNotSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
Assert.AreNotSame(original.DerivedProperty, clone.DerivedProperty);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedProperty);
var originalDerived = (DerivedReferenceType)original.DerivedProperty;
var clonedDerived = (DerivedReferenceType)clone.DerivedProperty;
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
Assert.AreEqual(0, clone.ReferenceTypeProperty.TestField);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][0],
clone.ReferenceTypeArrayProperty[1, 3][0]
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][2],
clone.ReferenceTypeArrayProperty[1, 3][2]
);
Assert.AreEqual(0, clone.ReferenceTypeArrayProperty[1, 3][0].TestField);
Assert.AreEqual(0, clone.ReferenceTypeArrayProperty[1, 3][2].TestField);
} else {
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
}
} else {
Assert.AreEqual(original.TestField, clone.TestField);
Assert.AreEqual(original.ValueTypeField.TestField, clone.ValueTypeField.TestField);
Assert.AreEqual(original.ValueTypeField.TestProperty, clone.ValueTypeField.TestProperty);
Assert.AreEqual(
original.ValueTypeProperty.TestField, clone.ValueTypeProperty.TestField
);
Assert.AreEqual(
original.ReferenceTypeField.TestField, clone.ReferenceTypeField.TestField
);
Assert.AreEqual(
original.ReferenceTypeField.TestProperty, clone.ReferenceTypeField.TestProperty
);
Assert.AreEqual(
original.ReferenceTypeProperty.TestField, clone.ReferenceTypeProperty.TestField
);
if(isDeepClone) {
Assert.AreNotSame(original.ReferenceTypeField, clone.ReferenceTypeField);
Assert.AreNotSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreNotSame(original.DerivedField, clone.DerivedField);
Assert.AreNotSame(original.DerivedProperty, clone.DerivedProperty);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedField);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedProperty);
var originalDerived = (DerivedReferenceType)original.DerivedField;
var clonedDerived = (DerivedReferenceType)clone.DerivedField;
Assert.AreEqual(originalDerived.TestField, clonedDerived.TestField);
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedField, clonedDerived.DerivedField);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
originalDerived = (DerivedReferenceType)original.DerivedProperty;
clonedDerived = (DerivedReferenceType)clone.DerivedProperty;
Assert.AreEqual(originalDerived.TestField, clonedDerived.TestField);
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedField, clonedDerived.DerivedField);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
Assert.AreNotSame(
original.ReferenceTypeArrayField, clone.ReferenceTypeArrayField
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][0],
clone.ReferenceTypeArrayProperty[1, 3][0]
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][2],
clone.ReferenceTypeArrayProperty[1, 3][2]
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][0].TestField,
clone.ReferenceTypeArrayProperty[1, 3][0].TestField
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][2].TestField,
clone.ReferenceTypeArrayProperty[1, 3][2].TestField
);
} else {
Assert.AreSame(original.DerivedField, clone.DerivedField);
Assert.AreSame(original.DerivedProperty, clone.DerivedProperty);
Assert.AreSame(original.ReferenceTypeField, clone.ReferenceTypeField);
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(
original.ReferenceTypeArrayField, clone.ReferenceTypeArrayField
);
Assert.AreSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
}
}
}
/// <summary>
/// Verifies that a cloned object exhibits the expected state for the type of
/// clone that has been performed
/// </summary>
/// <param name="original">Original instance the clone was created from</param>
/// <param name="clone">Cloned instance that will be checked for correctness</param>
/// <param name="isDeepClone">Whether the cloned instance is a deep clone</param>
/// <param name="isPropertyBasedClone">
/// Whether a property-based clone was performed
/// </param>
protected static void VerifyClone(
ref HierarchicalValueType original, ref HierarchicalValueType clone,
bool isDeepClone, bool isPropertyBasedClone
) {
if(isPropertyBasedClone) {
Assert.AreEqual(0, clone.TestField);
Assert.AreEqual(0, clone.ValueTypeField.TestField);
Assert.AreEqual(0, clone.ValueTypeField.TestProperty);
Assert.AreEqual(0, clone.ValueTypeProperty.TestField);
Assert.IsNull(clone.ReferenceTypeField);
Assert.IsNull(clone.DerivedField);
if(isDeepClone) {
Assert.AreNotSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
Assert.AreNotSame(original.DerivedProperty, clone.DerivedProperty);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedProperty);
var originalDerived = (DerivedReferenceType)original.DerivedProperty;
var clonedDerived = (DerivedReferenceType)clone.DerivedProperty;
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
Assert.AreEqual(0, clone.ReferenceTypeProperty.TestField);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][0],
clone.ReferenceTypeArrayProperty[1, 3][0]
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][2],
clone.ReferenceTypeArrayProperty[1, 3][2]
);
Assert.AreEqual(0, clone.ReferenceTypeArrayProperty[1, 3][0].TestField);
Assert.AreEqual(0, clone.ReferenceTypeArrayProperty[1, 3][2].TestField);
} else {
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
}
} else {
Assert.AreEqual(original.TestField, clone.TestField);
Assert.AreEqual(original.ValueTypeField.TestField, clone.ValueTypeField.TestField);
Assert.AreEqual(original.ValueTypeField.TestProperty, clone.ValueTypeField.TestProperty);
Assert.AreEqual(
original.ValueTypeProperty.TestField, clone.ValueTypeProperty.TestField
);
Assert.AreEqual(
original.ReferenceTypeField.TestField, clone.ReferenceTypeField.TestField
);
Assert.AreEqual(
original.ReferenceTypeField.TestProperty, clone.ReferenceTypeField.TestProperty
);
Assert.AreEqual(
original.ReferenceTypeProperty.TestField, clone.ReferenceTypeProperty.TestField
);
if(isDeepClone) {
Assert.AreNotSame(original.ReferenceTypeField, clone.ReferenceTypeField);
Assert.AreNotSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreNotSame(original.DerivedField, clone.DerivedField);
Assert.AreNotSame(original.DerivedProperty, clone.DerivedProperty);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedField);
Assert.IsInstanceOf<DerivedReferenceType>(clone.DerivedProperty);
var originalDerived = (DerivedReferenceType)original.DerivedField;
var clonedDerived = (DerivedReferenceType)clone.DerivedField;
Assert.AreEqual(originalDerived.TestField, clonedDerived.TestField);
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedField, clonedDerived.DerivedField);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
originalDerived = (DerivedReferenceType)original.DerivedProperty;
clonedDerived = (DerivedReferenceType)clone.DerivedProperty;
Assert.AreEqual(originalDerived.TestField, clonedDerived.TestField);
Assert.AreEqual(originalDerived.TestProperty, clonedDerived.TestProperty);
Assert.AreEqual(originalDerived.DerivedField, clonedDerived.DerivedField);
Assert.AreEqual(originalDerived.DerivedProperty, clonedDerived.DerivedProperty);
Assert.AreNotSame(
original.ReferenceTypeArrayField, clone.ReferenceTypeArrayField
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][0],
clone.ReferenceTypeArrayProperty[1, 3][0]
);
Assert.AreNotSame(
original.ReferenceTypeArrayProperty[1, 3][2],
clone.ReferenceTypeArrayProperty[1, 3][2]
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][0].TestField,
clone.ReferenceTypeArrayProperty[1, 3][0].TestField
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][2].TestField,
clone.ReferenceTypeArrayProperty[1, 3][2].TestField
);
} else {
Assert.AreSame(original.DerivedField, clone.DerivedField);
Assert.AreSame(original.DerivedProperty, clone.DerivedProperty);
Assert.AreSame(original.ReferenceTypeField, clone.ReferenceTypeField);
Assert.AreSame(original.ReferenceTypeProperty, clone.ReferenceTypeProperty);
Assert.AreSame(
original.ReferenceTypeArrayField, clone.ReferenceTypeArrayField
);
Assert.AreSame(
original.ReferenceTypeArrayProperty, clone.ReferenceTypeArrayProperty
);
}
}
Assert.AreEqual(original.TestProperty, clone.TestProperty);
Assert.AreEqual(
original.ValueTypeProperty.TestProperty, clone.ValueTypeProperty.TestProperty
);
Assert.AreEqual(
original.ReferenceTypeProperty.TestProperty, clone.ReferenceTypeProperty.TestProperty
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][0].TestProperty,
clone.ReferenceTypeArrayProperty[1, 3][0].TestProperty
);
Assert.AreEqual(
original.ReferenceTypeArrayProperty[1, 3][2].TestProperty,
clone.ReferenceTypeArrayProperty[1, 3][2].TestProperty
);
}
/// <summary>Creates a value type with random data for testing</summary>
/// <returns>A new value type with random data</returns>
protected static HierarchicalValueType CreateValueType() {
return new HierarchicalValueType() {
TestField = 123,
TestProperty = 321,
ReferenceTypeArrayField = new TestReferenceType[2, 4][] {
{
null, null, null, null
},
{
null, null, null,
new TestReferenceType[3] {
new TestReferenceType() { TestField = 101, TestProperty = 202 },
null,
new TestReferenceType() { TestField = 909, TestProperty = 808 }
}
},
},
ReferenceTypeArrayProperty = new TestReferenceType[2, 4][] {
{
null, null, null, null
},
{
null, null, null,
new TestReferenceType[3] {
new TestReferenceType() { TestField = 303, TestProperty = 404 },
null,
new TestReferenceType() { TestField = 707, TestProperty = 606 }
}
},
},
ValueTypeField = new TestValueType() {
TestField = 456,
TestProperty = 654
},
ValueTypeProperty = new TestValueType() {
TestField = 789,
TestProperty = 987,
},
ReferenceTypeField = new TestReferenceType() {
TestField = 135,
TestProperty = 531
},
ReferenceTypeProperty = new TestReferenceType() {
TestField = 246,
TestProperty = 642,
},
DerivedField = new DerivedReferenceType() {
DerivedField = 100,
DerivedProperty = 200,
TestField = 300,
TestProperty = 400
},
DerivedProperty = new DerivedReferenceType() {
DerivedField = 500,
DerivedProperty = 600,
TestField = 700,
TestProperty = 800
}
};
}
/// <summary>Creates a reference type with random data for testing</summary>
/// <returns>A new reference type with random data</returns>
protected static HierarchicalReferenceType CreateReferenceType() {
return new HierarchicalReferenceType() {
TestField = 123,
TestProperty = 321,
ReferenceTypeArrayField = new TestReferenceType[2, 4][] {
{
null, null, null, null
},
{
null, null, null,
new TestReferenceType[3] {
new TestReferenceType() { TestField = 101, TestProperty = 202 },
null,
new TestReferenceType() { TestField = 909, TestProperty = 808 }
}
},
},
ReferenceTypeArrayProperty = new TestReferenceType[2, 4][] {
{
null, null, null, null
},
{
null, null, null,
new TestReferenceType[3] {
new TestReferenceType() { TestField = 303, TestProperty = 404 },
null,
new TestReferenceType() { TestField = 707, TestProperty = 606 }
}
},
},
ValueTypeField = new TestValueType() {
TestField = 456,
TestProperty = 654
},
ValueTypeProperty = new TestValueType() {
TestField = 789,
TestProperty = 987,
},
ReferenceTypeField = new TestReferenceType() {
TestField = 135,
TestProperty = 531
},
ReferenceTypeProperty = new TestReferenceType() {
TestField = 246,
TestProperty = 642,
},
DerivedField = new DerivedReferenceType() {
DerivedField = 100,
DerivedProperty = 200,
TestField = 300,
TestProperty = 400
},
DerivedProperty = new DerivedReferenceType() {
DerivedField = 500,
DerivedProperty = 600,
TestField = 700,
TestProperty = 800
}
};
}
/// <summary>
/// Useless method that avoids a compile warnings due to unused fields
/// </summary>
protected void AvoidCompilerWarnings() {
var reference = new HierarchicalReferenceType() {
AlwaysNullField = new TestReferenceType()
};
var value = new HierarchicalValueType() {
AlwaysNullField = new TestReferenceType()
};
}
}
} // namespace Nuclex.Support.Cloning
#endif // UNITTEST