CSHARP-3396: Expose the Reason an Operation Fails Document Validation (#566)

Author: MikalaiMazurenka

src/MongoDB.Driver/MongoBulkWriteException.cs

@@ -121,14 +121,17 @@ private static string FormatMessage(IEnumerable<BulkWriteError> writeErrors, Wri
             var sb = new StringBuilder("A bulk write operation resulted in one or more errors.");
             if (writeErrors != null)
             {
+                sb.Append(" WriteErrors: [ ");
                 foreach (var writeError in writeErrors)
                 {
-                    sb.AppendLine().Append("  " + writeError.Message);
+                    sb.Append(writeError + ", ");
                 }
+                sb.Remove(sb.Length - 2, 2);
+                sb.Append(" ].");
             }
             if (writeConcernError != null)
             {
-                sb.AppendLine().Append("  " + writeConcernError.Message);
+                sb.Append($" WriteConcernError: {writeConcernError}.");
             }
 
             return sb.ToString();

src/MongoDB.Driver/MongoWriteException.cs

@@ -129,11 +129,11 @@ private static string FormatMessage(WriteError writeError, WriteConcernError wri
             var sb = new StringBuilder("A write operation resulted in an error.");
             if (writeError != null)
             {
-                sb.AppendLine().Append("  " + writeError.Message);
+                sb.Append($" WriteError: {writeError}.");
             }
             if (writeConcernError != null)
             {
-                sb.AppendLine().Append("  " + writeConcernError.Message);
+                sb.Append($" WriteConcernError: {writeConcernError}.");
             }
 
             return sb.ToString();

src/MongoDB.Driver/WriteConcernError.cs

@@ -13,8 +13,12 @@
 * limitations under the License.
 */
 
+#if !NETSTANDARD1_5
 using System;
+#endif
 using System.Collections.Generic;
+using System.Linq;
+using System.Text;
 using MongoDB.Bson;
 
 namespace MongoDB.Driver
@@ -93,6 +97,37 @@ public string Message
             get { return _message; }
         }
 
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            var sb = new StringBuilder($"{{ Code : \"{_code}\"");
+            if (_codeName != null)
+            {
+                sb.Append($", CodeName : \"{_codeName}\"");
+            }
+            if (_message != null)
+            {
+                sb.Append($", Message : \"{_message}\"");
+            }
+            if (_details != null)
+            {
+                sb.Append($", Details : \"{_details}\"");
+            }
+            if (_errorLabels != null && _errorLabels.Any())
+            {
+                sb.Append(", ErrorLabels : [ ");
+                foreach (var errorLabel in _errorLabels)
+                {
+                    sb.Append($"\"{errorLabel}\", ");
+                }
+                sb.Remove(sb.Length - 2, 2);
+                sb.Append(" ]");
+            }
+            sb.Append(" }");
+
+            return sb.ToString();
+        }
+
         // internal static methods
         internal static WriteConcernError FromCore(Core.Operations.BulkWriteConcernError error)
         {

src/MongoDB.Driver/WriteError.cs

@@ -16,6 +16,7 @@
 #if !NETSTANDARD1_5
 using System;
 #endif
+using System.Text;
 using MongoDB.Bson;
 
 namespace MongoDB.Driver
@@ -75,5 +76,22 @@ public string Message
         {
             get { return _message; }
         }
+
+        /// <inheritdoc/>
+        public override string ToString()
+        {
+            var stringBuilder = new StringBuilder($"{{ Category : \"{_category}\", Code : {_code}");
+            if (_message != null)
+            {
+                stringBuilder.Append($", Message : \"{_message}\"");
+            }
+            if (_details != null)
+            {
+                stringBuilder.Append($", Details : \"{_details}\"");
+            }
+            stringBuilder.Append(" }");
+
+            return stringBuilder.ToString();
+        }
     }
 }

tests/MongoDB.Driver.Tests/MongoBulkWriteExceptionTests.cs

@@ -24,7 +24,9 @@
 #endif
 using FluentAssertions;
 using MongoDB.Bson;
+#if !NETCOREAPP1_1
 using MongoDB.Bson.TestHelpers.EqualityComparers;
+#endif
 using MongoDB.Driver.Core.Clusters;
 using MongoDB.Driver.Core.Connections;
 using MongoDB.Driver.Core.Operations;
@@ -71,7 +73,7 @@ public void constructor_should_initialize_subject()
 
             subject.ConnectionId.Should().BeSameAs(__connectionId);
             subject.ErrorLabels.Should().BeEquivalentTo(__writeConcernError.ErrorLabels);
-            subject.Message.Should().Contain("bulk write operation");
+            subject.Message.Should().Be("A bulk write operation resulted in one or more errors. WriteErrors: [ { Category : \"Uncategorized\", Code : 1, Message : \"blah\", Details : \"{ \"a\" : 1 }\" } ]. WriteConcernError: { Code : \"11\", Message : \"funny\", Details : \"{ \"c\" : 1 }\", ErrorLabels : [ \"RetryableWriteError\" ] }.");
             subject.Result.Should().BeSameAs(__bulkWriteResult);
             subject.UnprocessedRequests.Should().Equal(__unprocessedRequests);
             subject.WriteConcernError.Should().BeSameAs(__writeConcernError);

tests/MongoDB.Driver.Tests/MongoCollectionProseTests.cs

@@ -15,14 +15,18 @@
 
 using System;
 using System.Collections.Generic;
+#if !NETCOREAPP1_1
 using System.IO;
+#endif
 using System.Net;
 #if NET452
 using System.Runtime.Serialization.Formatters.Binary;
 #endif
 using FluentAssertions;
 using MongoDB.Bson;
+#if !NETCOREAPP1_1
 using MongoDB.Bson.TestHelpers.EqualityComparers;
+#endif
 using MongoDB.Driver.Core.Clusters;
 using MongoDB.Driver.Core.Connections;
 using MongoDB.Driver.Core.Servers;
@@ -64,7 +68,7 @@ public void constructor_should_initialize_subject()
             subject.ConnectionId.Should().Be(__connectionId);
             subject.ErrorLabels.Should().BeEquivalentTo(__writeConcernError.ErrorLabels);
             subject.InnerException.Should().Be(__innerException);
-            subject.Message.Should().Be("A write operation resulted in an error." + Environment.NewLine + "  writeError" + Environment.NewLine + "  writeConcernError");
+            subject.Message.Should().Be("A write operation resulted in an error. WriteError: { Category : \"Uncategorized\", Code : 1, Message : \"writeError\", Details : \"{ \"details\" : \"writeError\" }\" }. WriteConcernError: { Code : \"1\", Message : \"writeConcernError\", Details : \"{ \"details\" : \"writeConcernError\" }\", ErrorLabels : [ \"RetryableWriteError\" ] }.");
             subject.WriteConcernError.Should().Be(__writeConcernError);
             subject.WriteError.Should().Be(__writeError);
         }
@@ -85,7 +89,7 @@ public void FromBulkWriteException_should_return_expected_result()
             result.ConnectionId.Should().Be(__connectionId);
             result.ErrorLabels.Should().BeEquivalentTo(writeConcernError.ErrorLabels);
             result.InnerException.Should().BeSameAs(bulkWriteException);
-            result.Message.Should().Be("A write operation resulted in an error." + Environment.NewLine + "  message" + Environment.NewLine + "  message");
+            result.Message.Should().Be("A write operation resulted in an error. WriteError: { Category : \"Uncategorized\", Code : 2, Message : \"message\", Details : \"{ \"details\" : 1 }\" }. WriteConcernError: { Code : \"1\", Message : \"message\", Details : \"{ \"details\" : 1 }\", ErrorLabels : [ \"RetryableWriteError\" ] }.");
             result.WriteConcernError.Should().Be(writeConcernError);
             result.WriteError.Should().Be(writeErrors[0]);
         }