Merge pull request #4452 from arturcic/fix/config-filename-case-insensitive

arturcic · web-flow · commit 22f553a696eb · 2025-03-12T11:07:50.000+01:00
Config filename case insensitive
diff --git a/.editorconfig b/.editorconfig
@@ -2,12 +2,12 @@
 
 # top-most EditorConfig file
 root = true
+charset = utf-8
 
 [*]
 indent_style = space
 indent_size = 4
 end_of_line = lf
-charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 
diff --git a/build/.run/Build.run.xml b/build/.run/Build.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Build" type="DotNetProject" factoryName=".NET Project">
     <option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />
     <option name="PROGRAM_PARAMETERS" value="--target=Build" />
diff --git a/build/.run/Clean.run.xml b/build/.run/Clean.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Clean" type="DotNetProject" factoryName=".NET Project">
     <option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />
     <option name="PROGRAM_PARAMETERS" value="--target=Clean" />
diff --git a/build/.run/Package.run.xml b/build/.run/Package.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Package" type="DotNetProject" factoryName=".NET Project" folderName="Package">
     <option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />
     <option name="PROGRAM_PARAMETERS" value="--target=Package" />
diff --git a/build/.run/PublishCoverage.run.xml b/build/.run/PublishCoverage.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="PublishCoverage" type="DotNetProject" factoryName=".NET Project" folderName="Unit Test">
     <option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />
     <option name="PROGRAM_PARAMETERS" value="--target=PublishCoverage --dotnet_version=8.0" />
diff --git a/build/.run/Test.run.xml b/build/.run/Test.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Test" type="DotNetProject" factoryName=".NET Project" folderName="Unit Test">
     <option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />
     <option name="PROGRAM_PARAMETERS" value="" />
diff --git a/build/CI.sln b/build/CI.sln
@@ -1,4 +1,4 @@
-﻿Microsoft Visual Studio Solution File, Format Version 12.00
+Microsoft Visual Studio Solution File, Format Version 12.00
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sln", "sln", "{EC2C1EC4-BE56-4CAE-A3EE-4A67EED6BC6C}"
 ProjectSection(SolutionItems) = preProject
 	Directory.Build.props = Directory.Build.props
diff --git a/build/CI.sln.DotSettings b/build/CI.sln.DotSettings
@@ -1,4 +1,4 @@
-﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=OS/@EntryIndexedValue">OS</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Addins/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=endgroup/@EntryIndexedValue">True</s:Boolean>
diff --git a/build/Directory.Build.props b/build/Directory.Build.props
@@ -1,4 +1,4 @@
-﻿<Project>
+<Project>
     <PropertyGroup>
         <OutputType>Exe</OutputType>
         <TargetFramework>net9.0</TargetFramework>
diff --git a/build/build/Build.csproj.DotSettings b/build/build/Build.csproj.DotSettings
@@ -1,3 +1,3 @@
-﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=tasks_005Cpackage/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=tasks_005Ctest/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/new-cli/.run/Tester.run.xml b/new-cli/.run/Tester.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Tester" type="DotNetProject" factoryName=".NET Project">
     <option name="EXE_PATH" value="$PROJECT_DIR$/GitVersion.Core.Tester/bin/Debug/net9.0/gv" />
     <option name="PROGRAM_PARAMETERS" value="" />
diff --git a/new-cli/GitVersion.Calculation/GitVersion.Calculation.csproj b/new-cli/GitVersion.Calculation/GitVersion.Calculation.csproj
@@ -1,4 +1,4 @@
-﻿<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
     <ItemGroup>
         <ProjectReference Include="..\GitVersion.Common.Command\GitVersion.Common.Command.csproj" />
diff --git a/new-cli/GitVersion.sln b/new-cli/GitVersion.sln
@@ -1,4 +1,4 @@
-﻿
+
 Microsoft Visual Studio Solution File, Format Version 12.00
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GitVersion.Cli", "GitVersion.Cli\GitVersion.Cli.csproj", "{E2520F2D-A6FF-4079-85A4-584AA0CC8594}"
 EndProject
diff --git a/new-cli/GitVersion.sln.DotSettings b/new-cli/GitVersion.sln.DotSettings
@@ -1,2 +1,2 @@
-﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=enricher/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
diff --git a/new-cli/nuget.config b/new-cli/nuget.config
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <packageSources>
     <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
diff --git a/src/.run/schema.run.xml b/src/.run/schema.run.xml
@@ -1,4 +1,4 @@
-﻿<component name="ProjectRunConfigurationManager">
+<component name="ProjectRunConfigurationManager">
   <configuration default="false" name="schema" type="DotNetProject" factoryName=".NET Project">
     <option name="EXE_PATH" value="$PROJECT_DIR$/GitVersion.Schema/bin/Debug/net9.0/schema" />
     <option name="PROGRAM_PARAMETERS" value="--OutputDirectory schemas --Version 6.1" />
diff --git a/src/GitVersion.App.Tests/TestBuildFile.proj b/src/GitVersion.App.Tests/TestBuildFile.proj
@@ -1,4 +1,4 @@
-﻿<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
   <Target Name="OutputResults">
     <Message Text="GitVersion_FullSemVer: $(GitVersion_FullSemVer)"/>
diff --git a/src/GitVersion.Configuration.Tests/Configuration/ConfigurationFileLocatorTests.cs b/src/GitVersion.Configuration.Tests/Configuration/ConfigurationFileLocatorTests.cs
@@ -153,6 +153,22 @@ public void DoNotThrowWhenWorkingAndRepoPathsAreSame_WithDifferentCasing()
             Should.NotThrow(() => this.configFileLocator.Verify(this.workingPath, this.repoPath));
         }
 
+        [Test]
+        public void DoNotThrowWhenFileNameAreSame_WithDifferentCasing()
+        {
+            this.workingPath = this.repoPath;
+
+            this.gitVersionOptions = new() { ConfigurationInfo = { ConfigurationFile = "MyConfig.yaml" } };
+            var sp = GetServiceProvider(this.gitVersionOptions);
+            this.configFileLocator = sp.GetRequiredService<IConfigurationFileLocator>();
+            this.fileSystem = sp.GetRequiredService<IFileSystem>();
+
+            using var _ = this.fileSystem.SetupConfigFile(path: this.workingPath, fileName: ConfigFile.ToLower());
+
+            var config = Should.NotThrow(() => this.configFileLocator.GetConfigurationFile(this.workingPath));
+            config.ShouldNotBe(null);
+        }
+
         [Test]
         public void DoNotThrowWhenConfigFileIsInSubDirectoryOfRepoPath()
         {
diff --git a/src/GitVersion.Configuration/ConfigurationFileLocator.cs b/src/GitVersion.Configuration/ConfigurationFileLocator.cs
@@ -16,7 +16,14 @@ internal class ConfigurationFileLocator(
     public const string DefaultAlternativeFileName = "GitVersion.yaml";
     public const string DefaultFileNameDotted = $".{DefaultFileName}";
     public const string DefaultAlternativeFileNameDotted = $".{DefaultAlternativeFileName}";
-    public List<string> SupportedConfigFileNames = [DefaultFileName, DefaultAlternativeFileName, DefaultFileNameDotted, DefaultAlternativeFileNameDotted];
+
+    private readonly string[] SupportedConfigFileNames =
+    [
+        DefaultFileName,
+        DefaultAlternativeFileName,
+        DefaultFileNameDotted,
+        DefaultAlternativeFileNameDotted
+    ];
 
     private readonly IFileSystem fileSystem = fileSystem.NotNull();
     private readonly ILog log = log.NotNull();
@@ -35,21 +42,28 @@ public void Verify(string? workingDirectory, string? projectRootDirectory)
     {
         if (directory is null) return null;
 
-        string?[] candidates = [this.ConfigurationFile, .. SupportedConfigFileNames];
-        var candidatePaths =
-            from candidate in candidates
-            where !candidate.IsNullOrWhiteSpace()
-            select PathHelper.Combine(directory, candidate);
+        string[] candidates = !string.IsNullOrWhiteSpace(this.ConfigurationFile)
+            ? [this.ConfigurationFile, .. this.SupportedConfigFileNames]
+            : this.SupportedConfigFileNames;
 
-        foreach (var candidatePath in candidatePaths)
+        foreach (var fileName in candidates)
         {
-            this.log.Debug($"Trying to find configuration file at '{candidatePath}'");
-            if (fileSystem.File.Exists(candidatePath))
+            this.log.Debug($"Trying to find configuration file {fileName} at '{directory}'");
+            if (directory != null && fileSystem.Directory.Exists(directory))
             {
-                this.log.Info($"Found configuration file at '{candidatePath}'");
-                return candidatePath;
+                var files = fileSystem.Directory.GetFiles(directory);
+
+                var matchingFile = files.FirstOrDefault(file =>
+                    string.Equals(fileSystem.Path.GetFileName(file), fileName, StringComparison.OrdinalIgnoreCase));
+
+                if (matchingFile != null)
+                {
+                    this.log.Info($"Found configuration file at '{matchingFile}'");
+                    return matchingFile;
+                }
             }
-            this.log.Debug($"Configuration file not found at '{candidatePath}'");
+
+            this.log.Debug($"Configuration file {fileName} not found at '{directory}'");
         }
 
         return null;
@@ -60,22 +74,18 @@ private void WarnAboutAmbiguousConfigFileSelection(string? workingDirectory, str
         var workingConfigFile = GetConfigurationFile(workingDirectory);
         var projectRootConfigFile = GetConfigurationFile(projectRootDirectory);
 
-        var hasConfigInWorkingDirectory = workingConfigFile != null;
-        var hasConfigInProjectRootDirectory = projectRootConfigFile != null;
+        var hasConfigInWorkingDirectory = workingConfigFile is not null;
+        var hasConfigInProjectRootDirectory = projectRootConfigFile is not null;
 
         if (hasConfigInProjectRootDirectory && hasConfigInWorkingDirectory)
         {
             throw new WarningException($"Ambiguous configuration file selection from '{workingConfigFile}' and '{projectRootConfigFile}'");
         }
 
-        if (!hasConfigInProjectRootDirectory && !hasConfigInWorkingDirectory)
-        {
-            if (!SupportedConfigFileNames.Any(entry => entry.Equals(this.ConfigurationFile, StringComparison.OrdinalIgnoreCase)))
-            {
-                workingConfigFile = PathHelper.Combine(workingDirectory, this.ConfigurationFile);
-                projectRootConfigFile = PathHelper.Combine(projectRootDirectory, this.ConfigurationFile);
-                throw new WarningException($"The configuration file was not found at '{workingConfigFile}' or '{projectRootConfigFile}'");
-            }
-        }
+        if (hasConfigInProjectRootDirectory || hasConfigInWorkingDirectory || this.SupportedConfigFileNames.Any(entry => entry.Equals(this.ConfigurationFile, StringComparison.OrdinalIgnoreCase))) return;
+
+        workingConfigFile = PathHelper.Combine(workingDirectory, this.ConfigurationFile);
+        projectRootConfigFile = PathHelper.Combine(projectRootDirectory, this.ConfigurationFile);
+        throw new WarningException($"The configuration file was not found at '{workingConfigFile}' or '{projectRootConfigFile}'");
     }
 }
diff --git a/src/GitVersion.Output.Tests/Output/Approved/fs/GitVersionInfoGeneratorTests.ShouldProperlyOutputNamespaceDeclaration.approved.txt b/src/GitVersion.Output.Tests/Output/Approved/fs/GitVersionInfoGeneratorTests.ShouldProperlyOutputNamespaceDeclaration.approved.txt
@@ -1,4 +1,4 @@
-﻿//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 //     This code was generated by a tool.
 //     GitVersion
diff --git a/src/GitVersion.Output.Tests/Output/Approved/vb/GitVersionInfoGeneratorTests.ShouldProperlyOutputNamespaceDeclaration.approved.txt b/src/GitVersion.Output.Tests/Output/Approved/vb/GitVersionInfoGeneratorTests.ShouldProperlyOutputNamespaceDeclaration.approved.txt
@@ -1,4 +1,4 @@
-﻿'------------------------------------------------------------------------------
+'------------------------------------------------------------------------------
 ' <auto-generated>
 '     This code was generated by a tool.
 '     GitVersion
diff --git a/src/GitVersion.Output/AssemblyInfo/AddFormats/VersionAssemblyInfo.fs b/src/GitVersion.Output/AssemblyInfo/AddFormats/VersionAssemblyInfo.fs
@@ -1 +1 @@
-﻿[<assembly: {0}>]
+[<assembly: {0}>]
diff --git a/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.cs b/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.cs
@@ -1,4 +1,4 @@
-﻿//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 // This code was generated by GitVersion.
 //
diff --git a/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.fs b/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.fs
@@ -1,4 +1,4 @@
-﻿//------------------------------------------------------------------------------
+//------------------------------------------------------------------------------
 // <auto-generated>
 // This code was generated by GitVersion.
 //
diff --git a/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.vb b/src/GitVersion.Output/AssemblyInfo/Templates/VersionAssemblyInfo.vb
@@ -1,4 +1,4 @@
-﻿''------------------------------------------------------------------------------
+''------------------------------------------------------------------------------
 '' <auto-generated>
 '' This code was generated by GitVersion.
 ''
diff --git a/src/GitVersion.sln.DotSettings b/src/GitVersion.sln.DotSettings
@@ -1,4 +1,4 @@
-﻿<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
 
 
 	<s:Boolean x:Key="/Default/CodeEditing/Intellisense/CodeCompletion/AutoCompleteBasicCompletion/@EntryValue">True</s:Boolean>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<component name="ProjectRunConfigurationManager">`
	`1`	`+<component name="ProjectRunConfigurationManager">`
`2`	`2`	`<configuration default="false" name="Build" type="DotNetProject" factoryName=".NET Project">`
`3`	`3`	`<option name="EXE_PATH" value="$PROJECT_DIR$/../run/build" />`
`4`	`4`	`<option name="PROGRAM_PARAMETERS" value="--target=Build" />`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Microsoft Visual Studio Solution File, Format Version 12.00`
	`1`	`+Microsoft Visual Studio Solution File, Format Version 12.00`
`2`	`2`	`Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "sln", "sln", "{EC2C1EC4-BE56-4CAE-A3EE-4A67EED6BC6C}"`
`3`	`3`	`ProjectSection(SolutionItems) = preProject`
`4`	`4`	`Directory.Build.props = Directory.Build.props`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">`
	`1`	`+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">`
`2`	`2`	`<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=OS/@EntryIndexedValue">OS</s:String>`
`3`	`3`	`<s:Boolean x:Key="/Default/UserDictionary/Words/=Addins/@EntryIndexedValue">True</s:Boolean>`
`4`	`4`	`<s:Boolean x:Key="/Default/UserDictionary/Words/=endgroup/@EntryIndexedValue">True</s:Boolean>`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-<Project>`
	`1`	`+<Project>`
`2`	`2`	`<PropertyGroup>`
`3`	`3`	`<OutputType>Exe</OutputType>`
`4`	`4`	`<TargetFramework>net9.0</TargetFramework>`