Include the file path in the exception when configuration loading fails

src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/FileConfigurationProvider.cs

@@ -65,10 +65,10 @@ private void Load(bool reload)
                 }
                 else
                 {
-                    var error = new StringBuilder($"The configuration file '{Source.Path}' was not found and is not optional.");
+                    var error = new StringBuilder(SR.Format(SR.Error_FileNotFound, Source.Path));
                     if (!string.IsNullOrEmpty(file?.PhysicalPath))
                     {
-                        error.Append($" The physical path is '{file.PhysicalPath}'.");
+                        error.Append(SR.Format(SR.Error_ExpectedPhysicalPath, file.PhysicalPath));
                     }
                     HandleException(ExceptionDispatchInfo.Capture(new FileNotFoundException(error.ToString())));
                 }
@@ -88,7 +88,8 @@ private void Load(bool reload)
                     }
                     catch (Exception e)
                     {
-                        HandleException(ExceptionDispatchInfo.Capture(e));
+                        var exception = new InvalidDataException(SR.Format(SR.Error_LoadFailed, file.PhysicalPath), e);
+                        HandleException(ExceptionDispatchInfo.Capture(exception));
                     }
                 }
             }
@@ -101,6 +102,9 @@ private void Load(bool reload)
         /// </summary>
         /// <exception cref="FileNotFoundException">If Optional is <c>false</c> on the source and a
         /// file does not exist at specified Path.</exception>
+        /// <exception cref="InvalidDataException">Wrapping any exception thrown by the concrete implementation of the
+        /// <see cref="Load()"/> method. Use the source <see cref="FileConfigurationSource.OnLoadException"/> callback
+        /// if you need more control over the exception.</exception>
         public override void Load()
         {
             Load(reload: false);

src/libraries/Microsoft.Extensions.Configuration.FileExtensions/src/Resources/Strings.resx

@@ -1,4 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
+<?xml version="1.0" encoding="utf-8"?>
 <root>
   <!-- 
     Microsoft ResX Schema 
@@ -118,9 +118,12 @@
     <value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
   </resheader>
   <data name="Error_ExpectedPhysicalPath" xml:space="preserve">
-    <value>The expected physical path was '{0}'.</value>
+    <value> The expected physical path is '{0}'.</value>
   </data>
   <data name="Error_FileNotFound" xml:space="preserve">
     <value>The configuration file '{0}' was not found and is not optional.</value>
   </data>
+  <data name="Error_LoadFailed" xml:space="preserve">
+    <value>Failed to load configuration from file '{0}'.</value>
+  </data>
 </root>

src/libraries/Microsoft.Extensions.Configuration.FileExtensions/tests/FileConfigurationProviderTest.cs

@@ -3,11 +3,9 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
-using System.Collections.Generic;
 using System.IO;
 using Microsoft.Extensions.Configuration.Test;
 using Microsoft.Extensions.FileProviders;
-using Microsoft.Extensions.Primitives;
 using Moq;
 using Xunit;
 
@@ -35,14 +33,55 @@ public void ProviderDisposesChangeTokenRegistration()
             Assert.Empty(changeToken.Callbacks);
         }
 
+        [Theory]
+        [InlineData(@"C:\path\to\configuration.txt")]
+        [InlineData(@"/path/to/configuration.txt")]
+        public void ProviderThrowsInvalidDataExceptionWhenLoadFails(string physicalPath)
+        {
+            var fileProviderMock = new Mock<IFileProvider>();
+            fileProviderMock.Setup(fp => fp.Watch(It.IsAny<string>())).Returns(new ConfigurationRootTest.ChangeToken());
+            fileProviderMock.Setup(fp => fp.GetFileInfo(It.IsAny<string>())).Returns(new FileInfoImpl(physicalPath));
+
+            var source = new FileConfigurationSourceImpl
+            {
+                FileProvider = fileProviderMock.Object,
+                ReloadOnChange = true,
+            };
+            var exceptionOnLoad = new Exception("An error occured");
+            var provider = new FileConfigurationProviderImpl(source, exceptionOnLoad);
+
+            var exception = Assert.Throws<InvalidDataException>(() => provider.Load());
+            Assert.Contains($"'{physicalPath}'", exception.Message);
+            Assert.Equal(exceptionOnLoad, exception.InnerException);
+        }
+
+        public class FileInfoImpl : IFileInfo
+        {
+            public FileInfoImpl(string physicalPath) => PhysicalPath = physicalPath;
+            public Stream CreateReadStream() => new MemoryStream();
+            public bool Exists => true;
+            public bool IsDirectory => false;
+            public DateTimeOffset LastModified => default;
+            public long Length => default;
+            public string Name => default;
+            public string PhysicalPath { get; }
+        }
+
         public class FileConfigurationProviderImpl : FileConfigurationProvider
         {
-            public FileConfigurationProviderImpl(FileConfigurationSource source)
+            private readonly Exception _exceptionOnLoad;
+
+            public FileConfigurationProviderImpl(FileConfigurationSource source, Exception exceptionOnLoad = null)
                 : base(source)
-            { }
+            {
+                _exceptionOnLoad = exceptionOnLoad;
+            }
 
             public override void Load(Stream stream)
-            { }
+            {
+                if (_exceptionOnLoad != null)
+                    throw _exceptionOnLoad;
+            }
         }
 
         public class FileConfigurationSourceImpl : FileConfigurationSource

src/libraries/Microsoft.Extensions.Configuration/tests/FunctionalTests/ConfigurationTests.cs

@@ -382,9 +382,9 @@ public void OnLoadErrorWillBeCalledOnJsonParseError()
                     .SetFileLoadExceptionHandler(jsonLoadError)
                     .Build();
             }
-            catch (Exception e)
+            catch (InvalidDataException e)
             {
-                Assert.Equal(e, jsonError);
+                Assert.Equal(e.InnerException, jsonError);
             }
 
             Assert.NotNull(provider);
@@ -410,9 +410,9 @@ public void OnLoadErrorWillBeCalledOnXmlParseError()
                     .SetFileLoadExceptionHandler(loadError)
                     .Build();
             }
-            catch (Exception e)
+            catch (InvalidDataException e)
             {
-                Assert.Equal(e, error);
+                Assert.Equal(e.InnerException, error);
             }
 
             Assert.NotNull(provider);
@@ -439,9 +439,9 @@ public void OnLoadErrorWillBeCalledOnIniLoadError()
                     .SetFileLoadExceptionHandler(loadError)
                     .Build();
             }
-            catch (FormatException e)
+            catch (InvalidDataException e)
             {
-                Assert.Equal(e, error);
+                Assert.Equal(e.InnerException, error);
             }
             Assert.NotNull(provider);
         }