chore: refactoring some code to introduce a common base class for all api classes

This commit is contained in:
Matthias Langhard
2021-05-21 22:13:04 +02:00
parent ac20e2e1d4
commit 89e7ce8449
34 changed files with 721 additions and 551 deletions

View File

@@ -0,0 +1,91 @@
using System.Linq;
using Novaloop.PaymoApi.ClientContacts;
using Novaloop.PaymoApi.ClientContacts.Models;
using Novaloop.PaymoApi.Clients;
using Novaloop.PaymoApi.Clients.Models;
using Novaloop.PaymoApi.Shared;
using Xunit;
namespace Novaloop.PaymoApi.Tests
{
public class ClientContactsApiTests
{
private readonly ClientContactsApi _clientContactsApi;
private readonly ClientsApi _clientsApi;
private readonly ClientContact _testClientContact = new ClientContact
{
Name = "Testclient",
Email = "test@client.de"
};
public ClientContactsApiTests()
{
_clientContactsApi = new ClientContactsApi(new BaseApi<GetClientContactsResponse, ClientContact>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
_clientsApi = new ClientsApi(new BaseApi<ClientsResponse, Client>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
}
[Fact]
public async void GetClientContacts()
{
// Arrange
// Act
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
// Assert
Assert.NotEmpty(clientContacts);
}
[Fact]
public async void GetClientContact()
{
// Arrange
// Act
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
var clientContact = await _clientContactsApi.GetClientContact(clientContacts.First().Id);
// Assert
Assert.NotNull(clientContact);
}
[Fact]
public async void CreateClientContact()
{
// Arrange
var existingClientContact = (await _clientsApi.GetClients()).First();
// Act
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _clientContactsApi.CreateClientContact(_testClientContact);
var clientContact = await _clientContactsApi.GetClientContact(createdClientContact.Id);
// Assert
Assert.Equal(_testClientContact.Name, clientContact.Name);
Assert.Equal(_testClientContact.Email, clientContact.Email);
// Cleanup
await _clientContactsApi.DeleteClientContact(createdClientContact.Id);
}
[Fact]
public async void DeleteClientContact()
{
// Arrange
var existingClientContact = (await _clientsApi.GetClients()).First();
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _clientContactsApi.CreateClientContact(_testClientContact);
// Act
await _clientContactsApi.DeleteClientContact(createdClientContact.Id);
var clientContacts = (await _clientContactsApi.GetClientContacts()).ToList();
// Assert
Assert.Empty(clientContacts.Where(c => c.Id == createdClientContact.Id));
}
}
}

98
tests/ClientsApiTests.cs Normal file
View File

@@ -0,0 +1,98 @@
using System.Linq;
using Novaloop.PaymoApi.Clients;
using Novaloop.PaymoApi.Clients.Models;
using Novaloop.PaymoApi.Shared;
using Xunit;
namespace Novaloop.PaymoApi.Tests
{
public class ClientsApiTests
{
private readonly ClientsApi _clientsApi;
private readonly Client _testClient = new Client
{
Name = "Testclient",
Email = "test@client.de"
};
public ClientsApiTests()
{
_clientsApi = new ClientsApi(new BaseApi<ClientsResponse, Client>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
}
[Fact]
public async void GetClients()
{
// Arrange
// Act
var clients = (await _clientsApi.GetClients()).ToList();
// Assert
Assert.NotEmpty(clients);
}
[Fact]
public async void GetClient()
{
// Arrange
// Act
var clients = (await _clientsApi.GetClients()).ToList();
var client = await _clientsApi.GetClient(clients.First().Id);
// Assert
Assert.NotNull(client);
}
[Fact]
public async void CreateClient()
{
// Arrange
// Act
var createdClient = await _clientsApi.CreateClient(_testClient);
var client = await _clientsApi.GetClient(createdClient.Id);
// Assert
Assert.Equal(_testClient.Name, client.Name);
Assert.Equal(_testClient.Email, client.Email);
// Cleanup
await _clientsApi.DeleteClient(createdClient.Id);
}
[Fact]
public async void DeleteClient()
{
// Arrange
var createdClient = await _clientsApi.CreateClient(_testClient);
// Act
await _clientsApi.DeleteClient(createdClient.Id);
var clients = (await _clientsApi.GetClients()).ToList();
// Assert
Assert.Empty(clients.Where(c => c.Id == createdClient.Id));
}
[Fact]
public async void UpdateClient()
{
// Arrange
var createdClient = await _clientsApi.CreateClient(_testClient);
var clientUpdateInfo = new Client {Name = "Updated"};
// Act
await _clientsApi.UpdateClient(clientUpdateInfo, createdClient.Id);
var updatedClient = await _clientsApi.GetClient(createdClient.Id);
// Assert
Assert.Equal(clientUpdateInfo.Name, updatedClient.Name);
}
}
}

View File

@@ -9,12 +9,12 @@ namespace Novaloop.PaymoApi.Tests
{
public static class DependencyFactory
{
public static PaymoApiClient GeneratePaymoApiClient()
public static ApiClient GeneratePaymoApiClient()
{
return new PaymoApiClient(new HttpClient {BaseAddress = new Uri("https://app.paymoapp.com/")});
return new ApiClient(new HttpClient {BaseAddress = new Uri("https://app.paymoapp.com/")});
}
public static IOptions<PaymoApiOptions> GenerateOptions()
public static IOptions<ApiOptions> GenerateOptions()
{
var paymoToken = new ConfigurationBuilder()
.SetBasePath(AppContext.BaseDirectory)
@@ -28,7 +28,7 @@ namespace Novaloop.PaymoApi.Tests
throw new ArgumentException("Please set the environment variable 'PAYMOAPIINTEGRATIONTESTS__PAYMOTESTPROJECTTOKEN' with the token of your paymo test-project. Look inside Bitwarden if you work @ Novaloop.");
}
return Options.Create(new PaymoApiOptions {ApiToken = paymoToken});
return Options.Create(new ApiOptions {ApiToken = paymoToken});
}
}
}

View File

@@ -1,89 +0,0 @@
using System.Linq;
using Novaloop.PaymoApi.ClientContacts;
using Novaloop.PaymoApi.ClientContacts.Models;
using Novaloop.PaymoApi.Clients;
using Xunit;
namespace Novaloop.PaymoApi.Tests
{
public class PaymoClientContactsApiTests
{
private readonly PaymoClientContactsApi _paymoClientContactsApi;
private readonly PaymoClientsApi _paymoClientsApi;
private readonly PaymoClientContact _testClientContact = new PaymoClientContact
{
Name = "Testclient",
Email = "test@client.de"
};
public PaymoClientContactsApiTests()
{
_paymoClientContactsApi = new PaymoClientContactsApi(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions());
_paymoClientsApi = new PaymoClientsApi(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions());
}
[Fact]
public async void GetClientContacts()
{
// Arrange
// Act
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
// Assert
Assert.NotEmpty(clientContacts);
}
[Fact]
public async void GetClientContact()
{
// Arrange
// Act
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
var clientContact = await _paymoClientContactsApi.GetClientContact(clientContacts.First().Id);
// Assert
Assert.NotNull(clientContact);
}
[Fact]
public async void CreateClientContact()
{
// Arrange
var existingClientContact = (await _paymoClientsApi.GetClients()).First();
// Act
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _paymoClientContactsApi.CreateClientContact(_testClientContact);
var clientContact = await _paymoClientContactsApi.GetClientContact(createdClientContact.Id);
// Assert
Assert.Equal(_testClientContact.Name, clientContact.Name);
Assert.Equal(_testClientContact.Email, clientContact.Email);
// Cleanup
await _paymoClientContactsApi.DeleteClientContact(createdClientContact.Id);
}
[Fact]
public async void DeleteClientContact()
{
// Arrange
var existingClientContact = (await _paymoClientsApi.GetClients()).First();
_testClientContact.ClientId = existingClientContact.Id;
var createdClientContact = await _paymoClientContactsApi.CreateClientContact(_testClientContact);
// Act
await _paymoClientContactsApi.DeleteClientContact(createdClientContact.Id);
var clientContacts = (await _paymoClientContactsApi.GetClientContacts()).ToList();
// Assert
Assert.Empty(clientContacts.Where(c => c.Id == createdClientContact.Id));
}
}
}

View File

@@ -1,81 +0,0 @@
using System.Linq;
using Novaloop.PaymoApi.Clients;
using Novaloop.PaymoApi.Clients.Models;
using Xunit;
namespace Novaloop.PaymoApi.Tests
{
public class PaymoClientsApiTests
{
private readonly PaymoClientsApi _paymoClientsApi;
private readonly PaymoClient _testClient = new PaymoClient
{
Name = "Testclient",
Email = "test@client.de"
};
public PaymoClientsApiTests()
{
_paymoClientsApi = new PaymoClientsApi(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions());
}
[Fact]
public async void GetClients()
{
// Arrange
// Act
var clients = (await _paymoClientsApi.GetClients()).ToList();
// Assert
Assert.NotEmpty(clients);
}
[Fact]
public async void GetClient()
{
// Arrange
// Act
var clients = (await _paymoClientsApi.GetClients()).ToList();
var client = await _paymoClientsApi.GetClient(clients.First().Id);
// Assert
Assert.NotNull(client);
}
[Fact]
public async void CreateClient()
{
// Arrange
// Act
var createdClient = await _paymoClientsApi.CreateClient(_testClient);
var client = await _paymoClientsApi.GetClient(createdClient.Id);
// Assert
Assert.Equal(_testClient.Name, client.Name);
Assert.Equal(_testClient.Email, client.Email);
// Cleanup
await _paymoClientsApi.DeleteClient(createdClient.Id);
}
[Fact]
public async void DeleteClient()
{
// Arrange
var createdClient = await _paymoClientsApi.CreateClient(_testClient);
// Act
await _paymoClientsApi.DeleteClient(createdClient.Id);
var clients = (await _paymoClientsApi.GetClients()).ToList();
// Assert
Assert.Empty(clients.Where(c => c.Id == createdClient.Id));
}
}
}

View File

@@ -1,89 +0,0 @@
using System.Linq;
using Novaloop.PaymoApi.Tasks;
using Novaloop.PaymoApi.Tasks.Models;
using Xunit;
using Xunit.Abstractions;
namespace Novaloop.PaymoApi.Tests
{
public class PaymoTasksApiTests
{
private readonly ITestOutputHelper _testOutputHelper;
private readonly PaymoTasksApi _paymoTasksApi;
private readonly PaymoTask _testTask;
public PaymoTasksApiTests(ITestOutputHelper testOutputHelper)
{
_testOutputHelper = testOutputHelper;
_paymoTasksApi = new PaymoTasksApi(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions());
_testTask = new PaymoTask
{
Name = "Testtask",
Description = "Just a little task"
};
}
[Fact]
public async void GetTasks()
{
// Arrange
// Act
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
// Assert
Assert.NotEmpty(tasks);
_testOutputHelper.WriteLine(string.Join(",", tasks));
}
[Fact]
public async void GetTask()
{
// Arrange
// Act
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
var task = await _paymoTasksApi.GetTask(tasks.First().Id);
// Assert
Assert.NotNull(task);
}
[Fact]
public async void CreateTask()
{
// Arrange
var existingTaskListId = (await _paymoTasksApi.GetTasks()).First().TasklistId;
// Act
_testTask.TasklistId = existingTaskListId;
var createdTask = await _paymoTasksApi.CreateTask(_testTask);
var task = await _paymoTasksApi.GetTask(createdTask.Id);
// Assert
Assert.Equal(_testTask.Name, task.Name);
Assert.Equal(_testTask.Description, task.Description);
// Cleanup
await _paymoTasksApi.DeleteTask(createdTask.Id);
}
[Fact]
public async void DeleteTask()
{
// Arrange
var existingTaskListId = (await _paymoTasksApi.GetTasks()).First().TasklistId;
_testTask.TasklistId = existingTaskListId;
var createdTask = await _paymoTasksApi.CreateTask(_testTask);
// Act
await _paymoTasksApi.DeleteTask(createdTask.Id);
var tasks = (await _paymoTasksApi.GetTasks()).ToList();
// Assert
Assert.Empty(tasks.Where(c => c.Id == createdTask.Id));
}
}
}

109
tests/TasksApiTests.cs Normal file
View File

@@ -0,0 +1,109 @@
using System.Linq;
using Novaloop.PaymoApi.Shared;
using Novaloop.PaymoApi.Tasks;
using Novaloop.PaymoApi.Tasks.Models;
using Xunit;
using Xunit.Abstractions;
namespace Novaloop.PaymoApi.Tests
{
public class TasksApiTests
{
private readonly ITestOutputHelper _testOutputHelper;
private readonly TasksApi _tasksApi;
private readonly Task _testTask;
public TasksApiTests(ITestOutputHelper testOutputHelper)
{
_testOutputHelper = testOutputHelper;
_tasksApi = new TasksApi(new BaseApi<TasksResponse, Task>(DependencyFactory.GeneratePaymoApiClient(), DependencyFactory.GenerateOptions()));
_testTask = new Task
{
Name = "Testtask",
Description = "Just a little task"
};
}
[Fact]
public async void GetTasks()
{
// Arrange
// Act
var tasks = (await _tasksApi.GetTasks()).ToList();
// Assert
Assert.NotEmpty(tasks);
_testOutputHelper.WriteLine(string.Join(",", tasks));
}
[Fact]
public async void GetTask()
{
// Arrange
// Act
var tasks = (await _tasksApi.GetTasks()).ToList();
var task = await _tasksApi.GetTask(tasks.First().Id);
// Assert
Assert.NotNull(task);
}
[Fact]
public async void CreateTask()
{
// Arrange
var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
// Act
_testTask.TasklistId = existingTaskListId;
var createdTask = await _tasksApi.CreateTask(_testTask);
var task = await _tasksApi.GetTask(createdTask.Id);
// Assert
Assert.Equal(_testTask.Name, task.Name);
Assert.Equal(_testTask.Description, task.Description);
// Cleanup
await _tasksApi.DeleteTask(createdTask.Id);
}
[Fact]
public async void DeleteTask()
{
// Arrange
var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
_testTask.TasklistId = existingTaskListId;
var createdTask = await _tasksApi.CreateTask(_testTask);
// Act
await _tasksApi.DeleteTask(createdTask.Id);
var tasks = (await _tasksApi.GetTasks()).ToList();
// Assert
Assert.Empty(tasks.Where(c => c.Id == createdTask.Id));
}
[Fact]
public async void UpdateTask()
{
// Arrange
var existingTaskListId = (await _tasksApi.GetTasks()).First().TasklistId;
_testTask.TasklistId = existingTaskListId;
var createdTask = await _tasksApi.CreateTask(_testTask);
var taskUpdateInfo = new Task {Name = "Updated", TasklistId = _testTask.TasklistId};
// Act
await _tasksApi.UpdateTask(taskUpdateInfo, createdTask.Id);
var updatedTask = await _tasksApi.GetTask(createdTask.Id);
// Assert
Assert.Equal(taskUpdateInfo.Name, updatedTask.Name);
}
}
}