Make errors more specific, add support for setting the launch URL for ASP.NET apps

mlorbetske · mlorbetske · commit 452e642ac754 · 2017-05-30T22:42:46.000-07:00
diff --git a/src/dotnet/commands/dotnet-run/LaunchSettings/ILaunchSettingsProvider.cs b/src/dotnet/commands/dotnet-run/LaunchSettings/ILaunchSettingsProvider.cs
@@ -7,7 +7,7 @@ public interface ILaunchSettingsProvider
     {
         string CommandName { get; }
 
-        bool TryApplySettings(JObject document, JObject model, ref ICommand command, out string runAfterLaunch);
+        LaunchSettingsApplyResult TryApplySettings(JObject document, JObject model, ref ICommand command);
     }
 
 }
diff --git a/src/dotnet/commands/dotnet-run/LaunchSettings/LaunchSettingsApplyResult.cs b/src/dotnet/commands/dotnet-run/LaunchSettings/LaunchSettingsApplyResult.cs
@@ -0,0 +1,18 @@
+namespace Microsoft.DotNet.Tools.Run.LaunchSettings
+{
+    public class LaunchSettingsApplyResult
+    {
+        public LaunchSettingsApplyResult(bool success, string failureReason, string runAfterLaunch = null)
+        {
+            Success = success;
+            FailureReason = failureReason;
+            RunAfterLaunch = runAfterLaunch;
+        }
+
+        public bool Success { get; }
+
+        public string FailureReason { get; }
+
+        public string RunAfterLaunch { get; }
+    }
+}
diff --git a/src/dotnet/commands/dotnet-run/LaunchSettings/LaunchSettingsManager.cs b/src/dotnet/commands/dotnet-run/LaunchSettings/LaunchSettingsManager.cs
@@ -21,7 +21,7 @@ static LaunchSettingsManager()
             };
         }
 
-        public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref ICommand command, out string runAfterLaunch, string profileName = null)
+        public static LaunchSettingsApplyResult TryApplyLaunchSettings(string launchSettingsJsonContents, ref ICommand command, string profileName = null)
         {
             try
             {
@@ -30,8 +30,7 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref
 
                 if (profilesObject == null)
                 {
-                    runAfterLaunch = null;
-                    return false;
+                    return new LaunchSettingsApplyResult(false, LocalizableStrings.LaunchProfilesCollectionIsNotAJsonObject);
                 }
 
                 JObject profileObject;
@@ -47,8 +46,7 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref
 
                     if (profileObject == null)
                     {
-                        runAfterLaunch = null;
-                        return false;
+                        return new LaunchSettingsApplyResult(false, LocalizableStrings.LaunchProfileIsNotAJsonObject);
                     }
                 }
 
@@ -72,18 +70,21 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref
 
                 var commandName = profileObject?[CommandNameKey]?.Value<string>();
 
-                if (profileObject == null || !TryLocateHandler(commandName, out ILaunchSettingsProvider provider))
+                if (profileObject == null)
+                {
+                    return new LaunchSettingsApplyResult(false, LocalizableStrings.UsableLaunchProfileCannotBeLocated);
+                }
+
+                if (!TryLocateHandler(commandName, out ILaunchSettingsProvider provider))
                 {
-                    runAfterLaunch = null;
-                    return false;
+                    return new LaunchSettingsApplyResult(false, string.Format(LocalizableStrings.LaunchProfileHandlerCannotBeLocated, commandName));
                 }
 
-                return provider.TryApplySettings(model, profileObject, ref command, out runAfterLaunch);
+                return provider.TryApplySettings(model, profileObject, ref command);
             }
-            catch
+            catch (Exception ex)
             {
-                runAfterLaunch = null;
-                return false;
+                return new LaunchSettingsApplyResult(false, string.Format(LocalizableStrings.UnexpectedExceptionProcessingLaunchSettings, ex.Message));
             }
         }
 
diff --git a/src/dotnet/commands/dotnet-run/LaunchSettings/ProjectLaunchSettingsProvider.cs b/src/dotnet/commands/dotnet-run/LaunchSettings/ProjectLaunchSettingsProvider.cs
@@ -11,7 +11,7 @@ public class ProjectLaunchSettingsProvider : ILaunchSettingsProvider
 
         public string CommandName => CommandNameValue;
 
-        public bool TryApplySettings(JObject document, JObject model, ref ICommand command, out string runAfterLaunch)
+        public LaunchSettingsApplyResult TryApplySettings(JObject document, JObject model, ref ICommand command)
         {
             try
             {
@@ -26,13 +26,16 @@ public bool TryApplySettings(JObject document, JObject model, ref ICommand comma
                     command.EnvironmentVariable(entry.Key, value);
                 }
 
-                runAfterLaunch = null;
-                return true;
+                if (!string.IsNullOrEmpty(config.ApplicationUrl))
+                {
+                    command.EnvironmentVariable("ASPNETCORE_URLS", config.ApplicationUrl);
+                }
+
+                return new LaunchSettingsApplyResult(true, null, config.LaunchUrl);
             }
-            catch
+            catch (Exception ex)
             {
-                runAfterLaunch = null;
-                return false;
+                return new LaunchSettingsApplyResult(false, ex.Message);
             }
         }
 
diff --git a/src/dotnet/commands/dotnet-run/LocalizableStrings.cs b/src/dotnet/commands/dotnet-run/LocalizableStrings.cs
@@ -35,8 +35,20 @@ internal class LocalizableStrings
 
         public const string RunCommandExceptionCouldNotLocateALaunchSettingsFile = "The specified launch profile could not be located.";
 
-        public const string RunCommandExceptionCouldNotApplyLaunchSettings = "The launch profile \"{0}\" could not be applied.";
+        public const string RunCommandExceptionCouldNotApplyLaunchSettings = "The launch profile \"{0}\" could not be applied.\n{1}";
 
         public const string DefaultLaunchProfileDisplayName = "(Default)";
+
+        public const string UsingLaunchSettingsFromMessage = "Using launch settings from {0}...";
+
+        public const string LaunchProfileIsNotAJsonObject = "Launch profile is not a JSON object.";
+
+        public const string LaunchProfileHandlerCannotBeLocated = "The launch profile type '{0}' is not supported.";
+
+        public const string UsableLaunchProfileCannotBeLocated = "A usable launch profile could not be located.";
+
+        public const string UnexpectedExceptionProcessingLaunchSettings = "An unexpected exception occurred while processing launch settings:\n{0}";
+
+        public const string LaunchProfilesCollectionIsNotAJsonObject = "The 'profiles' property of the launch settings document is not a JSON object.";
     }
 }
diff --git a/src/dotnet/commands/dotnet-run/RunCommand.cs b/src/dotnet/commands/dotnet-run/RunCommand.cs
@@ -44,18 +44,30 @@ public int Start()
                 var launchSettingsPath = Path.Combine(buildPathContainer, "Properties", "launchSettings.json");
                 if (File.Exists(launchSettingsPath))
                 {
-                    var launchSettingsFileContents = File.ReadAllText(launchSettingsPath);
-                    if (!LaunchSettingsManager.TryApplyLaunchSettings(launchSettingsFileContents, ref runCommand, out string runAfterLaunch, LaunchProfile))
+                    Reporter.Output.WriteLine(string.Format(LocalizableStrings.UsingLaunchSettingsFromMessage, launchSettingsPath));
+                    string profileName = string.IsNullOrEmpty(LaunchProfile) ? LocalizableStrings.DefaultLaunchProfileDisplayName : LaunchProfile;
+
+                    try
+                    {
+                        var launchSettingsFileContents = File.ReadAllText(launchSettingsPath);
+                        var applyResult = LaunchSettingsManager.TryApplyLaunchSettings(launchSettingsFileContents, ref runCommand, LaunchProfile);
+                        if (!applyResult.Success)
+                        {                            
+                            //Error that the launch profile couldn't be applied
+                            Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName, applyResult.FailureReason).Bold().Red());
+                        }
+                    }
+                    catch (IOException ex)
                     {
-                        string profileName = string.IsNullOrEmpty(LaunchProfile) ? LocalizableStrings.DefaultLaunchProfileDisplayName : LaunchProfile;
-                        //Error that the launch profile couldn't be applied
-                        Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName));
+                        Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName).Bold().Red());
+                        Reporter.Error.WriteLine(ex.Message.Bold().Red());
+                        return -1;
                     }
                 }
                 else if (!string.IsNullOrEmpty(LaunchProfile))
                 {
                     //Error that the launch profile couldn't be found
-                    Reporter.Error.WriteLine(LocalizableStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile);
+                    Reporter.Error.WriteLine(LocalizableStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile.Bold().Red());
                 }
             }
 
diff --git a/test/dotnet-run.Tests/GivenDotnetRunRunsCsProj.cs b/test/dotnet-run.Tests/GivenDotnetRunRunsCsProj.cs
@@ -436,7 +436,7 @@ public void ItSkipsLaunchProfilesWhenThereIsNoUsableDefault()
         }
 
         [Fact]
-        public void ItPrintsAnErrorWhenLaunchSettingsArCorrupted()
+        public void ItPrintsAnErrorWhenLaunchSettingsAreCorrupted()
         {
             var testAppName = "MSBuildTestAppWithCorruptedLaunchSettings";
             var testInstance = TestAssets.Get(testAppName)

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ public interface ILaunchSettingsProvider`
`7`	`7`	`{`
`8`	`8`	`string CommandName { get; }`
`9`	`9`
`10`		`- bool TryApplySettings(JObject document, JObject model, ref ICommand command, out string runAfterLaunch);`
	`10`	`+ LaunchSettingsApplyResult TryApplySettings(JObject document, JObject model, ref ICommand command);`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ static LaunchSettingsManager()`
`21`	`21`	`};`
`22`	`22`	`}`
`23`	`23`
`24`		`- public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref ICommand command, out string runAfterLaunch, string profileName = null)`
	`24`	`+ public static LaunchSettingsApplyResult TryApplyLaunchSettings(string launchSettingsJsonContents, ref ICommand command, string profileName = null)`
`25`	`25`	`{`
`26`	`26`	`try`
`27`	`27`	`{`
`@@ -30,8 +30,7 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref`
`30`	`30`
`31`	`31`	`if (profilesObject == null)`
`32`	`32`	`{`
`33`		`- runAfterLaunch = null;`
`34`		`- return false;`
	`33`	`+ return new LaunchSettingsApplyResult(false, LocalizableStrings.LaunchProfilesCollectionIsNotAJsonObject);`
`35`	`34`	`}`
`36`	`35`
`37`	`36`	`JObject profileObject;`
`@@ -47,8 +46,7 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref`
`47`	`46`
`48`	`47`	`if (profileObject == null)`
`49`	`48`	`{`
`50`		`- runAfterLaunch = null;`
`51`		`- return false;`
	`49`	`+ return new LaunchSettingsApplyResult(false, LocalizableStrings.LaunchProfileIsNotAJsonObject);`
`52`	`50`	`}`
`53`	`51`	`}`
`54`	`52`
`@@ -72,18 +70,21 @@ public static bool TryApplyLaunchSettings(string launchSettingsJsonContents, ref`
`72`	`70`
`73`	`71`	`var commandName = profileObject?[CommandNameKey]?.Value<string>();`
`74`	`72`
`75`		`- if (profileObject == null \|\| !TryLocateHandler(commandName, out ILaunchSettingsProvider provider))`
	`73`	`+ if (profileObject == null)`
	`74`	`+ {`
	`75`	`+ return new LaunchSettingsApplyResult(false, LocalizableStrings.UsableLaunchProfileCannotBeLocated);`
	`76`	`+ }`
	`77`	`+`
	`78`	`+ if (!TryLocateHandler(commandName, out ILaunchSettingsProvider provider))`
`76`	`79`	`{`
`77`		`- runAfterLaunch = null;`
`78`		`- return false;`
	`80`	`+ return new LaunchSettingsApplyResult(false, string.Format(LocalizableStrings.LaunchProfileHandlerCannotBeLocated, commandName));`
`79`	`81`	`}`
`80`	`82`
`81`		`- return provider.TryApplySettings(model, profileObject, ref command, out runAfterLaunch);`
	`83`	`+ return provider.TryApplySettings(model, profileObject, ref command);`
`82`	`84`	`}`
`83`		`- catch`
	`85`	`+ catch (Exception ex)`
`84`	`86`	`{`
`85`		`- runAfterLaunch = null;`
`86`		`- return false;`
	`87`	`+ return new LaunchSettingsApplyResult(false, string.Format(LocalizableStrings.UnexpectedExceptionProcessingLaunchSettings, ex.Message));`
`87`	`88`	`}`
`88`	`89`	`}`
`89`	`90`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public class ProjectLaunchSettingsProvider : ILaunchSettingsProvider`
`11`	`11`
`12`	`12`	`public string CommandName => CommandNameValue;`
`13`	`13`
`14`		`- public bool TryApplySettings(JObject document, JObject model, ref ICommand command, out string runAfterLaunch)`
	`14`	`+ public LaunchSettingsApplyResult TryApplySettings(JObject document, JObject model, ref ICommand command)`
`15`	`15`	`{`
`16`	`16`	`try`
`17`	`17`	`{`
`@@ -26,13 +26,16 @@ public bool TryApplySettings(JObject document, JObject model, ref ICommand comma`
`26`	`26`	`command.EnvironmentVariable(entry.Key, value);`
`27`	`27`	`}`
`28`	`28`
`29`		`- runAfterLaunch = null;`
`30`		`- return true;`
	`29`	`+ if (!string.IsNullOrEmpty(config.ApplicationUrl))`
	`30`	`+ {`
	`31`	`+ command.EnvironmentVariable("ASPNETCORE_URLS", config.ApplicationUrl);`
	`32`	`+ }`
	`33`	`+`
	`34`	`+ return new LaunchSettingsApplyResult(true, null, config.LaunchUrl);`
`31`	`35`	`}`
`32`		`- catch`
	`36`	`+ catch (Exception ex)`
`33`	`37`	`{`
`34`		`- runAfterLaunch = null;`
`35`		`- return false;`
	`38`	`+ return new LaunchSettingsApplyResult(false, ex.Message);`
`36`	`39`	`}`
`37`	`40`	`}`
`38`	`41`
Original file line number	Diff line number	Diff line change
`@@ -44,18 +44,30 @@ public int Start()`
`44`	`44`	`var launchSettingsPath = Path.Combine(buildPathContainer, "Properties", "launchSettings.json");`
`45`	`45`	`if (File.Exists(launchSettingsPath))`
`46`	`46`	`{`
`47`		`- var launchSettingsFileContents = File.ReadAllText(launchSettingsPath);`
`48`		`- if (!LaunchSettingsManager.TryApplyLaunchSettings(launchSettingsFileContents, ref runCommand, out string runAfterLaunch, LaunchProfile))`
	`47`	`+ Reporter.Output.WriteLine(string.Format(LocalizableStrings.UsingLaunchSettingsFromMessage, launchSettingsPath));`
	`48`	`+ string profileName = string.IsNullOrEmpty(LaunchProfile) ? LocalizableStrings.DefaultLaunchProfileDisplayName : LaunchProfile;`
	`49`	`+`
	`50`	`+ try`
	`51`	`+ {`
	`52`	`+ var launchSettingsFileContents = File.ReadAllText(launchSettingsPath);`
	`53`	`+ var applyResult = LaunchSettingsManager.TryApplyLaunchSettings(launchSettingsFileContents, ref runCommand, LaunchProfile);`
	`54`	`+ if (!applyResult.Success)`
	`55`	`+ {`
	`56`	`+ //Error that the launch profile couldn't be applied`
	`57`	`+ Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName, applyResult.FailureReason).Bold().Red());`
	`58`	`+ }`
	`59`	`+ }`
	`60`	`+ catch (IOException ex)`
`49`	`61`	`{`
`50`		`- string profileName = string.IsNullOrEmpty(LaunchProfile) ? LocalizableStrings.DefaultLaunchProfileDisplayName : LaunchProfile;`
`51`		`- //Error that the launch profile couldn't be applied`
`52`		`- Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName));`
	`62`	`+ Reporter.Error.WriteLine(string.Format(LocalizableStrings.RunCommandExceptionCouldNotApplyLaunchSettings, profileName).Bold().Red());`
	`63`	`+ Reporter.Error.WriteLine(ex.Message.Bold().Red());`
	`64`	`+ return -1;`
`53`	`65`	`}`
`54`	`66`	`}`
`55`	`67`	`else if (!string.IsNullOrEmpty(LaunchProfile))`
`56`	`68`	`{`
`57`	`69`	`//Error that the launch profile couldn't be found`
`58`		`- Reporter.Error.WriteLine(LocalizableStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile);`
	`70`	`+ Reporter.Error.WriteLine(LocalizableStrings.RunCommandExceptionCouldNotLocateALaunchSettingsFile.Bold().Red());`
`59`	`71`	`}`
`60`	`72`	`}`
`61`	`73`
Original file line number	Diff line number	Diff line change
`@@ -436,7 +436,7 @@ public void ItSkipsLaunchProfilesWhenThereIsNoUsableDefault()`
`436`	`436`	`}`
`437`	`437`
`438`	`438`	`[Fact]`
`439`		`- public void ItPrintsAnErrorWhenLaunchSettingsArCorrupted()`
	`439`	`+ public void ItPrintsAnErrorWhenLaunchSettingsAreCorrupted()`
`440`	`440`	`{`
`441`	`441`	`var testAppName = "MSBuildTestAppWithCorruptedLaunchSettings";`
`442`	`442`	`var testInstance = TestAssets.Get(testAppName)`