Merge pull request #1 from bunq/feature/unit-tests

Add first wave unit-tests

Author: dnl-blkv

.gitignore

@@ -263,3 +263,5 @@ pip-log.txt
 # bunq specific
 bunq.conf
 **/Tmp/
+bunq-test.conf
+config.json

Tests/BunqSdkCsharpTest/ApiContextHandler.cs

@@ -0,0 +1,62 @@
+using System;
+using System.Collections.Generic;
+using System.IO;
+using Bunq.Sdk.Context;
+using Bunq.Sdk.Exception;
+using Bunq.Sdk.Model.Generated;
+
+namespace Bunq.Sdk.Tests
+{
+    /// <summary>
+    /// Will check fi the current session token is still valid.
+    /// </summary>
+    public class ApiContextHandler
+    {
+        private const string FILENAME_CONTEXT_CONF = "../../../bunq-test.conf";
+        private const string DEVICE_DESCRIPTION = "Csharp unit test";
+        private static readonly string API_KEY = Config.GetApiKey();
+        private static readonly string FIELD_PERMITTED_IP = Config.GetPermittedIp();
+
+        /// <summary>
+        /// Calls IsSessionActive to check if the session token is still active and returns the ApiContext.
+        /// </summary>
+        public static ApiContext GetApiContext()
+        {
+            if (IsSessionActive()) return ApiContext.Restore(FILENAME_CONTEXT_CONF);
+
+            var permittedIp = new List<string> {FIELD_PERMITTED_IP};
+            var apiContext = new ApiContext(ApiEnvironmentType.SANDBOX, API_KEY);
+            apiContext.Initialize(DEVICE_DESCRIPTION, permittedIp);
+            apiContext.Save(FILENAME_CONTEXT_CONF);
+
+            return apiContext;
+        }
+
+        /// <summary>
+        /// Catches BunqEception if the conf file does not exist.
+        /// Catches ApiExceptoin if the session is inactive.
+        /// </summary>
+        /// <returns>True, if the restores ApiContext can be used, otherwise false.</returns>
+        private static bool IsSessionActive()
+        {
+            try
+            {
+                var apiContext = ApiContext.Restore(FILENAME_CONTEXT_CONF);
+                if (apiContext == null)
+                    return false;
+
+                User.List(apiContext);
+                
+                return true;
+            }
+            catch (BunqException)
+            {
+                return false;
+            }
+            catch (ApiException)
+            {
+                return false;
+            }
+        }
+    }
+}

Tests/BunqSdkCsharpTest/BunqSdkCsharpTest.csproj

@@ -0,0 +1,19 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <PropertyGroup>
+    <TargetFramework>netcoreapp1.1</TargetFramework>
+    <RootNamespace>Bunq.Sdk.Tests</RootNamespace>
+    <LangVersion>5</LangVersion>
+    <AssemblyName>BunqSdkCsharpTest.xunit.runner.json</AssemblyName>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
+    <PackageReference Include="xunit" Version="2.2.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
+    <Content Include="xunit.runner.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </Content>
+  </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\..\BunqSdkCsharp.csproj" />
+  </ItemGroup>
+</Project>

Tests/BunqSdkCsharpTest/Config.cs

@@ -0,0 +1,94 @@
+using System.IO;
+using Bunq.Sdk.Model.Generated.Object;
+using Newtonsoft.Json.Linq;
+
+namespace Bunq.Sdk.Tests
+{
+    public class Config
+    {
+        private const string FIELD_CONFIG_FILE_PATH = "../../../Resources/config.json";
+        private const string FIELD_USER_ID = "USER_ID";
+        private const string FIELD_API_KEY = "API_KEY";
+        private const string FIELD_PERMITTED_IP = "ipAddress";
+        private const string FIELD_ATTACHMENT_PUBLIC_TEST = "AttachmentPublicTest";
+        private const string FIELD_ATTACHMENT_PATH_IN = "PATH_IN";
+        private const string FIELD_ATTACHMENT_DESCRIPTION = "DESCRIPTION";
+        private const string FIELD_ATTACHMENT_CONTENT_TYPE = "CONTENT_TYPE";
+        private const string FIELD_MONETARY_ACCOUNT_ID = "MA_ID";
+        private const string FIELD_MONETARY_ACCOUNT_ID2 = "MA_ID2";
+        private const string FIELD_COUNTER_PARTY_SELF = "CounterPartySelf";
+        private const string FIELD_COUNTER_PARTY_OTHER = "CounterPartyOther";
+        private const string FIELD_COUNTER_ALIAS = "Alias";
+        private const string FIELD_COUNTER_TYPE = "Type";
+        private const string FIELD_TAB_USAGE_SINGLE = "TabUsageSingleTest";
+        private const string FIELD_CASH_REGISTER_ID = "CASH_REGISTER_ID";
+
+        public static int GetCashRegisterId()
+        {
+            return GetConfig()[FIELD_TAB_USAGE_SINGLE][FIELD_CASH_REGISTER_ID].ToObject<int>();
+        }
+
+        public static Pointer GetCounterAliasOther()
+        {
+            var alias = GetConfig()[FIELD_COUNTER_PARTY_OTHER][FIELD_COUNTER_ALIAS].ToString();
+            var type = GetConfig()[FIELD_COUNTER_PARTY_OTHER][FIELD_COUNTER_TYPE].ToString();
+            
+            return new Pointer(type, alias);
+        }
+
+        public static Pointer GetCounterAliasSelf()
+        {
+            var alias = GetConfig()[FIELD_COUNTER_PARTY_SELF][FIELD_COUNTER_ALIAS].ToString();
+            var type = GetConfig()[FIELD_COUNTER_PARTY_SELF][FIELD_COUNTER_TYPE].ToString();
+            
+            return new Pointer(type, alias);
+        }
+
+        public static int GetSecondMonetaryAccountId()
+        {
+            return GetConfig()[FIELD_MONETARY_ACCOUNT_ID2].ToObject<int>();
+        }
+
+        public static int GetMonetarytAccountId()
+        {
+            return GetConfig()[FIELD_MONETARY_ACCOUNT_ID].ToObject<int>();
+        }
+
+        public static string GetAttachmentPathIn()
+        {
+            return GetConfig()[FIELD_ATTACHMENT_PUBLIC_TEST][FIELD_ATTACHMENT_PATH_IN].ToString();
+        }
+
+        public static string GetAttachmentDescrpition()
+        {
+            return GetConfig()[FIELD_ATTACHMENT_PUBLIC_TEST][FIELD_ATTACHMENT_DESCRIPTION].ToString();
+        }
+
+        public static string GetAttachmentContentType()
+        {
+            return GetConfig()[FIELD_ATTACHMENT_PUBLIC_TEST][FIELD_ATTACHMENT_CONTENT_TYPE].ToString();
+        }
+
+        public static string GetPermittedIp()
+        {
+            return GetConfig()[FIELD_PERMITTED_IP].ToString();
+        }
+        public static string GetApiKey()
+        {
+            return GetConfig()[FIELD_API_KEY].ToString();
+        }
+
+        public static int GetUserId()
+        {
+            return GetConfig()[FIELD_USER_ID].ToObject<int>();
+        }
+        
+        private static JObject GetConfig()
+        {
+            var fileContentString = File.ReadAllText(FIELD_CONFIG_FILE_PATH);
+
+            return JObject.Parse(fileContentString);
+        }
+        
+    }
+}

Tests/BunqSdkCsharpTest/Model/Generated/AttachmentPublicTest.cs

@@ -0,0 +1,51 @@
+using System.Collections.Generic;
+using System.IO;
+using Bunq.Sdk.Context;
+using Bunq.Sdk.Http;
+using Bunq.Sdk.Model.Generated;
+using Xunit;
+
+namespace Bunq.Sdk.Tests.Model.Generated
+{
+    /// <summary>
+    /// Tests:
+    ///     AttachmentPublic
+    ///     AttachmentPublicContent
+    /// </summary>
+    public class AttachmentPublicTest
+    {
+        /// <summary>
+        /// Config values.
+        /// </summary>
+        private const string PATH_ATTACHMENT = "../../../Resources";
+        
+        private static readonly string CONTENT_TYPE = Config.GetAttachmentContentType();
+        private static readonly string ATTACHMENT_DESCRIPTION = Config.GetAttachmentDescrpition();
+        private static readonly string ATTACHMENT_PATH_IN = Config.GetAttachmentPathIn();
+     
+        /// <summary>
+        /// API context to use for the test API calls.
+        /// </summary>
+        private static readonly ApiContext API_CONTEXT = ApiContextHandler.GetApiContext();
+
+        /// <summary>
+        /// Tests if the file we upload is the file we are getting back once successfully uploaded does.
+        /// this by comparing the content of the files.
+        /// </summary>
+        [Fact]
+        public void TestAttachmentUploadAndRetrieval()
+        {
+            var fileContentBytes = File.ReadAllBytes(PATH_ATTACHMENT + ATTACHMENT_PATH_IN);
+            var customHeaders = new Dictionary<string, string>
+            {
+                {ApiClient.HEADER_CONTENT_TYPE, CONTENT_TYPE},
+                {ApiClient.HEADER_ATTACHMENT_DESCRIPTION, ATTACHMENT_DESCRIPTION}
+            };
+            
+            var attachmentUuid = AttachmentPublic.Create(API_CONTEXT, fileContentBytes, customHeaders);
+            var responseBytes = AttachmentPublicContent.List(API_CONTEXT, attachmentUuid);
+            
+            Assert.Equal(fileContentBytes, responseBytes);
+        }
+    }
+}

Tests/BunqSdkCsharpTest/Model/Generated/AvatarTest.cs

@@ -0,0 +1,67 @@
+using System.Collections.Generic;
+using System.IO;
+using Bunq.Sdk.Context;
+using Bunq.Sdk.Http;
+using Bunq.Sdk.Model.Generated;
+using Xunit;
+
+namespace Bunq.Sdk.Tests.Model.Generated
+{
+    /// <summary>
+    /// Tests:
+    ///     Avatar
+    ///     AttachmentPublic
+    ///     AttachmentPublicContent
+    /// </summary>
+    public class AvatarTest
+    {
+        /// <summary>
+        /// Config values.
+        /// </summary>
+        private const string PATH_TO_ATTACHMENT = "../../../Resources";
+        private const int INDEX_FIRST = 0;
+        
+        private static readonly string CONTEN_TYPE = Config.GetAttachmentContentType();
+        private static readonly string ATTACHMENT_DECSRIPTION = Config.GetAttachmentDescrpition();
+        private static readonly string ATTACHMENT_PATH_IN = Config.GetAttachmentPathIn();
+
+        /// <summary>
+        /// API context to use for the test API calls.
+        /// </summary>
+        private static readonly ApiContext API_CONTEXT = ApiContextHandler.GetApiContext();
+
+        /// <summary>
+        /// Tests the creation of an avatar by uploading a picture via AttachmentPublic and setting it as avatar 
+        /// via the uuid.
+        /// </summary>
+        [Fact]
+        public void TestCreateAvatarAndRetrieval()
+        {
+            var fileContentByte = File.ReadAllBytes(PATH_TO_ATTACHMENT + ATTACHMENT_PATH_IN);
+            var attachmentUuid = UploadAvatarAndGetUuid(fileContentByte);
+
+            var avatarMap = new Dictionary<string, object>
+            {
+                {Avatar.FIELD_ATTACHMENT_PUBLIC_UUID, attachmentUuid}
+            };
+            var avatarUuid = Avatar.Create(API_CONTEXT, avatarMap);
+
+            var attachmentUuidFromAvatar = Avatar.Get(API_CONTEXT, avatarUuid).Image[INDEX_FIRST].AttachmentPublicUuid;
+            var revievedFileContentByte = AttachmentPublicContent.List(API_CONTEXT, attachmentUuidFromAvatar);
+            
+            Assert.Equal(attachmentUuid, attachmentUuidFromAvatar);
+            Assert.Equal(fileContentByte, revievedFileContentByte);
+        }
+
+        private static string UploadAvatarAndGetUuid(byte[] fileContentByte)
+        {
+            var customHeaders = new Dictionary<string, string>
+            {
+                {ApiClient.HEADER_ATTACHMENT_DESCRIPTION, ATTACHMENT_DECSRIPTION},
+                {ApiClient.HEADER_CONTENT_TYPE, CONTEN_TYPE},
+            };
+
+            return AttachmentPublic.Create(API_CONTEXT, fileContentByte, customHeaders);
+        }
+    }
+}

Tests/BunqSdkCsharpTest/Model/Generated/CardDebitTest.cs

@@ -0,0 +1,76 @@
+using System;
+using System.Collections.Generic;
+using Bunq.Sdk.Context;
+using Bunq.Sdk.Model.Generated;
+using Bunq.Sdk.Model.Generated.Object;
+using Xunit;
+
+namespace Bunq.Sdk.Tests.Model.Generated
+{
+    /// <summary>
+    /// Tests:
+    ///     CardDebit
+    ///     CardName
+    /// </summary>
+    public class CardDebitTest
+    {
+        /// <summary>
+        /// Config values.
+        /// </summary>
+        private const string PIN_CODE = "4045";
+        private const int INDEX_FIRST = 0;
+        private const int NONNEGATIVE_INTEGER_MINIMUM = 0;
+        private const int BASE_DECIMAL = 10;
+        private const int CARD_SECOND_LINE_LENGTH_MAXIMUM = 20;
+        private const int NUMBER_ONE = 1;
+        
+        private static readonly int USER_ID = Config.GetUserId();
+        
+        /// <summary>
+        /// API context used to for the test API calls.
+        /// </summary>
+        private static readonly ApiContext API_CONTEXT = ApiContextHandler.GetApiContext();
+
+        /// <summary>
+        /// Tests ordering a new card and checks if the fields we have entered are indeed correct by.
+        /// </summary>
+        [Fact]
+        public void TestOrderNewMaestroCard()
+        {
+            var cardDebitMap = new Dictionary<string, object>
+            {
+                {CardDebit.FIELD_ALIAS, GetAlias()},
+                {CardDebit.FIELD_NAME_ON_CARD, GetAnAllowedName()},
+                {CardDebit.FIELD_PIN_CODE, PIN_CODE},
+                {CardDebit.FIELD_SECOND_LINE, GenerateRandomSecondLine()}
+            };
+            var cardDebit = CardDebit.Create(API_CONTEXT, cardDebitMap, USER_ID);
+
+            var cardFromCardEndpoint = Card.Get(API_CONTEXT, USER_ID, cardDebit.Id.Value);
+
+            Assert.Equal(cardDebit.SecondLine, cardFromCardEndpoint.SecondLine);
+            Assert.Equal(cardDebit.Created, cardFromCardEndpoint.Created);
+            Assert.Equal(cardDebit.NameOnCard, cardFromCardEndpoint.NameOnCard);
+        }
+
+        private static string GetAnAllowedName()
+        {
+            return CardName.List(API_CONTEXT, USER_ID)[INDEX_FIRST].PossibleCardNameArray[INDEX_FIRST];
+        }
+        
+        private static string GenerateRandomSecondLine()
+        {
+            var random = new Random();
+
+            return random.Next(
+                NONNEGATIVE_INTEGER_MINIMUM,
+                (int) Math.Pow(BASE_DECIMAL, CARD_SECOND_LINE_LENGTH_MAXIMUM + NUMBER_ONE) - NUMBER_ONE
+            ).ToString();
+        }
+
+        private static Pointer GetAlias()
+        {
+            return User.Get(API_CONTEXT, USER_ID).UserCompany.Alias[INDEX_FIRST];
+        }
+    }
+}