Swarm Murder University

.github/workflows/ci-suite.yml

@@ -151,7 +151,7 @@ jobs:
       run: docker build . -f build/Dockerfile
 
   linux-unit-tests:
-    name: Linux Unit Tests
+    name: Linux Tests
     strategy:
       fail-fast: false
       matrix:
@@ -173,7 +173,7 @@ jobs:
       run: dotnet build -c ${{ matrix.configuration }}NoService
 
     - name: Run Unit Tests
-      run: sudo dotnet test --no-build --logger GitHubActions --filter FullyQualifiedName!~IntegrationTest -c ${{ matrix.configuration }}NoService --collect:"XPlat Code Coverage" --settings build/coverlet.runsettings --results-directory ./TestResults tgstation-server.sln
+      run: sudo dotnet test --no-build --logger GitHubActions --filter FullyQualifiedName!~TestLiveServer -c ${{ matrix.configuration }}NoService --collect:"XPlat Code Coverage" --settings build/coverlet.runsettings --results-directory ./TestResults tgstation-server.sln
 
     - name: Store Code Coverage
       uses: actions/upload-artifact@v3
@@ -182,7 +182,7 @@ jobs:
         path: ./TestResults/
 
   windows-unit-tests:
-    name: Windows Unit Tests
+    name: Windows Tests
     strategy:
       fail-fast: false
       matrix:
@@ -204,7 +204,7 @@ jobs:
       run: dotnet build -c ${{ matrix.configuration }}
 
     - name: Run Unit Tests
-      run: dotnet test --no-build --logger GitHubActions --filter FullyQualifiedName!~IntegrationTest -c ${{ matrix.configuration }} --collect:"XPlat Code Coverage" --settings build/coverlet.runsettings --results-directory ./TestResults tgstation-server.sln
+      run: dotnet test --no-build --logger GitHubActions --filter FullyQualifiedName!~TestLiveServer -c ${{ matrix.configuration }} --collect:"XPlat Code Coverage" --settings build/coverlet.runsettings --results-directory ./TestResults tgstation-server.sln
 
     - name: Store Code Coverage
       uses: actions/upload-artifact@v3
@@ -213,7 +213,7 @@ jobs:
         path: ./TestResults/
 
   windows-integration-test:
-    name: Windows Integration Test
+    name: Windows Live Tests
     needs: dmapi-build
     env:
       TGS_TEST_DATABASE_TYPE: SqlServer
@@ -285,7 +285,7 @@ jobs:
         path: Artifacts/Service/
 
   linux-integration-tests:
-    name: Linux Integration Test
+    name: Linux Live Tests
     needs: dmapi-build
     services: # We start all dbs here so we can just code the stuff once
       postgres:

README.md

@@ -164,6 +164,8 @@ Create an `appsettings.Production.yml` file next to `appsettings.yml`. This will
 
 - `Swarm:Identifier` should be set uniquely on all swarmed servers. Used to identify the current server. This is also used to select which instances exist on the current machine and should not be changed post-setup.
 
+- `Swarm:UpdateRequiredNodeCount` should be set to the total number of servers in your swarm, minus the controller. Prevents updates from occurring unless the non-controller server count in the swarm is greater than or equal to this value.
+
 - `Security:OAuth:<Provider Name>`: Sets the OAuth client ID and secret for a given `<Provider Name>`. The currently supported providers are `Keycloak`, `GitHub`, `Discord`, `InvisionCommunity` and `TGForums`. Setting these fields to `null` disables logins with the provider, but does not stop users from associating their accounts using the API. Sample Entry:
 ```yml
 Security:

build/Version.props

@@ -4,13 +4,13 @@
   <Import Project="ControlPanelVersion.props" />
   <PropertyGroup>
     <TgsCoreVersion>5.11.0</TgsCoreVersion>
-    <TgsConfigVersion>4.5.0</TgsConfigVersion>
-    <TgsApiVersion>9.9.0</TgsApiVersion>
-    <TgsApiLibraryVersion>10.3.0</TgsApiLibraryVersion>
-    <TgsClientVersion>11.3.0</TgsClientVersion>
+    <TgsConfigVersion>4.6.0</TgsConfigVersion>
+    <TgsApiVersion>9.10.0</TgsApiVersion>
+    <TgsApiLibraryVersion>10.4.0</TgsApiLibraryVersion>
+    <TgsClientVersion>11.4.0</TgsClientVersion>
     <TgsDmapiVersion>6.4.2</TgsDmapiVersion>
     <TgsInteropVersion>5.6.0</TgsInteropVersion>
-    <TgsHostWatchdogVersion>1.2.1</TgsHostWatchdogVersion>
+    <TgsHostWatchdogVersion>1.2.2</TgsHostWatchdogVersion>
     <TgsContainerScriptVersion>1.2.1</TgsContainerScriptVersion>
     <TgsMigratorVersion>1.0.1</TgsMigratorVersion>
     <TgsNetVersion>net6.0</TgsNetVersion>

docs/API.dox

@@ -70,7 +70,7 @@ TGS will only every return the response codes listed here
 - 409: Conflict. Documented in the requests that use them
 - 410: Gone. Attempted to access/modify a resource that ideally should have been ready, but isn't or no longer is
 - 422: Unprocessable Entity: Used specifically when an operation that requires a server restart is unable to be performed due to the @ref Tgstation.Server.Host.Watchdog not being present in the deployment. Should not happen with a proper server configuration. Response body contains an @ref Tgstation.Server.Api.Models.ErrorMessage
-- 424: Failed Dependency: When a request that depends on the GitHub API fails for a reason other than rate limiting. Check server logs, usually this indicates a bad access token.
+- 424: Failed Dependency: When a request that depends on an external API fails for a reason other than rate limiting. The response body will contain an @ref Tgstation.Server.Api.Models.ErrorMessage model detailing the error.
 - 426: Upgrade required: Used when the client's API version is not compatible with the server's. Response body contains an @ref Tgstation.Server.Api.Models.ErrorMessage
 - 429: Rate limited. Used with operations that rely on GitHub.com. If a rate limit is hit for an operation this will be returned. Response will contain a Retry-After header
 - 500: Server error. Please report the request and response body to the code repository

src/Tgstation.Server.Api/Models/ErrorCode.cs

@@ -629,5 +629,11 @@ public enum ErrorCode : uint
 		/// </summary>
 		[Description("The deployment took longer than the configured timeout!")]
 		DeploymentTimeout,
+
+		/// <summary>
+		/// The server swarm has less than the expected amount of nodes.
+		/// </summary>
+		[Description("The server swarm has less than the expected amount of nodes!")]
+		SwarmIntegrityCheckFailed,
 	}
 }

src/Tgstation.Server.Api/Tgstation.Server.Api.csproj

@@ -16,13 +16,13 @@
     <RepositoryUrl>https://github.com/tgstation/tgstation-server</RepositoryUrl>
     <Copyright>2018-2023</Copyright>
     <PackageTags>json web api tgstation-server tgstation ss13 byond</PackageTags>
-    <PackageReleaseNotes>Added ChannelData field to ChatChannels model.</PackageReleaseNotes>
+    <PackageReleaseNotes>Added ErrorCode.SwarmIntegrityCheckFailed.</PackageReleaseNotes>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <CodeAnalysisRuleSet>../../build/analyzers.ruleset</CodeAnalysisRuleSet>
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
-    <DocumentationFile>bin\$(Configuration)\netstandard2.1\Tgstation.Server.Api.xml</DocumentationFile>
+    <DocumentationFile>bin\$(Configuration)\netstandard2.0\Tgstation.Server.Api.xml</DocumentationFile>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
     <NoWarn>CA1028</NoWarn>
   </PropertyGroup>

src/Tgstation.Server.Client/ApiClient.cs

@@ -20,6 +20,7 @@
 using Tgstation.Server.Api;
 using Tgstation.Server.Api.Models;
 using Tgstation.Server.Api.Models.Response;
+using Tgstation.Server.Common;
 
 namespace Tgstation.Server.Client
 {
@@ -50,7 +51,7 @@ public TimeSpan Timeout
 		}
 
 		/// <summary>
-		/// The <see cref="HttpClientImplementation"/> for the <see cref="ApiClient"/>.
+		/// The <see cref="IHttpClient"/> for the <see cref="ApiClient"/>.
 		/// </summary>
 		readonly IHttpClient httpClient;
 

src/Tgstation.Server.Client/ApiClientFactory.cs

@@ -1,6 +1,7 @@
 using System;
 
 using Tgstation.Server.Api;
+using Tgstation.Server.Common;
 
 namespace Tgstation.Server.Client
 {
@@ -13,7 +14,7 @@ sealed class ApiClientFactory : IApiClientFactory
 			ApiHeaders apiHeaders,
 			ApiHeaders? tokenRefreshHeaders,
 			bool authless) => new ApiClient(
-				new HttpClientImplementation(),
+				new HttpClient(),
 				url,
 				apiHeaders,
 				tokenRefreshHeaders,

src/Tgstation.Server.Client/Tgstation.Server.Client.csproj

@@ -16,13 +16,13 @@
     <RepositoryUrl>https://github.com/tgstation/tgstation-server</RepositoryUrl>
     <Copyright>2018-2023</Copyright>
     <PackageTags>json web api tgstation-server tgstation ss13 byond client</PackageTags>
-    <PackageReleaseNotes>Fix login refreshing not working.</PackageReleaseNotes>
+    <PackageReleaseNotes>Updated definitions for API version 9.10.0.</PackageReleaseNotes>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <CodeAnalysisRuleSet>../../build/analyzers.ruleset</CodeAnalysisRuleSet>
     <LangVersion>latest</LangVersion>
     <Nullable>enable</Nullable>
-    <DocumentationFile>bin\$(Configuration)\netstandard2.1\Tgstation.Server.Client.xml</DocumentationFile>
+    <DocumentationFile>bin\$(Configuration)\netstandard2.0\Tgstation.Server.Client.xml</DocumentationFile>
     <EnableNETAnalyzers>true</EnableNETAnalyzers>
   </PropertyGroup>
 
@@ -41,6 +41,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\Tgstation.Server.Api\Tgstation.Server.Api.csproj" />
+    <ProjectReference Include="..\Tgstation.Server.Common\Tgstation.Server.Common.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/Tgstation.Server.Common/HttpClient.cs

@@ -0,0 +1,50 @@
+using System;
+using System.Net.Http;
+using System.Net.Http.Headers;
+using System.Threading;
+using System.Threading.Tasks;
+
+namespace Tgstation.Server.Common
+{
+	/// <inheritdoc />
+	public sealed class HttpClient : IHttpClient
+	{
+		/// <inheritdoc />
+		public TimeSpan Timeout
+		{
+			get => httpClient.Timeout;
+			set => httpClient.Timeout = value;
+		}
+
+		/// <inheritdoc />
+		public HttpRequestHeaders DefaultRequestHeaders => httpClient.DefaultRequestHeaders;
+
+		/// <summary>
+		/// The real <see cref="System.Net.Http.HttpClient"/>.
+		/// </summary>
+		readonly System.Net.Http.HttpClient httpClient;
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="HttpClient"/> class.
+		/// </summary>
+		/// <param name="implementation">The <see cref="System.Net.Http.HttpClient"/> to wrap.</param>
+		public HttpClient(System.Net.Http.HttpClient implementation)
+		{
+			httpClient = implementation ?? throw new ArgumentNullException(nameof(implementation));
+		}
+
+		/// <summary>
+		/// Initializes a new instance of the <see cref="HttpClient"/> class.
+		/// </summary>
+		public HttpClient()
+			: this(new System.Net.Http.HttpClient())
+		{
+		}
+
+		/// <inheritdoc />
+		public void Dispose() => httpClient.Dispose();
+
+		/// <inheritdoc />
+		public Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken) => httpClient.SendAsync(request, cancellationToken);
+	}
+}

src/Tgstation.Server.Client/IHttpClient.cs → src/Tgstation.Server.Common/IHttpClient.cs

@@ -1,20 +1,26 @@
 using System;
 using System.Net.Http;
+using System.Net.Http.Headers;
 using System.Threading;
 using System.Threading.Tasks;
 
-namespace Tgstation.Server.Client
+namespace Tgstation.Server.Common
 {
 	/// <summary>
 	/// For sending HTTP requests.
 	/// </summary>
-	interface IHttpClient : IDisposable
+	public interface IHttpClient : IDisposable
 	{
 		/// <summary>
 		/// The request timeout.
 		/// </summary>
 		TimeSpan Timeout { get; set; }
 
+		/// <summary>
+		/// The <see cref="HttpRequestHeaders"/> used on every request.
+		/// </summary>
+		HttpRequestHeaders DefaultRequestHeaders { get; }
+
 		/// <summary>
 		/// Send an HTTP request.
 		/// </summary>

src/Tgstation.Server.Common/Tgstation.Server.Common.csproj

@@ -0,0 +1,31 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="../../build/Version.props" />
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <DebugType>Full</DebugType>
+    <Version>$(TgsCoreVersion)</Version>
+    <CodeAnalysisRuleSet>../../build/analyzers.ruleset</CodeAnalysisRuleSet>
+    <LangVersion>latest</LangVersion>
+    <Nullable>enable</Nullable>
+    <DocumentationFile>bin\$(Configuration)\netstandard2.0\Tgstation.Server.Client.xml</DocumentationFile>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)'=='Release'">
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- Usage: Linting -->
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Include="../../build/stylecop.json" />
+  </ItemGroup>
+</Project>

src/Tgstation.Server.Host.Common/HostExitCode.cs

@@ -0,0 +1,23 @@
+namespace Tgstation.Server.Host.Common
+{
+	/// <summary>
+	/// Represents the exit code of the <see cref="Host"/> program.
+	/// </summary>
+	public enum HostExitCode
+	{
+		/// <summary>
+		/// The program ran to completion and should not be re-executed.
+		/// </summary>
+		CompleteExecution,
+
+		/// <summary>
+		/// The program should be re-executed after applying pending updates.
+		/// </summary>
+		RestartRequested,
+
+		/// <summary>
+		/// The program errored and error data was writted to the pending update path as a file.
+		/// </summary>
+		Error,
+	}
+}

src/Tgstation.Server.Host.Common/Tgstation.Server.Host.Common.csproj

@@ -0,0 +1,32 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="../../build/Version.props" />
+
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <DebugType>Full</DebugType>
+    <Version>$(TgsCoreVersion)</Version>
+    <CodeAnalysisRuleSet>../../build/analyzers.ruleset</CodeAnalysisRuleSet>
+    <LangVersion>latest</LangVersion>
+    <IsPackable>false</IsPackable>
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <DocumentationFile>bin\$(Configuration)\netstandard2.0\Tgstation.Server.Host.Shared.xml</DocumentationFile>
+  </PropertyGroup>
+
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <WarningsAsErrors />
+  </PropertyGroup>
+
+  <ItemGroup>
+    <!-- Usage: Linting -->
+    <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
+
+  <ItemGroup>
+    <AdditionalFiles Include="../../build/stylecop.json" />
+  </ItemGroup>
+
+</Project>