Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Tests/HeuristicLab-3.3/DeepCloneableCloningTest.cs @ 9783

Last change on this file since 9783 was 9783, checked in by mkommend, 9 years ago

#2088: Adapted HL-3.3.Tests, Algorithms.DataAnalysis.Tests, and Collections.Test.

File size: 6.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2013 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Linq;
25using HeuristicLab.Common;
26using HeuristicLab.Core;
27using HeuristicLab.Optimization;
28using HeuristicLab.Persistence.Default.Xml;
29using HeuristicLab.PluginInfrastructure;
30using Microsoft.VisualStudio.TestTools.UnitTesting;
31
32namespace HeuristicLab.Tests {
33  /// <summary>
34  /// Summary description for DeepCloneableCloningTest
35  /// </summary>
36  [TestClass]
37  public class DeepCloneableCloningTest {
38
39    [ClassInitialize]
40    public static void MyClassInitialize(TestContext testContext) {
41      PluginLoader.Assemblies.Any();
42    }
43
44    private TestContext testContextInstance;
45    public TestContext TestContext {
46      get { return testContextInstance; }
47      set { testContextInstance = value; }
48    }
49
50    public DeepCloneableCloningTest() {
51      excludedTypes = new HashSet<Type>();
52      excludedTypes.Add(typeof(HeuristicLab.Problems.DataAnalysis.Dataset));
53      excludedTypes.Add(typeof(HeuristicLab.Problems.TravelingSalesman.DistanceMatrix));
54      excludedTypes.Add(typeof(HeuristicLab.Problems.DataAnalysis.ClassificationEnsembleSolution));
55      excludedTypes.Add(typeof(HeuristicLab.Problems.DataAnalysis.RegressionEnsembleSolution));
56
57      foreach (var symbolType in ApplicationManager.Manager.GetTypes(typeof(HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.Symbol)))
58        excludedTypes.Add(symbolType);
59      foreach (var grammarType in ApplicationManager.Manager.GetTypes(typeof(HeuristicLab.Encodings.SymbolicExpressionTreeEncoding.SymbolicExpressionGrammarBase)))
60        excludedTypes.Add(grammarType);
61    }
62
63    private readonly HashSet<Type> excludedTypes;
64
65    [TestMethod]
66    [TestCategory("General")]
67    [TestCategory("Essential")]
68    [TestProperty("Time", "long")]
69    [DeploymentItem(@"HeuristicLab-3.3\Resources\SamplesExperimentFinished.hl")]
70    public void TestCloningFinishedExperiment() {
71      Experiment experiment = (Experiment)XmlParser.Deserialize("SamplesExperimentFinished.hl");
72
73      Experiment clone = (Experiment)experiment.Clone(new Cloner());
74      var intersections = CheckTotalInequality(experiment, clone).Where(x => x.GetType().FullName.StartsWith("HeuristicLab"));
75
76      Assert.IsTrue(ProcessEqualObjects(experiment, intersections));
77    }
78
79    [TestMethod]
80    [TestCategory("General")]
81    [TestCategory("Essential")]
82    [TestProperty("Time", "long")]
83    public void TestCloningAllDeepCloneables() {
84      PluginLoader.Assemblies.ToArray();
85      bool success = true;
86      foreach (Type deepCloneableType in ApplicationManager.Manager.GetTypes(typeof(IDeepCloneable))) {
87        // skip types that explicitely choose not to deep-clone every member
88        if (excludedTypes.Contains(deepCloneableType)) continue;
89        // test only types contained in HL plugin assemblies
90        if (!PluginLoader.Assemblies.Contains(deepCloneableType.Assembly)) continue;
91        // test only instantiable types
92        if (deepCloneableType.IsAbstract || !deepCloneableType.IsClass) continue;
93
94        IDeepCloneable item = null;
95        try {
96          item = (IDeepCloneable)Activator.CreateInstance(deepCloneableType, nonPublic: false);
97        }
98        catch { continue; } // no default constructor
99
100        IDeepCloneable clone = null;
101        try {
102          clone = (IDeepCloneable)item.Clone(new Cloner());
103        }
104        catch (Exception e) {
105          TestContext.WriteLine(Environment.NewLine + deepCloneableType.FullName + ":");
106          TestContext.WriteLine("ERROR! " + e.GetType().Name + @" was thrown during cloning.
107All IDeepCloneable items with a default constructor should be cloneable when using that constructor!");
108          success = false;
109          continue;
110        }
111        var intersections = CheckTotalInequality(item, clone).Where(x => x.GetType().FullName.StartsWith("HeuristicLab"));
112        if (!intersections.Any()) continue;
113
114        if (!ProcessEqualObjects(item, intersections))
115          success = false;
116      }
117      Assert.IsTrue(success, "There are potential errors in deep cloning objects.");
118    }
119
120    private IEnumerable<object> CheckTotalInequality(object original, object clone) {
121      var originalObjects = new HashSet<object>(original.GetObjectGraphObjects(excludeStaticMembers: true).Where(x => !x.GetType().IsValueType), new ReferenceEqualityComparer());
122      var clonedObjects = new HashSet<object>(clone.GetObjectGraphObjects(excludeStaticMembers: true).Where(x => !x.GetType().IsValueType), new ReferenceEqualityComparer());
123
124      return originalObjects.Intersect(clonedObjects, new ReferenceEqualityComparer());
125    }
126
127    private bool ProcessEqualObjects(IDeepCloneable item, IEnumerable<object> intersections) {
128      bool success = true;
129      TestContext.WriteLine(Environment.NewLine + item.GetType().FullName + ":");
130      foreach (object o in intersections) {
131        string typeName = o.GetType().FullName;
132        if (excludedTypes.Contains(o.GetType())) {
133          //TestContext.WriteLine("Skipping excluded type " + typeName);
134        } else if (o is IDeepCloneable) {
135          string info = (o is IItem) ? ((IItem)o).ItemName + ((o is INamedItem) ? ", " + ((INamedItem)o).Name : String.Empty) : String.Empty;
136          TestContext.WriteLine("POTENTIAL ERROR! A DEEPCLONEABLE WAS NOT DEEP CLONED (" + info + "): " + typeName);
137          success = false;
138        } else
139          TestContext.WriteLine("WARNING: An object of type " + typeName + " is referenced in the original and in the clone.");
140      }
141      return success;
142    }
143  }
144}
Note: See TracBrowser for help on using the repository browser.