Merge pull request #1214 from github/1094-support-migrate-org

`--target-api-url` support for migrate repo and org
github · Jan 30, 2024 · dadf326 · dadf326
2 parents a4672f7 + 1bb6bec
commit dadf326
Show file tree

Hide file tree

Showing 10 changed files with 118 additions and 8 deletions.
diff --git a/RELEASENOTES.md b/RELEASENOTES.md
@@ -1 +1 @@
-
+- Add `--target-api-url` to `gh ado2gh migrate-repo`, `gh bbs2gh migrate-repo`, and `gh gei migrate-org` to support newer GitHub migration paths.
diff --git a/src/OctoshiftCLI.Tests/ado2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs b/src/OctoshiftCLI.Tests/ado2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs
@@ -35,7 +35,7 @@ public void Should_Have_Options()
         {
             _command.Should().NotBeNull();
             _command.Name.Should().Be("migrate-repo");
-            _command.Options.Count.Should().Be(11);
+            _command.Options.Count.Should().Be(12);
 
             TestHelpers.VerifyCommandOption(_command.Options, "ado-org", true);
             TestHelpers.VerifyCommandOption(_command.Options, "ado-team-project", true);
@@ -48,6 +48,7 @@ public void Should_Have_Options()
             TestHelpers.VerifyCommandOption(_command.Options, "ado-pat", false);
             TestHelpers.VerifyCommandOption(_command.Options, "github-pat", false);
             TestHelpers.VerifyCommandOption(_command.Options, "verbose", false);
+            TestHelpers.VerifyCommandOption(_command.Options, "target-api-url", false);
         }
 
         [Fact]
@@ -71,5 +72,28 @@ public void It_Uses_Github_Pat_When_Provided()
 
             _mockGithubApiFactory.Verify(m => m.Create(null, githubPat));
         }
+        [Fact]
+        public void It_Uses_Target_Api_Url_When_Provided()
+        {
+            var adoPat = "abc123";
+            var githubPat = "def456";
+            var targetApiUrl = "https://api.github.com";
+
+            var args = new MigrateRepoCommandArgs
+            {
+                AdoOrg = "foo-org",
+                AdoTeamProject = "blah-tp",
+                AdoRepo = "some-repo",
+                GithubOrg = "gh-org",
+                GithubRepo = "gh-repo",
+                AdoPat = adoPat,
+                GithubPat = githubPat,
+                TargetApiUrl = targetApiUrl
+            };
+
+            _command.BuildHandler(args, _serviceProvider);
+
+            _mockGithubApiFactory.Verify(m => m.Create(targetApiUrl, githubPat));
+        }
     }
 }
diff --git a/src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs b/src/OctoshiftCLI.Tests/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandTests.cs
@@ -56,7 +56,7 @@ public void Should_Have_Options()
         var command = new MigrateRepoCommand();
         command.Should().NotBeNull();
         command.Name.Should().Be("migrate-repo");
-        command.Options.Count.Should().Be(30);
+        command.Options.Count.Should().Be(31);
 
         TestHelpers.VerifyCommandOption(command.Options, "bbs-server-url", true);
         TestHelpers.VerifyCommandOption(command.Options, "bbs-project", true);
@@ -87,6 +87,7 @@ public void Should_Have_Options()
         TestHelpers.VerifyCommandOption(command.Options, "verbose", false);
         TestHelpers.VerifyCommandOption(command.Options, "keep-archive", false);
         TestHelpers.VerifyCommandOption(command.Options, "no-ssl-verify", false);
+        TestHelpers.VerifyCommandOption(command.Options, "target-api-url", false);
     }
 
     [Fact]
@@ -214,6 +215,27 @@ public void BuildHandler_Creates_GitHub_Api_When_Github_Org_Is_Provided()
         _mockGithubApiFactory.Verify(m => m.Create(null, GITHUB_PAT));
     }
 
+    [Fact]
+    public void BuildHandler_Uses_Target_Api_Url_When_Provided()
+    {
+        // Arrange
+        var targetApiUrl = "https://api.github.com";
+        var args = new MigrateRepoCommandArgs
+        {
+            GithubOrg = GITHUB_ORG,
+            GithubPat = GITHUB_PAT,
+            TargetApiUrl = targetApiUrl
+        };
+
+        // Act
+        var handler = _command.BuildHandler(args, _mockServiceProvider.Object);
+
+        // Assert
+        handler.Should().NotBeNull();
+
+        _mockGithubApiFactory.Verify(m => m.Create(targetApiUrl, GITHUB_PAT));
+    }
+
     [Fact]
     public void BuildHandler_Creates_Bbs_Api_When_Bbs_Server_Url_Is_Provided()
     {

diff --git a/src/OctoshiftCLI.Tests/gei/Commands/MigrateOrg/MigrateOrgCommandTests.cs b/src/OctoshiftCLI.Tests/gei/Commands/MigrateOrg/MigrateOrgCommandTests.cs
@@ -1,18 +1,42 @@
 using FluentAssertions;
+using Microsoft.Extensions.DependencyInjection;
+using Moq;
+using OctoshiftCLI.Contracts;
 using OctoshiftCLI.GithubEnterpriseImporter.Commands.MigrateOrg;
+using OctoshiftCLI.Services;
 using Xunit;
 
 namespace OctoshiftCLI.Tests.GithubEnterpriseImporter.Commands.MigrateOrg
 {
     public class MigrateOrgCommandTests
     {
+        private readonly Mock<ITargetGithubApiFactory> _mockGithubApiFactory = new();
+        private readonly Mock<OctoLogger> _mockOctoLogger = TestHelpers.CreateMock<OctoLogger>();
+        private readonly Mock<EnvironmentVariableProvider> _mockEnvironmentVariableProvider = TestHelpers.CreateMock<EnvironmentVariableProvider>();
+        private readonly Mock<WarningsCountLogger> _warningsCountLogger = TestHelpers.CreateMock<WarningsCountLogger>();
+
+        private readonly ServiceProvider _serviceProvider;
+        private readonly MigrateOrgCommand _command = new();
+
+        public MigrateOrgCommandTests()
+        {
+            var serviceCollection = new ServiceCollection();
+            serviceCollection
+                .AddSingleton(_mockOctoLogger.Object)
+                .AddSingleton(_mockGithubApiFactory.Object)
+                .AddSingleton(_mockEnvironmentVariableProvider.Object)
+                .AddSingleton(_warningsCountLogger.Object);
+
+            _serviceProvider = serviceCollection.BuildServiceProvider();
+        }
+
         [Fact]
         public void Should_Have_Options()
         {
             var command = new MigrateOrgCommand();
             command.Should().NotBeNull();
             command.Name.Should().Be("migrate-org");
-            command.Options.Count.Should().Be(7);
+            command.Options.Count.Should().Be(8);
 
             TestHelpers.VerifyCommandOption(command.Options, "github-source-org", true);
             TestHelpers.VerifyCommandOption(command.Options, "github-target-org", true);
@@ -21,6 +45,29 @@ public void Should_Have_Options()
             TestHelpers.VerifyCommandOption(command.Options, "github-source-pat", false);
             TestHelpers.VerifyCommandOption(command.Options, "github-target-pat", false);
             TestHelpers.VerifyCommandOption(command.Options, "verbose", false);
+            TestHelpers.VerifyCommandOption(command.Options, "target-api-url", false);
+        }
+
+        [Fact]
+        public void It_Uses_Target_Api_Url_When_Provided()
+        {
+            var githubSourcePat = "abc123";
+            var githubTargetPat = "def456";
+            var targetApiUrl = "https://api.github.com";
+
+            var args = new MigrateOrgCommandArgs
+            {
+                GithubSourceOrg = "source-org",
+                GithubSourcePat = githubSourcePat,
+                GithubTargetOrg = "target-org",
+                GithubTargetEnterprise = "target-enterprise",
+                GithubTargetPat = githubTargetPat,
+                TargetApiUrl = targetApiUrl
+            };
+
+            _command.BuildHandler(args, _serviceProvider);
+
+            _mockGithubApiFactory.Verify(m => m.Create(targetApiUrl, githubTargetPat));
         }
     }
 }
diff --git a/src/ado2gh/Commands/MigrateRepo/MigrateRepoCommand.cs b/src/ado2gh/Commands/MigrateRepo/MigrateRepoCommand.cs
@@ -26,6 +26,7 @@ public MigrateRepoCommand() : base(
             AddOption(AdoPat);
             AddOption(GithubPat);
             AddOption(Verbose);
+            AddOption(TargetApiUrl);
         }
 
         public Option<string> AdoOrg { get; } = new("--ado-org")
@@ -61,6 +62,10 @@ public MigrateRepoCommand() : base(
         {
             Description = "The visibility of the target repo. Defaults to private. Valid values are public, private, or internal."
         };
+        public Option<string> TargetApiUrl { get; } = new("--target-api-url")
+        {
+            Description = "The URL of the target API, if not migrating to github.com. Defaults to https://api.github.com"
+        };
         public Option<string> AdoPat { get; } = new("--ado-pat");
         public Option<string> GithubPat { get; } = new("--github-pat");
         public Option<bool> Verbose { get; } = new("--verbose");
@@ -79,7 +84,7 @@ public override MigrateRepoCommandHandler BuildHandler(MigrateRepoCommandArgs ar
 
             var log = sp.GetRequiredService<OctoLogger>();
             var githubApiFactory = sp.GetRequiredService<ITargetGithubApiFactory>();
-            var githubApi = githubApiFactory.Create(targetPersonalAccessToken: args.GithubPat);
+            var githubApi = githubApiFactory.Create(args.TargetApiUrl, args.GithubPat);
             var environmentVariableProvider = sp.GetRequiredService<EnvironmentVariableProvider>();
             var warningsCountLogger = sp.GetRequiredService<WarningsCountLogger>();
 

diff --git a/src/ado2gh/Commands/MigrateRepo/MigrateRepoCommandArgs.cs b/src/ado2gh/Commands/MigrateRepo/MigrateRepoCommandArgs.cs
@@ -16,5 +16,6 @@ public class MigrateRepoCommandArgs : CommandArgs
         public string AdoPat { get; set; }
         [Secret]
         public string GithubPat { get; set; }
+        public string TargetApiUrl { get; set; }
     }
 }
diff --git a/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommand.cs b/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommand.cs
@@ -47,6 +47,7 @@ public MigrateRepoCommand() : base(
         AddOption(Verbose);
         AddOption(KeepArchive);
         AddOption(NoSslVerify);
+        AddOption(TargetApiUrl);
     }
 
     public Option<string> BbsServerUrl { get; } = new(
@@ -182,7 +183,10 @@ public MigrateRepoCommand() : base(
     public Option<bool> KeepArchive { get; } = new(
         name: "--keep-archive",
         description: "Keeps the downloaded export archive after successfully uploading it. By default, it will be automatically deleted.");
-
+    public Option<string> TargetApiUrl { get; } = new("--target-api-url")
+    {
+        Description = "The URL of the target API, if not migrating to github.com. Defaults to https://api.github.com"
+    };
     public Option<bool> NoSslVerify { get; } = new(
         name: "--no-ssl-verify",
         description: "Disables SSL verification when communicating with your Bitbucket Server/Data Center instance. All other migration steps will continue to verify SSL. " +
@@ -212,7 +216,7 @@ public override MigrateRepoCommandHandler BuildHandler(MigrateRepoCommandArgs ar
         if (args.GithubOrg.HasValue())
         {
             var githubApiFactory = sp.GetRequiredService<GithubApiFactory>();
-            githubApi = githubApiFactory.Create(null, args.GithubPat);
+            githubApi = githubApiFactory.Create(args.TargetApiUrl, args.GithubPat);
         }
 
         if (args.BbsServerUrl.HasValue())

diff --git a/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandArgs.cs b/src/bbs2gh/Commands/MigrateRepo/MigrateRepoCommandArgs.cs
@@ -28,6 +28,7 @@ public class MigrateRepoCommandArgs : CommandArgs
     public string GithubPat { get; set; }
     public bool QueueOnly { get; set; }
     public string TargetRepoVisibility { get; set; }
+    public string TargetApiUrl { get; set; }
     public bool Kerberos { get; set; }
 
     public string BbsServerUrl { get; set; }

diff --git a/src/gei/Commands/MigrateOrg/MigrateOrgCommand.cs b/src/gei/Commands/MigrateOrg/MigrateOrgCommand.cs
@@ -16,6 +16,7 @@ public MigrateOrgCommand() : base(
             AddOption(GithubSourceOrg);
             AddOption(GithubTargetOrg);
             AddOption(GithubTargetEnterprise);
+            AddOption(TargetApiUrl);
 
             AddOption(GithubSourcePat);
             AddOption(GithubTargetPat);
@@ -40,6 +41,10 @@ public MigrateOrgCommand() : base(
         };
         public Option<string> GithubSourcePat { get; } = new("--github-source-pat");
         public Option<string> GithubTargetPat { get; } = new("--github-target-pat");
+        public Option<string> TargetApiUrl { get; } = new("--target-api-url")
+        {
+            Description = "The URL of the target API, if not migrating to github.com. Defaults to https://api.github.com"
+        };
         public Option<bool> QueueOnly { get; } = new("--queue-only")
         {
             Description = "Only queues the migration, does not wait for it to finish. Use the wait-for-migration command to subsequently wait for it to finish and view the status."
@@ -62,7 +67,7 @@ public override MigrateOrgCommandHandler BuildHandler(MigrateOrgCommandArgs args
             var environmentVariableProvider = sp.GetRequiredService<EnvironmentVariableProvider>();
 
             var targetGithubApiFactory = sp.GetRequiredService<ITargetGithubApiFactory>();
-            var targetGithubApi = targetGithubApiFactory.Create(targetPersonalAccessToken: args.GithubTargetPat);
+            var targetGithubApi = targetGithubApiFactory.Create(args.TargetApiUrl, args.GithubTargetPat);
 
             return new MigrateOrgCommandHandler(log, targetGithubApi, environmentVariableProvider);
         }

diff --git a/src/gei/Commands/MigrateOrg/MigrateOrgCommandArgs.cs b/src/gei/Commands/MigrateOrg/MigrateOrgCommandArgs.cs
@@ -14,6 +14,7 @@ public class MigrateOrgCommandArgs : CommandArgs
         public string GithubSourcePat { get; set; }
         [Secret]
         public string GithubTargetPat { get; set; }
+        public string TargetApiUrl { get; set; }
 
         public override void Validate(OctoLogger log)
         {