Make Configuration.BuildFrom() able to probe for the local configuration file

nulltoken · nulltoken · commit a0c2c9ce88d2 · 2015-05-31T16:39:10.000+02:00
diff --git a/LibGit2Sharp.Tests/ConfigurationFixture.cs b/LibGit2Sharp.Tests/ConfigurationFixture.cs
@@ -1,8 +1,10 @@
 ﻿using System;
+using System.Collections.Generic;
 using System.IO;
 using System.Linq;
 using LibGit2Sharp.Tests.TestHelpers;
 using Xunit;
+using Xunit.Extensions;
 
 namespace LibGit2Sharp.Tests
 {
@@ -367,8 +369,21 @@ public void CanTellIfASpecificStoreContainsAKey()
             }
         }
 
-        [Fact]
-        public void CanAccessConfigurationWithoutARepository()
+        public static IEnumerable<object[]> ConfigAccessors
+        {
+            get
+            {
+                return new List<object[]>
+                {
+                    new[] { new Func<string, string>(p => Path.Combine(p, ".git", "config")) },
+                    new[] { new Func<string, string>(p => Path.Combine(p, ".git")) },
+                    new[] { new Func<string, string>(p => p) },
+                };
+            }
+        }
+
+        [Theory, PropertyData("ConfigAccessors")]
+        public void CanAccessConfigurationWithoutARepository(Func<string, string> localConfigurationPathProvider)
         {
             var path = SandboxStandardTestRepoGitDir();
 
@@ -381,11 +396,18 @@ public void CanAccessConfigurationWithoutARepository()
                 repo.Config.Set("my.key", "mouse", ConfigurationLevel.Global);
             }
 
-            using (var config = Configuration.BuildFrom(Path.Combine(path, ".git", "config"), globalConfigPath))
+            using (var config = Configuration.BuildFrom(localConfigurationPathProvider(path), globalConfigPath))
             {
                 Assert.Equal("local", config.Get<string>("my.key").Value);
                 Assert.Equal("mouse", config.Get<string>("my.key", ConfigurationLevel.Global).Value);
             }
         }
+
+        [Fact]
+        public void PassingANonExistingLocalConfigurationFileToBuildFromthrowss()
+        {
+            Assert.Throws<FileNotFoundException>(() => Configuration.BuildFrom(
+                Path.Combine(Path.GetTempPath(), Path.GetRandomFileName())));
+        }
     }
 }
diff --git a/LibGit2Sharp.Tests/TestHelpers/BaseFixture.cs b/LibGit2Sharp.Tests/TestHelpers/BaseFixture.cs
@@ -336,8 +336,8 @@ protected string CreateConfigurationWithDummyUser(Signature signature)
         protected string CreateConfigurationWithDummyUser(string name, string email)
         {
             SelfCleaningDirectory scd = BuildSelfCleaningDirectory();
-            Directory.CreateDirectory(scd.DirectoryPath);
-            string configFilePath = Path.Combine(scd.DirectoryPath, "fake-config");
+
+            string configFilePath = Touch(scd.DirectoryPath, "fake-config");
 
             using (Configuration config = Configuration.BuildFrom(configFilePath))
             {
diff --git a/LibGit2Sharp/Configuration.cs b/LibGit2Sharp/Configuration.cs
@@ -60,7 +60,7 @@ private void Init()
             }
             else if (repoConfigPath != null)
             {
-                Proxy.git_config_add_file_ondisk(configHandle, repoConfigPath, ConfigurationLevel.Local);
+                Proxy.git_config_add_file_ondisk(configHandle, NormalizeConfigPath(repoConfigPath), ConfigurationLevel.Local);
             }
 
             if (globalConfigPath != null)
@@ -79,13 +79,46 @@ private void Init()
             }
         }
 
+        private FilePath NormalizeConfigPath(FilePath path)
+        {
+            if (File.Exists(path.Native))
+            {
+                return path;
+            }
+
+            if (!Directory.Exists(path.Native))
+            {
+                throw new FileNotFoundException("Cannot find repository configuration file", path.Native);
+            }
+
+            var configPath = Path.Combine(path.Native, "config");
+
+            if (File.Exists(configPath))
+            {
+                return configPath;
+            }
+
+            var gitConfigPath = Path.Combine(path.Native, ".git", "config");
+
+            if (File.Exists(gitConfigPath))
+            {
+                return gitConfigPath;
+            }
+
+            throw new FileNotFoundException("Cannot find repository configuration file", path.Native);
+        }
+
         /// <summary>
         /// Access configuration values without a repository.
         /// <para>
         ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </para>
+        /// <para>
+        ///   <paramref name="repositoryConfigurationFileLocation"/> can either contains a path to a file or a directory. In the latter case,
+        ///   this can be the working directory, the .git directory or the directory containing a bare repository.
+        /// </para>
         /// </summary>
-        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="repositoryConfigurationFileLocation">Path to an existing Repository configuration file.</param>
         /// <returns>An instance of <see cref="Configuration"/>.</returns>
         public static Configuration BuildFrom(
             string repositoryConfigurationFileLocation)
@@ -98,8 +131,12 @@ public static Configuration BuildFrom(
         /// <para>
         ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </para>
+        /// <para>
+        ///   <paramref name="repositoryConfigurationFileLocation"/> can either contains a path to a file or a directory. In the latter case,
+        ///   this can be the working directory, the .git directory or the directory containing a bare repository.
+        /// </para>
         /// </summary>
-        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="repositoryConfigurationFileLocation">Path to an existing Repository configuration file.</param>
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
         /// <returns>An instance of <see cref="Configuration"/>.</returns>
         public static Configuration BuildFrom(
@@ -114,8 +151,12 @@ public static Configuration BuildFrom(
         /// <para>
         ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </para>
+        /// <para>
+        ///   <paramref name="repositoryConfigurationFileLocation"/> can either contains a path to a file or a directory. In the latter case,
+        ///   this can be the working directory, the .git directory or the directory containing a bare repository.
+        /// </para>
         /// </summary>
-        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="repositoryConfigurationFileLocation">Path to an existing Repository configuration file.</param>
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
         /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
         /// <returns>An instance of <see cref="Configuration"/>.</returns>
@@ -132,8 +173,12 @@ public static Configuration BuildFrom(
         /// <para>
         ///   Generally you want to access configuration via an instance of <see cref="Repository"/> instead.
         /// </para>
+        /// <para>
+        ///   <paramref name="repositoryConfigurationFileLocation"/> can either contains a path to a file or a directory. In the latter case,
+        ///   this can be the working directory, the .git directory or the directory containing a bare repository.
+        /// </para>
         /// </summary>
-        /// <param name="repositoryConfigurationFileLocation">Path to a Repository configuration file.</param>
+        /// <param name="repositoryConfigurationFileLocation">Path to an existing Repository configuration file.</param>
         /// <param name="globalConfigurationFileLocation">Path to a Global configuration file. If null, the default path for a Global configuration file will be probed.</param>
         /// <param name="xdgConfigurationFileLocation">Path to a XDG configuration file. If null, the default path for a XDG configuration file will be probed.</param>
         /// <param name="systemConfigurationFileLocation">Path to a System configuration file. If null, the default path for a System configuration file will be probed.</param>

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,10 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Collections.Generic;`
`2`	`3`	`using System.IO;`
`3`	`4`	`using System.Linq;`
`4`	`5`	`using LibGit2Sharp.Tests.TestHelpers;`
`5`	`6`	`using Xunit;`
	`7`	`+using Xunit.Extensions;`
`6`	`8`
`7`	`9`	`namespace LibGit2Sharp.Tests`
`8`	`10`	`{`
`@@ -367,8 +369,21 @@ public void CanTellIfASpecificStoreContainsAKey()`
`367`	`369`	`}`
`368`	`370`	`}`
`369`	`371`
`370`		`- [Fact]`
`371`		`- public void CanAccessConfigurationWithoutARepository()`
	`372`	`+ public static IEnumerable<object[]> ConfigAccessors`
	`373`	`+ {`
	`374`	`+ get`
	`375`	`+ {`
	`376`	`+ return new List<object[]>`
	`377`	`+ {`
	`378`	`+ new[] { new Func<string, string>(p => Path.Combine(p, ".git", "config")) },`
	`379`	`+ new[] { new Func<string, string>(p => Path.Combine(p, ".git")) },`
	`380`	`+ new[] { new Func<string, string>(p => p) },`
	`381`	`+ };`
	`382`	`+ }`
	`383`	`+ }`
	`384`	`+`
	`385`	`+ [Theory, PropertyData("ConfigAccessors")]`
	`386`	`+ public void CanAccessConfigurationWithoutARepository(Func<string, string> localConfigurationPathProvider)`
`372`	`387`	`{`
`373`	`388`	`var path = SandboxStandardTestRepoGitDir();`
`374`	`389`
`@@ -381,11 +396,18 @@ public void CanAccessConfigurationWithoutARepository()`
`381`	`396`	`repo.Config.Set("my.key", "mouse", ConfigurationLevel.Global);`
`382`	`397`	`}`
`383`	`398`
`384`		`- using (var config = Configuration.BuildFrom(Path.Combine(path, ".git", "config"), globalConfigPath))`
	`399`	`+ using (var config = Configuration.BuildFrom(localConfigurationPathProvider(path), globalConfigPath))`
`385`	`400`	`{`
`386`	`401`	`Assert.Equal("local", config.Get<string>("my.key").Value);`
`387`	`402`	`Assert.Equal("mouse", config.Get<string>("my.key", ConfigurationLevel.Global).Value);`
`388`	`403`	`}`
`389`	`404`	`}`
	`405`	`+`
	`406`	`+ [Fact]`
	`407`	`+ public void PassingANonExistingLocalConfigurationFileToBuildFromthrowss()`
	`408`	`+ {`
	`409`	`+ Assert.Throws<FileNotFoundException>(() => Configuration.BuildFrom(`
	`410`	`+ Path.Combine(Path.GetTempPath(), Path.GetRandomFileName())));`
	`411`	`+ }`
`390`	`412`	`}`
`391`	`413`	`}`
Original file line number	Diff line number	Diff line change
`@@ -336,8 +336,8 @@ protected string CreateConfigurationWithDummyUser(Signature signature)`
`336`	`336`	`protected string CreateConfigurationWithDummyUser(string name, string email)`
`337`	`337`	`{`
`338`	`338`	`SelfCleaningDirectory scd = BuildSelfCleaningDirectory();`
`339`		`- Directory.CreateDirectory(scd.DirectoryPath);`
`340`		`- string configFilePath = Path.Combine(scd.DirectoryPath, "fake-config");`
	`339`	`+`
	`340`	`+ string configFilePath = Touch(scd.DirectoryPath, "fake-config");`
`341`	`341`
`342`	`342`	`using (Configuration config = Configuration.BuildFrom(configFilePath))`
`343`	`343`	`{`