Merge pull request #1499 from github/o1/push-mvlyxwzkvtxx

Support `--target-api-url` consistently on download-logs commands

Author: offbyone

RELEASENOTES.md

@@ -1 +1,3 @@
-
+- Fixed `ado2gh generate-script --download-migration-logs` to generate valid commands using `--target-api-url` that work with the `ado2gh download-logs` command
+- Added `--target-api-url` support to `ado2gh download-logs` and `bbs2gh download-logs` commands for GHEC data residency scenarios
+- Maintained backward compatibility: `--github-api-url` continues to work as an alias for `--target-api-url` in `ado2gh` and `bbs2gh` CLIs

src/Octoshift/Commands/DownloadLogs/DownloadLogsCommandBase.cs

@@ -31,9 +31,9 @@ public class DownloadLogsCommandBase : CommandBase<DownloadLogsCommandArgs, Down
         Description = "Migration ID to download logs for. If specified, --github-org and --github-repo are not required."
     };
 
-    public virtual Option<string> GithubApiUrl { get; } = new("--github-api-url")
+    public virtual Option<string> GithubApiUrl { get; } = new("--target-api-url")
     {
-        Description = "Target GitHub API URL if not targeting github.com (default: https://api.github.com)."
+        Description = "Target GitHub API URL if not targeting github.com (default: https://api.github.com). Also accepts --github-api-url for backward compatibility."
     };
 
     public virtual Option<string> GithubPat { get; } = new("--github-pat")

src/OctoshiftCLI.Tests/ado2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs

@@ -1,3 +1,4 @@
+using System.Linq;
 using OctoshiftCLI.AdoToGithub.Commands.DownloadLogs;
 using Xunit;
 
@@ -16,10 +17,22 @@ public void Should_Have_Options()
         TestHelpers.VerifyCommandOption(command.Options, "github-org", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-repo", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-id", false);
-        TestHelpers.VerifyCommandOption(command.Options, "github-api-url", false);
+        TestHelpers.VerifyCommandOption(command.Options, "target-api-url", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-pat", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-log-file", false);
         TestHelpers.VerifyCommandOption(command.Options, "overwrite", false);
         TestHelpers.VerifyCommandOption(command.Options, "verbose", false);
     }
+
+    [Fact]
+    public void Should_Support_Github_Api_Url_Alias_For_Backward_Compatibility()
+    {
+        // Test that --github-api-url still works as an alias for --target-api-url
+        var command = new DownloadLogsCommand();
+        var option = command.Options.FirstOrDefault(o => o.Name == "target-api-url");
+
+        Assert.NotNull(option);
+        Assert.Contains("--target-api-url", option.Aliases);
+        Assert.Contains("--github-api-url", option.Aliases);
+    }
 }

src/OctoshiftCLI.Tests/bbs2gh/Commands/DownloadLogs/DownloadLogsCommandTests.cs

@@ -1,3 +1,4 @@
+using System.Linq;
 using OctoshiftCLI.BbsToGithub.Commands.DownloadLogs;
 using Xunit;
 
@@ -16,10 +17,22 @@ public void Should_Have_Options()
         TestHelpers.VerifyCommandOption(command.Options, "github-org", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-repo", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-id", false);
-        TestHelpers.VerifyCommandOption(command.Options, "github-api-url", false);
+        TestHelpers.VerifyCommandOption(command.Options, "target-api-url", false);
         TestHelpers.VerifyCommandOption(command.Options, "github-pat", false);
         TestHelpers.VerifyCommandOption(command.Options, "migration-log-file", false);
         TestHelpers.VerifyCommandOption(command.Options, "overwrite", false);
         TestHelpers.VerifyCommandOption(command.Options, "verbose", false);
     }
+
+    [Fact]
+    public void Should_Support_Github_Api_Url_Alias_For_Backward_Compatibility()
+    {
+        // Test that --github-api-url still works as an alias for --target-api-url
+        var command = new DownloadLogsCommand();
+        var option = command.Options.FirstOrDefault(o => o.Name == "target-api-url");
+
+        Assert.NotNull(option);
+        Assert.Contains("--target-api-url", option.Aliases);
+        Assert.Contains("--github-api-url", option.Aliases);
+    }
 }

src/ado2gh/Commands/DownloadLogs/DownloadLogsCommand.cs

@@ -5,7 +5,13 @@
 
 namespace OctoshiftCLI.AdoToGithub.Commands.DownloadLogs;
 
-public class DownloadLogsCommand : DownloadLogsCommandBase
+public sealed class DownloadLogsCommand : DownloadLogsCommandBase
 {
-    public DownloadLogsCommand() : base() => AddOptions();
+    public DownloadLogsCommand() : base()
+    {
+        // Add backward compatibility alias for --github-api-url
+        GithubApiUrl.AddAlias("--github-api-url");
+
+        AddOptions();
+    }
 }

src/bbs2gh/Commands/DownloadLogs/DownloadLogsCommand.cs

@@ -5,7 +5,13 @@
 
 namespace OctoshiftCLI.BbsToGithub.Commands.DownloadLogs;
 
-public class DownloadLogsCommand : DownloadLogsCommandBase
+public sealed class DownloadLogsCommand : DownloadLogsCommandBase
 {
-    public DownloadLogsCommand() => AddOptions();
+    public DownloadLogsCommand()
+    {
+        // Add backward compatibility alias for --github-api-url
+        GithubApiUrl.AddAlias("--github-api-url");
+
+        AddOptions();
+    }
 }

src/gei/Commands/DownloadLogs/DownloadLogsCommand.cs

@@ -6,7 +6,7 @@
 
 namespace OctoshiftCLI.GithubEnterpriseImporter.Commands.DownloadLogs;
 
-public class DownloadLogsCommand : DownloadLogsCommandBase
+public sealed class DownloadLogsCommand : DownloadLogsCommandBase
 {
     public DownloadLogsCommand() : base() => AddOptions();