Add service.withPrivileged (#74)

* Add merge_group for PR CI * Update langversion * Use string literal * Configure line endings * Add WithPrivileged * Drop not necessary casting * Add PolySharp * Resolve code warnings
aviationexam · Oct 18, 2023 · a436951 · a436951
1 parent d315a64
commit a436951
Show file tree

Hide file tree

Showing 14 changed files with 98 additions and 40 deletions.
diff --git a/.github/workflows/pr-build.yml b/.github/workflows/pr-build.yml
@@ -6,6 +6,7 @@ on:
       - opened
       - synchronize
       - reopened
+  merge_group:
 
 jobs:
   unit-test:

diff --git a/src/DockerComposeBuilder.Examples.Complex/DockerComposeBuilder.Examples.Complex.csproj b/src/DockerComposeBuilder.Examples.Complex/DockerComposeBuilder.Examples.Complex.csproj
@@ -4,7 +4,7 @@
     <OutputType>Exe</OutputType>
     <TargetFramework>net7.0</TargetFramework>
     <Nullable>enable</Nullable>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>11.0</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

diff --git a/src/DockerComposeBuilder.Tests/ComposeBuilderTests.cs b/src/DockerComposeBuilder.Tests/ComposeBuilderTests.cs
@@ -17,8 +17,11 @@ public void EmptyComposeBuilderTest()
         var result = compose.Serialize();
 
         Assert.Equal(
-            @"version: ""3.8""
-", result
+            """
+            version: "3.8"
+
+            """,
+            result
         );
     }
 
@@ -35,11 +38,41 @@ public void ServiceWithImageTest()
         var result = compose.Serialize();
 
         Assert.Equal(
-            @"version: ""3.8""
-services:
-  a-service:
-    image: ""aviationexam/a-service""
-", result);
+            """
+            version: "3.8"
+            services:
+              a-service:
+                image: "aviationexam/a-service"
+
+            """,
+            result
+        );
+    }
+
+    [Fact]
+    public void PrivilegedServiceWithImageTest()
+    {
+        var compose = Builder.MakeCompose()
+            .WithServices(Builder.MakeService("a-service")
+                .WithImage("aviationexam/a-service")
+                .WithPrivileged()
+                .Build()
+            )
+            .Build();
+
+        var result = compose.Serialize();
+
+        Assert.Equal(
+            """
+            version: "3.8"
+            services:
+              a-service:
+                image: "aviationexam/a-service"
+                privileged: true
+
+            """,
+            result
+        );
     }
 
     [Fact]
@@ -58,13 +91,17 @@ public void ServiceWithBuildTest()
         var result = compose.Serialize();
 
         Assert.Equal(
-            @"version: ""3.8""
-services:
-  a-service:
-    image: ""aviationexam/a-service""
-    build:
-      dockerfile: ""a.dockerfile""
-", result);
+            """
+            version: "3.8"
+            services:
+              a-service:
+                image: "aviationexam/a-service"
+                build:
+                  dockerfile: "a.dockerfile"
+
+            """,
+            result
+        );
     }
 
     [Fact]
@@ -89,17 +126,21 @@ public void ServiceWithBuildArgumentsTest()
         var result = compose.Serialize();
 
         Assert.Equal(
-            @"version: ""3.8""
-services:
-  a-service:
-    image: ""aviationexam/a-service""
-    build:
-      context: "".""
-      dockerfile: ""a.dockerfile""
-      args:
-      - ""ENV_1""
-      - ""ENV_2=value""
-      - ""ENV_3=value""
-", result);
+            """
+            version: "3.8"
+            services:
+              a-service:
+                image: "aviationexam/a-service"
+                build:
+                  context: "."
+                  dockerfile: "a.dockerfile"
+                  args:
+                  - "ENV_1"
+                  - "ENV_2=value"
+                  - "ENV_3=value"
+
+            """,
+            result
+        );
     }
 }
diff --git a/src/DockerComposeBuilder.Tests/DockerComposeBuilder.Tests.csproj b/src/DockerComposeBuilder.Tests/DockerComposeBuilder.Tests.csproj
@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>net7.0</TargetFramework>
     <Nullable>enable</Nullable>
-    <LangVersion>10</LangVersion>
+    <LangVersion>11</LangVersion>
     <IsPackable>false</IsPackable>
   </PropertyGroup>
 

diff --git a/src/DockerComposeBuilder/Builders/ComposeBuilder.cs b/src/DockerComposeBuilder/Builders/ComposeBuilder.cs
@@ -77,7 +77,7 @@ public ComposeBuilder WithVolumes(params Volume[] volumes)
 
             foreach (var volume in volumes)
             {
-                if (WorkingObject.Volumes.ContainsKey(volume.Name))
+                if (WorkingObject.Volumes!.ContainsKey(volume.Name))
                 {
                     throw new Exception("Volume name already added to volumes, please pick a unique one!");
                 }

diff --git a/src/DockerComposeBuilder/Builders/ServiceBuilder.cs b/src/DockerComposeBuilder/Builders/ServiceBuilder.cs
@@ -34,7 +34,7 @@ public ServiceBuilder WithDependencies(params string[] services)
         {
             WorkingObject.DependsOn ??= new List<string>();
 
-            var dependsOnList = WorkingObject.DependsOn as List<string>;
+            var dependsOnList = WorkingObject.DependsOn;
 
             dependsOnList?.AddRange(services);
             return this;
@@ -129,6 +129,12 @@ public ServiceBuilder WithImage(string image)
             return this;
         }
 
+        public ServiceBuilder WithPrivileged(bool? privileged = true)
+        {
+            WorkingObject.Privileged = privileged;
+            return this;
+        }
+
         public ServiceBuilder WithNetworks(params string[] networks)
         {
             if (WorkingObject.Networks == null)

diff --git a/src/DockerComposeBuilder/Builders/Services/BuildBuilder.cs b/src/DockerComposeBuilder/Builders/Services/BuildBuilder.cs
@@ -6,7 +6,7 @@ namespace DockerComposeBuilder.Builders.Services;
 
 public class BuildBuilder : BaseBuilder<BuildBuilder, ServiceBuild>
 {
-    private BuildArgumentBuilder? _buildArgumentBuilder = null;
+    private BuildArgumentBuilder? _buildArgumentBuilder;
 
     public BuildBuilder WithContext(string context)
     {

diff --git a/src/DockerComposeBuilder/DockerComposeBuilder.csproj b/src/DockerComposeBuilder/DockerComposeBuilder.csproj
@@ -11,13 +11,14 @@
     <PackageProjectUrl>https://github.com/aviationexam/docker-compose-builder</PackageProjectUrl>
     <RepositoryUrl>https://github.com/aviationexam/docker-compose-builder</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>11.0</LangVersion>
     <PackageTags>Docker Docker-Compose Builder</PackageTags>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
     <Nullable>annotations</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="PolySharp" Version="1.13.2" PrivateAssets="all" />
     <PackageReference Include="YamlDotNet" Version="13.7.1" />
   </ItemGroup>
 

diff --git a/src/DockerComposeBuilder/Emitters/FlowStringEnumConverter.cs b/src/DockerComposeBuilder/Emitters/FlowStringEnumConverter.cs
@@ -17,9 +17,9 @@ IEventEmitter nextEmitter
 
         public override void Emit(ScalarEventInfo eventInfo, IEmitter emitter)
         {
-            if (eventInfo.Source.Type.IsEnum && eventInfo.Source.Value is { } value)
+            if (eventInfo.Source.Type is { IsEnum: true } sourceType && eventInfo.Source.Value is { } value)
             {
-                var enumMember = eventInfo.Source.Type.GetMember(eventInfo.Source.Value.ToString()).FirstOrDefault();
+                var enumMember = sourceType.GetMember(value.ToString()!).FirstOrDefault();
                 var yamlValue = enumMember?.GetCustomAttributes<EnumMemberAttribute>(true).Select(ema => ema.Value).FirstOrDefault() ?? value.ToString();
 
                 eventInfo = new ScalarEventInfo(new ObjectDescriptor(

diff --git a/src/DockerComposeBuilder/Emitters/YamlIEnumerableSkipEmptyObjectGraphVisitor.cs b/src/DockerComposeBuilder/Emitters/YamlIEnumerableSkipEmptyObjectGraphVisitor.cs
@@ -18,7 +18,7 @@ public override bool EnterMapping(IPropertyDescriptor key, IObjectDescriptor val
 
             if (value.Value == null)
             {
-                return retVal;
+                return false;
             }
 
             if (value.Value is IEnumerable enumerableObject)

diff --git a/...seBuilder/Extensions/IObjectExtensions.cs → ...seBuilder/Extensions/ComposeExtensions.cs b/...seBuilder/Extensions/IObjectExtensions.cs → ...seBuilder/Extensions/ComposeExtensions.cs
@@ -7,7 +7,7 @@ namespace DockerComposeBuilder.Extensions
 {
     public static class ComposeExtensions
     {
-        public static string Serialize(this Compose serializable)
+        public static string Serialize(this Compose serializable, string lineEndings = "\n")
         {
             var serializer = new SerializerBuilder()
                 .WithTypeConverter(new YamlValueCollectionConverter())
@@ -16,6 +16,7 @@ public static string Serialize(this Compose serializable)
                 .WithEventEmitter(nextEmitter => new FlowStringEnumConverter(nextEmitter))
                 .WithEventEmitter(nextEmitter => new ForceQuotedStringValuesEventEmitter(nextEmitter))
                 .WithEmissionPhaseObjectGraphVisitor(args => new YamlIEnumerableSkipEmptyObjectGraphVisitor(args.InnerVisitor))
+                .WithNewLine(lineEndings)
                 .Build();
 
             return serializer.Serialize(serializable);

diff --git a/src/DockerComposeBuilder/Model/Base/ObjectBase.cs b/src/DockerComposeBuilder/Model/Base/ObjectBase.cs
@@ -1,6 +1,7 @@
 using DockerComposeBuilder.Interfaces;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using YamlDotNet.Serialization;
 
 namespace DockerComposeBuilder.Model.Base
@@ -9,7 +10,7 @@ namespace DockerComposeBuilder.Model.Base
     public class ObjectBase : Dictionary<string, object>, IObject
     {
         [YamlIgnore]
-        public string Name { get; set; }
+        public string Name { get; set; } = null!;
 
         public T SetProperty<T>(string property, T value)
         {
@@ -23,7 +24,11 @@ public T SetProperty<T>(string property, T value)
             return value;
         }
 
-        public bool TryGetProperty<T>(string property, out T result) where T : class
+        public bool TryGetProperty<T>(
+            string property,
+            [NotNullWhen(true)]
+            out T? result
+        ) where T : class
         {
             if (ContainsKey(property))
             {
@@ -35,7 +40,7 @@ public bool TryGetProperty<T>(string property, out T result) where T : class
             return false;
         }
 
-        public T GetProperty<T>(string property) where T : class
+        public T? GetProperty<T>(string property) where T : class
         {
             TryGetProperty<T>(property, out var result);
             return result;

diff --git a/src/DockerComposeBuilder/Model/PlacementPreferences.cs b/src/DockerComposeBuilder/Model/PlacementPreferences.cs
@@ -8,7 +8,7 @@ public class PlacementPreferences : ObjectBase
     {
         public string Spread
         {
-            get => GetProperty<string>("spread");
+            get => GetProperty<string>("spread")!;
             set => SetProperty("spread", value);
         }
     }

diff --git a/src/DockerComposeBuilder/Model/Service.cs b/src/DockerComposeBuilder/Model/Service.cs
@@ -18,6 +18,9 @@ public class Service
         [YamlMember(Alias = "image")]
         public string? Image { get; set; }
 
+        [YamlMember(Alias = "privileged")]
+        public bool? Privileged { get; set; }
+
         [YamlMember(Alias = "build")]
         public ServiceBuild? Build { get; set; }