pse/adds component only projects (#109)

Adds component only projects
SwissLife-OSS · Jul 19, 2023 · 4e9fd4e · 4e9fd4e
1 parent d1cbefe
commit 4e9fd4e
Show file tree

Hide file tree

Showing 32 changed files with 141 additions and 143 deletions.
diff --git a/src/Confix.Tool/src/Confix.Tool/Configuration/JsonStringEnumCamelCaseConverter.cs b/src/Confix.Tool/src/Confix.Tool/Configuration/JsonStringEnumCamelCaseConverter.cs
diff --git a/src/Confix.Tool/src/Confix.Tool/Entities/Project/Configuration/ProjectConfiguration.cs b/src/Confix.Tool/src/Confix.Tool/Entities/Project/Configuration/ProjectConfiguration.cs
@@ -17,6 +17,7 @@ private static class FieldNames
         public const string ComponentProviders = "componentProviders";
         public const string ConfigurationFiles = "configurationFiles";
         public const string Subprojects = "subprojects";
+        public const string ProjectType = "type";
     }
 
     public ProjectConfiguration(
@@ -28,6 +29,7 @@ public ProjectConfiguration(
         IReadOnlyList<ComponentProviderConfiguration>? componentProviders,
         IReadOnlyList<ConfigurationFileConfiguration>? configurationFiles,
         IReadOnlyList<ProjectConfiguration>? subprojects,
+        string? projectType,
         IReadOnlyList<JsonFile> sourceFiles)
     {
         Name = name;
@@ -38,6 +40,7 @@ public ProjectConfiguration(
         ComponentProviders = componentProviders;
         ConfigurationFiles = configurationFiles;
         Subprojects = subprojects;
+        ProjectType = projectType;
         SourceFiles = sourceFiles;
     }
 
@@ -59,6 +62,8 @@ public ProjectConfiguration(
 
     public IReadOnlyList<JsonFile> SourceFiles { get; }
 
+    public string? ProjectType { get; }
+
     public static ProjectConfiguration Parse(JsonNode? node)
         => Parse(node, Array.Empty<JsonFile>());
 
@@ -118,6 +123,10 @@ public static ProjectConfiguration Parse(JsonNode? node, IReadOnlyList<JsonFile>
             .Select(Parse)
             .ToArray();
 
+        var projectType = obj
+            .MaybeProperty(FieldNames.ProjectType)
+            ?.ExpectValue<string>();
+
         return new ProjectConfiguration(
             name,
             environments,
@@ -127,6 +136,7 @@ public static ProjectConfiguration Parse(JsonNode? node, IReadOnlyList<JsonFile>
             componentProviders,
             configurationFiles,
             subprojects,
+            projectType,
             sourceFiles);
     }
 
@@ -163,6 +173,8 @@ public ProjectConfiguration Merge(ProjectConfiguration? other)
 
         var sourceFiles = SourceFiles.Concat(other.SourceFiles).ToArray();
 
+        var projectType = other.ProjectType ?? ProjectType;
+
         return new ProjectConfiguration(
             name,
             environments,
@@ -172,6 +184,7 @@ public ProjectConfiguration Merge(ProjectConfiguration? other)
             componentProviders,
             configurationFiles,
             subprojects,
+            projectType,
             sourceFiles);
     }
 
@@ -188,5 +201,5 @@ public ProjectConfiguration Merge(ProjectConfiguration? other)
     }
 
     public static ProjectConfiguration Empty { get; } =
-        new(null, null, null, null, null, null, null, null, Array.Empty<JsonFile>());
+        new(null, null, null, null, null, null, null, null, null, Array.Empty<JsonFile>());
 }
diff --git a/src/Confix.Tool/src/Confix.Tool/Entities/Project/ProjectDefintion.cs b/src/Confix.Tool/src/Confix.Tool/Entities/Project/ProjectDefintion.cs
@@ -16,6 +16,7 @@ public ProjectDefinition(
         IReadOnlyList<ComponentProviderDefinition> componentProviders,
         IReadOnlyList<ConfigurationFileDefinition> configurationFiles,
         IReadOnlyList<ProjectDefinition> subprojects,
+        ProjectType projectType,
         DirectoryInfo? directory)
     {
         Name = name;
@@ -26,6 +27,7 @@ public ProjectDefinition(
         ComponentProviders = componentProviders;
         ConfigurationFiles = configurationFiles;
         Subprojects = subprojects;
+        ProjectType = projectType;
         Directory = directory;
     }
 
@@ -45,6 +47,8 @@ public ProjectDefinition(
 
     public IReadOnlyList<ProjectDefinition> Subprojects { get; }
 
+    public ProjectType ProjectType { get; }
+
     [JsonIgnore]
     public DirectoryInfo? Directory { get; }
 
@@ -84,6 +88,12 @@ public static ProjectDefinition From(ProjectConfiguration configuration)
         var subprojects = configuration.Subprojects?.Select(From).ToArray() ??
             Array.Empty<ProjectDefinition>();
 
+        var projectType = configuration.ProjectType switch
+        {
+            "component" => ProjectType.Component,
+            _ => ProjectType.Default
+        };
+
         return new ProjectDefinition(
             name,
             environments,
@@ -93,6 +103,7 @@ public static ProjectDefinition From(ProjectConfiguration configuration)
             componentProviders,
             configurationFiles,
             subprojects,
+            projectType,
             lastConfigurationFile?.File.Directory);
     }
 
@@ -105,5 +116,6 @@ public static ProjectDefinition From(ProjectConfiguration configuration)
         Array.Empty<ComponentProviderDefinition>(),
         Array.Empty<ConfigurationFileDefinition>(),
         Array.Empty<ProjectDefinition>(),
+        ProjectType.Default,
         null);
 }
diff --git a/src/Confix.Tool/src/Confix.Tool/Entities/Project/ProjectType.cs b/src/Confix.Tool/src/Confix.Tool/Entities/Project/ProjectType.cs
@@ -0,0 +1,7 @@
+namespace Confix.Tool.Abstractions;
+
+public enum ProjectType
+{
+    Default,
+    Component
+}
diff --git a/src/Confix.Tool/src/Confix.Tool/Middlewares/Project/BuildComponentsOfProjectMiddleware.cs b/src/Confix.Tool/src/Confix.Tool/Middlewares/Project/BuildComponentsOfProjectMiddleware.cs
@@ -1,3 +1,4 @@
+using Confix.Tool.Abstractions;
 using Confix.Tool.Commands.Component;
 using Confix.Tool.Commands.Logging;
 using Confix.Tool.Commands.Temp;
@@ -32,10 +33,23 @@ public async Task InvokeAsync(IMiddlewareContext context, MiddlewareDelegate nex
             await pipeline.ExecuteAsync(componentContext);
         }
 
-        await next(context);
+        if (!project.IsOnlyComponents() && !context.IsOnlyComponents())
+        {
+            await next(context);
+        }
     }
 }
 
+file static class Extensions
+{
+    public static bool IsOnlyComponents(this IMiddlewareContext context)
+        => context.Parameter.TryGet(OnlyComponentsOption.Instance, out bool onlyComponents) &&
+            onlyComponents;
+
+    public static bool IsOnlyComponents(this ProjectDefinition project)
+        => project.ProjectType == ProjectType.Component;
+}
+
 file static class Log
 {
     public static void LogComponentDetected(

diff --git a/...Tool/src/Confix.Tool/Middlewares/Project/Extensions/BuildComponentsOfProjectExtensions.cs b/...Tool/src/Confix.Tool/Middlewares/Project/Extensions/BuildComponentsOfProjectExtensions.cs
@@ -0,0 +1,14 @@
+using Confix.Tool.Common.Pipelines;
+
+namespace Confix.Tool.Middlewares.Project;
+
+public static class BuildComponentsOfProjectExtensions
+{
+    public static IPipelineDescriptor UseBuildComponentsOfProject(
+        this IPipelineDescriptor descriptor)
+    {
+        descriptor.Use<BuildComponentsOfProjectMiddleware>();
+        descriptor.AddOption(OnlyComponentsOption.Instance);
+        return descriptor;
+    }
+}
diff --git a/src/Confix.Tool/src/Confix.Tool/Options/OnlyComponentsOption.cs b/src/Confix.Tool/src/Confix.Tool/Options/OnlyComponentsOption.cs
@@ -0,0 +1,16 @@
+using System.CommandLine;
+
+namespace Confix.Tool;
+
+public sealed class OnlyComponentsOption : Option<bool>
+{
+    public OnlyComponentsOption() : base(
+        "--only-components",
+        "If you specify this option, only the components will be built.")
+    {
+        IsRequired = false;
+        Arity = ArgumentArity.ZeroOrOne;
+    }
+
+    public static OnlyComponentsOption Instance { get; } = new();
+}
diff --git a/src/Confix.Tool/src/Confix.Tool/Pipelines/Project/ProjectBuildPipeline.cs b/src/Confix.Tool/src/Confix.Tool/Pipelines/Project/ProjectBuildPipeline.cs
@@ -13,7 +13,7 @@ protected override void Configure(IPipelineDescriptor builder)
             .Use<LoadConfigurationMiddleware>()
             .UseReadConfigurationFiles()
             .UseEnvironment()
-            .Use<BuildComponentsOfProjectMiddleware>()
+            .UseBuildComponentsOfProject()
             .UseCompleteWhenNoConfigurationFiles()
             .Use<VariableMiddleware>()
             .Use<BuildProjectMiddleware>()

diff --git a/src/Confix.Tool/src/Confix.Tool/Pipelines/Project/ProjectValidatePipeline.cs b/src/Confix.Tool/src/Confix.Tool/Pipelines/Project/ProjectValidatePipeline.cs
@@ -13,7 +13,7 @@ protected override void Configure(IPipelineDescriptor builder)
             .Use<LoadConfigurationMiddleware>()
             .UseReadConfigurationFiles()
             .UseEnvironment()
-            .Use<BuildComponentsOfProjectMiddleware>()
+            .UseBuildComponentsOfProject()
             .UseCompleteWhenNoConfigurationFiles()
             .Use<VariableMiddleware>()
             .Use<BuildProjectMiddleware>()

diff --git a/src/Confix.Tool/test/Confix.Tool.Tests/Commands/Variables/VariableCopyCommandTests.cs b/src/Confix.Tool/test/Confix.Tool.Tests/Commands/Variables/VariableCopyCommandTests.cs
@@ -104,7 +104,8 @@ public async Task Should_Copy_VariableFromOneProviderToTheOther()
         // Arrange
         using var cli = _cli;
         const string beforeValue = "test";
-        await _first.SetAsync("a.b", beforeValue, CancellationToken.None);
+        var node = (JsonNode?)beforeValue;
+        await _first.SetAsync("a.b", node!, CancellationToken.None);
 
         cli.Directories.Home.CreateConfixRc(_confixRc);
 
@@ -123,7 +124,8 @@ public async Task Should_Copy_VariableFromOneProviderToTheOther_When_DifferentEn
         // Arrange
         using var cli = _cli;
         const string beforeValue = "test";
-        await _first.SetAsync("a.b", beforeValue, CancellationToken.None);
+        var node = (JsonNode?)beforeValue;
+        await _first.SetAsync("a.b", node!, CancellationToken.None);
 
         cli.Directories.Home.CreateConfixRc(_confixRc);
 
@@ -143,7 +145,8 @@ public async Task Should_Fail_When_Environment_DoesNotExists()
         // Arrange
         using var cli = _cli;
         const string beforeValue = "test";
-        await _first.SetAsync("a.b", beforeValue, CancellationToken.None);
+        var node = (JsonNode?)beforeValue;
+        await _first.SetAsync("a.b", node!, CancellationToken.None);
 
         cli.Directories.Home.CreateConfixRc(_confixRc);
 

diff --git a/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Project/ProjectConfigurationTests.cs b/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Project/ProjectConfigurationTests.cs
@@ -162,6 +162,7 @@ public void Merge_Should_ReturnOriginalConfiguration_When_OtherConfigurationIsNu
             new List<ComponentProviderConfiguration>(),
             new List<ConfigurationFileConfiguration>(),
             new List<ProjectConfiguration>(),
+            null,
             Array.Empty<JsonFile>()
         );
 
@@ -215,8 +216,10 @@ public void Merge_Should_ReturnMergedConfiguration_When_OtherConfigurationIsNotN
                     null,
                     null,
                     null,
+                    null,
                     Array.Empty<JsonFile>())
             },
+            null,
             Array.Empty<JsonFile>());
         var other = new ProjectConfiguration(
             "MergedProject",
@@ -257,8 +260,10 @@ public void Merge_Should_ReturnMergedConfiguration_When_OtherConfigurationIsNotN
                     null,
                     null,
                     null,
+                    null,
                     Array.Empty<JsonFile>()),
             },
+            null,
             Array.Empty<JsonFile>()
         );
 
@@ -366,7 +371,7 @@ await File.WriteAllTextAsync(confixRcPath,
 
         var files = new List<JsonFile>
         {
-           await JsonFile.FromFile(new(confixRcPath), default)
+            await JsonFile.FromFile(new(confixRcPath), default)
         };
         // Act
         var result = ProjectConfiguration.LoadFromFiles(files);

diff --git a/....Tests/Entities/Project/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid.snap b/....Tests/Entities/Project/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid.snap
@@ -95,5 +95,6 @@
     }
   ],
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/.../__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentDisabled.snap b/.../__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentDisabled.snap
@@ -15,5 +15,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/...t/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentEnabled.snap b/...t/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentEnabled.snap
@@ -15,5 +15,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/...ct/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentLatest.snap b/...ct/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentLatest.snap
@@ -15,5 +15,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/...t/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentVersion.snap b/...t/__snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_ComponentVersion.snap
@@ -15,5 +15,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/...snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_NonRequiredArMissing.snap b/...snapshots__/ProjectConfigurationTests.Parse_Should_BeValid_When_NonRequiredArMissing.snap
@@ -7,5 +7,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/.../__snapshots__/ProjectConfigurationTests.Parse_Should_ParseSubProjects_When_Provided.snap b/.../__snapshots__/ProjectConfigurationTests.Parse_Should_ParseSubProjects_When_Provided.snap
@@ -7,5 +7,6 @@
   "ComponentProviders": null,
   "ConfigurationFiles": null,
   "Subprojects": null,
-  "SourceFiles": []
+  "SourceFiles": [],
+  "ProjectType": null
 }
diff --git a/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Repositories/RuntimeConfigurationTests.cs b/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Repositories/RuntimeConfigurationTests.cs
@@ -116,6 +116,7 @@ public void Merge_Should_ReturnMergedConfiguration_When_OtherConfigurationIsNotN
                 null,
                 null,
                 null,
+                null,
                 Array.Empty<JsonFile>()),
             new ComponentConfiguration("MergedComponent",
                 new List<ComponentInputConfiguration>(),

diff --git a/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Repositories/SolutionConfigurationTests.cs b/src/Confix.Tool/test/Confix.Tool.Tests/Entities/Repositories/SolutionConfigurationTests.cs
@@ -98,6 +98,7 @@ public void Merge_Should_ReturnMergedConfiguration_When_OtherConfigurationIsNotN
                 null,
                 null,
                 null,
+                null,
                 Array.Empty<JsonFile>()),
             new ComponentConfiguration("MergedComponent",
                 new List<ComponentInputConfiguration>(),

diff --git a/...s/Entities/Repositories/__snapshots__/RuntimeConfigurationTests.Parse_Should_BeValid.snap b/...s/Entities/Repositories/__snapshots__/RuntimeConfigurationTests.Parse_Should_BeValid.snap
@@ -15,7 +15,8 @@
     "ComponentProviders": null,
     "ConfigurationFiles": null,
     "Subprojects": null,
-    "SourceFiles": []
+    "SourceFiles": [],
+    "ProjectType": null
   },
   "Encryption": {
     "Provider": {

diff --git a/.../Entities/Repositories/__snapshots__/SolutionConfigurationTests.Parse_Should_BeValid.snap b/.../Entities/Repositories/__snapshots__/SolutionConfigurationTests.Parse_Should_BeValid.snap
@@ -23,7 +23,8 @@
     "ComponentProviders": null,
     "ConfigurationFiles": null,
     "Subprojects": null,
-    "SourceFiles": []
+    "SourceFiles": [],
+    "ProjectType": null
   },
   "SourceFiles": []
 }
diff --git a/src/Confix.Tool/test/Confix.Tool.Tests/Extensions/CommandLineBuilderExtensions.cs b/src/Confix.Tool/test/Confix.Tool.Tests/Extensions/CommandLineBuilderExtensions.cs
@@ -12,7 +12,7 @@ public static CommandLineBuilder AddTestService<T>(
     {
         builder.AddMiddleware(x =>
             {
-                T cache = default(T);
+                var cache = default(T);
                 x.BindingContext.AddService(sp => cache ??= factory(sp));
             },
             MiddlewareOrder.Configuration + 10);
-Original file line number
+Diff line change
@@ Expand Up @@
                     null,
                     null,
                     null,
+                    null,
                     Array.Empty<JsonFile>()),
                 new ComponentConfiguration("MergedComponent",
                     new List<ComponentInputConfiguration>(),
@@ Expand Down @@