Add first Unit and Integration Tests (#2)

Author: hf-kklein

README.md

@@ -29,3 +29,11 @@ Then, you can use the client like this:
 ```csharp
 
 ```
+
+## Development
+
+To run the integration test login to your docker to access the transformer.bee image.
+```bash
+docker login ghcr.io -u YOUR_GITHUB_USERNAME
+```
+then paste your PAT similarly to described in the [integration test CI pipeline](.github/workflows/integrationtests.yml)

TransformerBeeClient/TransformerBeeClient.IntegrationTest/ClientFixture.cs

@@ -0,0 +1,26 @@
+using Microsoft.Extensions.DependencyInjection;
+using Xunit;
+
+namespace TransformerBeeClient.IntegrationTest;
+
+/// <summary>
+/// A fixture that sets up the http client factory and an injectable service collection
+/// </summary>
+public class ClientFixture : IClassFixture<ClientFixture>
+{
+    public readonly IHttpClientFactory HttpClientFactory;
+
+    public readonly ServiceCollection ServiceCollection;
+
+    public ClientFixture()
+    {
+        var services = new ServiceCollection();
+        services.AddHttpClient("TransformerBee", client =>
+        {
+            client.BaseAddress = new Uri("http://localhost:5021"); // Check docker-compose.yml
+        });
+        var serviceProvider = services.BuildServiceProvider();
+        ServiceCollection = services;
+        HttpClientFactory = serviceProvider.GetService<IHttpClientFactory>();
+    }
+}

TransformerBeeClient/TransformerBeeClient.IntegrationTest/ConnectionTests.cs

@@ -0,0 +1,42 @@
+using FluentAssertions;
+using Microsoft.Extensions.DependencyInjection;
+using Xunit;
+
+namespace TransformerBeeClient.IntegrationTest;
+
+/// <summary>
+/// Tests that a connection to the API can be established
+/// </summary>
+public class ConnectionTests : IClassFixture<ClientFixture>
+{
+
+    private readonly ClientFixture _client;
+
+    public ConnectionTests(ClientFixture clientFixture)
+    {
+        _client = clientFixture;
+    }
+
+    [Fact]
+    public async Task IsAvailable_Returns_True_If_Service_Is_Available()
+    {
+        var httpClientFactory = _client.HttpClientFactory;
+        var client = new TransformerBeeRestClient(httpClientFactory);
+        var result = await client.IsAvailable();
+        result.Should().BeTrue();
+    }
+
+    [Fact]
+    public async Task IsAvailable_Throws_Exception_If_Host_Is_Unavailable()
+    {
+        var services = new ServiceCollection();
+        services.AddHttpClient("TransformerBee", client =>
+        {
+            client.BaseAddress = new Uri("http://localhost:1234"); // <-- no service running under this address
+        });
+        var serviceProvider = services.BuildServiceProvider();
+        var client = new TransformerBeeRestClient(serviceProvider.GetService<IHttpClientFactory>());
+        var checkIfIsAvailable = async () => await client.IsAvailable();
+        await checkIfIsAvailable.Should().ThrowAsync<HttpRequestException>();
+    }
+}

TransformerBeeClient/TransformerBeeClient.UnitTest/ConnectionTests.cs

@@ -0,0 +1,21 @@
+using FluentAssertions;
+using Microsoft.Extensions.DependencyInjection;
+using Xunit;
+
+namespace TransformerBeeClient.UnitTest;
+
+public class ConnectionTests
+{
+    [Fact]
+    public void IsAvailable_Throws_ArgumentNullException_If_BaseAddress_Is_Not_Configured()
+    {
+        var services = new ServiceCollection();
+        services.AddHttpClient("TransformerBee", client =>
+        {
+            client.BaseAddress = null;
+        });
+        var serviceProvider = services.BuildServiceProvider();
+        var instantiateClient = () => new TransformerBeeRestClient(serviceProvider.GetService<IHttpClientFactory>());
+        instantiateClient.Should().Throw<ArgumentNullException>();
+    }
+}

TransformerBeeClient/TransformerBeeClient.UnitTest/UnitTest1.cs

@@ -0,0 +1,6 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/Environment/UnitTesting/UnitTestSessionStore/Sessions/=de4efd69_002D9f4a_002D4e00_002D83fa_002Ddaa381865bd8/@EntryIndexedValue">&lt;SessionState ContinuousTestingMode="0" IsActive="True" Name="ConnectionTest" xmlns="urn:schemas-jetbrains-com:jetbrains-ut-session"&gt;&#xD;
+  &lt;TestAncestor&gt;&#xD;
+    &lt;TestId&gt;xUnit::80EF1570-CB4E-4E56-A8BC-56C787A48543::net8.0::TransformerBeeClient.UnitTest.ConnectionTests&lt;/TestId&gt;&#xD;
+  &lt;/TestAncestor&gt;&#xD;
+&lt;/SessionState&gt;</s:String></wpf:ResourceDictionary>

TransformerBeeClient/TransformerBeeClient.sln.DotSettings.user

@@ -0,0 +1,46 @@
+namespace TransformerBeeClient;
+
+/// <summary>
+/// a client for the transformer.bee REST API
+/// </summary>
+public class TransformerBeeRestClient
+{
+    private readonly HttpClient _httpClient;
+
+    /// <summary>
+    /// Provide the constructor with a http client factory.
+    /// It will create a client from said factory and use the <paramref name="clientName"/> for that.
+    /// </summary>
+    /// <param name="httpClientFactory">factory to create the http client from</param>
+    /// <param name="clientName">name used to create the client</param>
+    public TransformerBeeRestClient(IHttpClientFactory httpClientFactory, string clientName = "TransformerBee")
+    {
+        _httpClient = httpClientFactory.CreateClient(clientName);
+        if (_httpClient.BaseAddress == null)
+        {
+            throw new ArgumentNullException(nameof(httpClientFactory), $"The http client factory must provide a base address for the client with name '{clientName}'");
+        }
+    }
+
+    /// <summary>
+    /// tests if transformer bee is available
+    /// </summary>
+    /// <remarks>
+    /// Note that this does _not_ check if you're authenticated.
+    /// The method will probably throw an <see cref="HttpRequestException"/> if the host cannot be found.
+    /// </remarks>
+    /// <returns>
+    /// Returns true iff the transformer bee is available under the configured base address.
+    /// </returns>
+    public async Task<bool> IsAvailable()
+    {
+        var uriBuilder = new UriBuilder(_httpClient!.BaseAddress)
+        {
+            Path = "/version"
+        };
+
+        var versionUrl = uriBuilder.Uri.AbsoluteUri;
+        var response = await _httpClient.GetAsync(versionUrl);
+        return response.IsSuccessStatusCode;
+    }
+}

TransformerBeeClient/TransformerBeeClient/RestClient.cs

@@ -6,4 +6,12 @@
         <TargetFrameworks>net8.0;net6.0;net7.0</TargetFrameworks>
     </PropertyGroup>
 
+    <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
+      <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.Http" Version="8.0.0" />
+    </ItemGroup>
+
 </Project>