Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2521_ProblemRefactoring/HeuristicLab.Tests/HeuristicLab-3.3/StorableTest.cs @ 17260

Last change on this file since 17260 was 17260, checked in by abeham, 4 years ago

#2521: Worked on PTSP refactoring

File size: 6.8 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 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 System.Reflection;
26using System.Text;
27using HEAL.Attic;
28using HeuristicLab.Common;
29using HeuristicLab.MainForm;
30using HeuristicLab.PluginInfrastructure;
31using Microsoft.VisualStudio.TestTools.UnitTesting;
32
33namespace HeuristicLab.Tests {
34  [TestClass]
35  public class StorableTest {
36    [TestMethod]
37    [TestCategory("General")]
38    [TestCategory("Essential")]
39    [TestProperty("Time", "short")]
40    public void TestStorableConstructor() {
41      StringBuilder errorMessage = new StringBuilder();
42
43      foreach (Type storableType in ApplicationManager.Manager.GetTypes(typeof(object))
44        .Where(StorableTypeAttribute.IsStorableType)) {
45        //test only types contained in HL plugin assemblies
46        if (!storableType.Namespace.StartsWith("HeuristicLab")) continue;
47        if (storableType.Namespace.Contains(".Tests")) continue;
48        if (!PluginLoader.Assemblies.Contains(storableType.Assembly)) continue;
49
50        if (storableType.IsEnum || storableType.IsInterface) continue;
51        var storableFields = storableType
52          .GetFields(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public)
53          .Where(fi => StorableAttribute.IsStorable(fi));
54        var storableProps = storableType
55          .GetProperties(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public)
56          .Where(fi => StorableAttribute.IsStorable(fi));
57
58        // a storable constructor should be given but is not absolutely required.
59        // when there are no storable fields then a storable ctor has no real purpose.
60        if (!storableFields.Any() && !storableProps.Any()) continue;
61
62        IEnumerable<ConstructorInfo> ctors = storableType.GetConstructors(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public);
63        ConstructorInfo storableConstructor = ctors.Where(c => c.GetParameters().Count() == 1 && c.GetParameters().First().ParameterType == typeof(HEAL.Attic.StorableConstructorFlag)).FirstOrDefault();
64        if (storableConstructor == null) errorMessage.Append(Environment.NewLine + storableType.ToString() + ": No storable constructor is defined.");
65        else {
66          if (storableType.IsSealed && !storableConstructor.IsPrivate)
67            errorMessage.Append(Environment.NewLine + storableType.Namespace + "." + storableType.GetPrettyName() + ": Storable constructor must be private in sealed classes.");
68          else if (!storableType.IsSealed && !(storableConstructor.IsFamily || storableConstructor.IsPublic))
69            errorMessage.Append(Environment.NewLine + storableType.Namespace + "." + storableType.GetPrettyName() + ": Storable constructor must be protected (can be public in rare cases).");
70        }
71      }
72      Assert.IsTrue(errorMessage.Length == 0, errorMessage.ToString());
73    }
74
75    [TestMethod]
76    [TestCategory("General")]
77    [TestCategory("Essential")]
78    [TestProperty("Time", "short")]
79    public void TestStorableClass() {
80      var errorMessage = new StringBuilder();
81
82      foreach (var type in ApplicationManager.Manager.GetTypes(typeof(object), onlyInstantiable: false, includeGenericTypeDefinitions: true)
83        .Where(t => t.Namespace != null && !t.Namespace.Contains(".Tests"))
84        .Where(t => !StorableTypeAttribute.IsStorableType(t))) {
85        var members = type.GetMembers(BindingFlags.Instance | BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.DeclaredOnly);
86        var storableConstructor = members.SingleOrDefault(m => Attribute.IsDefined(m, typeof(StorableConstructorAttribute), inherit: false));
87        var storableMembers = members.Where(m => Attribute.IsDefined(m, typeof(StorableAttribute), inherit: false));
88
89        if (storableConstructor != null) {
90          errorMessage.Append(Environment.NewLine + type.Namespace + "." + type.GetPrettyName() + ": Contains a storable constructor but is not a storable type.");
91        } else if (storableMembers.Any()) {
92          errorMessage.Append(Environment.NewLine + type.Namespace + "." + type.GetPrettyName() + ": Contains at least one storable member but is not a storable type.");
93        }
94      }
95      Assert.IsTrue(errorMessage.Length == 0, errorMessage.ToString());
96    }
97
98    [TestMethod]
99    [TestCategory("General")]
100    [TestCategory("Essential")]
101    [TestProperty("Time", "short")]
102    public void TestStorableTypeAttributePresence() {
103      var errorMessage = new StringBuilder();
104      foreach (Assembly ass in AppDomain.CurrentDomain.GetAssemblies().Where(x => x.GetName().Name.StartsWith("HeuristicLab"))) {
105        if (ass == Assembly.GetExecutingAssembly()) continue;
106        foreach (Type t in ass.GetExportedTypes()) {
107          if (t.IsAbstract && t.IsSealed) continue; // static classes are abstract and sealed at IL level
108          if (t.Namespace != null && (t.Namespace.EndsWith(".Views")
109            || t.Namespace.StartsWith("ICSharpCode")
110            || t.Namespace.StartsWith("HeuristicLab.Problems.Instances")
111            || t.Namespace.StartsWith("HeuristicLab.PluginInfrastructure")
112            || t.Namespace.StartsWith("HeuristicLab.Persistence")
113            || t.Namespace.StartsWith("HeuristicLab.MainForm")
114            || t.Namespace.StartsWith("HeuristicLab.Clients")
115            || t.Namespace.StartsWith("HeuristicLab.CodeEditor")))
116            continue;
117          if (typeof(IPlugin).IsAssignableFrom(t) || typeof(Attribute).IsAssignableFrom(t) || typeof(Exception).IsAssignableFrom(t)
118            || typeof(EventArgs).IsAssignableFrom(t)
119            || typeof(IView).IsAssignableFrom(t) || typeof(System.Windows.Forms.Control).IsAssignableFrom(t)) continue;
120          var attr = StorableTypeAttribute.GetStorableTypeAttribute(t);
121          if (attr == null) {
122            errorMessage.AppendLine(t.FullName + ": Does not contain a storable type attribute.");
123          }
124        }
125      }
126      Assert.IsTrue(errorMessage.Length == 0, errorMessage.ToString());
127    }
128  }
129}
Note: See TracBrowser for help on using the repository browser.