decoupled modules from core and use abstractions instead

arturcic · arturcic · commit 06d76e5e6e83 · 2023-03-28T18:04:18.000+02:00
diff --git a/new-cli/GitVersion.Common/GitVersion.Common.csproj b/new-cli/GitVersion.Common/GitVersion.Common.csproj
@@ -3,64 +3,64 @@
     <PackageReference Include="Polly" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="..\..\src\GitVersion.Core\Git\AuthenticationInfo.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\AuthenticationInfo.cs">
       <Link>Git\AuthenticationInfo.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\CommitFilter.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\CommitFilter.cs">
       <Link>Git\CommitFilter.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IBranch.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IBranch.cs">
       <Link>Git\IBranch.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IBranchCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IBranchCollection.cs">
       <Link>Git\IBranchCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\ICommit.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\ICommit.cs">
       <Link>Git\ICommit.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\ICommitCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\ICommitCollection.cs">
       <Link>Git\ICommitCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IGitObject.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IGitObject.cs">
       <Link>Git\IGitObject.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IGitRepository.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IGitRepository.cs">
       <Link>Git\IGitRepository.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\INamedReference.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\INamedReference.cs">
       <Link>Git\INamedReference.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IObjectId.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IObjectId.cs">
       <Link>Git\IObjectId.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IReference.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IReference.cs">
       <Link>Git\IReference.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IReferenceCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IReferenceCollection.cs">
       <Link>Git\IReferenceCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IRefSpec.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IRefSpec.cs">
       <Link>Git\IRefSpec.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IRefSpecCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IRefSpecCollection.cs">
       <Link>Git\IRefSpecCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IRemote.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IRemote.cs">
       <Link>Git\IRemote.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\IRemoteCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\IRemoteCollection.cs">
       <Link>Git\IRemoteCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\ITag.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\ITag.cs">
       <Link>Git\ITag.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\ITagCollection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\ITagCollection.cs">
       <Link>Git\ITagCollection.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\ReferenceName.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\ReferenceName.cs">
       <Link>Git\ReferenceName.cs</Link>
     </Compile>
-    <Compile Include="..\..\src\GitVersion.Core\Git\RefSpecDirection.cs">
+    <Compile Include="..\..\src\GitVersion.Abstractions\Git\RefSpecDirection.cs">
       <Link>Git\RefSpecDirection.cs</Link>
     </Compile>
   </ItemGroup>
diff --git a/src/GitVersion.Abstractions/Agents/BuildAgentBase.cs b/src/GitVersion.Abstractions/Agents/BuildAgentBase.cs
@@ -7,12 +7,12 @@ namespace GitVersion.Agents;
 public abstract class BuildAgentBase : ICurrentBuildAgent
 {
     protected readonly ILog Log;
-    protected IEnvironment Environment { get; }
+    protected IEnvironment Environment;
 
     protected BuildAgentBase(IEnvironment environment, ILog log)
     {
         this.Log = log;
-        Environment = environment;
+        this.Environment = environment;
     }
 
     protected abstract string EnvironmentVariable { get; }
diff --git a/src/GitVersion.Abstractions/Common/IGitVersionModule.cs b/src/GitVersion.Abstractions/Common/IGitVersionModule.cs
@@ -1,8 +1,17 @@
+using GitVersion.Extensions;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace GitVersion;
 
 public interface IGitVersionModule
 {
     void RegisterTypes(IServiceCollection services);
+
+    static IEnumerable<Type> FindAllDerivedTypes<T>(Assembly? assembly)
+    {
+        assembly.NotNull();
+
+        var derivedType = typeof(T);
+        return assembly.GetTypes().Where(t => t != derivedType && derivedType.IsAssignableFrom(t));
+    }
 }
diff --git a/src/GitVersion.Abstractions/Common/Models/LogAction.cs b/src/GitVersion.Abstractions/Common/Models/LogAction.cs
diff --git a/src/GitVersion.Abstractions/Extensions/Disposable.cs b/src/GitVersion.Abstractions/Extensions/Disposable.cs
diff --git a/src/GitVersion.Abstractions/Extensions/GitVersionVariablesExtensions.cs b/src/GitVersion.Abstractions/Extensions/GitVersionVariablesExtensions.cs
@@ -0,0 +1,52 @@
+using System.Text.Encodings.Web;
+using GitVersion.OutputVariables;
+
+namespace GitVersion.Extensions;
+
+public static class GitVersionVariablesExtensions
+{
+    public static string ToJsonString(this GitVersionVariables gitVersionVariables)
+    {
+        var variablesType = typeof(VersionVariablesJsonModel);
+        var variables = new VersionVariablesJsonModel();
+
+        foreach (var (key, value) in gitVersionVariables.OrderBy(x => x.Key))
+        {
+            var propertyInfo = variablesType.GetProperty(key);
+            propertyInfo?.SetValue(variables, ChangeType(value, propertyInfo.PropertyType));
+        }
+
+        var serializeOptions = GetJsonSerializerOptions();
+
+        return JsonSerializer.Serialize(variables, serializeOptions);
+    }
+
+    public static JsonSerializerOptions GetJsonSerializerOptions()
+    {
+        var serializeOptions = new JsonSerializerOptions
+        {
+            WriteIndented = true,
+            Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping,
+            Converters =
+            {
+                new VersionVariablesJsonStringConverter()
+            }
+        };
+        return serializeOptions;
+    }
+
+    private static object? ChangeType(object? value, Type type)
+    {
+        if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>))
+        {
+            if (value == null || value.ToString()?.Length == 0)
+            {
+                return null;
+            }
+
+            type = Nullable.GetUnderlyingType(type)!;
+        }
+
+        return Convert.ChangeType(value, type);
+    }
+}
diff --git a/src/GitVersion.Abstractions/Extensions/LogExtensions.cs b/src/GitVersion.Abstractions/Extensions/LogExtensions.cs
diff --git a/src/GitVersion.Abstractions/Extensions/ReadEmbeddedResourceExtensions.cs b/src/GitVersion.Abstractions/Extensions/ReadEmbeddedResourceExtensions.cs
diff --git a/src/GitVersion.Abstractions/Extensions/StringExtensions.cs b/src/GitVersion.Abstractions/Extensions/StringExtensions.cs
@@ -1,5 +1,6 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Text.RegularExpressions;
+using GitVersion.Helpers;
 
 namespace GitVersion.Extensions;
 
@@ -19,15 +20,15 @@ public static bool IsValidPath(this string? path)
 
         try
         {
-            _ = Path.GetFullPath(path);
+            _ = PathHelper.GetFullPath(path);
         }
         catch
         {
-            path = Path.Combine(Environment.CurrentDirectory, path);
+            path = PathHelper.Combine(Environment.CurrentDirectory, path);
 
             try
             {
-                _ = Path.GetFullPath(path);
+                _ = PathHelper.GetFullPath(path);
             }
             catch
             {
diff --git a/src/GitVersion.Abstractions/GitVersion.Abstractions.csproj b/src/GitVersion.Abstractions/GitVersion.Abstractions.csproj
@@ -10,6 +10,7 @@
 
     <ItemGroup>
       <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" />
+      <PackageReference Include="Microsoft.Extensions.Options" />
       <PackageReference Include="Polly" />
     </ItemGroup>
 
diff --git a/src/GitVersion.Abstractions/Helpers/PathHelper.cs b/src/GitVersion.Abstractions/Helpers/PathHelper.cs
diff --git a/src/GitVersion.Abstractions/Output/VersionVariablesJsonModel.cs b/src/GitVersion.Abstractions/Output/VersionVariablesJsonModel.cs
diff --git a/src/GitVersion.Abstractions/Output/VersionVariablesJsonStringConverter.cs b/src/GitVersion.Abstractions/Output/VersionVariablesJsonStringConverter.cs
diff --git a/src/GitVersion.BuildAgents/GitVersion.BuildAgents.csproj b/src/GitVersion.BuildAgents/GitVersion.BuildAgents.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <ItemGroup>
-        <ProjectReference Include="..\GitVersion.Core\GitVersion.Core.csproj"/>
+        <ProjectReference Include="..\GitVersion.Abstractions\GitVersion.Abstractions.csproj"/>
     </ItemGroup>
     <ItemGroup>
         <InternalsVisibleTo Include="GitVersion.App.Tests"/>
diff --git a/src/GitVersion.BuildAgents/GitVersionBuildAgentsModule.cs b/src/GitVersion.BuildAgents/GitVersionBuildAgentsModule.cs
@@ -2,11 +2,11 @@
 
 namespace GitVersion.Agents;
 
-public class GitVersionBuildAgentsModule : GitVersionModule
+public class GitVersionBuildAgentsModule : IGitVersionModule
 {
-    public override void RegisterTypes(IServiceCollection services)
+    public void RegisterTypes(IServiceCollection services)
     {
-        var buildAgents = FindAllDerivedTypes<BuildAgentBase>(Assembly.GetAssembly(GetType()));
+        var buildAgents = IGitVersionModule.FindAllDerivedTypes<BuildAgentBase>(Assembly.GetAssembly(GetType()));
 
         foreach (var buildAgent in buildAgents)
         {
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/JsonVersionBuilderTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/JsonVersionBuilderTests.cs
@@ -1,5 +1,5 @@
 using GitVersion.Core.Tests.Helpers;
-using GitVersion.OutputVariables;
+using GitVersion.Extensions;
 using GitVersion.VersionCalculation;
 using Microsoft.Extensions.DependencyInjection;
 
diff --git a/src/GitVersion.Core.Tests/VersionCalculation/VariableProviderTests.cs b/src/GitVersion.Core.Tests/VersionCalculation/VariableProviderTests.cs
@@ -1,6 +1,6 @@
 using GitVersion.Core.Tests.Helpers;
+using GitVersion.Extensions;
 using GitVersion.Logging;
-using GitVersion.OutputVariables;
 using GitVersion.VersionCalculation;
 using Microsoft.Extensions.DependencyInjection;
 
diff --git a/src/GitVersion.Core/Configuration/Init/GitVersionInitModule.cs b/src/GitVersion.Core/Configuration/Init/GitVersionInitModule.cs
@@ -3,14 +3,14 @@
 
 namespace GitVersion.Configuration.Init;
 
-public class GitVersionInitModule : GitVersionModule
+public class GitVersionInitModule : IGitVersionModule
 {
-    public override void RegisterTypes(IServiceCollection services)
+    public void RegisterTypes(IServiceCollection services)
     {
         services.AddTransient<IConfigInitWizard, ConfigInitWizard>();
         services.AddTransient<IConfigInitStepFactory, ConfigInitStepFactory>();
 
-        var steps = FindAllDerivedTypes<ConfigInitWizardStep>(Assembly.GetAssembly(GetType()));
+        var steps = IGitVersionModule.FindAllDerivedTypes<ConfigInitWizardStep>(Assembly.GetAssembly(GetType()));
 
         foreach (var step in steps)
         {
diff --git a/src/GitVersion.Core/Core/GitVersionModule.cs b/src/GitVersion.Core/Core/GitVersionModule.cs
diff --git a/src/GitVersion.Core/Helpers/VersionVariablesHelper.cs b/src/GitVersion.Core/Helpers/VersionVariablesHelper.cs
@@ -1,4 +1,3 @@
-using System.Text.Encodings.Web;
 using GitVersion.Extensions;
 using GitVersion.Helpers;
 using YamlDotNet.Serialization;
@@ -9,7 +8,7 @@ public static class VersionVariablesHelper
 {
     public static GitVersionVariables FromJson(string json)
     {
-        var serializeOptions = JsonSerializerOptions();
+        var serializeOptions = GitVersionVariablesExtensions.GetJsonSerializerOptions();
         var variablePairs = JsonSerializer.Deserialize<Dictionary<string, string>>(json, serializeOptions);
         return FromDictionary(variablePairs);
     }
@@ -33,22 +32,6 @@ public static GitVersionVariables FromFile(string filePath, IFileSystem fileSyst
         }
     }
 
-    public static string ToJsonString(this GitVersionVariables gitVersionVariables)
-    {
-        var variablesType = typeof(VersionVariablesJsonModel);
-        var variables = new VersionVariablesJsonModel();
-
-        foreach (var (key, value) in gitVersionVariables.OrderBy(x => x.Key))
-        {
-            var propertyInfo = variablesType.GetProperty(key);
-            propertyInfo?.SetValue(variables, ChangeType(value, propertyInfo.PropertyType));
-        }
-
-        var serializeOptions = JsonSerializerOptions();
-
-        return JsonSerializer.Serialize(variables, serializeOptions);
-    }
-
     private static GitVersionVariables FromDictionary(IEnumerable<KeyValuePair<string, string>>? properties)
     {
         var type = typeof(GitVersionVariables);
@@ -71,25 +54,4 @@ private static GitVersionVariables FromFileInternal(string filePath, IFileSystem
         var versionVariables = FromDictionary(dictionary);
         return versionVariables;
     }
-
-    private static JsonSerializerOptions JsonSerializerOptions()
-    {
-        var serializeOptions = new JsonSerializerOptions { WriteIndented = true, Encoder = JavaScriptEncoder.UnsafeRelaxedJsonEscaping, Converters = { new VersionVariablesJsonStringConverter() } };
-        return serializeOptions;
-    }
-
-    private static object? ChangeType(object? value, Type type)
-    {
-        if (type.IsGenericType && type.GetGenericTypeDefinition() == typeof(Nullable<>))
-        {
-            if (value == null || value.ToString()?.Length == 0)
-            {
-                return null;
-            }
-
-            type = Nullable.GetUnderlyingType(type)!;
-        }
-
-        return Convert.ChangeType(value, type);
-    }
 }
diff --git a/src/GitVersion.Core/VersionCalculation/BaseVersionCalculators/VersionStrategyModule.cs b/src/GitVersion.Core/VersionCalculation/BaseVersionCalculators/VersionStrategyModule.cs
@@ -2,11 +2,11 @@
 
 namespace GitVersion.VersionCalculation;
 
-public class VersionStrategyModule : GitVersionModule
+public class VersionStrategyModule : IGitVersionModule
 {
-    public override void RegisterTypes(IServiceCollection services)
+    public void RegisterTypes(IServiceCollection services)
     {
-        var versionStrategies = FindAllDerivedTypes<IVersionStrategy>(Assembly.GetAssembly(GetType()))
+        var versionStrategies = IGitVersionModule.FindAllDerivedTypes<IVersionStrategy>(Assembly.GetAssembly(GetType()))
             .Where(x => x is { IsAbstract: false, IsInterface: false });
 
         foreach (var versionStrategy in versionStrategies)
diff --git a/src/GitVersion.LibGit2Sharp/Git/GitRepository.extended.cs b/src/GitVersion.LibGit2Sharp/Git/GitRepository.extended.cs
@@ -92,7 +92,7 @@ private DirectReference GetPullRequestReference(AuthenticationInfo auth, LibGit2
                 : network.ListReferences(remote))
             .Select(r => r.ResolveToDirectReference()).ToList();
 
-        this.log.Info($"Remote Refs:{System.Environment.NewLine}" + string.Join(System.Environment.NewLine, remoteTips.Select(r => r.CanonicalName)));
+        this.log.Info($"Remote Refs:{Environment.NewLine}" + string.Join(Environment.NewLine, remoteTips.Select(r => r.CanonicalName)));
         var refs = remoteTips.Where(r => r.TargetIdentifier == headTipSha).ToList();
 
         switch (refs.Count)
diff --git a/src/GitVersion.LibGit2Sharp/GitVersion.LibGit2Sharp.csproj b/src/GitVersion.LibGit2Sharp/GitVersion.LibGit2Sharp.csproj
@@ -5,7 +5,7 @@
     </ItemGroup>
 
     <ItemGroup>
-        <ProjectReference Include="..\GitVersion.Core\GitVersion.Core.csproj" />
+        <ProjectReference Include="..\GitVersion.Abstractions\GitVersion.Abstractions.csproj"/>
     </ItemGroup>
 
     <ItemGroup>
diff --git a/src/GitVersion.Output/GitVersion.Output.csproj b/src/GitVersion.Output/GitVersion.Output.csproj
@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <ItemGroup>
-        <ProjectReference Include="..\GitVersion.Core\GitVersion.Core.csproj" />
+        <ProjectReference Include="..\GitVersion.Abstractions\GitVersion.Abstractions.csproj" />
     </ItemGroup>
     <ItemGroup>
         <Compile Remove="*\AddFormats\**\*.*" />
diff --git a/src/GitVersion.Output/GitVersionInfo/GitVersionInfoGenerator.cs b/src/GitVersion.Output/GitVersionInfo/GitVersionInfoGenerator.cs
@@ -42,7 +42,7 @@ public void Execute(GitVersionVariables variables, GitVersionInfoContext context
         var indentation = GetIndentation(fileExtension);
 
         var lines = variables.OrderBy(x => x.Key).Select(v => string.Format(indentation + addFormat, v.Key, v.Value));
-        var members = string.Join(System.Environment.NewLine, lines);
+        var members = string.Join(Environment.NewLine, lines);
 
         var fileContents = string.Format(template, members);
 

Original file line number	Diff line number	Diff line change
`@@ -7,12 +7,12 @@ namespace GitVersion.Agents;`
`7`	`7`	`public abstract class BuildAgentBase : ICurrentBuildAgent`
`8`	`8`	`{`
`9`	`9`	`protected readonly ILog Log;`
`10`		`- protected IEnvironment Environment { get; }`
	`10`	`+ protected IEnvironment Environment;`
`11`	`11`
`12`	`12`	`protected BuildAgentBase(IEnvironment environment, ILog log)`
`13`	`13`	`{`
`14`	`14`	`this.Log = log;`
`15`		`- Environment = environment;`
	`15`	`+ this.Environment = environment;`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`protected abstract string EnvironmentVariable { get; }`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System.Diagnostics.CodeAnalysis;`
`2`	`2`	`using System.Text.RegularExpressions;`
	`3`	`+using GitVersion.Helpers;`
`3`	`4`
`4`	`5`	`namespace GitVersion.Extensions;`
`5`	`6`
`@@ -19,15 +20,15 @@ public static bool IsValidPath(this string? path)`
`19`	`20`
`20`	`21`	`try`
`21`	`22`	`{`
`22`		`- _ = Path.GetFullPath(path);`
	`23`	`+ _ = PathHelper.GetFullPath(path);`
`23`	`24`	`}`
`24`	`25`	`catch`
`25`	`26`	`{`
`26`		`- path = Path.Combine(Environment.CurrentDirectory, path);`
	`27`	`+ path = PathHelper.Combine(Environment.CurrentDirectory, path);`
`27`	`28`
`28`	`29`	`try`
`29`	`30`	`{`
`30`		`- _ = Path.GetFullPath(path);`
	`31`	`+ _ = PathHelper.GetFullPath(path);`
`31`	`32`	`}`
`32`	`33`	`catch`
`33`	`34`	`{`