Merge pull request #4340 from arturcic/feature/filesystem

Improve IFileSystem usage in the app (part 1)

Author: arturcic

src/GitVersion.App.Tests/ArgumentParserTests.cs

@@ -12,6 +12,7 @@ public class ArgumentParserTests : TestBase
 {
     private IEnvironment environment;
     private IArgumentParser argumentParser;
+    private IFileSystem fileSystem;
 
     [SetUp]
     public void SetUp()
@@ -23,6 +24,7 @@ public void SetUp()
         });
         this.environment = sp.GetRequiredService<IEnvironment>();
         this.argumentParser = sp.GetRequiredService<IArgumentParser>();
+        this.fileSystem = sp.GetRequiredService<IFileSystem>();
     }
 
     [Test]
@@ -337,7 +339,8 @@ public void UpdateAssemblyInfoWithMultipleFilenamesMatchingGlobbing()
         using var file2 = File.Create(assemblyFile2);
 
         var subdir = PathHelper.Combine(repo.RepositoryPath, "subdir");
-        Directory.CreateDirectory(subdir);
+
+        this.fileSystem.CreateDirectory(subdir);
         var assemblyFile3 = PathHelper.Combine(subdir, "LocalAssemblyInfo.cs");
         using var file3 = File.Create(assemblyFile3);
 
@@ -358,7 +361,7 @@ public void UpdateAssemblyInfoWithRelativeFilename()
         using var file = File.Create(assemblyFile);
 
         var targetPath = PathHelper.Combine(repo.RepositoryPath, "subdir1", "subdir2");
-        Directory.CreateDirectory(targetPath);
+        this.fileSystem.CreateDirectory(targetPath);
 
         var arguments = this.argumentParser.ParseArguments($"-targetpath {targetPath} -updateAssemblyInfo ..\\..\\CommonAssemblyInfo.cs");
         arguments.UpdateAssemblyInfo.ShouldBe(true);

src/GitVersion.App.Tests/GitVersion.App.Tests.csproj

@@ -19,9 +19,7 @@
         <Compile Include="..\GitVersion.Core.Tests\Helpers\ExecutableHelper.cs" Link="Helpers\ExecutableHelper.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestConsoleAdapter.cs" Link="Helpers\TestConsoleAdapter.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestEnvironment.cs" Link="Helpers\TestEnvironment.cs" />
-        <Compile Include="..\GitVersion.Core.Tests\Helpers\TestFileSystem.cs" Link="Helpers\TestFileSystem.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestLogAppender.cs" Link="Helpers\TestLogAppender.cs" />
-        <Compile Include="..\GitVersion.Core.Tests\Helpers\TestStream.cs" Link="Helpers\TestStream.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\TestBase.cs" Link="Helpers\TestBase.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Helpers\GitVersionCoreTestModule.cs" Link="Helpers\GitVersionCoreTestModule.cs" />
         <Compile Include="..\GitVersion.Core.Tests\Extensions\GitVersionVariablesExtensions.cs" Link="Extensions\GitVersionVariablesExtensions.cs" />

src/GitVersion.App/ArgumentParser.cs

@@ -6,10 +6,15 @@
 
 namespace GitVersion;
 
-internal class ArgumentParser(IEnvironment environment, ICurrentBuildAgent buildAgent, IConsole console, IGlobbingResolver globbingResolver)
+internal class ArgumentParser(IEnvironment environment,
+                              IFileSystem fileSystem,
+                              ICurrentBuildAgent buildAgent,
+                              IConsole console,
+                              IGlobbingResolver globbingResolver)
     : IArgumentParser
 {
     private readonly IEnvironment environment = environment.NotNull();
+    private readonly IFileSystem fileSystem = fileSystem.NotNull();
     private readonly ICurrentBuildAgent buildAgent = buildAgent.NotNull();
     private readonly IConsole console = console.NotNull();
     private readonly IGlobbingResolver globbingResolver = globbingResolver.NotNull();
@@ -97,19 +102,19 @@ public Arguments ParseArguments(string[] commandLineArguments)
         return arguments;
     }
 
-    private static void ValidateConfigurationFile(Arguments arguments)
+    private void ValidateConfigurationFile(Arguments arguments)
     {
         if (arguments.ConfigurationFile.IsNullOrWhiteSpace()) return;
 
         if (Path.IsPathRooted(arguments.ConfigurationFile))
         {
-            if (!File.Exists(arguments.ConfigurationFile)) throw new WarningException($"Could not find config file at '{arguments.ConfigurationFile}'");
+            if (!this.fileSystem.Exists(arguments.ConfigurationFile)) throw new WarningException($"Could not find config file at '{arguments.ConfigurationFile}'");
             arguments.ConfigurationFile = Path.GetFullPath(arguments.ConfigurationFile);
         }
         else
         {
             var configFilePath = Path.GetFullPath(PathHelper.Combine(arguments.TargetPath, arguments.ConfigurationFile));
-            if (!File.Exists(configFilePath)) throw new WarningException($"Could not find config file at '{configFilePath}'");
+            if (!this.fileSystem.Exists(configFilePath)) throw new WarningException($"Could not find config file at '{configFilePath}'");
             arguments.ConfigurationFile = configFilePath;
         }
     }
@@ -161,7 +166,7 @@ private void ParseTargetPath(Arguments arguments, string? name, IReadOnlyList<st
         {
             EnsureArgumentValueCount(values);
             arguments.TargetPath = value;
-            if (!Directory.Exists(value))
+            if (string.IsNullOrWhiteSpace(value) || !this.fileSystem.DirectoryExists(value))
             {
                 this.console.WriteLine($"The working directory '{value}' does not exist.");
             }

src/GitVersion.App/GitVersionExecutor.cs

@@ -8,6 +8,7 @@ namespace GitVersion;
 
 internal class GitVersionExecutor(
     ILog log,
+    IFileSystem fileSystem,
     IConsole console,
     IVersionWriter versionWriter,
     IHelpWriter helpWriter,
@@ -21,6 +22,7 @@ internal class GitVersionExecutor(
     : IGitVersionExecutor
 {
     private readonly ILog log = log.NotNull();
+    private readonly IFileSystem fileSystem = fileSystem.NotNull();
     private readonly IConsole console = console.NotNull();
     private readonly IVersionWriter versionWriter = versionWriter.NotNull();
     private readonly IHelpWriter helpWriter = helpWriter.NotNull();
@@ -131,7 +133,7 @@ private bool HandleNonMainCommand(GitVersionOptions gitVersionOptions, out int e
             GitExtensions.DumpGraphLog(logMessage => this.log.Info(logMessage));
         }
 
-        if (!Directory.Exists(workingDirectory))
+        if (!this.fileSystem.DirectoryExists(workingDirectory))
         {
             this.log.Warning($"The working directory '{workingDirectory}' does not exist.");
         }

src/GitVersion.Configuration.Tests/Configuration/ConfigurationProviderTests.cs

@@ -285,7 +285,8 @@ public void NoWarnOnGitVersionYmlFile()
 
         this.configurationProvider.ProvideForDirectory(this.repoPath);
 
-        stringLogger.Length.ShouldBe(0);
+        var filePath = PathHelper.Combine(this.repoPath, ConfigurationFileLocator.DefaultFileName);
+        stringLogger.ShouldContain($"Found configuration file at '{filePath}'");
     }
 
     [Test]

src/GitVersion.Configuration.Tests/Configuration/Extensions.cs

@@ -13,6 +13,12 @@ public static IDisposable<string> SetupConfigFile(this IFileSystem fileSystem, s
         }
 
         var fullPath = PathHelper.Combine(path, fileName);
+        var directory = PathHelper.GetDirectoryName(fullPath);
+        if (!fileSystem.DirectoryExists(directory))
+        {
+            fileSystem.CreateDirectory(directory);
+        }
+
         fileSystem.WriteAllText(fullPath, text);
 
         return Disposable.Create(fullPath, () => fileSystem.Delete(fullPath));

src/GitVersion.Configuration/ConfigurationProvider.cs

@@ -21,7 +21,7 @@ public IGitVersionConfiguration Provide(IReadOnlyDictionary<object, object?>? ov
     {
         var gitVersionOptions = this.options.Value;
         var workingDirectory = gitVersionOptions.WorkingDirectory;
-        var projectRootDirectory = workingDirectory.FindGitDir()?.WorkingTreeDirectory;
+        var projectRootDirectory = this.fileSystem.FindGitDir(workingDirectory)?.WorkingTreeDirectory;
 
         var configurationFile = this.configFileLocator.GetConfigurationFile(workingDirectory)
                              ?? this.configFileLocator.GetConfigurationFile(projectRootDirectory);

src/GitVersion.Core.Tests/Core/DynamicRepositoryTests.cs

@@ -10,46 +10,18 @@ public class DynamicRepositoryTests : TestBase
 {
     private string? workDirectory;
 
-    private static void ClearReadOnly(DirectoryInfo parentDirectory)
-    {
-        parentDirectory.Attributes = FileAttributes.Normal;
-        foreach (var fi in parentDirectory.GetFiles())
-        {
-            fi.Attributes = FileAttributes.Normal;
-        }
-        foreach (var di in parentDirectory.GetDirectories())
-        {
-            ClearReadOnly(di);
-        }
-    }
+    [SetUp]
+    public void SetUp() => this.workDirectory = PathHelper.Combine(Path.GetTempPath(), "GV");
 
-    [OneTimeSetUp]
-    public void CreateTemporaryRepository()
-    {
-        // Note: we can't use guid because paths will be too long
-        this.workDirectory = PathHelper.Combine(Path.GetTempPath(), "GV");
-
-        // Clean directory upfront, some build agents are having troubles
-        if (Directory.Exists(this.workDirectory))
-        {
-            var di = new DirectoryInfo(this.workDirectory);
-            ClearReadOnly(di);
-
-            Directory.Delete(this.workDirectory, true);
-        }
-
-        Directory.CreateDirectory(this.workDirectory);
-    }
-
-    [OneTimeTearDown]
-    public void Cleanup()
+    [TearDown]
+    public void TearDown()
     {
     }
 
     // Note: use same name twice to see if changing commits works on same (cached) repository
     [NonParallelizable]
-    [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "efddf2f92c539a9c27f1904d952dcab8fb955f0e", "5.8.2-56")]
     [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "2dc142a4a4df77db61a00d9fb7510b18b3c2c85a", "5.8.2-47")]
+    [TestCase("GV_main", "https://github.com/GitTools/GitVersion", MainBranch, "efddf2f92c539a9c27f1904d952dcab8fb955f0e", "5.8.2-56")]
     public void FindsVersionInDynamicRepo(string name, string url, string targetBranch, string commitId, string expectedFullSemVer)
     {
         var root = PathHelper.Combine(this.workDirectory, name);
@@ -64,21 +36,22 @@ public void FindsVersionInDynamicRepo(string name, string url, string targetBran
                 TargetBranch = targetBranch,
                 CommitId = commitId
             },
-            Settings = { NoFetch = false },
+            Settings = { NoFetch = false, NoCache = true },
             WorkingDirectory = workingDirectory
         };
         var options = Options.Create(gitVersionOptions);
 
-        Directory.CreateDirectory(dynamicDirectory);
-        Directory.CreateDirectory(workingDirectory);
-
         var sp = ConfigureServices(services => services.AddSingleton(options));
 
         sp.DiscoverRepository();
 
         var gitPreparer = sp.GetRequiredService<IGitPreparer>();
         gitPreparer.Prepare();
 
+        var fileSystem = sp.GetRequiredService<IFileSystem>();
+        fileSystem.CreateDirectory(dynamicDirectory);
+        fileSystem.CreateDirectory(workingDirectory);
+
         var gitVersionCalculator = sp.GetRequiredService<IGitVersionCalculateTool>();
 
         var versionVariables = gitVersionCalculator.CalculateVersionVariables();

src/GitVersion.Core.Tests/Core/GitVersionExecutorTests.cs

@@ -67,7 +67,7 @@ public void CacheKeyForWorktree()
     {
         using var fixture = new EmptyRepositoryFixture();
         fixture.Repository.MakeACommit();
-        var worktreePath = PathHelper.Combine(Directory.GetParent(fixture.RepositoryPath)?.FullName, Guid.NewGuid().ToString());
+        var worktreePath = GetWorktreePath(fixture);
         try
         {
             // create a branch and a new worktree for it
@@ -395,7 +395,7 @@ public void GetProjectRootDirectoryWorkingDirectoryWithWorktree()
         using var fixture = new EmptyRepositoryFixture();
         fixture.Repository.MakeACommit();
 
-        var worktreePath = PathHelper.Combine(Directory.GetParent(fixture.RepositoryPath)?.FullName, Guid.NewGuid().ToString());
+        var worktreePath = GetWorktreePath(fixture);
         try
         {
             // create a branch and a new worktree for it
@@ -451,7 +451,7 @@ public void GetDotGitDirectoryWorktree()
         using var fixture = new EmptyRepositoryFixture();
         fixture.Repository.MakeACommit();
 
-        var worktreePath = PathHelper.Combine(Directory.GetParent(fixture.RepositoryPath)?.FullName, Guid.NewGuid().ToString());
+        var worktreePath = GetWorktreePath(fixture);
         try
         {
             // create a branch and a new worktree for it
@@ -588,6 +588,12 @@ public void CalculateVersionVariables_ShallowFetch_ThrowException()
         exception?.Message.ShouldBe("Repository is a shallow clone. Git repositories must contain the full history. See https://gitversion.net/docs/reference/requirements#unshallow for more info.");
     }
 
+    private static string GetWorktreePath(EmptyRepositoryFixture fixture)
+    {
+        var worktreePath = PathHelper.Combine(Directory.GetParent(fixture.RepositoryPath)?.FullName, Guid.NewGuid().ToString());
+        return worktreePath;
+    }
+
     private IGitVersionCalculateTool GetGitVersionCalculator(GitVersionOptions gitVersionOptions, ILog? logger = null, IGitRepository? repository = null, IFileSystem? fs = null)
     {
         this.sp = GetServiceProvider(gitVersionOptions, logger, repository, fs);

src/GitVersion.Core.Tests/Helpers/GitVersionCoreTestModule.cs

@@ -17,7 +17,7 @@ public void RegisterTypes(IServiceCollection services)
         services.AddModule(new GitVersionConfigurationModule());
         services.AddModule(new GitVersionCoreModule());
 
-        services.AddSingleton<IFileSystem, TestFileSystem>();
+        services.AddSingleton<IFileSystem, FileSystem>();
         services.AddSingleton<IEnvironment, TestEnvironment>();
         services.AddSingleton<ILog, NullLog>();
     }