csharp/src/Google.Protobuf.Test/EqualityTester.cs

   1 #region Copyright notice and license
   2 // Protocol Buffers - Google's data interchange format
   3 // Copyright 2015 Google Inc.  All rights reserved.
   4 // https://developers.google.com/protocol-buffers/
   5 //
   6 // Redistribution and use in source and binary forms, with or without
   7 // modification, are permitted provided that the following conditions are
   8 // met:
   9 //
  10 //     * Redistributions of source code must retain the above copyright
  11 // notice, this list of conditions and the following disclaimer.
  12 //     * Redistributions in binary form must reproduce the above
  13 // copyright notice, this list of conditions and the following disclaimer
  14 // in the documentation and/or other materials provided with the
  15 // distribution.
  16 //     * Neither the name of Google Inc. nor the names of its
  17 // contributors may be used to endorse or promote products derived from
  18 // this software without specific prior written permission.
  19 //
  20 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  23 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  24 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  25 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  26 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  27 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  28 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  29 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  30 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31 #endregion
  32
  33 using System;
  34 using NUnit.Framework;
  35
  36 namespace Google.Protobuf
  37 {
  38     /// <summary>
  39     /// Helper methods when testing equality. NUnit's Assert.AreEqual and
  40     /// Assert.AreNotEqual methods try to be clever with collections, which can
  41     /// be annoying...
  42     /// </summary>
  43     internal static class EqualityTester
  44     {
  45         public static void AssertEquality<T>(T first, T second) where T : IEquatable<T>
  46         {
  47             Assert.IsTrue(first.Equals(second));
  48             Assert.IsTrue(first.Equals((object) second));
  49             Assert.AreEqual(first.GetHashCode(), second.GetHashCode());
  50         }
  51
  52         public static void AssertInequality<T>(T first, T second, bool checkHashcode = true) where T : IEquatable<T>
  53         {
  54             Assert.IsFalse(first.Equals(second));
  55             Assert.IsFalse(first.Equals((object) second));
  56             // While this isn't a requirement, the chances of this test failing due to
  57             // coincidence rather than a bug are very small.
  58             // For such rare cases, an argument can be used to disable the check.
  59             if (checkHashcode && first != null && second != null)
  60             {
  61                 Assert.AreNotEqual(first.GetHashCode(), second.GetHashCode());
  62             }
  63         }
  64     }
  65 }