Implements --no-launch-profile-arguments dotnet-run option (#45841)

dotnet · Jan 9, 2025 · fc944af · fc944af
1 parent 6319104
commit fc944af
Show file tree

Hide file tree

Showing 18 changed files with 117 additions and 17 deletions.
diff --git a/src/Cli/dotnet/commands/dotnet-run/LocalizableStrings.resx b/src/Cli/dotnet/commands/dotnet-run/LocalizableStrings.resx
@@ -139,6 +139,9 @@
   <data name="CommandOptionNoLaunchProfileDescription" xml:space="preserve">
     <value>Do not attempt to use launchSettings.json to configure the application.</value>
   </data>
+  <data name="CommandOptionNoLaunchProfileArgumentsDescription" xml:space="preserve">
+    <value>Do not use arguments specified in launch profile to run the application.</value>
+  </data>
   <data name="ConfigurationOptionDescription" xml:space="preserve">
     <value>The configuration to run for. The default for most projects is 'Debug'.</value>
   </data>

diff --git a/src/Cli/dotnet/commands/dotnet-run/Program.cs b/src/Cli/dotnet/commands/dotnet-run/Program.cs
@@ -59,6 +59,7 @@ public static RunCommand FromParseResult(ParseResult parseResult)
                 projectFileOrDirectory: parseResult.GetValue(RunCommandParser.ProjectOption),
                 launchProfile: parseResult.GetValue(RunCommandParser.LaunchProfileOption),
                 noLaunchProfile: parseResult.HasOption(RunCommandParser.NoLaunchProfileOption),
+                noLaunchProfileArguments: parseResult.HasOption(RunCommandParser.NoLaunchProfileArgumentsOption),
                 noRestore: parseResult.HasOption(RunCommandParser.NoRestoreOption) || parseResult.HasOption(RunCommandParser.NoBuildOption),
                 interactive: parseResult.HasOption(RunCommandParser.InteractiveOption),
                 verbosity: parseResult.HasOption(CommonOptions.VerbosityOption) ? parseResult.GetValue(CommonOptions.VerbosityOption) : null,

diff --git a/src/Cli/dotnet/commands/dotnet-run/RunCommand.cs b/src/Cli/dotnet/commands/dotnet-run/RunCommand.cs
@@ -20,30 +20,36 @@ public partial class RunCommand
     {
         private record RunProperties(string? RunCommand, string? RunArguments, string? RunWorkingDirectory);
 
-        public bool NoBuild { get; private set; }
-        public string ProjectFileFullPath { get; private set; }
+        public bool NoBuild { get; }
+        public string? ProjectFileOrDirectory { get; }
+        public string ProjectFileFullPath { get; }
         public string[] Args { get; set; }
-        public bool NoRestore { get; private set; }
+        public bool NoRestore { get; }
         public VerbosityOptions? Verbosity { get; }
-        public bool Interactive { get; private set; }
-        public string[] RestoreArgs { get; private set; }
+        public bool Interactive { get; }
+        public string[] RestoreArgs { get; }
 
         /// <summary>
         /// Environment variables specified on command line via -e option.
         /// </summary>
-        public IReadOnlyDictionary<string, string> EnvironmentVariables { get; private set; }
+        public IReadOnlyDictionary<string, string> EnvironmentVariables { get; }
 
         private bool ShouldBuild => !NoBuild;
 
-        public string LaunchProfile { get; private set; }
-        public bool NoLaunchProfile { get; private set; }
-        private bool UseLaunchProfile => !NoLaunchProfile;
+        public string LaunchProfile { get; }
+        public bool NoLaunchProfile { get; }
+
+        /// <summary>
+        /// True to ignore command line arguments specified by launch profile.
+        /// </summary>
+        public bool NoLaunchProfileArguments { get; }
 
         public RunCommand(
             bool noBuild,
             string? projectFileOrDirectory,
             string launchProfile,
             bool noLaunchProfile,
+            bool noLaunchProfileArguments,
             bool noRestore,
             bool interactive,
             VerbosityOptions? verbosity,
@@ -52,9 +58,11 @@ public RunCommand(
             IReadOnlyDictionary<string, string> environmentVariables)
         {
             NoBuild = noBuild;
+            ProjectFileOrDirectory = projectFileOrDirectory;
             ProjectFileFullPath = DiscoverProjectFilePath(projectFileOrDirectory);
             LaunchProfile = launchProfile;
             NoLaunchProfile = noLaunchProfile;
+            NoLaunchProfileArguments = noLaunchProfileArguments;
             Args = args;
             Interactive = interactive;
             NoRestore = noRestore;
@@ -125,7 +133,7 @@ private void ApplyLaunchSettingsProfileToCommand(ICommand targetCommand, Project
                 targetCommand.EnvironmentVariable(entry.Key, value);
             }
 
-            if (string.IsNullOrEmpty(targetCommand.CommandArgs) && launchSettings.CommandLineArgs != null)
+            if (!NoLaunchProfileArguments && string.IsNullOrEmpty(targetCommand.CommandArgs) && launchSettings.CommandLineArgs != null)
             {
                 targetCommand.SetCommandArgs(launchSettings.CommandLineArgs);
             }
@@ -134,7 +142,7 @@ private void ApplyLaunchSettingsProfileToCommand(ICommand targetCommand, Project
         private bool TryGetLaunchProfileSettingsIfNeeded(out ProjectLaunchSettingsModel? launchSettingsModel)
         {
             launchSettingsModel = default;
-            if (!UseLaunchProfile)
+            if (NoLaunchProfile)
             {
                 return true;
             }

diff --git a/src/Cli/dotnet/commands/dotnet-run/RunCommandParser.cs b/src/Cli/dotnet/commands/dotnet-run/RunCommandParser.cs
@@ -34,6 +34,11 @@ internal static class RunCommandParser
             Description = LocalizableStrings.CommandOptionNoLaunchProfileDescription
         };
 
+        public static readonly CliOption<bool> NoLaunchProfileArgumentsOption = new("--no-launch-profile-arguments")
+        {
+            Description = LocalizableStrings.CommandOptionNoLaunchProfileArgumentsDescription
+        };
+
         public static readonly CliOption<bool> NoBuildOption = new("--no-build")
         {
             Description = LocalizableStrings.CommandOptionNoBuildDescription

diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.cs.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.cs.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.de.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.de.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.es.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.es.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.fr.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.fr.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.it.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.it.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ja.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ja.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ko.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ko.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.pl.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.pl.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.pt-BR.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.pt-BR.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ru.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.ru.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.tr.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.tr.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.zh-Hans.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.zh-Hans.xlf
diff --git a/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.zh-Hant.xlf b/src/Cli/dotnet/commands/dotnet-run/xlf/LocalizableStrings.zh-Hant.xlf
diff --git a/test/dotnet-run.Tests/GivenDotnetRunBuildsCsProj.cs b/test/dotnet-run.Tests/GivenDotnetRunBuildsCsProj.cs
@@ -856,21 +856,39 @@ public void EnvVariablesSpecifiedInLaunchProfileOverrideImplicitlySetVariables()
         [Fact]
         public void ItIncludesCommandArgumentsSpecifiedInLaunchSettings()
         {
-            var expectedValue = "TestAppCommandLineArguments";
-            var secondExpectedValue = "SecondTestAppCommandLineArguments";
-            var testAppName = "TestAppWithLaunchSettings";
-            var testInstance = _testAssetsManager.CopyTestAsset(testAppName)
+            var testInstance = _testAssetsManager.CopyTestAsset("TestAppWithLaunchSettings")
                 .WithSource();
 
+            // launchSettings.json specifies commandLineArgs="TestAppCommandLineArguments SecondTestAppCommandLineArguments"
+
             new DotnetCommand(Log, "run")
                .WithWorkingDirectory(testInstance.Path)
                .Execute()
                .Should()
                .Pass()
                .And
-               .HaveStdOutContaining(expectedValue)
+               .HaveStdOutContaining("TestAppCommandLineArguments")
+               .And
+               .HaveStdOutContaining("SecondTestAppCommandLineArguments");
+        }
+
+        [Fact]
+        public void ItIgnoresCommandArgumentsSpecifiedInLaunchSettings()
+        {
+            var testInstance = _testAssetsManager.CopyTestAsset("TestAppWithLaunchSettings")
+                .WithSource();
+
+            // launchSettings.json specifies commandLineArgs="TestAppCommandLineArguments SecondTestAppCommandLineArguments"
+
+            new DotnetCommand(Log, "run", "--no-launch-profile-arguments")
+               .WithWorkingDirectory(testInstance.Path)
+               .Execute()
+               .Should()
+               .Pass()
+               .And
+               .NotHaveStdOutContaining("TestAppCommandLineArguments")
                .And
-               .HaveStdOutContaining(secondExpectedValue);
+               .NotHaveStdOutContaining("SecondTestAppCommandLineArguments");
         }
 
         [Fact]