A service has no console, and a refused data folder or server.json throws before the server's log file exists, so the SCM recorded only error 1064 and the entry to check was lost. ServiceMain and the stop path now also write the reason to the Application event log (source TitanoServer, advapi32 ReportEventW, no message file registered). The Windows README says where to look and that a data folder created by an unelevated console run must be deleted or given to Administrators first. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012iLMBNwBE2GnphAsu4cjaC
153 lines
8.7 KiB
C#
153 lines
8.7 KiB
C#
using System.Diagnostics.Eventing.Reader;
|
|
using System.Security.AccessControl;
|
|
using System.Security.Principal;
|
|
using Titano.Server.Hosting;
|
|
using Titano.Server.Hosting.Windows;
|
|
using Titano.Testing;
|
|
|
|
namespace Titano.Server.Tests.Hosting;
|
|
|
|
public sealed class WindowsServiceTests(TestContext context)
|
|
{
|
|
[Test]
|
|
public void CommandSwitchesAreParsedAndTheRestPassedOn()
|
|
{
|
|
Assert.Equal(ServerCommand.Run, ServerCommandLine.Parse([]).Command);
|
|
var service = ServerCommandLine.Parse(["--service", "--urls", "x"]);
|
|
Assert.Equal(ServerCommand.Service, service.Command);
|
|
Assert.SequenceEqual(["--urls", "x"], service.HostArguments);
|
|
Assert.Equal(ServerCommand.InstallService, ServerCommandLine.Parse(["--install-service"]).Command);
|
|
Assert.Equal(ServerCommand.UninstallService, ServerCommandLine.Parse(["--uninstall-service"]).Command);
|
|
Assert.Equal(ServerCommand.HealthCheck, ServerCommandLine.Parse(["--healthcheck"]).Command);
|
|
Assert.Equal(ServerCommand.Help, ServerCommandLine.Parse(["/?"]).Command);
|
|
Assert.NotNull(ServerCommandLine.Parse(["--install-service", "--uninstall-service"]).Error);
|
|
Assert.Null(ServerCommandLine.Parse(["--service", "--service"]).Error);
|
|
}
|
|
|
|
[Test]
|
|
public void StatusReportsFollowTheServiceControlManagerRules()
|
|
{
|
|
var tracker = new ServiceStatusTracker();
|
|
var start = tracker.StartPending(60_000);
|
|
Assert.Equal((ServiceState.StartPending, 0u, 1u, 60_000u), (start.State, start.ControlsAccepted, start.CheckPoint, start.WaitHintMilliseconds));
|
|
Assert.Equal(2u, tracker.StartPending(60_000).CheckPoint);
|
|
var running = tracker.Running();
|
|
Assert.Equal((ServiceState.Running, ServiceStatusTracker.AcceptStop | ServiceStatusTracker.AcceptShutdown, 0u), (running.State, running.ControlsAccepted, running.CheckPoint));
|
|
Assert.Throws<InvalidOperationException>(() => tracker.Running());
|
|
Assert.Equal(1u, tracker.StopPending(35_000).CheckPoint);
|
|
Assert.Equal(2u, tracker.StopPending(35_000).CheckPoint);
|
|
var stopped = tracker.Stopped(0);
|
|
Assert.Equal((ServiceState.Stopped, 0u, 0u), (stopped.State, stopped.ControlsAccepted, stopped.CheckPoint));
|
|
Assert.Throws<InvalidOperationException>(() => tracker.StopPending(1));
|
|
Assert.Equal(1064u, new ServiceStatusTracker().Stopped(1064).ExitCode);
|
|
}
|
|
|
|
[Test]
|
|
public void AServiceFailureLeadsWithTheReasonTheServerGave()
|
|
{
|
|
var refused = new InvalidOperationException(@"C:\ProgramData\Titano Server belongs to PC\ada, not to SYSTEM, Administrators or the account Titano Server runs as.");
|
|
var text = ServiceEventLog.Describe("Titano Server did not start:", refused);
|
|
Assert.True(text.StartsWith(@"Titano Server did not start: C:\ProgramData\Titano Server belongs to PC\ada", StringComparison.Ordinal), text);
|
|
Assert.Contains("System.InvalidOperationException", text);
|
|
|
|
// ReportEvent refuses a longer string: the text is cut, never between the halves of a surrogate pair.
|
|
var cut = ServiceEventLog.Describe("x", new InvalidOperationException(new string('a', ServiceEventLog.MaxLength)));
|
|
Assert.Equal(ServiceEventLog.MaxLength, cut.Length);
|
|
Assert.True(cut.EndsWith("a\u2026", StringComparison.Ordinal), cut[^5..]);
|
|
var pair = ServiceEventLog.Describe("x", new InvalidOperationException(new string('a', ServiceEventLog.MaxLength - 4) + "\uD83D\uDE00" + new string('b', 99)));
|
|
Assert.Equal(ServiceEventLog.MaxLength - 1, pair.Length);
|
|
Assert.True(pair.EndsWith("a\u2026", StringComparison.Ordinal), pair[^5..]);
|
|
}
|
|
|
|
[Test]
|
|
[WindowsOnly]
|
|
public void AServiceFailureReachesTheApplicationEventLog()
|
|
{
|
|
if (!OperatingSystem.IsWindows()) return;
|
|
// Written as a source of its own, so a test run never looks like a failed service in Event Viewer.
|
|
const string source = "Titano.Server.Tests";
|
|
var marker = source + " " + Guid.NewGuid().ToString("N");
|
|
Assert.True(ServiceEventLog.Error(source, ServiceEventLog.StartFailed, marker), "the Application log takes the event");
|
|
var filter = $"*[System[Provider[@Name='{source}'] and EventID={ServiceEventLog.StartFailed}]]";
|
|
var query = new EventLogQuery("Application", PathType.LogName, filter) { ReverseDirection = true };
|
|
for (var attempt = 0; attempt < 50; attempt++)
|
|
{
|
|
using (var reader = new EventLogReader(query))
|
|
{
|
|
for (var read = 0; read < 100 && reader.ReadEvent() is { } record; read++)
|
|
{
|
|
using (record)
|
|
{
|
|
// The event's one string, which Event Viewer shows whole.
|
|
if (record.Properties.Count != 1 || record.Properties[0].Value as string != marker) continue;
|
|
Assert.Equal((byte?)2, record.Level, "an error");
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
Thread.Sleep(100);
|
|
}
|
|
Assert.Fail($"No {source} event carries '{marker}'.");
|
|
}
|
|
|
|
[Test]
|
|
[WindowsOnly]
|
|
public void TheServiceIsRegisteredOnlyFromInsideProgramFiles()
|
|
{
|
|
if (!OperatingSystem.IsWindows()) return;
|
|
var programFiles = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
|
|
Assert.True(ServiceInstaller.IsUnderProgramFiles(Path.Combine(programFiles, "Titano", "Titano.Server.exe")));
|
|
Assert.False(ServiceInstaller.IsUnderProgramFiles(programFiles));
|
|
Assert.False(ServiceInstaller.IsUnderProgramFiles(programFiles + " Tools\\Titano"));
|
|
Assert.False(ServiceInstaller.IsUnderProgramFiles(Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "Programs", "Titano")));
|
|
Assert.False(ServiceInstaller.IsUnderProgramFiles(Path.Combine(programFiles, "..", "Titano")));
|
|
// The test build is not under Program Files: registering it is refused, naming the folder.
|
|
Assert.Contains(Path.TrimEndingDirectorySeparator(AppContext.BaseDirectory), Assert.NotNull(ServiceInstaller.UnsafeLocation()));
|
|
}
|
|
|
|
[Test]
|
|
[WindowsOnly]
|
|
public void AnyFileOrdinaryUsersCanChangeIsFound()
|
|
{
|
|
if (!OperatingSystem.IsWindows()) return;
|
|
using var identity = WindowsIdentity.GetCurrent();
|
|
if (!new WindowsPrincipal(identity).IsInRole(WindowsBuiltInRole.Administrator)) Assert.Inconclusive("registering a service needs an administrator");
|
|
var folder = new DirectoryInfo(context.CreateTempDirectory("program"));
|
|
File.WriteAllBytes(Path.Combine(folder.FullName, "Titano.Server.exe"), [1]);
|
|
var satellite = new FileInfo(Path.Combine(folder.CreateSubdirectory("it").FullName, "Titano.Core.resources.dll"));
|
|
File.WriteAllBytes(satellite.FullName, [1]);
|
|
|
|
// Like Program Files: administrators may change the folder, users only read it.
|
|
var locked = new DirectorySecurity();
|
|
locked.SetAccessRuleProtection(isProtected: true, preserveInheritance: false);
|
|
var everything = InheritanceFlags.ContainerInherit | InheritanceFlags.ObjectInherit;
|
|
foreach (var account in new[] { new SecurityIdentifier(WellKnownSidType.LocalSystemSid, null), new SecurityIdentifier(WellKnownSidType.BuiltinAdministratorsSid, null), identity.User! })
|
|
locked.AddAccessRule(new FileSystemAccessRule(account, FileSystemRights.FullControl, everything, PropagationFlags.None, AccessControlType.Allow));
|
|
locked.AddAccessRule(new FileSystemAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), FileSystemRights.ReadAndExecute, everything,
|
|
PropagationFlags.None, AccessControlType.Allow));
|
|
folder.SetAccessControl(locked);
|
|
Assert.Null(ServiceInstaller.FindChangeable(folder, recursive: true));
|
|
|
|
// One satellite assembly users may replace is enough: the service would load it as SYSTEM.
|
|
var open = satellite.GetAccessControl();
|
|
open.AddAccessRule(new FileSystemAccessRule(new SecurityIdentifier(WellKnownSidType.BuiltinUsersSid, null), FileSystemRights.Modify, AccessControlType.Allow));
|
|
satellite.SetAccessControl(open);
|
|
Assert.Equal(satellite.FullName, ServiceInstaller.FindChangeable(folder, recursive: true));
|
|
Assert.Null(ServiceInstaller.FindChangeable(folder, recursive: false));
|
|
}
|
|
|
|
[Test]
|
|
[WindowsOnly]
|
|
public void TheDispatcherDeclinesAConsoleProcess()
|
|
{
|
|
if (!OperatingSystem.IsWindows()) return;
|
|
var built = false;
|
|
Assert.False(WindowsServiceHost.Run(() =>
|
|
{
|
|
built = true;
|
|
throw new InvalidOperationException("never built outside the SCM");
|
|
}));
|
|
Assert.False(built);
|
|
}
|
|
}
|