OSS-694: Validate input parameters (#149)

* OSS-694: Added  nullable validation for input parameters in public methods

* OSS-694: Added extention AssertNotNull  and changed all null checking to AssertNotNull

* OSS-694: Added null exception test

Author: shestakovg

FaunaDB.Client.Test/ClientTest.cs

@@ -2657,6 +2657,26 @@ public async Task TestTimeDiff()
             Assert.AreEqual(2L, res3.To<long>().Value);
         }
 
+        [Test]
+        public void GetClientExceptionTest()
+        {
+            var exception1 = Assert.Throws<ArgumentNullException>(
+              () => new FaunaClient(secret: null, endpoint: faunaEndpoint)
+            );
+
+            Assert.That(exception1.Message, Does.Contain("secret"));
+
+            var exception2 = Assert.Throws<ArgumentNullException>(
+              () => new FaunaClient(secret: faunaSecret, endpoint: null)
+            );
+            Assert.That(exception2.Message, Does.Contain("endpoint"));
+
+            var exception3 = Assert.Throws<ArgumentNullException>(
+              () => new FaunaClient(secret: null, endpoint: null)
+            );
+            Assert.That(exception3.Message, Does.Contain("secret"));
+        }
+
         private async Task<Value> NewCollectionWithValues(string colName, string indexName, int size = 10, bool indexWithAllValues = false)
         {
             RefV aCollection = (await client.Query(CreateCollection(Obj("name", colName))))

FaunaDB.Client/Client/DefaultClientIO.cs

@@ -9,6 +9,7 @@
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+using FaunaDB.Errors;
 
 namespace FaunaDB.Client
 {
@@ -31,6 +32,11 @@ class DefaultClientIO : IClientIO
 
         internal DefaultClientIO(HttpClient client, AuthenticationHeaderValue authHeader, LastSeen lastSeen, Uri endpoint, TimeSpan? timeout, Version httpVersion)
         {
+            client.AssertNotNull(nameof(client));
+            authHeader.AssertNotNull(nameof(authHeader));
+            endpoint.AssertNotNull(nameof(endpoint));
+            lastSeen.AssertNotNull(nameof(lastSeen));
+
             this.client = client;
             this.authHeader = authHeader;
             this.lastSeen = lastSeen;
@@ -207,16 +213,13 @@ static class HttpRequestExtensions
 
         public static void SetTimeout(this HttpRequestMessage request, TimeSpan? timeout)
         {
-            if (request == null)
-                throw new ArgumentNullException(nameof(request));
-
+            request.AssertNotNull(nameof(request));
             request.Properties[TimeoutPropertyKey] = timeout;
         }
 
         public static TimeSpan? GetTimeout(this HttpRequestMessage request)
         {
-            if (request == null)
-                throw new ArgumentNullException(nameof(request));
+            request.AssertNotNull(nameof(request));
 
             if (request.Properties.TryGetValue(TimeoutPropertyKey, out var value) && value is TimeSpan timeout)
                 return timeout;

FaunaDB.Client/Client/FaunaClient.cs

@@ -46,6 +46,7 @@ public FaunaClient(
         /// </summary>
         public FaunaClient(IClientIO clientIO)
         {
+            clientIO.AssertNotNull(nameof(clientIO));
             this.clientIO = clientIO;
         }
 
@@ -246,6 +247,9 @@ static IClientIO CreateClient(
             HttpClient httpClient = null,
             Version httpVersion = null)
         {
+            secret.AssertNotNull(nameof(secret));
+            endpoint.AssertNotNull(nameof(endpoint));
+
             return new DefaultClientIO(
                 secret: secret,
                 endpoint: new Uri(endpoint),

FaunaDB.Client/Client/LastSeen.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Threading;
 
 /// <summary>

FaunaDB.Client/Client/StreamingEventHandler.cs

@@ -18,6 +18,7 @@ public class StreamingEventHandler : IObservable<Value>, IDisposable
 
         public StreamingEventHandler(Stream dataSource)
         {
+            dataSource.AssertNotNull(nameof(dataSource));
             observers = new List<IObserver<Value>>();
             streamReader = new StreamReader(dataSource);
         }

FaunaDB.Client/Client/StreamingEventMonitor.cs

@@ -1,5 +1,6 @@
 using System;
 using FaunaDB.Types;
+using FaunaDB.Errors;
 
 namespace FaunaDB.Client
 {
@@ -23,6 +24,7 @@ public StreamingEventMonitor(Action<Value> onNext, Action<Exception> onError, Ac
 
         public void Subscribe(StreamingEventHandler provider)
         {
+            provider.AssertNotNull(nameof(provider));
             cancellation = provider.Subscribe(this);
             this.provider = provider;
             this.provider.RequestData();

FaunaDB.Client/Errors/NotNullValidator.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace FaunaDB.Errors
+{
+    static class NotNullValidator
+    {
+        public static void AssertNotNull(this object value, string valueName)
+        {
+            if (value == null)
+            {
+                throw new ArgumentNullException(valueName);
+            }
+        }
+    }
+}

FaunaDB.Client/Query/PageHelper.cs

@@ -3,6 +3,7 @@
 using System.Threading.Tasks;
 using FaunaDB.Client;
 using FaunaDB.Types;
+using FaunaDB.Errors;
 
 namespace FaunaDB.Query
 {
@@ -27,6 +28,9 @@ public PageHelper(FaunaClient client,
                           Expr events = null,
                           Expr sources = null)
         {
+            client.AssertNotNull(nameof(client));
+            set.AssertNotNull(nameof(set));
+
             this.client = client;
             this.set = set;
             this.ts = ts;

FaunaDB.Client/Query/Unescaped.cs

@@ -1,4 +1,5 @@
 using FaunaDB.Types;
+using FaunaDB.Errors;
 using Newtonsoft.Json;
 using System.Linq;
 using System;
@@ -16,9 +17,7 @@ class UnescapedObject : Expr
 
         public UnescapedObject(IReadOnlyDictionary<string, Expr> values)
         {
-            if (values == null)
-                throw new ArgumentNullException(nameof(values));
-
+            values.AssertNotNull(nameof(values));
             Values = values;
         }
 
@@ -74,17 +73,13 @@ class UnescapedArray : Expr
 
         public UnescapedArray(IReadOnlyList<Expr> value)
         {
-            if (value == null)
-                throw new ArgumentNullException(nameof(value));
-
+            value.AssertNotNull(nameof(value));
             Value = value;
         }
 
         public UnescapedArray(params Expr[] value)
         {
-            if (value == null)
-                throw new ArgumentNullException(nameof(value));
-
+            value.AssertNotNull(nameof(value));
             Value = value;
         }
 

FaunaDB.Client/Types/ArrayV.cs

@@ -1,5 +1,6 @@
 using FaunaDB.Query;
 using FaunaDB.Utils;
+using FaunaDB.Errors;
 using Newtonsoft.Json;
 using System;
 using System.Collections;
@@ -28,18 +29,14 @@ internal ArrayV(params Value[] values) : this((IEnumerable<Value>)values)
 
         internal ArrayV(IEnumerable<Value> values)
         {
+            values.AssertNotNull(nameof(values));
             Value = new List<Value>(values);
-
-            if (values == null)
-                throw new ArgumentNullException(nameof(values));
         }
 
         internal ArrayV(IReadOnlyList<Value> value)
         {
+            value.AssertNotNull(nameof(value));
             Value = value;
-
-            if (value == null)
-                throw new ArgumentNullException(nameof(value));
         }
 
         internal ArrayV(Action<Action<Value>> builder)