Merge pull request #2945 from mark-monteiro/integration-tests

Add Integration Tests For BrandingService

tests/MediaBrowser.Api.Tests/BrandingServiceTests.cs

@@ -0,0 +1,49 @@
+using System.Text.Json;
+using System.Threading.Tasks;
+using MediaBrowser.Model.Branding;
+using Xunit;
+
+namespace MediaBrowser.Api.Tests
+{
+    public sealed class BrandingServiceTests : IClassFixture<JellyfinApplicationFactory>
+    {
+        private readonly JellyfinApplicationFactory _factory;
+
+        public BrandingServiceTests(JellyfinApplicationFactory factory)
+        {
+            _factory = factory;
+        }
+
+        [Fact]
+        public async Task GetConfiguration_ReturnsCorrectResponse()
+        {
+            // Arrange
+            var client = _factory.CreateClient();
+
+            // Act
+            var response = await client.GetAsync("/Branding/Configuration");
+
+            // Assert
+            response.EnsureSuccessStatusCode();
+            Assert.Equal("application/json; charset=utf-8", response.Content.Headers.ContentType.ToString());
+            var responseBody = await response.Content.ReadAsStreamAsync();
+            _ = await JsonSerializer.DeserializeAsync<BrandingOptions>(responseBody);
+        }
+
+        [Theory]
+        [InlineData("/Branding/Css")]
+        [InlineData("/Branding/Css.css")]
+        public async Task GetCss_ReturnsCorrectResponse(string url)
+        {
+            // Arrange
+            var client = _factory.CreateClient();
+
+            // Act
+            var response = await client.GetAsync(url);
+
+            // Assert
+            response.EnsureSuccessStatusCode();
+            Assert.Equal("text/css", response.Content.Headers.ContentType.ToString());
+        }
+    }
+}

tests/MediaBrowser.Api.Tests/JellyfinApplicationFactory.cs

@@ -0,0 +1,120 @@
+using System;
+using System.Collections.Concurrent;
+using System.IO;
+using Emby.Server.Implementations;
+using Emby.Server.Implementations.IO;
+using Emby.Server.Implementations.Networking;
+using Jellyfin.Drawing.Skia;
+using Jellyfin.Server;
+using MediaBrowser.Common;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc.Testing;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Serilog;
+using Serilog.Extensions.Logging;
+
+namespace MediaBrowser.Api.Tests
+{
+    /// <summary>
+    /// Factory for bootstrapping the Jellyfin application in memory for functional end to end tests.
+    /// </summary>
+    public class JellyfinApplicationFactory : WebApplicationFactory<Startup>
+    {
+        private static readonly string _testPathRoot = Path.Combine(Path.GetTempPath(), "jellyfin-test-data");
+        private static readonly ConcurrentBag<IDisposable> _disposableComponents = new ConcurrentBag<IDisposable>();
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="JellyfinApplicationFactory"/> class.
+        /// </summary>
+        public JellyfinApplicationFactory()
+        {
+            // Perform static initialization that only needs to happen once per test-run
+            Log.Logger = new LoggerConfiguration().WriteTo.Console().CreateLogger();
+            Program.PerformStaticInitialization();
+        }
+
+        /// <inheritdoc/>
+        protected override IWebHostBuilder CreateWebHostBuilder()
+        {
+            return new WebHostBuilder();
+        }
+
+        /// <inheritdoc/>
+        protected override void ConfigureWebHost(IWebHostBuilder builder)
+        {
+            // Specify the startup command line options
+            var commandLineOpts = new StartupOptions
+            {
+                NoWebClient = true,
+                NoAutoRunWebApp = true
+            };
+
+            // Use a temporary directory for the application paths
+            var webHostPathRoot = Path.Combine(_testPathRoot, "test-host-" + Path.GetFileNameWithoutExtension(Path.GetRandomFileName()));
+            Directory.CreateDirectory(Path.Combine(webHostPathRoot, "logs"));
+            Directory.CreateDirectory(Path.Combine(webHostPathRoot, "config"));
+            Directory.CreateDirectory(Path.Combine(webHostPathRoot, "cache"));
+            Directory.CreateDirectory(Path.Combine(webHostPathRoot, "jellyfin-web"));
+            var appPaths = new ServerApplicationPaths(
+                webHostPathRoot,
+                Path.Combine(webHostPathRoot, "logs"),
+                Path.Combine(webHostPathRoot, "config"),
+                Path.Combine(webHostPathRoot, "cache"),
+                Path.Combine(webHostPathRoot, "jellyfin-web"));
+
+            // Create the logging config file
+            // TODO: We shouldn't need to do this since we are only logging to console
+            Program.InitLoggingConfigFile(appPaths).GetAwaiter().GetResult();
+
+            // Create a copy of the application configuration to use for startup
+            var startupConfig = Program.CreateAppConfiguration(commandLineOpts, appPaths);
+
+            ILoggerFactory loggerFactory = new SerilogLoggerFactory();
+            _disposableComponents.Add(loggerFactory);
+
+            // Create the app host and initialize it
+            var appHost = new CoreAppHost(
+                appPaths,
+                loggerFactory,
+                commandLineOpts,
+                new ManagedFileSystem(loggerFactory.CreateLogger<ManagedFileSystem>(), appPaths),
+                new NetworkManager(loggerFactory.CreateLogger<NetworkManager>()));
+            _disposableComponents.Add(appHost);
+            var serviceCollection = new ServiceCollection();
+            appHost.Init(serviceCollection);
+
+            // Configure the web host builder
+            Program.ConfigureWebHostBuilder(builder, appHost, serviceCollection, commandLineOpts, startupConfig, appPaths);
+        }
+
+        /// <inheritdoc/>
+        protected override TestServer CreateServer(IWebHostBuilder builder)
+        {
+            // Create the test server using the base implementation
+            var testServer = base.CreateServer(builder);
+
+            // Finish initializing the app host
+            var appHost = (CoreAppHost)testServer.Services.GetRequiredService<IApplicationHost>();
+            appHost.ServiceProvider = testServer.Services;
+            appHost.InitializeServices().GetAwaiter().GetResult();
+            appHost.RunStartupTasksAsync().GetAwaiter().GetResult();
+
+            return testServer;
+        }
+
+        /// <inheritdoc/>
+        protected override void Dispose(bool disposing)
+        {
+            foreach (var disposable in _disposableComponents)
+            {
+                disposable.Dispose();
+            }
+
+            _disposableComponents.Clear();
+
+            base.Dispose(disposing);
+        }
+    }
+}

tests/MediaBrowser.Api.Tests/MediaBrowser.Api.Tests.csproj

@@ -0,0 +1,33 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+    <IsPackable>false</IsPackable>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" Version="3.1.3" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="16.5.0" />
+    <PackageReference Include="xunit" Version="2.4.1" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.1" />
+    <PackageReference Include="coverlet.collector" Version="1.2.1" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\Jellyfin.Server\Jellyfin.Server.csproj" />
+    <ProjectReference Include="..\..\MediaBrowser.Api\MediaBrowser.Api.csproj" />
+  </ItemGroup>
+
+  <!-- Code Analyzers-->
+  <ItemGroup Condition=" '$(Configuration)' == 'Debug' ">
+    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="2.9.8" PrivateAssets="All" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118" PrivateAssets="All" />
+  </ItemGroup>
+
+  <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
+    <CodeAnalysisRuleSet>../jellyfin-tests.ruleset</CodeAnalysisRuleSet>
+  </PropertyGroup>
+
+</Project>

tests/jellyfin-tests.ruleset

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="Rules for MediaBrowser.Api.Tests" Description="Code analysis rules for MediaBrowser.Api.Tests.csproj" ToolsVersion="14.0">
+
+  <!-- Include the solution default RuleSet. The rules in this file will override the defaults. -->
+  <Include Path="../jellyfin.ruleset" Action="Default" />
+
+  <!-- StyleCop Analyzer Rules -->
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+    <!-- SA0001: XML comment analysis is disabled due to project configuration -->
+    <Rule Id="SA0001" Action="None" />
+  </Rules>
+
+  <!-- FxCop Analyzer Rules -->
+  <Rules AnalyzerId="Microsoft.CodeAnalysis.FxCopAnalyzers" RuleNamespace="Microsoft.Design">
+    <!-- CA1707: Identifiers should not contain underscores -->
+    <Rule Id="CA1707" Action="None" />
+    <!-- CA2007: Consider calling ConfigureAwait on the awaited task -->
+    <Rule Id="CA2007" Action="None" />
+    <!-- CA2234: Pass system uri objects instead of strings -->
+    <Rule Id="CA2234" Action="Info" />      
+  </Rules>
+</RuleSet>