Refactoring of Messaging tests

Vonage · Mar 1, 2022 · ef15833 · ef15833
1 parent 0dd59ae
commit ef15833
Show file tree

Hide file tree

Showing 11 changed files with 202 additions and 100 deletions.
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsAsyncBadResponse.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsAsyncBadResponse.json
@@ -0,0 +1,9 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "status": "4",
+      "error-text": "invalid credentials"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsAsyncWithAllPropertiesSet.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsAsyncWithAllPropertiesSet.json
@@ -0,0 +1,14 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "to": "447700900000",
+      "message-id": "0A0000000123ABCD1",
+      "status": "0",
+      "remaining-balance": "3.14159265",
+      "message-price": "0.03330000",
+      "network": "12345",
+      "account-ref": "customer1234"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsBadResponse.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsBadResponse.json
@@ -0,0 +1,9 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "status": "4",
+      "error-text": "invalid credentials"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsTypicalUsageSimplifiedAsync.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsTypicalUsageSimplifiedAsync.json
@@ -0,0 +1,14 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "to": "447700900000",
+      "message-id": "0A0000000123ABCD1",
+      "status": "0",
+      "remaining-balance": "3.14159265",
+      "message-price": "0.03330000",
+      "network": "12345",
+      "account-ref": "customer1234"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsWithAllPropertiesSet.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsWithAllPropertiesSet.json
@@ -0,0 +1,14 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "to": "447700900000",
+      "message-id": "0A0000000123ABCD1",
+      "status": "0",
+      "remaining-balance": "3.14159265",
+      "message-price": "0.03330000",
+      "network": "12345",
+      "account-ref": "customer1234"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/Data/MessagingTests/SendSmsWrongCredentialsThrowsException.json b/Vonage.Test.Unit/Data/MessagingTests/SendSmsWrongCredentialsThrowsException.json
@@ -0,0 +1,9 @@
+{
+  "message-count": "1",
+  "messages": [
+    {
+      "status": "4",
+      "error-text": "invalid credentials"
+    }
+  ]
+}
diff --git a/Vonage.Test.Unit/MessagingTests.cs b/Vonage.Test.Unit/MessagingTests.cs
@@ -1,9 +1,6 @@
 using Newtonsoft.Json;
 using Vonage.Messaging;
-using System;
 using System.Collections.Generic;
-using System.Linq;
-using System.Text;
 using System.Threading.Tasks;
 using System.Web;
 using Xunit;
@@ -16,28 +13,16 @@ public class MessagingTests : TestBase
         [Theory]
         [InlineData(false)]
         [InlineData(true)]
-        public void KitcenSinkSendSms(bool passCreds)
+        public void SendSmsWithAllPropertiesSet(bool passCreds)
         {
-            var expectedResponse = @"{
-                  ""message-count"": ""1"",
-                  ""messages"": [
-                    {
-                      ""to"": ""447700900000"",
-                      ""message-id"": ""0A0000000123ABCD1"",
-                      ""status"": ""0"",
-                      ""remaining-balance"": ""3.14159265"",
-                      ""message-price"": ""0.03330000"",
-                      ""network"": ""12345"",
-                      ""account-ref"": ""customer1234""
-                    }
-                  ]
-                }";
+            var expectedResponse = GetExpectedJson();
             var expectedUri = $"{RestUrl}/sms/json?";
             var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}" +
                 $"&ttl=900000&status-report-req=true&callback={HttpUtility.UrlEncode("https://example.com/sms-dlr")}&message-class=0" +
                 $"&type=text&vcard=none&vcal=none&body=638265253311&udh=06050415811581&protocol-id=127&title=welcome&url={HttpUtility.UrlEncode("https://example.com")}" +
                 $"&validity=300000&client-ref=my-personal-reference&account-ref=customer1234&entity-id=testEntity&content-id=testcontent&api_key={ApiKey}&api_secret={ApiSecret}&";
-            var request = new Messaging.SendSmsRequest
+
+            var request = new SendSmsRequest
             {
                 AccountRef = "customer1234",
                 Body = "638265253311",
@@ -57,23 +42,70 @@ public void KitcenSinkSendSms(bool passCreds)
                 Vcal = "none",
                 Vcard = "none",
                 Url = "https://example.com",
-                ContentId ="testcontent",
-                EntityId="testEntity"
-
-
+                ContentId = "testcontent",
+                EntityId = "testEntity"
             };
+
             var creds = Request.Credentials.FromApiKeyAndSecret(ApiKey, ApiSecret);
             Setup(expectedUri, expectedResponse, expectedRequestContent);
             var client = new VonageClient(creds);
-            Messaging.SendSmsResponse response;
-            if (passCreds)
-            {
-                response = client.SmsClient.SendAnSms(request, creds);
-            }
-            else
+
+            var response = passCreds
+                ? client.SmsClient.SendAnSms(request, creds)
+                : client.SmsClient.SendAnSms(request);
+
+            Assert.Equal("1", response.MessageCount);
+            Assert.Equal("447700900000", response.Messages[0].To);
+            Assert.Equal("0A0000000123ABCD1", response.Messages[0].MessageId);
+            Assert.Equal("0", response.Messages[0].Status);
+            Assert.Equal("3.14159265", response.Messages[0].RemainingBalance);
+            Assert.Equal("12345", response.Messages[0].Network);
+            Assert.Equal("customer1234", response.Messages[0].AccountRef);
+        }
+
+        [Theory]
+        [InlineData(false)]
+        [InlineData(true)]
+        public async Task SendSmsAsyncWithAllPropertiesSet(bool passCreds)
+        {
+            var expectedResponse = GetExpectedJson();
+            var expectedUri = $"{RestUrl}/sms/json?";
+            var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}" +
+                $"&ttl=900000&status-report-req=true&callback={HttpUtility.UrlEncode("https://example.com/sms-dlr")}&message-class=0" +
+                $"&type=text&vcard=none&vcal=none&body=638265253311&udh=06050415811581&protocol-id=127&title=welcome&url={HttpUtility.UrlEncode("https://example.com")}" +
+                $"&validity=300000&client-ref=my-personal-reference&account-ref=customer1234&entity-id=testEntity&content-id=testcontent&api_key={ApiKey}&api_secret={ApiSecret}&";
+
+            var request = new SendSmsRequest
             {
-                response = client.SmsClient.SendAnSms(request);
-            }
+                AccountRef = "customer1234",
+                Body = "638265253311",
+                Callback = "https://example.com/sms-dlr",
+                ClientRef = "my-personal-reference",
+                From = "AcmeInc",
+                To = "447700900000",
+                MessageClass = 0,
+                ProtocolId = 127,
+                StatusReportReq = true,
+                Text = "Hello World!",
+                Title = "welcome",
+                Ttl = 900000,
+                Type = SmsType.text,
+                Udh = "06050415811581",
+                Validity = "300000",
+                Vcal = "none",
+                Vcard = "none",
+                Url = "https://example.com",
+                ContentId = "testcontent",
+                EntityId = "testEntity"
+            };
+
+            var creds = Request.Credentials.FromApiKeyAndSecret(ApiKey, ApiSecret);
+            Setup(expectedUri, expectedResponse, expectedRequestContent);
+            var client = new VonageClient(creds);
+
+            var response = passCreds
+                ? await client.SmsClient.SendAnSmsAsync(request, creds)
+                : await client.SmsClient.SendAnSmsAsync(request);
 
             Assert.Equal("1", response.MessageCount);
             Assert.Equal("447700900000", response.Messages[0].To);
@@ -84,7 +116,7 @@ public void KitcenSinkSendSms(bool passCreds)
             Assert.Equal("customer1234", response.Messages[0].AccountRef);
         }
 
-        [Fact]        
+        [Fact]
         public void SendSmsTypicalUsage()
         {
             var expectedResponse = @"{
@@ -149,22 +181,9 @@ public void SendSmsTypicalUsageSimplified()
         }
 
         [Fact]
-        public async void SendSmsTypicalUsageSimplifiedAsync()
+        public async Task SendSmsTypicalUsageSimplifiedAsync()
         {
-            var expectedResponse = @"{
-                  ""message-count"": ""1"",
-                  ""messages"": [
-                    {
-                      ""to"": ""447700900000"",
-                      ""message-id"": ""0A0000000123ABCD1"",
-                      ""status"": ""0"",
-                      ""remaining-balance"": ""3.14159265"",
-                      ""message-price"": ""0.03330000"",
-                      ""network"": ""12345"",
-                      ""account-ref"": ""customer1234""
-                    }
-                  ]
-                }";
+            var expectedResponse = GetExpectedJson();
             var expectedUri = $"{RestUrl}/sms/json?";
             var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}&type=text&api_key={ApiKey}&api_secret={ApiSecret}&";
             Setup(expectedUri, expectedResponse, expectedRequestContent);
@@ -215,29 +234,35 @@ public void SendSmsUnicode()
         [Fact]
         public void SendSmsBadResponse()
         {
-            var expectedResponse = @"{
-                  ""message-count"": ""1"",
-                  ""messages"": [
-                    {                      
-                      ""status"": ""4"",
-                      ""error-text"":""invalid credentials""
-                    }
-                  ]
-                }";
+            var expectedResponse = GetExpectedJson();
             var expectedUri = $"{RestUrl}/sms/json?";
             var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}&api_key={ApiKey}&api_secret={ApiSecret}&";
             Setup(expectedUri, expectedResponse, expectedRequestContent);
             var client = new VonageClient(Request.Credentials.FromApiKeyAndSecret(ApiKey, ApiSecret));
-            try
-            {
-                var response = client.SmsClient.SendAnSms(new Messaging.SendSmsRequest { From = "AcmeInc", To = "447700900000", Text = "Hello World!" });
-                Assert.True(false);
-            }
-            catch(Messaging.VonageSmsResponseException nex)
-            {
-                Assert.Equal($"SMS Request Failed with status: {nex.Response.Messages[0].Status} and error message: {nex.Response.Messages[0].ErrorText}", nex.Message);
-                Assert.Equal(SmsStatusCode.InvalidCredentials, nex.Response.Messages[0].StatusCode);
-            }
+
+            var exception = Assert.Throws<VonageSmsResponseException>(() =>
+                client.SmsClient.SendAnSms(new SendSmsRequest { From = "AcmeInc", To = "447700900000", Text = "Hello World!" }));
+
+            Assert.NotNull(exception);
+            Assert.Equal($"SMS Request Failed with status: {exception.Response.Messages[0].Status} and error message: {exception.Response.Messages[0].ErrorText}", exception.Message);
+            Assert.Equal(SmsStatusCode.InvalidCredentials, exception.Response.Messages[0].StatusCode);
+        }
+
+        [Fact]
+        public async Task SendSmsAsyncBadResponse()
+        {
+            var expectedResponse = GetExpectedJson();
+            var expectedUri = $"{RestUrl}/sms/json?";
+            var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}&api_key={ApiKey}&api_secret={ApiSecret}&";
+            Setup(expectedUri, expectedResponse, expectedRequestContent);
+            var client = new VonageClient(Request.Credentials.FromApiKeyAndSecret(ApiKey, ApiSecret));
+
+            var exception = await Assert.ThrowsAsync<VonageSmsResponseException>(async () =>
+                await client.SmsClient.SendAnSmsAsync(new SendSmsRequest { From = "AcmeInc", To = "447700900000", Text = "Hello World!" }));
+
+            Assert.NotNull(exception);
+            Assert.Equal($"SMS Request Failed with status: {exception.Response.Messages[0].Status} and error message: {exception.Response.Messages[0].ErrorText}", exception.Message);
+            Assert.Equal(SmsStatusCode.InvalidCredentials, exception.Response.Messages[0].StatusCode);
         }
 
         [Fact]
@@ -246,17 +271,15 @@ public void NullMessagesResponse()
             var expectedResponse = @"";
             var expectedUri = $"{RestUrl}/sms/json?";
             var expectedRequestContent = $"from=AcmeInc&to=447700900000&text={HttpUtility.UrlEncode("Hello World!")}&api_key={ApiKey}&api_secret={ApiSecret}&";
+
             Setup(expectedUri, expectedResponse, expectedRequestContent);
             var client = new VonageClient(Request.Credentials.FromApiKeyAndSecret(ApiKey, ApiSecret));
-            try
-            {
-                var response = client.SmsClient.SendAnSms(new Messaging.SendSmsRequest { From = "AcmeInc", To = "447700900000", Text = "Hello World!" });
-                Assert.True(false);
-            }
-            catch (Messaging.VonageSmsResponseException nex)
-            {
-                Assert.Equal($"Encountered an Empty SMS response", nex.Message);
-            }
+
+            var exception = Assert.Throws<VonageSmsResponseException>(() =>
+                client.SmsClient.SendAnSms(new SendSmsRequest { From = "AcmeInc", To = "447700900000", Text = "Hello World!" }));
+
+            Assert.NotNull(exception);
+            Assert.Equal($"Encountered an Empty SMS response", exception.Message);
         }
 
         [Fact]
@@ -390,7 +413,7 @@ public void TestValidateSignature()
             var TestSigningSecret = "Y6dI3wtDP8myVH5tnDoIaTxEvAJhgDVCczBa1mHniEqsdlnnebg";
             var json = JsonConvert.SerializeObject(inboundSmsShell, Formatting.None, new JsonSerializerSettings { DefaultValueHandling = DefaultValueHandling.Ignore });
             var dict = JsonConvert.DeserializeObject<Dictionary<string, string>>(json);
-            inboundSmsShell.Sig = Cryptography.SmsSignatureGenerator.GenerateSignature(Messaging.InboundSms.ConstructSignatureStringFromDictionary(dict),TestSigningSecret,Cryptography.SmsSignatureGenerator.Method.md5);
+            inboundSmsShell.Sig = Cryptography.SmsSignatureGenerator.GenerateSignature(Messaging.InboundSms.ConstructSignatureStringFromDictionary(dict), TestSigningSecret, Cryptography.SmsSignatureGenerator.Method.md5);
             Assert.True(inboundSmsShell.ValidateSignature(TestSigningSecret, Cryptography.SmsSignatureGenerator.Method.md5));
         }
 

diff --git a/Vonage.Test.Unit/TestBase.cs b/Vonage.Test.Unit/TestBase.cs
@@ -9,8 +9,6 @@
 using System.Threading.Tasks;
 using Moq;
 using Moq.Protected;
-using Newtonsoft.Json;
-using Newtonsoft.Json.Linq;
 
 namespace Vonage.Test.Unit
 {
@@ -59,18 +57,19 @@ public static string AssemblyDirectory
 
         public void Setup(string uri, string responseContent, string requestContent = null, HttpStatusCode expectedCode = HttpStatusCode.OK)
         {
-            typeof(Configuration).GetField("_client", BindingFlags.Instance | BindingFlags.NonPublic).SetValue(Configuration.Instance, null);
+            typeof(Configuration).GetField("_client", BindingFlags.Instance | BindingFlags.NonPublic)?.SetValue(Configuration.Instance, null);
             var mockHandler = new Mock<HttpMessageHandler>(MockBehavior.Strict);
             mockHandler
                 .Protected()
                 .Setup<Task<HttpResponseMessage>>(MOCKED_METHOD,
-                ItExpr.Is<HttpRequestMessage>(
-                    x =>
-                    string.Equals(x.RequestUri.AbsoluteUri, uri, StringComparison.OrdinalIgnoreCase) &&
-                    (requestContent == null) ||
-                    (string.Equals(x.Content.ReadAsStringAsync().Result, requestContent, StringComparison.OrdinalIgnoreCase))),
-                ItExpr.IsAny<CancellationToken>())
-                .ReturnsAsync(new HttpResponseMessage()
+                    ItExpr.Is<HttpRequestMessage>(
+                        x =>
+                        string.Equals(x.RequestUri.AbsoluteUri, uri, StringComparison.OrdinalIgnoreCase) &&
+                        requestContent == null ||
+                        string.Equals(x.Content.ReadAsStringAsync().Result, requestContent, StringComparison.OrdinalIgnoreCase)),
+                    ItExpr.IsAny<CancellationToken>()
+                )
+                .ReturnsAsync(new HttpResponseMessage
                 {
                     StatusCode = expectedCode,
                     Content = new StringContent(responseContent)
@@ -81,16 +80,16 @@ public void Setup(string uri, string responseContent, string requestContent = nu
 
         public void Setup(string uri, byte[] responseContent, HttpStatusCode expectedCode = HttpStatusCode.OK)
         {
-            typeof(Configuration).GetField("_client", System.Reflection.BindingFlags.Instance | System.Reflection.BindingFlags.NonPublic).SetValue(Configuration.Instance, null);
+            typeof(Configuration).GetField("_client", BindingFlags.Instance | BindingFlags.NonPublic)?.SetValue(Configuration.Instance, null);
             var mockHandler = new Mock<HttpMessageHandler>(MockBehavior.Strict);
             mockHandler
                 .Protected()
                 .Setup<Task<HttpResponseMessage>>(MOCKED_METHOD,
-                ItExpr.Is<HttpRequestMessage>(
-                    x =>
-                    string.Equals(x.RequestUri.AbsoluteUri, uri, StringComparison.OrdinalIgnoreCase)),
-                ItExpr.IsAny<CancellationToken>())
-                .ReturnsAsync(new HttpResponseMessage()
+                    ItExpr.Is<HttpRequestMessage>(
+                        x =>
+                        string.Equals(x.RequestUri.AbsoluteUri, uri, StringComparison.OrdinalIgnoreCase)),
+                    ItExpr.IsAny<CancellationToken>())
+                .ReturnsAsync(new HttpResponseMessage
                 {
                     StatusCode = expectedCode,
                     Content = new StreamContent(new MemoryStream(responseContent))