Initialize unit tests project (#11)

# Description

Initialize unit tests on this repo, with a bit of tooling, code coverage calculation and reporting.

Necessary refactor: API controller now receive a Kuzzle API interface (`IKuzzleApi`) instead of a Kuzzle instance, because mocking can only be done with interfaces or abstract classes.

:warning: this project cannot be built nor tested using monodevelop due to current compatibility problems between dotnet-core and msbuild. Read the README documentation to build this SDK from the CLI.
See NuGet/Home#7956

Author: scottinet

.gitignore

@@ -5,3 +5,6 @@ packages/
 */bin/
 */obj/
 *.csproj.nuget.cache
+mono_crash.*
+lcov.info
+codecov

.travis.yml

@@ -8,7 +8,11 @@ install:
   - dotnet restore
 
 script:
+  # incompatibilities with msbuild, so building with .net core instead
   - dotnet build $TRAVIS_BUILD_DIR/Kuzzle/Kuzzle.csproj -c Release
+  - dotnet build $TRAVIS_BUILD_DIR/Kuzzle.Tests/Kuzzle.Tests.csproj
+  - dotnet test /p:CollectCoverage=true /p:CoverletOutputFormat=lcov /p:CoverletOutput=$TRAVIS_BUILD_DIR/lcov.info
+  - curl -s https://codecov.io/bash > codecov && bash codecov
 
 deploy:
   skip_cleanup: true

Kuzzle.Tests/API/Controllers/AuthControllerTest.cs

@@ -0,0 +1,60 @@
+using Xunit;
+using KuzzleSdk.API.Controllers;
+using Newtonsoft.Json.Linq;
+using KuzzleSdk.Exceptions;
+
+namespace Kuzzle.Tests.API.Controllers {
+  public class AuthControllerTest {
+    private readonly AuthController _authController;
+    private readonly KuzzleApiMock _api;
+
+    public AuthControllerTest() {
+      _api = new KuzzleApiMock();
+      _authController = new AuthController(_api.MockedObject);
+    }
+
+    [Fact]
+    public async void CheckTokenAsyncTestSuccess() {
+      string token = "foobar";
+
+      _api.SetResult(@"{result: {foo: 123}}");
+      _api.Mock.SetupProperty(a => a.Jwt, "foo");
+
+      JObject result = await _authController.CheckTokenAsync(token);
+
+      _api.Verify(new JObject {
+        { "controller", "auth" },
+        { "action", "checkToken" },
+        { "body", new JObject{ { "token", token } } }
+      });
+
+      Assert.Equal<JObject>(
+        new JObject { { "foo", 123 } },
+        result,
+        new JTokenEqualityComparer());
+
+      _api.Mock.VerifySet(a => a.Jwt = null);
+      _api.Mock.VerifySet(a => a.Jwt = "foo");
+    }
+
+    [Fact]
+    public async void CheckTokenAsyncTestFailure() {
+      string token = "foobar";
+
+      _api.SetError();
+      _api.Mock.SetupProperty(a => a.Jwt, "foo");
+
+      await Assert.ThrowsAsync<ApiErrorException>(
+        () => _authController.CheckTokenAsync(token));
+
+      _api.Verify(new JObject {
+        { "controller", "auth" },
+        { "action", "checkToken" },
+        { "body", new JObject{ { "token", token } } }
+      });
+
+      _api.Mock.VerifySet(a => a.Jwt = null);
+      _api.Mock.VerifySet(a => a.Jwt = "foo");
+    }
+  }
+}

Kuzzle.Tests/API/KuzzleApiMock.cs

@@ -0,0 +1,47 @@
+using System;
+using System.Threading.Tasks;
+using KuzzleSdk;
+using KuzzleSdk.API;
+using KuzzleSdk.Exceptions;
+using Moq;
+using Newtonsoft.Json.Linq;
+
+namespace Kuzzle.Tests.API {
+  public class KuzzleApiMock {
+    public Mock<IKuzzleApi> Mock { get; }
+
+    public IKuzzleApi MockedObject {
+      get { return Mock.Object; }
+    }
+
+    private ApiErrorException GetApiErrorException(int status, string message) {
+      var r = Response.FromString($"{{error: {{message: \"{message}\", status: {status} }} }}");
+      return new ApiErrorException(r);
+    }
+
+    public KuzzleApiMock() {
+      Mock = new Mock<IKuzzleApi>();
+    }
+
+    public void SetResult(string apiResult) {
+      Mock
+        .Setup(api => api.QueryAsync(It.IsAny<JObject>()))
+        .Returns(Task.FromResult(Response.FromString(apiResult)));
+    }
+
+    public void SetError(int status = 400, string message = "Errored Test") {
+      var t = new TaskCompletionSource<Response>();
+      t.SetException(GetApiErrorException(status, message));
+
+      Mock
+        .Setup(api => api.QueryAsync(It.IsAny<JObject>()))
+        .Returns(t.Task);
+    }
+
+    public void Verify(JObject expectedQuery) {
+      Mock.Verify(
+        api => api.QueryAsync(
+          It.Is<JObject>(o => JToken.DeepEquals(o, expectedQuery))));
+    }
+  }
+}

Kuzzle.Tests/Kuzzle.Tests.csproj

@@ -0,0 +1,31 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <!--
+      Do not upgrade to netcoreapp2.2 or upper
+      until msbuild+mono+monodevelop are compatible with it.
+      See https://github.com/NuGet/Home/issues/7956
+    -->
+    <TargetFramework>netcoreapp2.1</TargetFramework>
+
+    <IsPackable>false</IsPackable>
+    <ReleaseVersion>0.1.0</ReleaseVersion>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.0.1" />
+    <PackageReference Include="xunit" Version="2.4.0" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.0" />
+    <PackageReference Include="Moq" Version="4.11.0" />
+    <PackageReference Include="coverlet.msbuild" Version="2.6.2" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Kuzzle\Kuzzle.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="API\" />
+    <Folder Include="API\Controllers\" />
+  </ItemGroup>
+</Project>

Kuzzle/API/Controllers/AuthController.cs

@@ -1,24 +1,27 @@
 using System;
 using System.Threading.Tasks;
+using System.Runtime.CompilerServices;
 using Newtonsoft.Json.Linq;
 
+[assembly: InternalsVisibleTo("Kuzzle.Tests")]
+
 namespace KuzzleSdk.API.Controllers {
   /// <summary>
   /// Implements the "auth" Kuzzle API controller
   /// </summary>
   public sealed class AuthController : BaseController {
-    internal AuthController(Kuzzle k) : base(k) { }
+    internal AuthController(IKuzzleApi api) : base(api) { }
 
     /// <summary>
     /// Checks the validity of an authentication token.
     /// </summary>
     public async Task<JObject> CheckTokenAsync(string token) {
-      string jwt = kuzzle.Jwt;
-      kuzzle.Jwt = null;
+      string jwt = api.Jwt;
+      api.Jwt = null;
       Response response;
 
       try {
-        response = await kuzzle.QueryAsync(new JObject {
+        response = await api.QueryAsync(new JObject {
           { "controller", "auth" },
           { "action", "checkToken" },
           {
@@ -29,7 +32,7 @@ public async Task<JObject> CheckTokenAsync(string token) {
           }
         });
       } finally {
-        kuzzle.Jwt = jwt;
+        api.Jwt = jwt;
       }
 
       return (JObject)response.Result;
@@ -41,7 +44,7 @@ public async Task<JObject> CheckTokenAsync(string token) {
     public async Task<JObject> CreateMyCredentialsAsync(
         string strategy,
         JObject credentials) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "checkToken" },
         { "body", credentials },
@@ -56,7 +59,7 @@ public async Task<JObject> CreateMyCredentialsAsync(
     /// specified authentication strategy.
     /// </summary>
     public async Task<bool> CredentialsExistAsync(string strategy) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "credentialsExist" },
         { "strategy", strategy }
@@ -74,7 +77,7 @@ public async Task<bool> CredentialsExistAsync(string strategy) {
     /// the deleted credentials.
     /// </summary>
     public async Task DeleteMyCredentialsAsync(string strategy) {
-      await kuzzle.QueryAsync(new JObject {
+      await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "deleteMyCredentials" },
         { "strategy", strategy }
@@ -85,7 +88,7 @@ await kuzzle.QueryAsync(new JObject {
     /// Returns information about the currently logged in user.
     /// </summary>
     public async Task<JObject> GetCurrentUserAsync() {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "getCurrentUser" }
       });
@@ -99,7 +102,7 @@ public async Task<JObject> GetCurrentUserAsync() {
     /// should never include any sensitive information.
     /// </summary>
     public async Task<JObject> GetMyCredentialsAsync(string strategy) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "getMyCredentials" },
         { "strategy", strategy }
@@ -113,7 +116,7 @@ public async Task<JObject> GetMyCredentialsAsync(string strategy) {
     /// current user.
     /// </summary>
     public async Task<JArray> GetMyRightsAsync() {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "getMyRights" }
       });
@@ -125,7 +128,7 @@ public async Task<JArray> GetMyRightsAsync() {
     /// Gets the exhaustive list of registered authentication strategies.
     /// </summary>
     public async Task<JArray> GetStrategiesAsync() {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "getStrategies" }
       });
@@ -138,24 +141,24 @@ public async Task<JArray> GetStrategiesAsync() {
     /// </summary>
     public async Task<JObject> LoginAsync(
         string strategy, JObject credentials, string expiresIn = null) {
-      string jwt = kuzzle.Jwt;
-      kuzzle.Jwt = null;
+      string jwt = api.Jwt;
+      api.Jwt = null;
       Response response;
 
       try {
-        response = await kuzzle.QueryAsync(new JObject {
+        response = await api.QueryAsync(new JObject {
           { "controller", "auth" },
           { "action", "login" },
           { "strategy", strategy },
           { "body", credentials },
           { "expiresIn", expiresIn }
         });
       } catch (Exception) {
-        kuzzle.Jwt = jwt;
+        api.Jwt = jwt;
         throw;
       }
 
-      kuzzle.Jwt = (string)response.Result["jwt"];
+      api.Jwt = (string)response.Result["jwt"];
 
       return (JObject)response.Result;
     }
@@ -165,7 +168,7 @@ public async Task<JObject> LoginAsync(
     /// If there were any, real-time subscriptions are cancelled.
     /// </summary>
     public async Task LogoutAsync() {
-      await kuzzle.QueryAsync(new JObject {
+      await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "logout" }
       });
@@ -175,13 +178,13 @@ await kuzzle.QueryAsync(new JObject {
     /// Refreshes an authentication token.
     /// </summary>
     public async Task<JObject> RefreshTokenAsync(string expiresIn = null) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "login" },
         { "expiresIn", expiresIn }
       });
 
-      kuzzle.Jwt = (string)response.Result["jwt"];
+      api.Jwt = (string)response.Result["jwt"];
 
       return (JObject)response.Result;
     }
@@ -192,7 +195,7 @@ public async Task<JObject> RefreshTokenAsync(string expiresIn = null) {
     public async Task<JObject> UpdateMyCredentialsAsync(
         string strategy,
         JObject credentials) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "updateMyCredentials" },
         { "strategy", strategy },
@@ -207,7 +210,7 @@ public async Task<JObject> UpdateMyCredentialsAsync(
     /// associated profiles cannot be updated)
     /// </summary>
     public async Task<JObject> UpdateSelfAsync(JObject content) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "updateSelf" },
         { "body", content }
@@ -224,7 +227,7 @@ public async Task<JObject> UpdateSelfAsync(JObject content) {
     public async Task<bool> ValidateMyCredentialsAsync(
         string strategy,
         JObject credentials) {
-      Response response = await kuzzle.QueryAsync(new JObject {
+      Response response = await api.QueryAsync(new JObject {
         { "controller", "auth" },
         { "action", "validateMyCredentials" },
         { "body", credentials },

Kuzzle/API/Controllers/BaseController.cs

@@ -6,10 +6,10 @@ public class BaseController {
     /// <summary>
     /// Kuzzle instance.
     /// </summary>
-    protected readonly Kuzzle kuzzle;
+    protected readonly IKuzzleApi api;
 
-    internal BaseController(Kuzzle k) {
-      kuzzle = k;
+    internal BaseController(IKuzzleApi k) {
+      api = k;
     }
   }
 }