test(setup): prune a real stopped service whose program is gone, and leave another folder's
The service steps were only checked against in-memory records and registry copies. On an elevated runner the test registers two throwaway demand-start services through the Service Control Manager, one starting a program of the install folder and one of another folder, and checks that setup finds only the first, prunes it, and leaves the second registered. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012iLMBNwBE2GnphAsu4cjaC
This commit is contained in:
2 files changed
+127
No files matched your search
@@ -0,0 +1,90 @@
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace Titano.App.Tests.Setup;
|
||||
|
||||
/// <summary>
|
||||
/// Throwaway Windows services for the tests of setup's service steps: stopped, started on demand only, never running.
|
||||
/// Creating and deleting them needs administrator rights.
|
||||
/// </summary>
|
||||
internal static partial class ScratchServices
|
||||
{
|
||||
private const uint ScManagerConnect = 0x1;
|
||||
private const uint ScManagerCreateService = 0x2;
|
||||
private const uint ServiceAllAccess = 0xF01FF;
|
||||
private const uint Delete = 0x10000;
|
||||
private const uint ServiceWin32OwnProcess = 0x10;
|
||||
private const uint ServiceDemandStart = 0x3;
|
||||
private const uint ServiceErrorNormal = 0x1;
|
||||
|
||||
/// <summary>Registers <paramref name="name"/> to start <paramref name="commandLine"/>; throws when Windows refuses.</summary>
|
||||
public static void Create(string name, string commandLine)
|
||||
{
|
||||
var manager = OpenSCManagerW(null, null, ScManagerConnect | ScManagerCreateService);
|
||||
if (manager == 0) throw new InvalidOperationException($"Service Control Manager not opened (error {Marshal.GetLastPInvokeError()})");
|
||||
try
|
||||
{
|
||||
var service = CreateServiceW(manager, name, name, ServiceAllAccess, ServiceWin32OwnProcess, ServiceDemandStart, ServiceErrorNormal,
|
||||
commandLine, null, 0, null, null, null);
|
||||
if (service == 0) throw new InvalidOperationException($"Service {name} not created (error {Marshal.GetLastPInvokeError()})");
|
||||
CloseServiceHandle(service);
|
||||
}
|
||||
finally
|
||||
{
|
||||
CloseServiceHandle(manager);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>True while <paramref name="name"/> is registered (marked for deletion or not).</summary>
|
||||
public static bool Exists(string name)
|
||||
{
|
||||
var manager = OpenSCManagerW(null, null, ScManagerConnect);
|
||||
if (manager == 0) return false;
|
||||
try
|
||||
{
|
||||
var service = OpenServiceW(manager, name, Delete);
|
||||
if (service == 0) return false;
|
||||
CloseServiceHandle(service);
|
||||
return true;
|
||||
}
|
||||
finally
|
||||
{
|
||||
CloseServiceHandle(manager);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Deletes <paramref name="name"/> when it is still registered; never throws (test clean-up).</summary>
|
||||
public static void DeleteQuietly(string name)
|
||||
{
|
||||
var manager = OpenSCManagerW(null, null, ScManagerConnect);
|
||||
if (manager == 0) return;
|
||||
try
|
||||
{
|
||||
var service = OpenServiceW(manager, name, Delete);
|
||||
if (service == 0) return;
|
||||
DeleteService(service);
|
||||
CloseServiceHandle(service);
|
||||
}
|
||||
finally
|
||||
{
|
||||
CloseServiceHandle(manager);
|
||||
}
|
||||
}
|
||||
|
||||
[LibraryImport("advapi32.dll", SetLastError = true, StringMarshalling = StringMarshalling.Utf16)]
|
||||
private static partial nint OpenSCManagerW(string? machineName, string? databaseName, uint desiredAccess);
|
||||
|
||||
[LibraryImport("advapi32.dll", SetLastError = true, StringMarshalling = StringMarshalling.Utf16)]
|
||||
private static partial nint CreateServiceW(nint manager, string serviceName, string displayName, uint desiredAccess, uint serviceType, uint startType,
|
||||
uint errorControl, string binaryPathName, string? loadOrderGroup, nint tagId, string? dependencies, string? serviceStartName, string? password);
|
||||
|
||||
[LibraryImport("advapi32.dll", SetLastError = true, StringMarshalling = StringMarshalling.Utf16)]
|
||||
private static partial nint OpenServiceW(nint manager, string serviceName, uint desiredAccess);
|
||||
|
||||
[LibraryImport("advapi32.dll", SetLastError = true)]
|
||||
[return: MarshalAs(UnmanagedType.Bool)]
|
||||
private static partial bool DeleteService(nint service);
|
||||
|
||||
[LibraryImport("advapi32.dll", SetLastError = true)]
|
||||
[return: MarshalAs(UnmanagedType.Bool)]
|
||||
private static partial bool CloseServiceHandle(nint handle);
|
||||
}
|
||||
@@ -113,6 +113,43 @@ public sealed class SetupEngineTests(TestContext context)
|
||||
Assert.Equal(SetupExitCode.Success, InstalledServices.Apply([gone], ServiceActions.Remove | ServiceActions.Start));
|
||||
}
|
||||
|
||||
[Test]
|
||||
[WindowsOnly]
|
||||
public void AServiceWhoseProgramIsGoneIsDeletedAndAnotherFoldersServiceStays()
|
||||
{
|
||||
// The Service Control Manager registers services for administrators only; CI runners have the rights.
|
||||
if (!Elevation.IsElevated) TestContext.Skip("needs administrator rights");
|
||||
var root = context.CreateTempDirectory("services");
|
||||
var folder = Path.Combine(root, "Apps");
|
||||
Directory.CreateDirectory(folder);
|
||||
var ours = "TitanoTest" + Guid.NewGuid().ToString("N");
|
||||
var other = "TitanoTest" + Guid.NewGuid().ToString("N");
|
||||
try
|
||||
{
|
||||
// Two stopped services whose programs are gone: one in the install folder, one in a folder setup did not install.
|
||||
ScratchServices.Create(ours, $"\"{Path.Combine(folder, "Titano.Server.exe")}\" --service");
|
||||
ScratchServices.Create(other, $"\"{Path.Combine(root, "Elsewhere", "Titano.Server.exe")}\" --service");
|
||||
|
||||
var found = InstalledServices.Find(CommandProgram.FullPaths(folder, ["Titano.Server.exe"]));
|
||||
var service = Assert.Contains(found, s => s.Name == ours);
|
||||
Assert.False(found.Any(s => s.Name == other), "a service of another folder is not this installation's");
|
||||
Assert.False(InstalledServices.IsRunning(service));
|
||||
Assert.True(InstalledServices.NeedsWork([service], ServiceActions.Prune), "a service whose program is gone is pruned");
|
||||
Assert.False(InstalledServices.NeedsWork([service], ServiceActions.Start), "nothing to start: its program is gone");
|
||||
|
||||
Assert.Equal(SetupExitCode.Success, InstalledServices.Apply(found, ServiceActions.Prune));
|
||||
|
||||
Assert.False(ScratchServices.Exists(ours), "the pruned service is deleted");
|
||||
Assert.True(ScratchServices.Exists(other), "the other folder's service stays");
|
||||
Assert.Empty(InstalledServices.Find(CommandProgram.FullPaths(folder, ["Titano.Server.exe"])));
|
||||
}
|
||||
finally
|
||||
{
|
||||
ScratchServices.DeleteQuietly(ours);
|
||||
ScratchServices.DeleteQuietly(other);
|
||||
}
|
||||
}
|
||||
|
||||
[Test]
|
||||
[WindowsOnly]
|
||||
public void UninstallRemovesOnlyTheSignInEntriesOfTheProgramsItRemoves()
|
||||
|
||||
Reference in new issue
Block a user