Merge pull request #108 from notion-dotnet/test/add-unit-or-integration-tests-for-users-client

Add tests for Users client ✅

Author: KoditkarVedant

Test/Notion.UnitTests/Notion.UnitTests.csproj

@@ -66,6 +66,12 @@
     <None Update="data\databases\DatabasesQueryResponse.json">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </None>
+    <None Update="data\users\ListUsersResponse.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
+    <None Update="data\users\RetrieveUserResponse.json">
+      <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+    </None>
   </ItemGroup>
 
 </Project>

Test/Notion.UnitTests/UserClientTest.cs

@@ -1,36 +1,82 @@
-using System.Threading.Tasks;
+using System.IO;
+using System.Threading.Tasks;
+using FluentAssertions;
 using Notion.Client;
+using WireMock.ResponseBuilders;
 using Xunit;
 
 namespace Notion.UnitTests
 {
-    public class UserClientTest
+    public class UserClientTest : ApiTestBase
     {
         private readonly IUsersClient _client;
 
         public UserClientTest()
         {
-            var options = new ClientOptions
-            {
-                AuthToken = "<Token>"
-            };
-
-            _client = new UsersClient(new RestClient(options));
+            _client = new UsersClient(new RestClient(ClientOptions));
         }
 
-        [Fact(Skip = "Internal testing purpose")]
+        [Fact]
         public async Task ListUsers()
         {
-            var usersList = await _client.ListAsync();
-            Assert.NotNull(usersList);
+            // Arrange
+            var jsonData = await File.ReadAllTextAsync("data/users/ListUsersResponse.json");
+            var path = ApiEndpoints.UsersApiUrls.List();
+
+            Server.Given(CreateGetRequestBuilder(path))
+                .RespondWith(
+                Response.Create()
+                    .WithStatusCode(200)
+                    .WithBody(jsonData)
+            );
+
+            // Act
+            var users = await _client.ListAsync();
+
+            // Assert
+            users.Results.Should().SatisfyRespectively(
+                user =>
+                {
+                    user.Id.Should().Be("5e37c1b4-630f-4e81-bd6b-296af31e345f");
+                    user.Name.Should().Be("Vedant Koditkar");
+                    user.Type.Should().Be("person");
+                    user.Person.Email.Should().Be("vedkoditkar@gmail.com");
+                    user.Bot.Should().BeNull();
+                },
+                user =>
+                {
+                    user.Id.Should().Be("590693f3-797f-4970-98ff-7284106393e5");
+                    user.Name.Should().Be("Test");
+                    user.Type.Should().Be("bot");
+                    user.Person.Should().BeNull();
+                }
+            );
         }
 
-        [Fact(Skip = "Internal testing purpose")]
+        [Fact]
         public async Task RetrieveUser()
         {
-            string userId = "5e37c1b4-630f-4e81-bd6b-296af31e345f";
+            // Arrange
+            var jsonData = await File.ReadAllTextAsync("data/users/RetrieveUserResponse.json");
+            var userId = "5e37c1b4-630f-4e81-bd6b-296af31e345f";
+            var path = ApiEndpoints.UsersApiUrls.Retrieve(userId);
+
+            Server.Given(CreateGetRequestBuilder(path))
+                .RespondWith(
+                Response.Create()
+                    .WithStatusCode(200)
+                    .WithBody(jsonData)
+            );
+
+            // Act
             var user = await _client.RetrieveAsync(userId);
-            Assert.NotNull(user);
+
+            // Assert
+            user.Id.Should().Be("5e37c1b4-630f-4e81-bd6b-296af31e345f");
+            user.Name.Should().Be("Vedant Koditkar");
+            user.Type.Should().Be("person");
+            user.Person.Email.Should().Be("vedkoditkar@gmail.com");
+            user.Bot.Should().BeNull();
         }
     }
 }

Test/Notion.UnitTests/data/users/ListUsersResponse.json

@@ -0,0 +1,25 @@
+{
+  "object": "list",
+  "results": [
+    {
+      "object": "user",
+      "id": "5e37c1b4-630f-4e81-bd6b-296af31e345f",
+      "name": "Vedant Koditkar",
+      "avatar_url": "https://lh3.googleusercontent.com/a-/AOh14Gg4lnfwJviST_tKZZpMfKrgmjp8wRzPBg9ec6sG7w=s100",
+      "type": "person",
+      "person": {
+        "email": "vedkoditkar@gmail.com"
+      }
+    },
+    {
+      "object": "user",
+      "id": "590693f3-797f-4970-98ff-7284106393e5",
+      "name": "Test",
+      "avatar_url": null,
+      "type": "bot",
+      "bot": {}
+    }
+  ],
+  "next_cursor": null,
+  "has_more": false
+}

Test/Notion.UnitTests/data/users/RetrieveUserResponse.json

@@ -0,0 +1,10 @@
+{
+  "object": "user",
+  "id": "5e37c1b4-630f-4e81-bd6b-296af31e345f",
+  "name": "Vedant Koditkar",
+  "avatar_url": "https://lh3.googleusercontent.com/a-/AOh14Gg4lnfwJviST_tKZZpMfKrgmjp8wRzPBg9ec6sG7w=s100",
+  "type": "person",
+  "person": {
+    "email": "vedkoditkar@gmail.com"
+  }
+}