Systemd support (#60)

* enable systemd support Signed-off-by: clemensv <[email protected]>
Azure · Sep 20, 2022 · 44cf8e1 · 44cf8e1
1 parent e969c35
commit 44cf8e1
Show file tree

Hide file tree

Showing 14 changed files with 78 additions and 98 deletions.
diff --git a/.github/workflows/main-ci-build.yml b/.github/workflows/main-ci-build.yml
@@ -82,6 +82,9 @@ jobs:
     - name: Build for Fedora 30-x64
       run: dotnet msbuild /t:Restore,Package /p:WindowsOnly=false /p:RuntimeIdentifier=fedora.34-x64 /p:Configuration=Release /p:TargetFramework=net6.0 /p:VersionSuffix=rel
       if: matrix.os == 'ubuntu-latest'
+    - name: Build for CentOS 9-x64
+      run: dotnet msbuild /t:Restore,Package /p:WindowsOnly=false /p:RuntimeIdentifier=centos.9-x64 /p:Configuration=Release /p:TargetFramework=net6.0 /p:VersionSuffix=rel
+      if: matrix.os == 'ubuntu-latest'
 
     - name: Unit Test Windows x64
       env:

diff --git a/build/repo.props b/build/repo.props
@@ -5,12 +5,15 @@
 		<TargetFrameworks>$(CoreFrameworks)</TargetFrameworks>
 		<TargetFramework Condition="'$(TargetFramework)'==''">net6.0</TargetFramework>
 		<WindowsRuntimeIdentifiers Condition="'$(OS)'=='Windows_NT'">win10-x64;win10-x86;win10-arm64;</WindowsRuntimeIdentifiers>
-		<UnixRuntimeIdentifiers Condition="'$(WindowsOnly)'=='false'">osx-x64;debian.10-x64;ubuntu.18.04-x64;ubuntu.18.04-arm64;ubuntu.20.04-x64;ubuntu.20.04-arm64;opensuse.15.0-x64;fedora.34-x64</UnixRuntimeIdentifiers>
+		<UnixRuntimeIdentifiers Condition="'$(WindowsOnly)'=='false'">osx-x64;debian.10-x64;ubuntu.18.04-x64;ubuntu.18.04-arm64;ubuntu.20.04-x64;ubuntu.20.04-arm64;opensuse.15.0-x64;fedora.34-x64;centos.9-x64</UnixRuntimeIdentifiers>
 		<RuntimeIdentifiers>$(WindowsRuntimeIdentifiers)$(UnixRuntimeIdentifiers)</RuntimeIdentifiers>
 	</PropertyGroup>
 	<PropertyGroup Condition="'$(OS)' == 'Windows_NT' OR $(RuntimeIdentifier.StartsWith('win'))">
 		<DefineConstants>_WINDOWS</DefineConstants>
 	</PropertyGroup>
+	<PropertyGroup Condition="$(RuntimeIdentifier.StartsWith('ubuntu')) OR $(RuntimeIdentifier.StartsWith('debian')) OR $(RuntimeIdentifier.StartsWith('rhel')) OR $(RuntimeIdentifier.StartsWith('centos')) OR $(RuntimeIdentifier.StartsWith('fedora')) ">
+		<DefineConstants>_SYSTEMD</DefineConstants>
+	</PropertyGroup>
 	<ItemGroup>
 		<DotNetCoreRuntime Include="$(MicrosoftNETCoreAppPackageVersion)" />
 	</ItemGroup>

diff --git a/package-all.cmd b/package-all.cmd
@@ -10,9 +10,9 @@ echo *** Building and packaging Windows Targets
 
 if %_DOCKER_BUILD% == "true" (
    echo *** Windows only
-   dotnet msbuild /t:clean,restore,package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-x64 %*
-   dotnet msbuild /t:clean,restore,Package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-arm64 %*
-   dotnet msbuild /t:clean,restore,Package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-x86 %*
+   dotnet msbuild /t:restore,package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-x64 %*
+   dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-arm64 %*
+   dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-x86 %*
 ) else (
     echo *** All platforms
     dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=true /p:TargetFramework=net6.0 /p:RuntimeIdentifier=win10-x64 %*
@@ -26,6 +26,7 @@ if %_DOCKER_BUILD% == "true" (
     dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=ubuntu.20.04-arm64 %*
     dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=opensuse.15.0-x64 %*
     dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=fedora.34-x64 %*
+    dotnet msbuild /t:restore,Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=centos.9-x64 %*
 )
 
 if not errorlevel 0 exit /b 1

diff --git a/package.sh b/package.sh
@@ -10,5 +10,6 @@ dotnet msbuild /t:Package /p:Configuration=Release /p:WindowsOnly=false /p:Targe
 dotnet msbuild /t:Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=ubuntu.20.04-arm64 $_BuildProp $_VersionProp $@
 dotnet msbuild /t:Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=opensuse.15.0-x64 $_BuildProp $_VersionProp $@
 dotnet msbuild /t:Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=fedora.34-x64 $_BuildProp $_VersionProp $@
+dotnet msbuild /t:Package /p:Configuration=Release /p:WindowsOnly=false /p:TargetFramework=net6.0 /p:RuntimeIdentifier=centos.9-x64 $_BuildProp $_VersionProp $@
 
 popd
diff --git a/src/Microsoft.Azure.Relay.Bridge/Configuration/CommandLineSettings.cs b/src/Microsoft.Azure.Relay.Bridge/Configuration/CommandLineSettings.cs
@@ -19,9 +19,9 @@ public class CommandLineSettings
         public bool? ServiceInstall { get; set; }
         [Option(CommandOptionType.NoValue, LongName = "svcuninstall", ShortName = "U", Description = "Uninstall Windows Service")]
         public bool? ServiceUninstall { get; set; }
-        [Option(CommandOptionType.NoValue, LongName = "svc", ShortName = "svc", Description = "Reserved for Windows service control manager")]
-        public bool? ServiceRun { get; set; }
 #endif
+        [Option(CommandOptionType.NoValue, LongName = "svc", ShortName = "svc", Description = "Reserved for background service invocation")]
+        public bool? ServiceRun { get; set; }
         [Option(CommandOptionType.SingleValue, ShortName = "b", Description = "Source address of forwarding connections.")]
         public string BindAddress { get; set; }
         [Option(CommandOptionType.SingleValue, ShortName = "e", Description = "Relay endpoint URI")]

diff --git a/src/azbridge/Program.cs b/src/azbridge/Program.cs
@@ -53,12 +53,16 @@ static int Run(CommandLineSettings settings, string[] args)
                     ServiceLauncher.UninstallService();
                     return 0;
                 }
-                else if (settings.ServiceRun.HasValue && settings.ServiceRun.Value)
+#endif
+#if _WINDOWS || _SYSTEMD
+                if (settings.ServiceRun.HasValue && settings.ServiceRun.Value)
                 {
                     ServiceLauncher.RunAsync(settings).GetAwaiter().GetResult();
                     return 0;
                 }
 #endif
+
+
                 if ( !string.IsNullOrEmpty(settings.ConfigFile) && !File.Exists(settings.ConfigFile))
                 {
                     Console.WriteLine($"The config file was not found: {settings.ConfigFile}");

diff --git a/src/azbridge/RelayBridgeService.cs b/src/azbridge/RelayBridgeService.cs
@@ -1,4 +1,4 @@
-#if _WINDOWS
+#if _WINDOWS || _SYSTEMD
 using Microsoft.Azure.Relay.Bridge.Configuration;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
@@ -47,33 +47,36 @@ public override Task StartAsync(CancellationToken cancellationToken)
             }
         }
 
-        public override Task StopAsync(CancellationToken cancellationToken)
+        public override async Task StopAsync(CancellationToken cancellationToken)
         {
             try
             {
+                await base.StopAsync(cancellationToken);
                 if (host != null)
                 {
                     host.Stop();
                     host = null;
-                }
-                return base.StopAsync(cancellationToken);
+                }                
             }
             catch (System.Exception ex)
             {
                 _logger.LogError(ex, "{Message}", ex.Message);
                 Environment.Exit(1);
-                return Task.CompletedTask;
             }
         }
 
         protected override Task ExecuteAsync(CancellationToken stoppingToken)
         {
             try
             {
-                if (host != null)
+                return Task.Run(() =>
                 {
-                    host.Start();
-                }
+                    if (host != null)
+                    {
+                        host.Start();
+                    }
+                    stoppingToken.WaitHandle.WaitOne();
+                });
             }
             catch (System.Exception ex)
             {

diff --git a/src/azbridge/ServiceLauncher.cs b/src/azbridge/ServiceLauncher.cs
@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-#if _WINDOWS
+#if _WINDOWS || _SYSTEMD
 namespace azbridge
 {
     using Microsoft.Azure.Relay.Bridge.Configuration;
@@ -85,20 +85,25 @@ internal static async Task RunAsync(CommandLineSettings settings)
             {
                 logLevel = LogLevel.None;
             }
-            
-            
+
+
             IHost host = Host.CreateDefaultBuilder()
+#if _WINDOWS
                 .UseWindowsService(options =>
                 {
                     options.ServiceName = ServiceName;
                 })
+#elif _SYSTEMD
+                .UseSystemd()
+#endif
+
                 .ConfigureServices(services =>
                 {
                     LoggerProviderOptions.RegisterProviderOptions<EventLogSettings, EventLogLoggerProvider>(services);
                     services.Configure<EventLogSettings>(settings =>
                     {
                         settings.SourceName = ServiceName;
-                    });                    
+                    });
                     services.AddSingleton(config);
                     services.AddHostedService<RelayBridgeService>();
                 })
@@ -111,7 +116,7 @@ internal static async Task RunAsync(CommandLineSettings settings)
                         var dir = Path.GetDirectoryName(config.LogFileName);
                         var ext = Path.GetExtension(config.LogFileName);
                         var fileName = Path.Combine(dir, $"{fn}-{{Date}}{ext}");
-                        logging.AddFile(fileName, logLevel);                        
+                        logging.AddFile(fileName, logLevel);
                     }
                 })
                 .Build();
@@ -151,34 +156,12 @@ public static void ShellExecute(string command, string parameters)
             };
             process.Start();
             process.WaitForExit();
-            if ( process.ExitCode != 0 )
+            if (process.ExitCode != 0)
             {
                 throw new Exception($"Process failed with exit code {process.ExitCode}");
             }
         }
 
-        internal static void StartService()
-        {
-            if (!IsInstalled())
-                return;
-#if _WINDOWS
-#pragma warning disable CA1416 // Validate platform compatibility
-            using (ServiceController controller =
-                new ServiceController(ServiceName))
-            {
-                if (controller.Status != ServiceControllerStatus.Running)
-                {
-                    controller.Start();
-                    controller.WaitForStatus(ServiceControllerStatus.Running,
-                        TimeSpan.FromSeconds(10));
-                }
-            }
-#pragma warning restore CA1416 // Validate platform compatibility
-#else
-             return true;
-#endif
-        }
-
         internal static bool IsInstalled()
         {
 #if _WINDOWS
@@ -200,51 +183,6 @@ internal static bool IsInstalled()
              return true;
 #endif
         }
-
-        internal static bool IsRunning()
-        {
-#if _WINDOWS
-#pragma warning disable CA1416 // Validate platform compatibility
-
-            using (var controller = new ServiceController(ServiceName))
-            {
-                if (!IsInstalled())
-                    return false;
-                return (controller.Status == ServiceControllerStatus.Running);
-            }
-#pragma warning restore CA1416 // Validate platform compatibility
-#else
-             return true;
-#endif
-        }
-
-
-        internal static void StopService()
-        {
-#if _WINDOWS
-#pragma warning disable CA1416 // Validate platform compatibility
-            if (!IsInstalled())
-                return;
-            using (ServiceController controller =
-                new ServiceController(ServiceName))
-            {
-                try
-                {
-                    if (controller.Status != ServiceControllerStatus.Stopped)
-                    {
-                        controller.Stop();
-                        controller.WaitForStatus(ServiceControllerStatus.Stopped,
-                             TimeSpan.FromSeconds(10));
-                    }
-                }
-                catch
-                {
-                    throw;
-                }
-            }
-        }
-#pragma warning restore CA1416 // Validate platform compatibility
-#endif
     }
 }
 #endif
diff --git a/src/azbridge/azbridge.csproj b/src/azbridge/azbridge.csproj
@@ -30,13 +30,20 @@
 	</PropertyGroup>
 
 	<Choose>
-		<When Condition="'$(OS)' == 'Windows_NT' OR $(RuntimeIdentifier.StartsWith('win'))">
+		<When Condition="$(DefineConstants.Contains('_WINDOWS'))">
 			<ItemGroup>
 				<PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.0" />
 				<PackageReference Include="Microsoft.Extensions.Hosting.WindowsServices" Version="6.0.0" />
 				<PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
 			</ItemGroup>
 		</When>
+		<Otherwise>
+			<ItemGroup>
+				<PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.0" />
+				<PackageReference Include="Microsoft.Extensions.Hosting.Systemd" Version="6.0.0" />
+				<PackageReference Include="Microsoft.Extensions.Http" Version="6.0.0" />
+			</ItemGroup>
+		</Otherwise>
 	</Choose>
 
 
@@ -55,6 +62,9 @@
 		<Content Include="azbridge_config.machine.yml" CopyToPublishDirectory="PreserveNewest" Condition="! $(RuntimeIdentifier.StartsWith('win'))">
 			<LinuxPath>/etc/azbridge/azbridge_config.machine.yml</LinuxPath>
 		</Content>
+		<Content Include="azbridge.service" CopyToPublishDirectory="PreserveNewest" Condition="$(DefineConstants.Contains('_SYSTEMD'))">
+			<LinuxPath>/etc/systemd/system/azbridge.service</LinuxPath>
+		</Content>
 		<Content Include="azbridge.sh" CopyToPublishDirectory="PreserveNewest" Condition="! $(RuntimeIdentifier.StartsWith('win'))" RemoveOnUninstall="true">
 			<LinuxPath>/etc/profile.d/azbridge.sh</LinuxPath>
 			<LinuxFileMode Condition="!($(RuntimeIdentifier.StartsWith('rhel')) OR $(RuntimeIdentifier.StartsWith('fedora')) OR $(RuntimeIdentifier.StartsWith('opensuse')) OR $(RuntimeIdentifier.StartsWith('centos')))">0555</LinuxFileMode>
@@ -65,8 +75,8 @@
 	</ItemGroup>
 
 	<PropertyGroup>
-		<PostInstallScript>ln -sf /usr/share/azbridge/azbridge /usr/local/bin/azbridge</PostInstallScript>
-		<PostRemoveScript>rm /usr/local/bin/azbridge</PostRemoveScript>
+		<PostInstallScript>ln -sf /usr/share/azbridge/azbridge /usr/local/bin/azbridge;</PostInstallScript>
+		<PostRemoveScript>/bin/rm -f /usr/local/bin/azbridge;</PostRemoveScript>
 	</PropertyGroup>
 
 	<ItemGroup>
@@ -94,7 +104,7 @@
 		</ProjectReference>
 	</ItemGroup>
 
-	<!-- Fedora, CentOS, and RHEL dependencies -->
+	<!-- Debian and Ubuntu -->
 	<ItemGroup Condition="$(RuntimeIdentifier.StartsWith('debian')) OR $(RuntimeIdentifier.StartsWith('ubuntu')) OR $(RuntimeIdentifier.StartsWith('linuxmint'))">
 		<DebDependency Include="ca-certificates" Version="" />
 	</ItemGroup>
@@ -104,10 +114,10 @@
 	</ItemGroup>
 
 	<!-- Linux Daemon install properties -->
-	<PropertyGroup Condition="$(UnixRuntimeIdentifiers.Contains($(RuntimeIdentifier)))">
+	<PropertyGroup Condition="$(DefineConstants.Contains('_SYSTEMD'))">
 		<CreateUser>true</CreateUser>
 		<UserName>azbridge</UserName>
-		<InstallService>false</InstallService>
+		<InstallService>true</InstallService>
 		<SymlinkAppHostInBin>true</SymlinkAppHostInBin>
 	</PropertyGroup>
 

diff --git a/src/azbridge/azbridge.service b/src/azbridge/azbridge.service
@@ -2,7 +2,8 @@
 Description=Azure Relay Bridge
 
 [Service]
-ExecStart=/usr/shared/azbridge
+Type=notify
+ExecStart=/usr/share/azbridge/azbridge --svc
 
 [Install]
 WantedBy=multi-user.target
diff --git a/src/azbridge/azbridge_config.svc.yml b/src/azbridge/azbridge_config.svc.yml
@@ -93,8 +93,8 @@ LocalForward :
 
 LogLevel : ERROR
 
-# Name of the log file. Not used in Windows service mode when logging is directed to 
-# the Windows event log.
+# Name of the log file. Not used in Windows service mode or SystemD mode when logging is directed to 
+# the Windows event log or SystemD logs 
 
 LogFileName : 
 

diff --git a/test/nginx/Test.proj b/test/nginx/Test.proj
@@ -6,7 +6,7 @@
 
   <PropertyGroup>
     <ImageSuffix Condition="$(RuntimeIdentifier.StartsWith('debian')) OR $(RuntimeIdentifier.StartsWith('ubuntu')) OR $(RuntimeIdentifier.StartsWith('linuxmint'))">deb</ImageSuffix>
-    <ImageSuffix Condition="$(RuntimeIdentifier.StartsWith('rhel')) OR $(RuntimeIdentifier.StartsWith('fedora')) OR $(RuntimeIdentifier.StartsWith('opensuse'))">rpm</ImageSuffix>
+    <ImageSuffix Condition="$(RuntimeIdentifier.StartsWith('rhel')) OR $(RuntimeIdentifier.StartsWith('fedora')) OR $(RuntimeIdentifier.StartsWith('opensuse')) OR $(RuntimeIdentifier.StartsWith('centos'))">rpm</ImageSuffix>
     <ImageSuffix Condition="'$(ImageSuffix)' == ''">tar.gz</ImageSuffix>
   </PropertyGroup>
 

diff --git a/test/nginx/centos.9-x64.client.dockerfile b/test/nginx/centos.9-x64.client.dockerfile
@@ -0,0 +1,8 @@
+FROM tgagor/centos:9 AS build1
+RUN yum install -y wget >/dev/null
+
+FROM build1 AS build2
+ARG package_name
+COPY ./tmp/$package_name .
+RUN yum install -y ./$package_name
+
diff --git a/test/nginx/centos.9-x64.server.dockerfile b/test/nginx/centos.9-x64.server.dockerfile
@@ -0,0 +1,8 @@
+FROM tgagor/centos:9 AS build1
+RUN yum install -y nginx >/dev/null
+COPY index.html /usr/share/nginx/html
+
+FROM build1 AS build2
+ARG package_name
+COPY ./tmp/$package_name .
+RUN yum install -y ./$package_name